javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-15 09:34:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
ionic-framework/angular/test
History
Liam DeBeasi ce2e37b1a1 fix(angular): null values are not converted to falsy value (#26341) 
BREAKING CHANGE:

Datetime:

Passing the empty string to the `value` property will now error as it is not a valid ISO-8601 value.

Angular:

`null` values on form components will no longer be converted to the empty string (`''`) or `false`. This impacts `ion-checkbox`, `ion-datetime`, `ion-input`, `ion-radio`, `ion-radio-group`, ion-range`, `ion-searchbar`, `ion-segment`, `ion-select`, `ion-textarea`, and `ion-toggle`.
2022-11-23 13:03:13 -05:00
..
apps
Merge remote-tracking branch 'origin/main' into sync-7-11-15-22
2022-11-15 15:40:21 -05:00
base
fix(angular): null values are not converted to falsy value (#26341)
2022-11-23 13:03:13 -05:00
build.sh
feat(angular): use standalone components with routing (#25589)
2022-08-30 10:38:16 -04:00
README.md
test(angular): add info on how to disable cache (#25924)
2022-09-12 16:03:56 -04:00
sync-e2e.sh
feat(angular): use standalone components with routing (#25589)
2022-08-30 10:38:16 -04:00

README.md

Angular E2E Test Apps

Ionic Framework supports multiple versions of Angular. As a result, we need to verify that Ionic works correctly with each of these Angular versions.

Application Cache

Angular CLI creates a cache of several files on disk by default in the .angular directory. This decreases the time taken to build the test application. When testing changes by directly modifying Ionic's source code in node_modules, you may need to manually clear the .angular cache and restart the local server every time you make a change. As a result, it may be desirable to disable the .angular cache while making changes to the code.

See https://angular.io/cli/cache for more information.

Disable Cache

ng cache disable

Note: You may need to manually remove the .angular directory once after running this command.

Enable Cache

ng cache enable

Test App Build Structure

Unlike other test applications, these test apps are broken up into multiple directories. These directories are then combined to create a single application. This allows us to share common application code, tests, etc so that each app is being tested the same way. Below details the different pieces that help create a single test application.

apps - This directory contains partial applications for each version of Angular we want to test. Typically these directories contain new package.json files, angular.json files, and more. If you have code that is specific to a particular version of Angular, put it in this directory.

base - This directory contains the base application that each test app will use. This is where tests, application logic, and more live. If you have code that needs to be run on every test app, put it in this directory.

build - When the apps and base directories are merged, the final result is put in this directory. The build directory should never be committed to git.

build.sh - This is the script that merges the apps and base directories and places the built application in the build directory.

Usage:

# Build a test app using apps/ng14 as a reference
./build.sh ng14

How to modify test apps

To add new tests, components, or pages, modify the base project. This ensures that tests are run for every tested version.

If you want to add a version-specific change, add the change inside of the appropriate projects in apps. Be sure to replicate the directory structure. For example, if you are adding a new E2E test file called test.spec.ts in apps/ng14, make sure you place the file in apps/ng14/e2e/src/test.spec.ts.

Version-specific tests

If you need to add E2E tests that are only run on a specific version of the JS Framework, replicate the VersionTest component on each partial application. This ensures that tests for framework version X do not get run for framework version Y.

Adding New Test Apps

As we add support for new versions of Angular, we will also need to update this directory to test against new applications. The following steps can serve as a guide for adding new apps:

  1. Navigate to the built app for the most recent version of Angular that Ionic tests.
  2. Update the application by following the steps on https://update.angular.io/.
  3. Make note of any files that changed during the upgrade (package.json, package-lock.json, angular.json, etc).
  4. Copy the changed files to a new directory in apps.
  5. Add a new entry to the matrix for test-core-angular in ./github/workflows/build.yml. This will allow the new test app to run against all PRs.
  6. Commit these changes and push.

Example:

In this example, we are going to add the Angular 14 test app.

  1. Build the Angular 13 test app using ./build.sh ng13.
  2. Navigate to build/ng13.
  3. Perform the upgrade steps on https://update.angular.io/. The "From" field should say "13.0" and the "To" field should say "14.0".

Note: You may encounter some other peer dependency issues not covered by the Angular Upgrade Guide. These peer dependency issues can be resolved manually by updating the installed version of each dependency.

  1. Observe that the output of the Angular upgrade indicates that the following files were modified:

angular.json package-lock.json package.json tsconfig.json src/app/form/form.component.ts src/app/modal-example/modal-example.component.ts

  1. Create a directory in apps named ng14.
  2. Copy the modified files to the apps/ng14 directory.
  3. Open ./github/workflows/build.yml and find the test-angular-e2e job.
  4. Find the apps field under matrix.
  5. Add "ng14" to the apps field.
  6. Committ these changes and push.