build: migrate theming tests to rules_js

devversion · devversion · commit 2888934b48bb · 2025-03-24T17:56:07.000+01:00
Migrates the theming tests to `rules_js`. This also requires us to bring
in the Jasmine ruleset, and fix some issues with the test tsconfig.
diff --git a/.aspect/rules/external_repository_action_cache/npm_translate_lock_MzA5NzUwNzMx b/.aspect/rules/external_repository_action_cache/npm_translate_lock_MzA5NzUwNzMx
@@ -2,7 +2,7 @@
 # Input hashes for repository rule npm_translate_lock(name = "npm2", pnpm_lock = "@//:pnpm-lock.yaml").
 # This file should be checked into version control along with the pnpm-lock.yaml file.
 .npmrc=-2023857461
-package.json=-2113674231
-pnpm-lock.yaml=409413002
+package.json=-370577278
+pnpm-lock.yaml=997015112
 pnpm-workspace.yaml=1711114604
-yarn.lock=1593491870
+yarn.lock=-987404687
diff --git a/WORKSPACE b/WORKSPACE
@@ -209,6 +209,17 @@ http_archive(
     url = "https://github.com/aspect-build/rules_rollup/releases/download/v2.0.0/rules_rollup-v2.0.0.tar.gz",
 )
 
+http_archive(
+    name = "aspect_rules_jasmine",
+    sha256 = "0d2f9c977842685895020cac721d8cc4f1b37aae15af46128cf619741dc61529",
+    strip_prefix = "rules_jasmine-2.0.0",
+    url = "https://github.com/aspect-build/rules_jasmine/releases/download/v2.0.0/rules_jasmine-v2.0.0.tar.gz",
+)
+
+load("@aspect_rules_jasmine//jasmine:dependencies.bzl", "rules_jasmine_dependencies")
+
+rules_jasmine_dependencies()
+
 load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")
 
 git_repository(
diff --git a/package.json b/package.json
@@ -38,8 +38,8 @@
     "tslint": "tslint -c tslint.json --project ./tsconfig.json",
     "stylelint": "stylelint \"src/**/*.+(css|scss)\" --config .stylelintrc.json",
     "resync-caretaker-app": "ts-node --project scripts/tsconfig.json scripts/caretaking/resync-caretaker-app-prs.ts",
-    "ts-circular-deps:check": "yarn -s ng-dev ts-circular-deps check --config ./src/circular-deps-test.conf.js",
-    "ts-circular-deps:approve": "yarn -s ng-dev ts-circular-deps approve --config ./src/circular-deps-test.conf.js",
+    "ts-circular-deps:check": "yarn -s ng-dev ts-circular-deps check --config ./src/circular-deps-test.conf.cjs",
+    "ts-circular-deps:approve": "yarn -s ng-dev ts-circular-deps approve --config ./src/circular-deps-test.conf.cjs",
     "merge": "yarn -s ng-dev pr merge",
     "approve-api": "node ./scripts/approve-api-golden.js",
     "approve-size-tests": "node ./scripts/approve-size-golden.js",
@@ -134,6 +134,7 @@
     "inquirer": "^8.2.0",
     "jasmine": "^4.1.0",
     "jasmine-core": "^4.1.0",
+    "jasmine-reporters": "^2.5.2",
     "jsonc-parser": "^3.0.0",
     "kagekiri": "^1.4.1",
     "karma": "^6.3.12",
@@ -164,6 +165,7 @@
     "semver": "^7.3.5",
     "send": "^0.17.2",
     "shelljs": "^0.8.5",
+    "source-map-support": "^0.5.21",
     "stylelint": "^14.14.0",
     "terser": "^5.10.0",
     "ts-node": "^10.9.1",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/BUILD.bazel b/src/BUILD.bazel
@@ -1,5 +1,6 @@
 load("@npm//@bazel/concatjs:index.bzl", "ts_config")
 load("@aspect_rules_ts//ts:defs.bzl", rules_js_tsconfig = "ts_config")
+load("@aspect_bazel_lib//lib:copy_to_bin.bzl", "copy_to_bin")
 load("//src/cdk:config.bzl", "CDK_ENTRYPOINTS")
 load("//src/material:config.bzl", "MATERIAL_ENTRYPOINTS", "MATERIAL_TESTING_ENTRYPOINTS")
 load("//tools/dgeni:index.bzl", "dgeni_api_docs")
@@ -24,7 +25,16 @@ exports_files([
 ts_config(
     name = "tsconfig-test",
     src = "bazel-tsconfig-test.json",
-    deps = ["bazel-tsconfig-build.json"],
+    deps = [
+        "bazel-tsconfig-build.json",
+        "//:node_modules/@types/jasmine",
+        "//:node_modules/@types/node",
+    ],
+)
+
+copy_to_bin(
+    name = "package_json",
+    srcs = ["package.json"],
 )
 
 dgeni_api_docs(
diff --git a/src/bazel-tsconfig-test.json b/src/bazel-tsconfig-test.json
@@ -5,7 +5,7 @@
   "extends": "./bazel-tsconfig-build.json",
   "compilerOptions": {
     "importHelpers": true,
-    "types": ["jasmine"]
+    "types": ["jasmine", "node"]
   },
   "bazelOptions": {
     "suppressTsconfigOverrideWarnings": true
diff --git a/src/circular-deps-test.conf.cjs b/src/circular-deps-test.conf.cjs
diff --git a/src/material/core/theming/tests/BUILD.bazel b/src/material/core/theming/tests/BUILD.bazel
@@ -1,4 +1,5 @@
-load("//tools:defaults.bzl", "jasmine_node_test", "sass_binary", "ts_library")
+load("//tools:defaults.bzl", "sass_binary")
+load("//tools:defaults2.bzl", "jasmine_test", "ts_project")
 load("@bazel_skylib//rules:build_test.bzl", "build_test")
 
 package(default_visibility = ["//visibility:public"])
@@ -52,29 +53,29 @@ build_test(
     ],
 )
 
-ts_library(
+ts_project(
     name = "unit_test_lib",
     testonly = True,
     srcs = glob([
         "*.spec.ts",
     ]),
-    # TODO(ESM): remove this once the Bazel NodeJS rules can handle ESM with `nodejs_binary`.
-    devmode_module = "commonjs",
     deps = [
-        "//tools/postcss",
-        "//tools/sass:sass_lib",
-        "@npm//@bazel/runfiles",
-        "@npm//@types/jasmine",
-        "@npm//@types/node",
-        "@npm//postcss",
-        "@npm//sass",
+        "//:node_modules/@bazel/runfiles",
+        "//:node_modules/postcss",
+        "//:node_modules/sass",
+        "//tools/postcss:postcss_rjs",
+        "//tools/sass:sass_lib_rjs",
     ],
 )
 
-jasmine_node_test(
+jasmine_test(
     name = "unit_tests",
-    srcs = [":unit_test_lib"],
     data = [
+        ":unit_test_lib_rjs",
+        "//src/material:sass_lib",
+        "//src/material-experimental:sass_lib",
+    ],
+    no_copy_to_bin = [
         "//src/material:sass_lib",
         "//src/material-experimental:sass_lib",
     ],
diff --git a/src/material/core/theming/tests/m3-theme.spec.ts b/src/material/core/theming/tests/m3-theme.spec.ts
@@ -3,7 +3,7 @@ import * as path from 'path';
 import {parse} from 'postcss';
 import {compileString} from 'sass';
 
-import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer';
+import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer.js';
 
 // Note: For Windows compatibility, we need to resolve the directory paths through runfiles
 // which are guaranteed to reside in the source tree.
diff --git a/src/material/core/theming/tests/theming-definition-api.spec.ts b/src/material/core/theming/tests/theming-definition-api.spec.ts
@@ -3,7 +3,7 @@ import {compileString} from 'sass';
 import {runfiles} from '@bazel/runfiles';
 import * as path from 'path';
 
-import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer';
+import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer.js';
 
 // Note: For Windows compatibility, we need to resolve the directory paths through runfiles
 // which are guaranteed to reside in the source tree.
diff --git a/src/material/core/theming/tests/theming-inspection-api.spec.ts b/src/material/core/theming/tests/theming-inspection-api.spec.ts
@@ -2,7 +2,7 @@ import {compileString} from 'sass';
 import {runfiles} from '@bazel/runfiles';
 import * as path from 'path';
 
-import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer';
+import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer.js';
 
 // Note: For Windows compatibility, we need to resolve the directory paths through runfiles
 // which are guaranteed to reside in the source tree.
diff --git a/src/material/core/theming/tests/theming-mixin-api.spec.ts b/src/material/core/theming/tests/theming-mixin-api.spec.ts
@@ -3,8 +3,8 @@ import {compileString} from 'sass';
 import {runfiles} from '@bazel/runfiles';
 import * as path from 'path';
 
-import {compareNodes} from '../../../../../tools/postcss/compare-nodes';
-import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer';
+import {compareNodes} from '../../../../../tools/postcss/compare-nodes.js';
+import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer.js';
 
 // Note: For Windows compatibility, we need to resolve the directory paths through runfiles
 // which are guaranteed to reside in the source tree.
diff --git a/src/material/core/theming/tests/theming-typography-hierarchy.spec.ts b/src/material/core/theming/tests/theming-typography-hierarchy.spec.ts
@@ -2,7 +2,7 @@ import {compileString} from 'sass';
 import {runfiles} from '@bazel/runfiles';
 import * as path from 'path';
 
-import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer';
+import {createLocalAngularPackageImporter} from '../../../../../tools/sass/local-sass-importer.js';
 
 // Note: For Windows compatibility, we need to resolve the directory paths through runfiles
 // which are guaranteed to reside in the source tree.
diff --git a/src/package.json b/src/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}
diff --git a/tools/defaults.bzl b/tools/defaults.bzl
@@ -107,7 +107,8 @@ def ts_library(
         **kwargs
     )
 
-    if module_name and not testonly:
+    # TODO(devversion): Partner with ISE team to support `rules_js` here.
+    if False and module_name and not testonly:
         _make_tsec_test(kwargs["name"])
 
 def ng_module(
@@ -147,7 +148,8 @@ def ng_module(
         **kwargs
     )
 
-    if module_name and not testonly:
+    # TODO(devversion): Partner with ISE team to support `rules_js` here.
+    if False and module_name and not testonly:
         _make_tsec_test(kwargs["name"])
 
 def ng_package(name, srcs = [], deps = [], externals = PKG_EXTERNALS, readme_md = None, visibility = None, **kwargs):
diff --git a/tools/defaults2.bzl b/tools/defaults2.bzl
@@ -1,3 +1,4 @@
+load("@aspect_rules_jasmine//jasmine:defs.bzl", _jasmine_test = "jasmine_test")
 load("//tools/bazel:ts_project_interop.bzl", _ts_project = "ts_project")
 load("//tools/bazel:module_name.bzl", "compute_module_name")
 
@@ -10,5 +11,28 @@ def ts_project(
         name,
         source_map = source_map,
         module_name = compute_module_name(testonly),
+        testonly = testonly,
+        **kwargs
+    )
+
+def jasmine_test(data = [], args = [], **kwargs):
+    # Create relative path to root, from current package dir. Necessary as
+    # we change the `chdir` below to the package directory.
+    relative_to_root = "/".join([".."] * len(native.package_name().split("/")))
+
+    _jasmine_test(
+        node_modules = "//:node_modules",
+        chdir = native.package_name(),
+        args = [
+            "--require=%s/node_modules/source-map-support/register.js" % relative_to_root,
+            "**/*spec.js",
+            "**/*spec.mjs",
+            "**/*spec.cjs",
+        ] + args,
+        data = data + [
+            "//:node_modules/source-map-support",
+            # Needed to ensure code is recognized as ESM.
+            "//src:package_json",
+        ],
         **kwargs
     )
diff --git a/yarn.lock b/yarn.lock
@@ -9514,7 +9514,7 @@ jasmine-core@~2.8.0:
   resolved "https://registry.yarnpkg.com/jasmine-core/-/jasmine-core-2.8.0.tgz#bcc979ae1f9fd05701e45e52e65d3a5d63f1a24e"
   integrity sha512-SNkOkS+/jMZvLhuSx1fjhcNWUC/KG6oVyFUGkSBEr9n1axSNduWU8GlI7suaHXr4yxjet6KjrUZxUTE5WzzWwQ==
 
-jasmine-reporters@~2.5.0:
+jasmine-reporters@^2.5.2, jasmine-reporters@~2.5.0:
   version "2.5.2"
   resolved "https://registry.yarnpkg.com/jasmine-reporters/-/jasmine-reporters-2.5.2.tgz#b5dfa1d9c40b8020c5225e0e1e2b9953d66a4d69"
   integrity sha512-qdewRUuFOSiWhiyWZX8Yx3YNQ9JG51ntBEO4ekLQRpktxFTwUHy24a86zD/Oi2BRTKksEdfWQZcQFqzjqIkPig==
@@ -13557,7 +13557,7 @@ source-map-resolve@^0.6.0:
     atob "^2.1.2"
     decode-uri-component "^0.2.0"
 
-source-map-support@0.5.21, source-map-support@^0.5.5, source-map-support@~0.5.20:
+source-map-support@0.5.21, source-map-support@^0.5.21, source-map-support@^0.5.5, source-map-support@~0.5.20:
   version "0.5.21"
   resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f"
   integrity sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==
