Test E2E resource naming

utils/testResourceName.js

@@ -0,0 +1,16 @@
+const crypto = require("crypto");
+
+function generateUniqueName(baseName, options, environment = process.env) {
+  const length = options?.length ?? 1;
+  const timestamp = options?.timestampped === undefined ? true : options.timestampped;
+  const prefixed = options?.prefixed === undefined ? true : options.prefixed;
+
+  const runId = environment.GITHUB_RUN_ID;
+  const runAttempt = environment.GITHUB_RUN_ATTEMPT ?? "1";
+  const runPrefix = runId ? `${runId}_${runAttempt}_` : "";
+  const prefix = prefixed ? `t_${runPrefix}` : "";
+  const suffix = timestamp ? `_${Date.now()}` : "";
+  return `${prefix}${baseName}${crypto.randomBytes(length).toString("hex")}${suffix}`;
+}
+
+module.exports = { generateUniqueName };

utils/testResourceName.test.js

@@ -0,0 +1,52 @@
+const assert = require("node:assert/strict");
+const test = require("node:test");
+const { generateUniqueName } = require("./testResourceName");
+
+const noRandomSuffix = { length: 0 };
+
+test("includes the workflow run and attempt in CI resource names", () => {
+  const name = generateUniqueName("db", noRandomSuffix, {
+    GITHUB_RUN_ID: "12345",
+    GITHUB_RUN_ATTEMPT: "2",
+  });
+
+  assert.match(name, /^t_12345_2_db_\d+$/);
+});
+
+test("defaults a missing workflow attempt to one", () => {
+  const name = generateUniqueName("db", noRandomSuffix, { GITHUB_RUN_ID: "12345" });
+
+  assert.match(name, /^t_12345_1_db_\d+$/);
+});
+
+test("preserves the local resource name format outside GitHub Actions", () => {
+  const name = generateUniqueName("db", noRandomSuffix, {});
+
+  assert.match(name, /^t_db_\d+$/);
+});
+
+test("omits the test and workflow prefixes when requested", () => {
+  const name = generateUniqueName(
+    "db",
+    { ...noRandomSuffix, prefixed: false },
+    {
+      GITHUB_RUN_ID: "12345",
+      GITHUB_RUN_ATTEMPT: "2",
+    },
+  );
+
+  assert.match(name, /^db_\d+$/);
+});
+
+test("omits the timestamp when requested", () => {
+  const name = generateUniqueName(
+    "db",
+    { ...noRandomSuffix, timestampped: false },
+    {
+      GITHUB_RUN_ID: "12345",
+      GITHUB_RUN_ATTEMPT: "2",
+    },
+  );
+
+  assert.equal(name, "t_12345_2_db");
+});