feat(scripts): add test:e2e:legacy:preview (#6538)

Author: trivikr

package.json

@@ -36,7 +36,8 @@
     "test:ci": "lerna run test --since origin/main",
     "test:e2e": "node ./tests/e2e/index.js && node ./tests/canary/canary",
     "test:e2e:legacy": "cucumber-js --fail-fast",
-    "test:e2e:legacy:since:release": "./tests/e2e-legacy/index.js",
+    "test:e2e:legacy:preview": "./tests/e2e-legacy/preview.mjs",
+    "test:e2e:legacy:since:release": "./tests/e2e-legacy/since-release.mjs",
     "test:functional": "jest --passWithNoTests --config tests/functional/jest.config.js && lerna run test:unit --scope \"@aws-sdk/client-*\"",
     "test:integration": "jest --config jest.config.integ.js --passWithNoTests",
     "test:integration:legacy": "yarn test:e2e:legacy",

tests/e2e-legacy/getAllTags.mjs

@@ -0,0 +1,15 @@
+import { join } from "path";
+import { execSync } from "child_process";
+import { getDirName } from "./getDirName.mjs";
+
+const __dirname = getDirName();
+const FEATURES_FOLDER = join(__dirname, "..", "..", "features");
+
+const execOptions = {
+  ...process,
+  cwd: __dirname,
+  encoding: "utf-8",
+};
+
+export const getAllTags = () =>
+  execSync(`grep -h ^@ ${join(FEATURES_FOLDER, "**", "*.feature")}`, execOptions).split(/[\n ]/g);

tests/e2e-legacy/getDirName.mjs

@@ -0,0 +1,4 @@
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+
+export const getDirName = () => dirname(fileURLToPath(import.meta.url));

tests/e2e-legacy/getPackageTags.mjs

@@ -0,0 +1,5 @@
+export const getPackageTags = (packages) =>
+  packages
+    .map((name) => name.replace("@aws-sdk/client-", ""))
+    .map((name) => name.replace("-", ""))
+    .map((name) => `@${name}`);

tests/e2e-legacy/index.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+import { execSync } from "child_process";
+import { getDirName } from "./getDirName.mjs";
+import { getAllTags } from "./getAllTags.mjs";
+import { getPackageTags } from "./getPackageTags.mjs";
+import { runTestForTags } from "./runTestForTags.mjs";
+
+const __dirname = getDirName();
+
+const execOptions = { ...process, cwd: __dirname, encoding: "utf-8" };
+const commitMessage = execSync(`git show -s --format=%s`, execOptions);
+const prefix = commitMessage.split(":")[0];
+const scope = prefix.substring(prefix.indexOf("(") + 1, prefix.indexOf(")"));
+console.info(`Updated scope: ${scope}`);
+
+if (!scope) {
+  console.info(`Couldn't find scope in commit message '${commitMessage}'`);
+  process.exit(1);
+}
+
+const allTags = getAllTags();
+const changedPackageTags = getPackageTags([`@aws-sdk/${scope}`]);
+const tagsToTest = changedPackageTags.filter((tag) => allTags.includes(tag));
+runTestForTags(tagsToTest);

tests/e2e-legacy/preview.mjs

@@ -0,0 +1,26 @@
+import { join, resolve } from "path";
+import { spawn } from "child_process";
+import { getDirName } from "./getDirName.mjs";
+
+const __dirname = getDirName();
+const ROOT = resolve(join(__dirname, "..", ".."));
+
+export const runTestForTags = (tagsToTest) => {
+  if (tagsToTest.length === 0) {
+    console.info("No clients with e2e-legacy test cases have changed.");
+    return;
+  }
+
+  // Cucumber requires cwd to contain the test cases.
+  const command = `${join("node_modules", ".bin", "cucumber-js")}`;
+  const args = ["--fail-fast", "-t", `"${tagsToTest.join(" or ")}"`];
+  console.info(`Running cucumber test: \n${command} ${args.join(" ")}`);
+
+  const execOptions = { ...process, cwd: ROOT, encoding: "utf-8", shell: true };
+  const cucumber = spawn(command, args, execOptions);
+  cucumber.stdout.pipe(process.stdout);
+  cucumber.stderr.pipe(process.stderr);
+  cucumber.on("close", (code) => {
+    process.exit(code);
+  });
+};

tests/e2e-legacy/runTestForTags.mjs

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+import { join } from "path";
+import { execSync } from "child_process";
+import { getDirName } from "./getDirName.mjs";
+import { getAllTags } from "./getAllTags.mjs";
+import { getPackageTags } from "./getPackageTags.mjs";
+import { runTestForTags } from "./runTestForTags.mjs";
+
+const __dirname = getDirName();
+const ROOT_BIN = join(__dirname, "..", "..", "node_modules", ".bin");
+
+console.info(`Looking for changed packages...`);
+let changedPackages = [];
+try {
+  const execOptions = { ...process, cwd: __dirname, encoding: "utf-8" };
+  changedPackages = execSync(`${join(ROOT_BIN, "lerna")} changed`, execOptions).split("\n");
+} catch (e) {
+  // Swallow error because Lerna throws if no package changes.
+}
+
+const allTags = getAllTags();
+const changedPackageTags = getPackageTags(changedPackages);
+const tagsToTest = changedPackageTags.filter((tag) => allTags.includes(tag));
+runTestForTags(tagsToTest);