1f89c6130e
Currently, when running the ngcc binary directly and provide an invalid option ngcc will not error out and the user might have a hard time telling why ngcc is behaving not as expected.
With this change we now output an actionable error:
```
yarn ngcc --unknown-option
Options:
--version Show version number [boolean]
-s, --source A path (relative to the working directory)
of the `node_modules` folder to process.
[default: "./node_modules"]
-p, --properties An array of names of properties in
package.json to compile (e.g. `module` or
`es2015`)
Each of these properties should hold the
path to a bundle-format.
If provided, only the specified properties
are considered for processing.
If not provided, all the supported format
properties (e.g. fesm2015, fesm5, es2015,
esm2015, esm5, main, module) in the
package.json are considered. [array]
-t, --target A relative path (from the `source` path) to
a single entry-point to process (plus its
dependencies).
--first-only If specified then only the first matching
package.json property will be compiled.
[boolean]
--create-ivy-entry-points If specified then new `*_ivy_ngcc`
entry-points will be added to package.json
rather than modifying the ones in-place.
For this to work you need to have custom
resolution set up (e.g. in webpack) to look
for these new entry-points.
The Angular CLI does this already, so it is
safe to use this option if the project is
being built via the CLI. [boolean]
--legacy-message-ids Render `$localize` messages with legacy
format ids.
The default value is `true`. Only set this
to `false` if you do not want legacy
message ids to
be rendered. For example, if you are not
using legacy message ids in your
translation files
AND are not doing compile-time inlining of
translations, in which case the extra
message ids
would add unwanted size to the final source
bundle.
It is safe to leave this set to true if you
are doing compile-time inlining because the
extra
legacy message ids will all be stripped
during translation.
[boolean] [default: true]
--async Whether to compile asynchronously. This is
enabled by default as it allows
compilations to be parallelized.
Disabling asynchronous compilation may be
useful for debugging.
[boolean] [default: true]
-l, --loglevel The lowest severity logging message that
should be output.
[choices: "debug", "info", "warn", "error"]
--invalidate-entry-point-manifest If this is set then ngcc will not read an
entry-point manifest file from disk.
Instead it will walking the directory tree
as normal looking for entry-points, and
then write a new manifest file.
[boolean] [default: false]
--help Show help [boolean]
Unknown arguments: unknown-option, unknownOption
```
PR Close #36010
|
||
|---|---|---|
| .. | ||
| bazel | ||
| bazel-schematics | ||
| cli-hello-world | ||
| cli-hello-world-ivy-compat | ||
| cli-hello-world-ivy-i18n | ||
| cli-hello-world-ivy-minimal | ||
| cli-hello-world-lazy | ||
| cli-hello-world-lazy-rollup | ||
| dynamic-compiler | ||
| hello_world__closure | ||
| hello_world__systemjs_umd | ||
| i18n | ||
| injectable-def | ||
| ivy-i18n | ||
| language_service_plugin | ||
| ng_elements | ||
| ng_elements_schematics | ||
| ng_update | ||
| ng_update_migrations | ||
| ngcc | ||
| platform-server | ||
| service-worker-schema | ||
| side-effects | ||
| terser | ||
| typings_test_ts36 | ||
| typings_test_ts37 | ||
| typings_test_ts38 | ||
| .gitignore | ||
| BUILD.bazel | ||
| README.md | ||
| _payload-limits.json | ||
| angular_integration_test.bzl | ||
| check-dependencies.js | ||
| get-sharded-tests.js | ||
| run_tests.sh | ||
README.md
Integration tests for Angular
This directory contains end-to-end tests for Angular. Each directory is a self-contained application that exactly mimics how a user might expect Angular to work, so they allow high-fidelity reproductions of real-world issues.
For this to work, we first build the Angular distribution via ./scripts/build/build-packages-dist.js, then
install the distribution into each app.
To test Angular CLI applications, we use the cli-hello-world-* integration tests.
When a significant change is released in the CLI, the applications should be updated with
ng update:
$ cd integration/cli-hello-world[-*]
$ yarn install
$ yarn ng update @angular/cli @angular-devkit/build-angular
$ yarn build
$ yarn test
Afterwards the @angular/cli and @angular-devkit/build-angular should be reverted to the file:../ urls
and the main package.json should be updated with the new versions.
Render3 tests
The directory cli-hello-world-ivy-compat contains a test for render3 used with the angular cli.
The cli-hello-world-ivy-minimal contains a minimal ivy app that is meant to mimic the bazel
equivalent in packages/core/test/bundling/hello_world, and should be kept similar.
Writing an integration test
The API for each test is:
- Each sub-directory here is an integration test
- Each test should have a
package.jsonfile - The test runner will run
yarnandyarn teston the package
This means that the test should be started by test script, like
"scripts": {"test": "runProgramA && assertResultIsGood"}
Note that the package.json file uses a special file:../../dist scheme to reference the Angular
packages, so that the locally-built Angular is installed into the test app.
Also, beware of floating (non-locked) dependencies. If in doubt, you can install the package
directly from file:../../node_modules.
WARNING
Always ensure that
yarn.lockfiles are up-to-date with the correspondingpackage.jsonfiles (wrt the non-local dependencies - i.e. dependencies whose versions do not start withfile:).You can update a
yarn.lockfile by runningyarn installin the project subdirectory.
Running integration tests
$ ./integration/run_tests.sh
The test runner will first re-build any stale npm packages, then cd into each subdirectory to
execute the test.
Running integration tests under Bazel
The PR https://github.com/angular/angular/pull/33927 added the ability to run integration tests with Bazel. These tests can be resource intensive so it is recommended to limit the number of concurrent test jobs with the --local_test_jobs bazel flag.
Locally, if Bazel uses all of your cores to run the maximum number of integration tests in parallel then this can lead to test timeouts and flakes and freeze up your machine while these tests are running. You can limit the number of concurrent local integration tests that run with:
yarn bazel test --local_test_jobs=<N> //integration/...
Set a reasonable local_test_jobs limit for your local machine to prevent full cpu utilization during local development test runs.
To avoid having to specify this command line flag, you may want to include it in your .bazelrc.user file:
test --local_test_jobs=<N>
The downside of this is that this will apply to all tests and not just the resource intensive integration tests.
Bazel-in-bazel integration tests
Two of the integration tests that run Bazel-in-Bazel are particularly resource intensive and are tagged "manual" and "exclusive". To run these tests use,
yarn bazel test //integration:bazel_test
yarn bazel test //integration:bazel-schematics_test
Adding a new integration test
When adding a new integration test, follow the steps below to add a bazel test target for the new test.
- Add new test to
INTEGRATION_TESTSobject in/integration/BUILD.bazel(and tag as"no-ivy-aot"if not meant to be run against ivy bundles). NB: if the test requires any special attribute then make a new angular_integration_test target instead. - If test requires ports and does not support ethereal ports then make sure the port is unique and add it to the "manually configured ports" comment to document which port it is using
- Add at least the following two entries
.bazelignore(as they may contain BUILD files)integration/new_test/node_modulesintegration/new_test/.yarn_local_cache
- Add any other untracked folders to
.bazelignorethat may containBUILDfiles - If there are tracked BUILD files in the integration test folder (
integration/bazelhas these for example) add those folders to thebuild --deleted_packagesandquery --deleted_packageslines in.bazelrc
Browser tests
For integration tests we use the puppeteer provisioned version of Chrome. For both Karma and Protractor tests we set a number of browser testing flags. To avoid duplication, they will be listed and explained here and the code will reference this file for more information.
No Sandbox: --no-sandbox
The sandbox needs to be disabled with the --no-sandbox flag for both Karma and Protractor tests, because it causes Chrome to crash on some environments.
See: http://chromedriver.chromium.org/help/chrome-doesn-t-start See: https://github.com/puppeteer/puppeteer/blob/v1.0.0/docs/troubleshooting.md#chrome-headless-fails-due-to-sandbox-issues
Headless: --headless
So that browsers are not popping up and tearing down when running these tests we run Chrome in headless mode. The --headless flag puts Chrome in headless mode and a number of other flags are recommended in this mode as well:
--headless--disable-gpu--disable-dev-shm-usage--hide-scrollbars--mute-audio
These come from the flags that puppeteer passes to chrome when it launches it in headless mode: 18f2ecdffd/lib/Launcher.js (L91)
And from the flags that the Karma ChromeHeadless browser passes to Chrome: 5f70a76de8/index.js (L171)
Disable shared memory space: --disable-dev-shm-usage
The --disable-dev-shm-usage flag disables the usage of /dev/shm because it causes Chrome to crash on some environments.
On CircleCI, the puppeteer provisioned Chrome crashes with CI we get Root cause: org.openqa.selenium.WebDriverException: unknown error: DevToolsActivePort file doesn't exist which resolves without this flag.
See: https://github.com/puppeteer/puppeteer/blob/v1.0.0/docs/troubleshooting.md#tips See: https://stackoverflow.com/questions/50642308/webdriverexception-unknown-error-devtoolsactiveport-file-doesnt-exist-while-t