refactor(bazel): update integration test rule to use rules_js

devversion · devversion · commit 29d4705ef8ba · 2025-04-11T17:49:21.000+02:00
Technically this wouldn't be necessary for `rules_js` as the rule is
pretty agnostic, but it means we don't end up hitting the `@npm`
workspace, or more `rules_nodejs` dependencies— so it's part of our
migration.

Also this commit simplifies some logic around the temporary directory
creation to spare an extra dependency.

We also remove some unnecessary Windows logic.

Finally, we fix runfile resolution to work with `rules_js`, without
relying on any runfile helpes, as we can expect a runfiles directory
with proper real files.
diff --git a/bazel/BUILD.bazel b/bazel/BUILD.bazel
@@ -27,7 +27,6 @@ filegroup(
         "//bazel/esbuild:files",
         "//bazel/git-toolchain:files",
         "//bazel/http-server:files",
-        "//bazel/integration:files",
         "//bazel/karma:files",
         "//bazel/map-size-tracking:files",
         "//bazel/private:files",
diff --git a/bazel/integration/BUILD.bazel b/bazel/integration/BUILD.bazel
@@ -1,9 +0,0 @@
-package(default_visibility = ["//visibility:public"])
-
-# Make source files available for distribution via pkg_npm
-filegroup(
-    name = "files",
-    srcs = glob(["*"]) + [
-        "//bazel/integration/test_runner:files",
-    ],
-)
diff --git a/bazel/integration/index.bzl b/bazel/integration/index.bzl
@@ -1,4 +1,4 @@
-load("@build_bazel_rules_nodejs//:index.bzl", "nodejs_test")
+load("@aspect_rules_js//js:defs.bzl", "js_test")
 
 def _serialize_file(file):
     """Serializes a file into a struct that matches the `BazelFileInfo` type in the
@@ -259,11 +259,11 @@ def integration_test(
         toolchains = toolchains,
     )
 
-    nodejs_test(
+    js_test(
         name = name,
-        data = ["//bazel/integration/test_runner", ":" + config_target],
-        templated_args = ["--nobazel_run_linker", "$(rootpath :%s)" % config_target],
-        entry_point = "//bazel/integration/test_runner:main.ts",
+        data = ["@devinfra//bazel/integration/test_runner", ":%s" % config_target],
+        fixed_args = ["$(rootpath :%s)" % config_target],
+        entry_point = "@devinfra//bazel/integration/test_runner:main.mjs",
         tags = tags,
         **kwargs
     )
diff --git a/bazel/integration/test_runner/BUILD.bazel b/bazel/integration/test_runner/BUILD.bazel
@@ -1,25 +1,13 @@
-load("//bazel:defaults.bzl", "ts_library")
+load("@aspect_rules_ts//ts:defs.bzl", "ts_project")
 
 package(default_visibility = ["//visibility:public"])
 
-ts_library(
+ts_project(
     name = "test_runner",
-    srcs = glob(["*.ts"]),
-    module_name = "@angular/build-tooling/bazel/integration/test_runner",
-    # A tsconfig needs to be specified as otherwise `ts_library` will look for the config
-    # in `//:package.json` and this breaks when the BUILD file is copied to `@npm//`.
-    tsconfig = "//:tsconfig.json",
+    srcs = glob(["*.mts"]),
+    tsconfig = "//bazel:tsconfig",
     deps = [
-        "@npm//@bazel/runfiles",
-        "@npm//@types/node",
-        "@npm//@types/tmp",
-        "@npm//tmp",
-        "@npm//true-case-path",
+        "//bazel:node_modules/@types/node",
+        "//bazel:node_modules/true-case-path",
     ],
 )
-
-# Make source files available for distribution via pkg_npm
-filegroup(
-    name = "files",
-    srcs = glob(["*"]),
-)
diff --git a/bazel/integration/test_runner/bazel.mts b/bazel/integration/test_runner/bazel.mts
@@ -6,11 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {debug} from './debug';
-import {runfiles} from '@bazel/runfiles';
-
-// Exposing the runfiles to keep the Bazel-specific code local to this file.
-export {runfiles};
+import path from 'node:path';
+import assert from 'node:assert';
+import {debug} from './debug.mjs';
 
 /**
  * Interface describing a file captured in the Bazel action.
@@ -38,8 +36,9 @@ export interface BazelExpandedValue {
 }
 
 /** Resolves the specified Bazel file to an absolute disk path. */
-export function resolveBazelFile(file: BazelFileInfo): string {
-  return runfiles.resolveWorkspaceRelative(file.shortPath);
+export function resolveBazelFile(file: Pick<BazelFileInfo, 'shortPath'>): string {
+  // CWD is runfiles root inside workspace. All short paths naturally work.
+  return path.join(process.cwd(), file.shortPath);
 }
 
 /**
@@ -53,7 +52,8 @@ export function resolveBazelFile(file: BazelFileInfo): string {
  */
 export async function resolveBinaryWithRunfilesGracefully(binary: string): Promise<string> {
   try {
-    const resolved = runfiles.resolveWorkspaceRelative(binary);
+    // CWD is runfiles root inside workspace. All short paths naturally work.
+    const resolved = path.join(process.cwd(), binary);
     debug(`Resolved ${binary} to ${resolved} using runfile resolution.`);
     return resolved;
   } catch {
diff --git a/bazel/integration/test_runner/constants.mts b/bazel/integration/test_runner/constants.mts
diff --git a/bazel/integration/test_runner/debug.mts b/bazel/integration/test_runner/debug.mts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as util from 'util';
+import util from 'node:util';
 
 /** Function for printing debug messages when working with the test runner. */
 export const debug = util.debuglog('ng-integration-test');
diff --git a/bazel/integration/test_runner/file_system_utils.mts b/bazel/integration/test_runner/file_system_utils.mts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as fs from 'fs';
+import fs from 'node:fs';
 import {trueCasePath} from 'true-case-path';
 
 /** Gets whether the file is executable or not. */
diff --git a/bazel/integration/test_runner/main.mts b/bazel/integration/test_runner/main.mts
@@ -6,10 +6,11 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {TestRunner} from './runner';
-import {BazelExpandedValue, BazelFileInfo, runfiles} from './bazel';
-import * as fs from 'fs';
-import {debug} from './debug';
+import {TestRunner} from './runner.mjs';
+import {BazelExpandedValue, BazelFileInfo} from './bazel.mjs';
+import fs from 'node:fs';
+import path from 'node:path';
+import {debug} from './debug.mjs';
 
 /**
  * Test config that is passed as JSON from the Bazel action.
@@ -30,7 +31,8 @@ async function main(): Promise<void> {
   debug(`Running test with arguments: ${process.argv.join(' ')}`);
   debug(`Current working directory: ${process.cwd()}`);
 
-  const configPath = runfiles.resolveWorkspaceRelative(process.argv[2]);
+  // Config is passed as short path, relative to current working dir.
+  const configPath = path.resolve(process.argv[2]);
   const configContent = await fs.promises.readFile(configPath, 'utf8');
   const config = JSON.parse(configContent) as TestConfig;
 
diff --git a/bazel/integration/test_runner/package_json.mts b/bazel/integration/test_runner/package_json.mts
@@ -7,7 +7,7 @@
  */
 
 import * as fs from 'fs';
-import {debug} from './debug';
+import {debug} from './debug.mjs';
 
 /** Record capturing dependencies in a `package.json`. */
 export type DependencyRecord = Record<string, string>;
diff --git a/bazel/integration/test_runner/process_utils.mts b/bazel/integration/test_runner/process_utils.mts
@@ -6,10 +6,10 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as childProcess from 'child_process';
-import * as path from 'path';
-import {debug} from './debug';
-import {getCaseExactRealpath} from './file_system_utils';
+import childProcess from 'node:child_process';
+import path from 'node:path';
+import {debug} from './debug.mjs';
+import {getCaseExactRealpath} from './file_system_utils.mjs';
 
 /**
  * Regular expression matching environment variable substitutions
@@ -81,7 +81,6 @@ export function prependToPathVariable(pathToAdd: string, existingPathVar: string
  */
 export function getBinaryPassThroughScript(binaryFilePath: string) {
   return {
-    cmd: `@echo off\nCALL "${path.win32.normalize(binaryFilePath)}" %*`,
-    bash: `${path.posix.normalize(binaryFilePath)} $@`,
+    bash: `${path.posix.normalize(binaryFilePath)} "$@"`,
   };
 }
diff --git a/bazel/integration/test_runner/runner.mts b/bazel/integration/test_runner/runner.mts
@@ -6,32 +6,30 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import * as fs from 'fs';
-import * as path from 'path';
-import * as tmp from 'tmp';
-import * as os from 'os';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
 
 import {
   BazelExpandedValue,
   BazelFileInfo,
   resolveBazelFile,
   resolveBinaryWithRunfilesGracefully,
-} from './bazel';
+} from './bazel.mjs';
 import {
   PackageMappings,
   readPackageJsonContents,
   updateMappingsForPackageJson,
-} from './package_json';
-import {addWritePermissionFlag, writeExecutableFile} from './file_system_utils';
+} from './package_json.mjs';
+import {addWritePermissionFlag, writeExecutableFile} from './file_system_utils.mjs';
 import {
   expandEnvironmentVariableSubstitutions,
   getBinaryPassThroughScript,
   prependToPathVariable,
   runCommandInChildProcess,
-} from './process_utils';
-
-import {ENVIRONMENT_TMP_PLACEHOLDER} from './constants';
-import {debug} from './debug';
+} from './process_utils.mjs';
+import {ENVIRONMENT_TMP_PLACEHOLDER} from './constants.mjs';
+import {debug} from './debug.mjs';
 
 /** Error class that is used when an integration command fails.  */
 class IntegrationTestCommandError extends Error {}
@@ -55,7 +53,7 @@ export class TestRunner {
     private readonly testFiles: BazelFileInfo[],
     private readonly testPackage: string,
     private readonly testPackageRelativeWorkingDir: string,
-    private readonly toolMappings: Record<string, BazelFileInfo>,
+    private readonly toolMappings: Record<string, Pick<BazelFileInfo, 'shortPath'>>,
     private readonly npmPackageMappings: Record<string, BazelFileInfo>,
     private readonly commands: [[binary: BazelExpandedValue, ...args: string[]]],
     environment: EnvironmentConfig,
@@ -70,13 +68,13 @@ export class TestRunner {
 
     // Create the test sandbox directory. The working directory does not need to
     // be explicitly created here as the test file copying should create the folder.
-    await fs.promises.mkdir(testSandboxDir);
+    await fs.mkdir(testSandboxDir);
 
     const toolMappings = await this._setupToolMappingsForTest(testTmpDir);
     const testEnv = await this._buildTestProcessEnvironment(testTmpDir, toolMappings.binDir);
 
     debug(`Temporary directory for integration test: ${path.normalize(testTmpDir)}`);
-    debug(`Test files are copied into: ${path.normalize(testSandboxDir)}`);
+    debug(`Test files are copied into: ${path.normalize(testWorkingDir)}`);
     console.info(`Running test in directory: ${path.normalize(testWorkingDir)}`);
 
     await this._copyTestFilesToDirectory(testSandboxDir);
@@ -90,7 +88,7 @@ export class TestRunner {
       // We keep the temporary directory on disk if the users wants to debug the test.
       if (!this.isTestDebugMode) {
         debug('Deleting the integration test temporary directory..');
-        await fs.promises.rm(testTmpDir, {force: true, recursive: true, maxRetries: 3});
+        await fs.rm(testTmpDir, {force: true, recursive: true, maxRetries: 3});
       }
     }
   }
@@ -111,17 +109,7 @@ export class TestRunner {
     // system directories are always writable. See:
     // Linux: https://github.com/bazelbuild/bazel/blob/d35f923b098e4dc9c90b1ab66b413c216bdee638/src/main/java/com/google/devtools/build/lib/sandbox/LinuxSandboxedSpawnRunner.java#L280.
     // Darwin: https://github.com/bazelbuild/bazel/blob/d35f923b098e4dc9c90b1ab66b413c216bdee638/src/main/java/com/google/devtools/build/lib/sandbox/DarwinSandboxedSpawnRunner.java#L170.
-    return new Promise((resolve, reject) => {
-      tmp.dir(
-        {
-          template: 'ng-integration-test-XXXXXX',
-          // Always keep the directory for debugging. We will handle the deletion
-          // manually and need full control over the directory persistence.
-          keep: true,
-        },
-        (err, tmpPath) => (err ? reject(err) : resolve(path.resolve(tmpPath))),
-      );
-    });
+    return fs.mkdtemp(path.join(os.tmpdir(), 'ng-integration-test'));
   }
 
   /**
@@ -149,8 +137,8 @@ export class TestRunner {
     const outAbsolutePath = path.join(tmpDir, outRelativePath);
     const resolvedFilePath = resolveBazelFile(file);
 
-    await fs.promises.mkdir(path.dirname(outAbsolutePath), {recursive: true});
-    await fs.promises.copyFile(resolvedFilePath, outAbsolutePath);
+    await fs.mkdir(path.dirname(outAbsolutePath), {recursive: true});
+    await fs.copyFile(resolvedFilePath, outAbsolutePath);
 
     // Bazel removes the write permission from all generated files. Since we copied
     // the test files over to a directory, we want to re-add the write permission in
@@ -164,17 +152,16 @@ export class TestRunner {
    * directory can be added to the `$PATH` later when commands are executed.
    */
   private async _setupToolMappingsForTest(testDir: string) {
-    const toolBinDir = path.join(testDir, '.integration-bazel-tool-bin');
+    const toolBinDir = path.join(testDir, 'integration-bazel-tool-bin');
 
     // Create the bin directory for the tool mappings.
-    await fs.promises.mkdir(toolBinDir, {recursive: true});
+    await fs.mkdir(toolBinDir, {recursive: true});
 
     for (const [toolName, toolFile] of Object.entries(this.toolMappings)) {
       const toolAbsolutePath = resolveBazelFile(toolFile);
       const passThroughScripts = getBinaryPassThroughScript(toolAbsolutePath);
       const toolDelegateBasePath = path.join(toolBinDir, toolName);
 
-      await writeExecutableFile(`${toolDelegateBasePath}.cmd`, passThroughScripts.cmd);
       await writeExecutableFile(`${toolDelegateBasePath}.sh`, passThroughScripts.bash);
       await writeExecutableFile(toolDelegateBasePath, passThroughScripts.bash);
     }
@@ -207,7 +194,7 @@ export class TestRunner {
 
     // Write the new `package.json` file to the test directory, overwriting
     // the `package.json` file initially copied as a test input/file.
-    await fs.promises.writeFile(pkgJsonPath, JSON.stringify(newPkgJson, null, 2));
+    await fs.writeFile(pkgJsonPath, JSON.stringify(newPkgJson, null, 2));
   }
 
   /**
@@ -230,15 +217,21 @@ export class TestRunner {
       if (value.containsExpansion) {
         envValue = await resolveBinaryWithRunfilesGracefully(envValue);
       } else if (envValue === ENVIRONMENT_TMP_PLACEHOLDER) {
-        envValue = path.join(testTmpDir, `.tmp-env-${i++}`);
-        await fs.promises.mkdir(envValue);
+        envValue = path.join(testTmpDir, `tmp-env-${i++}`);
+        await fs.mkdir(envValue);
       }
 
       testEnv[variableName] = envValue;
     }
 
     const commandPath = prependToPathVariable(toolsBinDir, testEnv.PATH ?? '');
-    return {...testEnv, PATH: commandPath};
+    return {
+      ...testEnv,
+      PATH: commandPath,
+      // `rules_js` binaries are never build actions, so can be set to `.`.
+      // See: https://github.com/aspect-build/rules_js/blob/674f689ff56b962c3cb0509a4b97e99af049a6eb/js/private/js_binary.sh.tpl#L200-L207
+      BAZEL_BINDIR: '.',
+    };
   }
 
   /**
@@ -301,16 +294,9 @@ export class TestRunner {
   private _assignDefaultEnvironmentVariables(baseEnv: EnvironmentConfig): EnvironmentConfig {
     const defaults: EnvironmentConfig = {
       'HOME': {value: ENVIRONMENT_TMP_PLACEHOLDER, containsExpansion: false},
+      'PROFILE': {value: ENVIRONMENT_TMP_PLACEHOLDER, containsExpansion: false},
     };
 
-    // Support windows-specific system variables. We don't want to always assign these as
-    // it would result in unnecessary directories being created all the time.
-    if (os.platform() === 'win32') {
-      defaults.USERPROFILE = {value: ENVIRONMENT_TMP_PLACEHOLDER, containsExpansion: false};
-      defaults.APPDATA = {value: ENVIRONMENT_TMP_PLACEHOLDER, containsExpansion: false};
-      defaults.LOCALAPPDATA = {value: ENVIRONMENT_TMP_PLACEHOLDER, containsExpansion: false};
-    }
-
     return {...defaults, ...baseEnv};
   }
 }
diff --git a/bazel/integration/tests/custom_env_variables/test.js b/bazel/integration/tests/custom_env_variables/test.js
@@ -20,7 +20,7 @@ if (process.env.MANUAL_ROOT_PATH !== '../npm/node_modules/semver/package.json')
   process.exit(1);
 }
 
-if (!process.env.HOME.includes('.tmp-env-')) {
+if (!process.env.HOME.includes('tmp-env-')) {
   console.error('Expected `HOME` to point to a temporary environment directory.');
   process.exit(1);
 }
diff --git a/bazel/package.json b/bazel/package.json
@@ -4,7 +4,8 @@
     "@microsoft/api-extractor": "7.52.3",
     "@types/node": "22.14.0",
     "piscina": "^4.9.2",
-    "typescript": "5.8.2"
+    "typescript": "5.8.2",
+    "true-case-path": "2.2.1"
   },
   "pnpm": {
     "onlyBuiltDependencies": []
diff --git a/bazel/pnpm-lock.yaml b/bazel/pnpm-lock.yaml
