[Eng] Update Dependency Test & Docs (Azure#34245)

minhanh-phan · web-flow · commit e8766b739ea6 · 2025-05-07T14:57:42.000-07:00
After the unifying test changes in this PR Azure#34132, this PR aims to: * Remove references to `unit-test` and `integration-test` with `test` * Update min/max testing to look for the right updated scripts
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -15,56 +15,17 @@
       "cwd": "${workspaceFolder}/sdk/${input:package-directory}"
     },
     {
-      "name": "unit:current-file",
+      "name": "test:current-file",
       "type": "node",
       "request": "launch",
       "runtimeExecutable": "rushx",
-      "runtimeArgs": ["unit-test:node"],
+      "runtimeArgs": ["test:node"],
       "args": ["--", "--inspect-brk", "--no-file-parallelism", "${fileBasename}"],
       "autoAttachChildProcesses": false,
       "skipFiles": ["<node_internals>/**"],
       "console": "integratedTerminal",
       "attachSimplePort": 9229,
       "cwd": "${fileDirname}"
-    },
-    {
-      "name": "unit-customized:current-file",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "rushx",
-      "runtimeArgs": ["unit-test:node"],
-      "args": ["--inspect-brk", "--no-file-parallelism", "${fileBasename}"],
-      "autoAttachChildProcesses": false,
-      "skipFiles": ["<node_internals>/**"],
-      "console": "integratedTerminal",
-      "attachSimplePort": 9229,
-      "cwd": "${fileDirname}"
-    },
-    {
-      "name": "integration:current-file",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "rushx",
-      "runtimeArgs": ["integration-test:node"],
-      "args": ["--", "--inspect-brk", "--no-file-parallelism", "${fileBasename}"],
-      "autoAttachChildProcesses": false,
-      "skipFiles": ["<node_internals>/**"],
-      "console": "integratedTerminal",
-      "attachSimplePort": 9229,
-      "cwd": "${fileDirname}"
-    },
-    {
-      "name": "integration-customized:current-file",
-      "type": "node",
-      "request": "launch",
-      "runtimeExecutable": "rushx",
-      "runtimeArgs": ["integration-test:node"],
-      "args": ["--inspect-brk", "--no-file-parallelism", "${fileBasename}"],
-      "autoAttachChildProcesses": false,
-      "skipFiles": ["<node_internals>/**"],
-      "console": "integratedTerminal",
-      "attachSimplePort": 9229,
-      "cwd": "${fileDirname}"
     }
   ],
   "inputs": [
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,8 +29,8 @@ If you encounter any bugs with the library, please file an issue in the [Issues]
 
 Some guidance for when you make a contribution:
 
-- Add/update unit tests and code as required by your change
-- Make sure you run all the unit tests on the affected platform(s)/languages. If the change is in common code, generally running on one platform would be acceptable.
+- Add/update tests and code as required by your change
+- Make sure you run all the tests on the affected platform(s)/languages. If the change is in common code, generally running on one platform would be acceptable.
 - Run end-to-end tests or simple sample code to make sure the lib works in an end-to-end scenario.
 
 ## Big contributions
@@ -199,18 +199,12 @@ All projects have at least the following scripts:
 - `clean`: Remove generated and temporary files
 - `execute:samples`: Execute samples using the source code
 - `format`: Reformat project files with Prettier
-- `integration-test:browser`: Execute browser integration tests
-- `integration-test:node`: Execute Node integration tests
-- `integration-test`: Execute all integration tests
 - `lint:fix`: Fix ESLint issues within the project
 - `lint`: Show ESLint issues within the project
 - `pack`: Run `npm pack` on the project
 - `test:browser`: Execute browser dev tests
 - `test:node`: Execute Node dev tests
 - `test`: Execute all dev tests
-- `unit-test:browser`: Execute browser unit tests
-- `unit-test:node`: Execute Node unit tests
-- `unit-test`: Execute all unit tests
 
 Projects may optionally have the following scripts:
 
@@ -290,7 +284,7 @@ The second type of libraries is more complex to develop and maintain because the
 
 Rush assumes that anything printed to `STDERR` is a warning. Your package scripts should avoid writing to `STDERR` unless emitting warnings or errors, since this will cause Rush to flag them as warnings during the execution of your build or script command. If your library uses a tool that can't be configured this way, you can still append `2>&1` to the command which will redirect all output to `STDOUT`. You won't see warnings show up, but Rush will still consider the command to have failed as long as it returns a nonzero exit code.
 
-In general, it's recommended to avoid using NPM [hook scripts](https://docs.npmjs.com/misc/scripts) (those starting with `pre` / `post`). The build system will always explicitly run the `install`, `build`, `build:test`, `pack`, `lint`, `unit-test`, and `integration-test` scripts at the appropriate times during the build. Adding hooks that perform steps like installing dependencies or compiling the source code will at best slow down the build, and at worst may lead to difficult to diagnose build failures.
+In general, it's recommended to avoid using NPM [hook scripts](https://docs.npmjs.com/misc/scripts) (those starting with `pre` / `post`). The build system will always explicitly run the `install`, `build`, `build:test`, `pack`, `lint`, and `test` scripts at the appropriate times during the build. Adding hooks that perform steps like installing dependencies or compiling the source code will at best slow down the build, and at worst may lead to difficult to diagnose build failures.
 
 Because Rush uses PNPM to download and manage dependencies, it's **_especially_** important to make sure that none of your package scripts are calling `npm install` when your library is built via the Rush toolchain. Most commonly this occurs in a `prepack` or `prebuild` script. Ensure your library does not contain these scripts - or if you determine that such a script is required, ensure that it doesn't run `npm install`.
 
diff --git a/common/config/rush/command-line.json b/common/config/rush/command-line.json
@@ -47,28 +47,6 @@
       "summary": "Reformat projects",
       "enableParallelism": true
     },
-    {
-      "commandKind": "bulk",
-      "name": "integration-test:browser",
-      "summary": "Execute browser integration tests defined in projects",
-      "enableParallelism": true,
-      "allowWarningsInSuccessfulBuild": true
-    },
-    {
-      "commandKind": "bulk",
-      "name": "integration-test:node",
-      "summary": "Execute Node integration tests defined in projects",
-      "enableParallelism": true,
-      "allowWarningsInSuccessfulBuild": true
-    },
-    {
-      "commandKind": "bulk",
-      "name": "integration-test",
-      "summary": "Execute integration tests defined in projects",
-      "description": "Execute tests which require an actual service instance (live Azure, emulator, etc). Integration tests typically require service endpoints to be specified via environment variables in order to run.",
-      "enableParallelism": true,
-      "allowWarningsInSuccessfulBuild": true
-    },
     {
       "commandKind": "bulk",
       "name": "lint",
diff --git a/common/tools/dev-tool/src/commands/admin/list/packages.ts b/common/tools/dev-tool/src/commands/admin/list/packages.ts
@@ -39,13 +39,10 @@ export default async function IdentifyPackage(
   const fullProjectPath = path.join(root, projectFolder);
   const { packageJson } = await resolveProject(fullProjectPath);
 
-  const unitTestNodeScript = packageJson.scripts["unit-test:node"];
-  const integrationTestNodeScript = packageJson.scripts["integration-test:node"];
+  const testNodeScript = packageJson.scripts["test:node"];
 
-  if (unitTestNodeScript.includes("dev-tool run test:node-js-input") ||
-    integrationTestNodeScript.includes("dev-tool run test:node-js-input") ||
-    unitTestNodeScript.includes("dev-tool run test:node-tsx-ts") ||
-    integrationTestNodeScript.includes("dev-tool run test:node-tsx-ts")) {
+  if (testNodeScript.includes("dev-tool run test:node-js-input") ||
+    testNodeScript.includes("dev-tool run test:node-tsx-ts")) {
     if (!packageJson.devDependencies["tsx"]) {
       console.log(`    updating ${packageName} ${fullProjectPath} testing scripts`);
       packageJson.devDependencies["tsx"] = "^4.7.1";
diff --git a/common/tools/dev-tool/src/commands/admin/migrate-package.ts b/common/tools/dev-tool/src/commands/admin/migrate-package.ts
@@ -348,15 +348,15 @@ function setScriptsSection(
   scripts["build"] = "npm run clean && dev-tool run build-package && dev-tool run extract-api";
 
   if (options.browser) {
-    scripts["unit-test:browser"] =
+    scripts["test:browser"] =
       "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser";
   }
 
-  scripts["unit-test:node"] = "dev-tool run test:vitest";
+  scripts["test:node"] = "dev-tool run test:vitest";
+  scripts["test:node:esm"] = "dev-tool run test:vitest --esm";
 
   if (options.isArm) {
-    scripts["unit-test:browser"] = "echo skipped";
-    scripts["integration-test:node"] = "dev-tool run test:vitest --esm";
+    scripts["test:browser"] = "echo skipped";
   }
 
   if (!options.formatTests) {
diff --git a/eng/tools/dependency-testing/README.md b/eng/tools/dependency-testing/README.md
@@ -75,16 +75,21 @@ Note : If the above step fails, you can reset the repo: `git clean -f -x -d` (Wa
 ### Troubleshooting guide for min-max test failures
 
 #### This is not a module
+
 When you see an error message as shown below, it implies that there has been an internal source reference in a file inside the test/public folder that has been replaced by an empty file to avoid multiple versions of a dependency being pulled in.
 
 ```
 communicationIdentityClient.mocked.spec.ts(8,68): error TS2306: File '/mnt/vss/_work/1/s/sdk/communication/communication-identity/test/public/utils/mockHttpClients.ts' is not a module.
 utils/testCommunicationIdentityClient.ts(17,8): error TS2306: File '/mnt/vss/_work/1/s/sdk/communication/communication-identity/test/public/utils/mockHttpClients.ts' is not a module.
 ```
+
 To fix the error, first locate where in the above file are you using the internal source reference. For example, from the above error, you notice that `/mnt/vss/_work/1/s/sdk/communication/communication-identity/test/public/utils/mockHttpClients.ts` probably has an internal source reference, which is why it's not accessible anymore since it's replaced by an empty file by the dependency-testing tool. This is the internal source reference detected in the `test/public/utils/mockHttpClients.ts` file.
+
 ```
 import { CommunicationIdentityAccessTokenResult } from "../../../src/generated/src/models";
 ```
+
 After locating the internal source reference, you have one of the following options:
+
 - Either expose the above interface/ constant through the public API in the src/index.ts file of the Azure-SDK and change the import to accessing it from the src in this format - `../../../src` so that it becomes a public reference
 - Or move the tests and references to test/internal folder if there's something you are accessing that cannot be exposed publicly.
diff --git a/eng/tools/dependency-testing/index.js b/eng/tools/dependency-testing/index.js
@@ -56,34 +56,35 @@ function outputTestPath(projectFolderPath, sourceDir, testFolder) {
 }
 /**
  * This function uses the package's timeout in it's package.json for
- * the integration-test:node command for the min-max tests.
+ * the test:node command for the min-max tests.
  * This function basically does a string search for "timeout" / "test-timeout" / "hook-timeout" in the package's package.json
  * and replaces the command for timeout in new package.json in the test or test/public folder.
  * @param testPackageJson - the package.json that will be created in the test folder
  * @param packageJsonContents - the package's package.json contents
  */
 async function usePackageTestTimeout(testPackageJson, packageJsonContents) {
-  if (packageJsonContents.scripts["integration-test:node"]) {
+  if (packageJsonContents.scripts["test:node"]) {
     // Replace any test-timeout
     let timeoutPattern = /--(test-)?timeout\s+(\d+)/;
-    let replaceWithTimeout =
-      packageJsonContents.scripts["integration-test:node"].match(timeoutPattern);
+    let replaceWithTimeout = packageJsonContents.scripts["test:node"].match(timeoutPattern);
     if (replaceWithTimeout !== null) {
       const timeoutArgument = `${replaceWithTimeout[1] || ""}timeout`;
       const packageTimeout = replaceWithTimeout[2];
-      testPackageJson.scripts["integration-test:node"] = testPackageJson.scripts[
-        "integration-test:node"
-      ].replace(timeoutPattern, `--${timeoutArgument} ${packageTimeout}`);
+      testPackageJson.scripts["test:node"] = testPackageJson.scripts["test:node"].replace(
+        timeoutPattern,
+        `--${timeoutArgument} ${packageTimeout}`,
+      );
     }
 
     // Replace any hook-timeout
     timeoutPattern = /--hook-timeout\s+(\d+)/; // this is only a vitest concept, so there's just one pattern
-    replaceWithTimeout = packageJsonContents.scripts["integration-test:node"].match(timeoutPattern);
+    replaceWithTimeout = packageJsonContents.scripts["test:node"].match(timeoutPattern);
     if (replaceWithTimeout !== null) {
       const packageTimeout = replaceWithTimeout[1];
-      testPackageJson.scripts["integration-test:node"] = testPackageJson.scripts[
-        "integration-test:node"
-      ].replace(timeoutPattern, `--hook-timeout ${packageTimeout}`);
+      testPackageJson.scripts["test:node"] = testPackageJson.scripts["test:node"].replace(
+        timeoutPattern,
+        `--hook-timeout ${packageTimeout}`,
+      );
     }
   }
 }
@@ -117,10 +118,10 @@ async function insertPackageJson(
       packageJsonContents.name.replace("@azure-rest/", "azure-rest-") + "-test";
   }
   testPackageJson.type = packageJsonContents.type;
-  if (packageJsonContents.scripts["integration-test:node"].includes("vitest")) {
-    testPackageJson.scripts["integration-test:node"] =
+  if (packageJsonContents.scripts["test:node"].includes("vitest")) {
+    testPackageJson.scripts["test:node"] =
       "dev-tool run test:vitest -- -c vitest.dependency-test.config.ts --test-timeout 180000 --hook-timeout 180000";
-    testPackageJson.scripts["integration-test:browser"] =
+    testPackageJson.scripts["test:browser"] =
       "dev-tool run build-test && dev-tool run test:vitest --browser  -- -c vitest.dependency-test.browser.config.ts";
     testPackageJson.scripts["build"] = "echo skipped.";
   }
@@ -419,7 +420,7 @@ async function main(argv) {
     testFolder,
   );
   await insertTsConfigJson(targetPackagePath, testFolder);
-  if (packageJsonContents.scripts["integration-test:node"].includes("vitest")) {
+  if (packageJsonContents.scripts["test:node"].includes("vitest")) {
     copyVitestConfig(targetPackagePath, testFolder);
   }
   if (dryRun) {
diff --git a/eng/tools/dependency-testing/templates/package.json b/eng/tools/dependency-testing/templates/package.json
@@ -8,9 +8,9 @@
   },
   "scripts": {
     "build": "tsc -p .",
-    "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "mocha --require tsx --require source-map-support/register --reporter mocha-multi-reporter.js  --reporter-option output=test-results.xml --timeout 350000 --full-trace \"dist-esm/**/{,!(browser)/**/}*.spec.js\" --exit",
-    "integration-test": "npm run integration-test:node && echo skipped: npm run integration-test:browser"
+    "test:browser": "karma start --single-run",
+    "test:node": "mocha --require tsx --require source-map-support/register --reporter mocha-multi-reporter.js  --reporter-option output=test-results.xml --timeout 350000 --full-trace \"dist-esm/**/{,!(browser)/**/}*.spec.js\" --exit",
+    "test": "npm run test:node && echo skipped: npm run test:browser"
   },
   "repository": {
     "type": "git",
diff --git a/sdk/test-utils/recorder/ASSET_SYNC_WORKFLOW.md b/sdk/test-utils/recorder/ASSET_SYNC_WORKFLOW.md
@@ -56,7 +56,7 @@ At this point, you should have an `assets.json` file under your SDK.
 
 Run your tests using the usual [package.json scripts].
 
-`rushx integration-test:node`, for example.
+`rushx test:node`, for example.
 
 With asset sync enabled, there is one extra step that must be taken before you create a PR with changes to recorded tests: you must push the new recordings to the assets repo. This is done with the following command:
 
