build: remove legacy integration test runner (angular#35985)

* integration tests target definitions in integration/BUILD.bazel updated to use a single dict
* payload tracking for integration tests updated to work under Bazel
* legacy integration_test CI job removed
* integration/run_tests.sh script no longer used in CI so it has been updated for running integration tests locally in the legacy way

PR Close angular#35985

Author: gregmagolan

Diff for: .circleci/config.yml

@@ -556,22 +556,6 @@ jobs:
             - ng/dist/packages-dist-ivy-aot
             - ng/dist/zone.js-dist-ivy-aot
 
-  # We run a subset of the integration tests outside of Bazel that track
-  # payload size.
-  # See comments inside the integration/run_tests.sh script.
-  # TODO(gregmagolan): move payload size tracking to Bazel and remove this job.
-  integration_test:
-    executor: default-executor
-    parallelism: 3
-    steps:
-      - custom_attach_workspace
-      - init_environment
-      - install_chrome_libs
-      - install_java
-      # Runs the integration tests in parallel across multiple CircleCI container instances. The
-      # amount of container nodes for this job is controlled by the "parallelism" option.
-      - run: ./integration/run_tests.sh ${CIRCLE_NODE_INDEX} ${CIRCLE_NODE_TOTAL}
-
   # This job creates compressed tarballs (`.tgz` files) for all Angular packages and stores them as
   # build artifacts. This makes it easy to try out changes from a PR build for testing purposes.
   # More info CircleCI build artifacts: https://circleci.com/docs/2.0/artifacts
@@ -855,9 +839,6 @@ workflows:
       - test_aio_preview:
           requires:
             - aio_preview
-      - integration_test:
-          requires:
-            - build-npm-packages
       - publish_packages_as_artifacts:
           requires:
             - build-npm-packages
@@ -870,7 +851,6 @@ workflows:
             # Only publish if tests and integration tests pass
             - test
             - test_ivy_aot
-            - integration_test
             # Only publish if `aio`/`docs` tests using the locally built Angular packages pass
             - test_aio_local
             - test_aio_local_viewengine

Diff for: .circleci/env.sh

@@ -82,6 +82,22 @@ openssl aes-256-cbc -d -in "${projectDir}/.circleci/gcp_token" \
 ####################################################################################################
 cp "${projectDir}/.circleci/bazel.linux.rc" "$HOME/.bazelrc";
 
+####################################################################################################
+# Create shell script in /tmp for Bazel actions to access CI envs without
+# busting the cache. Used by payload-size.sh script in integration tests.
+####################################################################################################
+readonly bazelVarEnv="/tmp/bazel-ci-env.sh"
+echo "# Setup by /.circle/env.sh" > $bazelVarEnv
+echo "export PROJECT_ROOT=\"${PROJECT_ROOT}\";" >> $bazelVarEnv
+echo "export CI_BRANCH=\"${CI_BRANCH}\";" >> $bazelVarEnv
+echo "export CI_BUILD_URL=\"${CI_BUILD_URL}\";" >> $bazelVarEnv
+echo "export CI_COMMIT=\"${CI_COMMIT}\";" >> $bazelVarEnv
+echo "export CI_COMMIT_RANGE=\"${CI_COMMIT_RANGE}\";" >> $bazelVarEnv
+echo "export CI_PULL_REQUEST=\"${CI_PULL_REQUEST}\";" >> $bazelVarEnv
+echo "export CI_REPO_NAME=\"${CI_REPO_NAME}\";" >> $bazelVarEnv
+echo "export CI_REPO_OWNER=\"${CI_REPO_OWNER}\";" >> $bazelVarEnv
+echo "export CI_SECRET_PAYLOAD_FIREBASE_TOKEN=\"${CI_SECRET_PAYLOAD_FIREBASE_TOKEN}\";" >> $bazelVarEnv
+
 ####################################################################################################
 ####################################################################################################
 ##                  Source `$BASH_ENV` to make the variables available immediately.               ##

Diff for: BUILD.bazel

@@ -5,6 +5,9 @@ exports_files([
     "protractor-perf.conf.js",
     "karma-js.conf.js",
     "browser-providers.conf.js",
+    "scripts/ci/track-payload-size.sh",
+    "scripts/ci/payload-size.sh",
+    "scripts/ci/payload-size.js",
 ])
 
 alias(

Diff for: integration/BUILD.bazel

@@ -1,5 +1,9 @@
 load(":angular_integration_test.bzl", "angular_integration_test")
 
+exports_files([
+    "_payload-limits.json",
+])
+
 # Some integration ports must be managed manually to be unique and in other
 # cases the tests are able to select a random free port.
 #
@@ -24,76 +28,82 @@ load(":angular_integration_test.bzl", "angular_integration_test")
 # A subset of these tests fail or are not meant to be run with ivy bundles. These are tagged
 # "no-ivy-aot".
 INTEGRATION_TESTS = {
-    "bazel": [
-        # Bazel-in-bazel tests are resource intensive and should not be over-parallized
-        # as they will compete for the resources of other parallel tests slowing
-        # everything down. Ask Bazel to allocate multiple CPUs for these tests with "cpu:n" tag.
-        "cpu:3",
-        "no-ivy-aot",
-    ],
-    "bazel-schematics": [
-        # Bazel-in-bazel tests are resource intensive and should not be over-parallized
-        # as they will complete for the resources of other parallel tests slowing
-        # everything down. Ask Bazel to allocate multiple CPUs for these tests with "cpu:n" tag.
-        "cpu:3",
-        "no-ivy-aot",
-    ],
-    "cli-hello-world": [],
-    "cli-hello-world-ivy-compat": [],
-    "cli-hello-world-ivy-i18n": ["no-ivy-aot"],
-    "cli-hello-world-ivy-minimal": [],
-    "cli-hello-world-lazy": [],
-    "cli-hello-world-lazy-rollup": [],
-    "dynamic-compiler": ["no-ivy-aot"],
-    "hello_world__closure": ["no-ivy-aot"],
-    "i18n": ["no-ivy-aot"],
-    "injectable-def": ["no-ivy-aot"],
-    "ivy-i18n": ["no-ivy-aot"],
-    "language_service_plugin": [],
-    "ng_elements": ["no-ivy-aot"],
-    "ng_elements_schematics": ["no-ivy-aot"],
-    "ng_update": [],
-    "ng_update_migrations": ["no-ivy-aot"],
-    "ngcc": ["no-ivy-aot"],
-    "platform-server": ["no-ivy-aot"],
-    "service-worker-schema": [],
-    "side-effects": ["no-ivy-aot"],
-    "terser": [],
+    "bazel": {
+        "tags": [
+            # Bazel-in-bazel tests are resource intensive and should not be over-parallized
+            # as they will compete for the resources of other parallel tests slowing
+            # everything down. Ask Bazel to allocate multiple CPUs for these tests with "cpu:n" tag.
+            "cpu:3",
+            "no-ivy-aot",
+        ],
+    },
+    "bazel-schematics": {
+        "tags": [
+            # Bazel-in-bazel tests are resource intensive and should not be over-parallized
+            # as they will complete for the resources of other parallel tests slowing
+            # everything down. Ask Bazel to allocate multiple CPUs for these tests with "cpu:n" tag.
+            "cpu:3",
+            "no-ivy-aot",
+        ],
+    },
+    "cli-hello-world": {"commands": "payload_size_tracking"},
+    "cli-hello-world-ivy-compat": {"commands": "payload_size_tracking"},
+    "cli-hello-world-ivy-i18n": {
+        "commands": "payload_size_tracking",
+        "tags": ["no-ivy-aot"],
+    },
+    "cli-hello-world-ivy-minimal": {"commands": "payload_size_tracking"},
+    "cli-hello-world-lazy": {
+        "commands": "payload_size_tracking",
+        # TODO: cli-hello-world-lazy fails on a bundle size check with Ivy bundles
+        "tags": ["no-ivy-aot"],
+    },
+    "cli-hello-world-lazy-rollup": {"commands": "payload_size_tracking"},
+    "dynamic-compiler": {"tags": ["no-ivy-aot"]},
+    "hello_world__closure": {
+        "commands": "payload_size_tracking",
+        "tags": ["no-ivy-aot"],
+    },
+    "hello_world__systemjs_umd": {
+        # Special case for `hello_world__systemjs_umd` test as we want to pin
+        # `systems` at version 0.20.2 and not link to the the root @npm//systemjs
+        # which is stuck at 0.18.10 and can't be updated to 0.20.2 without
+        # breaking the legacy saucelabs job.
+        "pinned_npm_packages": ["systemjs"],
+    },
+    "i18n": {"tags": ["no-ivy-aot"]},
+    "injectable-def": {"tags": ["no-ivy-aot"]},
+    "ivy-i18n": {"tags": ["no-ivy-aot"]},
+    "language_service_plugin": {},
+    "ng_elements": {"tags": ["no-ivy-aot"]},
+    "ng_elements_schematics": {"tags": ["no-ivy-aot"]},
+    "ng_update": {},
+    "ng_update_migrations": {"tags": ["no-ivy-aot"]},
+    "ngcc": {"tags": ["no-ivy-aot"]},
+    "platform-server": {"tags": ["no-ivy-aot"]},
+    "service-worker-schema": {},
+    "side-effects": {"tags": ["no-ivy-aot"]},
+    "terser": {},
+    "typings_test_ts36": {
+        # Special case for `typings_test_ts36` test as we want to pin
+        # `typescript` at version 3.6.x for that test and not link to the
+        # root @npm//typescript package.
+        "pinned_npm_packages": ["typescript"],
+    },
+    "typings_test_ts37": {
+        # Special case for `typings_test_ts37` test as we want to pin
+        # `typescript` at version 3.7.x for that test and not link to the
+        # root @npm//typescript package.
+        "pinned_npm_packages": ["typescript"],
+    },
 }
 
 [
     angular_integration_test(
-        name = test_folder + "_test",
-        tags = INTEGRATION_TESTS[test_folder],
-        test_folder = test_folder,
+        name = test_folder,
+        commands = INTEGRATION_TESTS[test_folder].get("commands", "default"),
+        pinned_npm_packages = INTEGRATION_TESTS[test_folder].get("pinned_npm_packages", []),
+        tags = INTEGRATION_TESTS[test_folder].get("tags", []),
     )
     for test_folder in INTEGRATION_TESTS
 ]
-
-# Special case for `typings_test_ts36` test as we want to pin
-# `typescript` at version 3.6.x for that test and not link to the
-# root @npm//typescript package.
-angular_integration_test(
-    name = "typings_test_ts36_test",
-    pinned_npm_packages = ["typescript"],
-    test_folder = "typings_test_ts36",
-)
-
-# Special case for `typings_test_ts37` test as we want to pin
-# `typescript` at version 3.7.x for that test and not link to the
-# root @npm//typescript package.
-angular_integration_test(
-    name = "typings_test_ts37_test",
-    pinned_npm_packages = ["typescript"],
-    test_folder = "typings_test_ts37",
-)
-
-# Special case for `hello_world__systemjs_umd` test as we want to pin
-# `systems` at version 0.20.2 and not link to the the root @npm//systemjs
-# which is stuck at 0.18.10 and can't be updated to 0.20.2 without
-# breaking the legacy saucelabs job.
-angular_integration_test(
-    name = "hello_world__systemjs_umd_test",
-    pinned_npm_packages = ["systemjs"],
-    test_folder = "hello_world__systemjs_umd",
-)

Diff for: integration/README.md

@@ -98,7 +98,7 @@ yarn bazel test //integration:bazel-schematics_test
 
 When adding a new integration test, follow the steps below to add a bazel test target for the new test.
 
-1. Add new test to `INTEGRATION_TESTS` object 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.*
+1. Add new test to `INTEGRATION_TESTS` object in `/integration/BUILD.bazel` (and tag as `"no-ivy-aot"` if not meant to be run against ivy bundles).
 2. 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
 3. Add at least the following two entries `.bazelignore` (as they may contain BUILD files)
    1. `integration/new_test/node_modules`

Diff for: integration/angular_integration_test.bzl

@@ -80,35 +80,56 @@ def npm_package_archives():
 def _npm_package_archive_label(package_name):
     return package_name.replace("/", "_").replace("@", "") + "_archive"
 
-def _angular_integration_test(pinned_npm_packages = [], **kwargs):
+def _angular_integration_test(name, **kwargs):
     "Set defaults for the npm_integration_test common to the angular repo"
-    commands = kwargs.pop("commands", None)
-    if not commands:
-        # By default run `yarn install` followed by `yarn test` using
-        # the bazel managed hermetic version of yarn inside
-        commands = [
-            # Workaround https://github.com/yarnpkg/yarn/issues/2165
-            # Yarn will cache file://dist URIs and not update Angular code
-            "rm -rf ./.yarn_local_cache",
-            "mkdir .yarn_local_cache",
-            "patch-package-json",
-            "$(rootpath @nodejs//:yarn_bin) install --cache-folder ./.yarn_local_cache",
-            "$(rootpath @nodejs//:yarn_bin) test",
-            "rm -rf ./.yarn_local_cache",
+    payload_size_tracking = kwargs.pop("payload_size_tracking", [])
+    pinned_npm_packages = kwargs.pop("pinned_npm_packages", [])
+    data = [
+        # We need the yarn_bin & yarn_files available at runtime
+        "@nodejs//:yarn_bin",
+        "@nodejs//:yarn_files",
+    ]
+
+    # By default run `yarn install` followed by `yarn test` using
+    # the bazel managed hermetic version of yarn inside
+    DEFAULT_COMMANDS = [
+        "patch-package-json",
+        # Workaround https://github.com/yarnpkg/yarn/issues/2165
+        # Yarn will cache file://dist URIs and not update Angular code
+        "rm -rf ./.yarn_local_cache",
+        "mkdir .yarn_local_cache",
+        "$(rootpath @nodejs//:yarn_bin) install --cache-folder ./.yarn_local_cache",
+        "$(rootpath @nodejs//:yarn_bin) test",
+    ]
+
+    commands = kwargs.pop("commands", [])
+    if commands == "default":
+        commands = DEFAULT_COMMANDS
+    elif commands == "payload_size_tracking":
+        commands = DEFAULT_COMMANDS + [
+            "$(rootpath @nodejs//:yarn_bin) build",
+            "$(rootpath //:scripts/ci/track-payload-size.sh) %s dist/*.js true ${RUNFILES}/angular/$(rootpath //integration:_payload-limits.json)" % name,
+        ]
+        data = data + [
+            "//integration:_payload-limits.json",
+            "//:scripts/ci/track-payload-size.sh",
+            "//:scripts/ci/payload-size.sh",
+            "//:scripts/ci/payload-size.js",
         ]
 
     # Complete list of npm packages to override in the test's package.json file mapped to
     # tgz archive to use for the replacement. This is the full list for all integration
     # tests. Any given integration does not need to use all of these packages.
     npm_packages = {}
-    for name in NPM_PACKAGE_ARCHIVES:
-        if name not in pinned_npm_packages:
-            npm_packages["@npm//:" + _npm_package_archive_label(name)] = name
-    for name in GENERATED_NPM_PACKAGES:
-        last_segment_name = name if name.find("/") == -1 else name.split("/")[-1]
-        npm_packages["//packages/%s:npm_package_archive" % last_segment_name] = name
+    for pkg in NPM_PACKAGE_ARCHIVES:
+        if pkg not in pinned_npm_packages:
+            npm_packages["@npm//:" + _npm_package_archive_label(pkg)] = pkg
+    for pkg in GENERATED_NPM_PACKAGES:
+        last_segment_name = pkg if pkg.find("/") == -1 else pkg.split("/")[-1]
+        npm_packages["//packages/%s:npm_package_archive" % last_segment_name] = pkg
 
     npm_integration_test(
+        name = name + "_test",
         check_npm_packages = GENERATED_NPM_PACKAGES,
         commands = commands,
         npm_packages = npm_packages,
@@ -122,11 +143,7 @@ def _angular_integration_test(pinned_npm_packages = [], **kwargs):
             # Remote doesn't work as it needs network access right now
             "no-remote-exec",
         ],
-        data = kwargs.pop("data", []) + [
-            # We need the yarn_bin & yarn_files available at runtime
-            "@nodejs//:yarn_bin",
-            "@nodejs//:yarn_files",
-        ],
+        data = kwargs.pop("data", []) + data,
         # 15-minute timeout
         timeout = "long",
         # Tells bazel that this test should be allocated a large amount of memory.
@@ -135,21 +152,20 @@ def _angular_integration_test(pinned_npm_packages = [], **kwargs):
         **kwargs
     )
 
-def angular_integration_test(name, test_folder, pinned_npm_packages = [], **kwargs):
+def angular_integration_test(name, **kwargs):
     "Sets up the integration test target based on the test folder name"
     native.filegroup(
         name = "_%s_sources" % name,
         srcs = native.glob(
-            include = ["%s/**" % test_folder],
+            include = ["%s/**" % name],
             exclude = [
-                "%s/node_modules/**" % test_folder,
-                "%s/.yarn_local_cache/**" % test_folder,
+                "%s/node_modules/**" % name,
+                "%s/.yarn_local_cache/**" % name,
             ],
         ),
     )
     _angular_integration_test(
         name = name,
         test_files = kwargs.pop("test_files", "_%s_sources" % name),
-        pinned_npm_packages = pinned_npm_packages,
         **kwargs
     )