@red-hat-developer-hub/e2e-test-utils 1.1.31 → 1.1.33

package/dist/playwright/global-setup.d.ts

@@ -2,5 +2,6 @@
  * Global setup for Playwright tests.
  * This file runs once before all tests.
  */
-export default function globalSetup(): Promise<void>;
+import { type FullConfig } from "@playwright/test";
+export default function globalSetup(config: FullConfig): Promise<void>;
 //# sourceMappingURL=global-setup.d.ts.map

package/dist/playwright/global-setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"global-setup.d.ts","sourceRoot":"","sources":["../../src/playwright/global-setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AA2EH,wBAA8B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAMzD"}
+{"version":3,"file":"global-setup.d.ts","sourceRoot":"","sources":["../../src/playwright/global-setup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,kBAAkB,CAAC;AA6EnD,wBAA8B,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAQ3E"}

package/dist/playwright/global-setup.js

@@ -2,10 +2,13 @@
  * Global setup for Playwright tests.
  * This file runs once before all tests.
  */
+import dotenv from "dotenv";
+import { resolve } from "path";
 import { KubernetesClientHelper } from "../utils/kubernetes-client.js";
 import { $ } from "../utils/bash.js";
 import { KeycloakHelper } from "../deployment/keycloak/index.js";
 import { DEFAULT_KEYCLOAK_CONFIG, DEFAULT_RHDH_CLIENT, DEFAULT_USERS, } from "../deployment/keycloak/constants.js";
+import { loadLocalVaultSecrets } from "../utils/vault.js";
 const REQUIRED_BINARIES = ["oc", "kubectl", "helm"];
 async function checkRequiredBinaries() {
     const missingBinaries = [];
@@ -58,10 +61,27 @@ async function deployKeycloak() {
         testPassword: DEFAULT_USERS[0].password,
     });
 }
-export default async function globalSetup() {
+export default async function globalSetup(config) {
     console.log("Running global setup...");
     await checkRequiredBinaries();
+    await loadLocalVaultSecrets();
+    loadDotenvFromProjects(config);
     await setClusterRouterBaseEnv();
     await deployKeycloak();
     console.log("Global setup completed successfully");
 }
+/**
+ * Loads .env files from each project's e2e-tests directory.
+ * Uses `override: true` so local .env values take priority over Vault secrets.
+ */
+function loadDotenvFromProjects(config) {
+    const seen = new Set();
+    for (const project of config.projects) {
+        // testDir points to e2e-tests/tests, go up one level to e2e-tests/
+        const e2eRoot = resolve(project.testDir, "..");
+        if (seen.has(e2eRoot))
+            continue;
+        seen.add(e2eRoot);
+        dotenv.config({ path: resolve(e2eRoot, ".env"), override: true });
+    }
+}

package/dist/utils/plugin-metadata.d.ts

@@ -28,9 +28,11 @@ export interface DynamicPluginsConfig {
 export declare function isNightlyJob(): boolean;
 /**
  * Extracts the plugin name from a package path or OCI reference.
+ * Strips the `-dynamic` suffix so local paths and OCI refs for the same
+ * logical plugin produce the same key.
  *
  * Handles various formats:
- * - Local path: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar
+ * - Local path: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar-dynamic
  * - OCI with alias: oci://quay.io/rhdh/plugin@sha256:...!backstage-community-plugin-tech-radar
  * - OCI without alias: oci://quay.io/rhdh/backstage-community-plugin-tech-radar:tag
  */

package/dist/utils/plugin-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-metadata.d.ts","sourceRoot":"","sources":["../../src/utils/plugin-metadata.ts"],"names":[],"mappings":"AAWA,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAaD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAID;;;;;;;;;GASG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAqBtC;AAID;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAI5D;AAYD,eAAO,MAAM,qBAAqB,gBAAgB,CAAC;AAEnD,wBAAgB,oBAAoB,CAClC,YAAY,GAAE,MAA8B,GAC3C,MAAM,GAAG,IAAI,CAQf;AAED,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CAyBzB;AAED,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAwBtC;AA2JD;;;;;;;GAOG;AACH;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,MAAM,CAMT;AAqGD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CAW7E;AAED;;;;;;;GAOG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAwB/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,oBAAoB,EAC5B,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CA6B/B"}
+{"version":3,"file":"plugin-metadata.d.ts","sourceRoot":"","sources":["../../src/utils/plugin-metadata.ts"],"names":[],"mappings":"AAWA,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAaD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAID;;;;;;;;;GASG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAqBtC;AAID;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAI5D;AAYD,eAAO,MAAM,qBAAqB,gBAAgB,CAAC;AAEnD,wBAAgB,oBAAoB,CAClC,YAAY,GAAE,MAA8B,GAC3C,MAAM,GAAG,IAAI,CAQf;AAED,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,cAAc,CAAC,CAyBzB;AAED,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAwBtC;AA2JD;;;;;;;GAOG;AACH;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,MAAM,CAMT;AAqGD;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,oBAAoB,CAW7E;AAED;;;;;;;GAOG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAwB/B;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,oBAAoB,EAC5B,YAAY,GAAE,MAA8B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CA6B/B"}

package/dist/utils/plugin-metadata.js

@@ -35,16 +35,18 @@ export function isNightlyJob() {
 // ── Utilities ─────────────────────────────────────────────────────────────────
 /**
  * Extracts the plugin name from a package path or OCI reference.
+ * Strips the `-dynamic` suffix so local paths and OCI refs for the same
+ * logical plugin produce the same key.
  *
  * Handles various formats:
- * - Local path: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar
+ * - Local path: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar-dynamic
  * - OCI with alias: oci://quay.io/rhdh/plugin@sha256:...!backstage-community-plugin-tech-radar
  * - OCI without alias: oci://quay.io/rhdh/backstage-community-plugin-tech-radar:tag
  */
 export function extractPluginName(packageRef) {
     const ref = packageRef.includes("!") ? packageRef.split("!")[0] : packageRef;
     const match = ref.match(/\/([^/:@]+)(?:[:@].*)?$/);
-    return match?.[1] || packageRef;
+    return (match?.[1] || packageRef).replace(/-dynamic$/, "");
 }
 /**
  * Derives the displayName from a packageName.
@@ -207,7 +209,7 @@ export function getNormalizedPluginMergeKey(entry) {
     if (pkg === undefined || pkg === "") {
         return "";
     }
-    return extractPluginName(pkg).replace(/-dynamic$/, "");
+    return extractPluginName(pkg);
 }
 async function resolvePluginPackages(plugins, metadataMap, metadataPath) {
     // Build PR OCI URLs if applicable

package/dist/utils/tests/plugin-metadata.pr.test.js

@@ -256,6 +256,61 @@ describe("processPluginsForDeployment — PR mode", () => {
             await fs.remove(metadataDir);
         }
     });
+    // ── -dynamic suffix normalization ────────────────────────────────────────
+    describe("-dynamic suffix normalization", () => {
+        it("resolves OCI plugin to metadata when dynamicArtifact has -dynamic suffix", async () => {
+            const metadataDir = await createMetadataFixture([
+                {
+                    name: "backstage-plugin-catalog-backend-module-github",
+                    packageName: "@backstage/plugin-catalog-backend-module-github",
+                    dynamicArtifact: "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic",
+                    appConfigExamples: {
+                        catalog: { providers: { github: { org: "test" } } },
+                    },
+                },
+            ]);
+            try {
+                const config = {
+                    plugins: [
+                        {
+                            package: "oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-github:bs_1.45.3__0.11.2",
+                            disabled: false,
+                        },
+                    ],
+                };
+                const result = await processPluginsForDeployment(config, metadataDir);
+                assert.ok(result.plugins[0].pluginConfig, "metadata config must be injected even when dynamicArtifact has -dynamic suffix but OCI URL does not");
+                assert.deepStrictEqual(result.plugins[0].pluginConfig, { catalog: { providers: { github: { org: "test" } } } }, "injected config must match metadata appConfigExamples");
+            }
+            finally {
+                await fs.remove(metadataDir);
+            }
+        });
+        it("keeps local -dynamic path unchanged when metadata also has -dynamic", async () => {
+            const metadataDir = await createMetadataFixture([
+                {
+                    name: "backstage-plugin-catalog-backend-module-github",
+                    packageName: "@backstage/plugin-catalog-backend-module-github",
+                    dynamicArtifact: "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic",
+                },
+            ]);
+            try {
+                const config = {
+                    plugins: [
+                        {
+                            package: "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic",
+                            disabled: false,
+                        },
+                    ],
+                };
+                const result = await processPluginsForDeployment(config, metadataDir);
+                assert.strictEqual(result.plugins[0].package, "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic", "local path with -dynamic must stay unchanged");
+            }
+            finally {
+                await fs.remove(metadataDir);
+            }
+        });
+    });
     // ── PR vs nightly precedence ────────────────────────────────────────────
     describe("PR vs nightly precedence", () => {
         it("isNightlyJob returns false when both GIT_PR_NUMBER and E2E_NIGHTLY_MODE are set", () => {

package/dist/utils/tests/plugin-metadata.test.js

@@ -18,8 +18,8 @@ describe("extractPluginName", () => {
     it("extracts name from OCI URL with tag only (no alias)", () => {
         assert.strictEqual(extractPluginName("oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-tekton:bs_1.45.3__3.33.3"), "backstage-community-plugin-tekton");
     });
-    it("extracts name from local path", () => {
-        assert.strictEqual(extractPluginName("./dynamic-plugins/dist/backstage-community-plugin-keycloak-dynamic"), "backstage-community-plugin-keycloak-dynamic");
+    it("extracts name from local path and strips -dynamic suffix", () => {
+        assert.strictEqual(extractPluginName("./dynamic-plugins/dist/backstage-community-plugin-keycloak-dynamic"), "backstage-community-plugin-keycloak");
     });
     it("extracts name from OCI URL with digest but no alias", () => {
         assert.strictEqual(extractPluginName("oci://quay.io/rhdh/backstage-plugin-events-backend-module-github@sha256:c1d17d47aaa"), "backstage-plugin-events-backend-module-github");

package/dist/utils/vault.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Loads secrets from HashiCorp Vault into process.env.
+ * Only runs when `VAULT=1` or `VAULT=true` is set. Handles OIDC login automatically.
+ *
+ * Fetches secrets from:
+ * - Global path: `<basePath>/global`
+ * - Per-workspace paths: `<basePath>/workspaces/<name>`
+ *
+ * Configure via env vars:
+ * - `VAULT_ADDR` — Vault server URL (default: https://vault.ci.openshift.org)
+ * - `VAULT_BASE_PATH` — Base path in Vault (default: selfservice/rhdh-plugin-export-overlays)
+ *
+ * Security: Only key names are logged, never secret values.
+ */
+export declare function loadLocalVaultSecrets(): Promise<void>;
+//# sourceMappingURL=vault.d.ts.map

package/dist/utils/vault.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vault.d.ts","sourceRoot":"","sources":["../../src/utils/vault.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAiE3D"}

package/dist/utils/vault.js

@@ -0,0 +1,94 @@
+import { $ } from "./bash.js";
+const VAULT_ADDR_DEFAULT = "https://vault.ci.openshift.org";
+const VAULT_BASE_PATH_DEFAULT = "selfservice/rhdh-plugin-export-overlays";
+/**
+ * Loads secrets from HashiCorp Vault into process.env.
+ * Only runs when `VAULT=1` or `VAULT=true` is set. Handles OIDC login automatically.
+ *
+ * Fetches secrets from:
+ * - Global path: `<basePath>/global`
+ * - Per-workspace paths: `<basePath>/workspaces/<name>`
+ *
+ * Configure via env vars:
+ * - `VAULT_ADDR` — Vault server URL (default: https://vault.ci.openshift.org)
+ * - `VAULT_BASE_PATH` — Base path in Vault (default: selfservice/rhdh-plugin-export-overlays)
+ *
+ * Security: Only key names are logged, never secret values.
+ */
+export async function loadLocalVaultSecrets() {
+    if (process.env.VAULT !== "1" && process.env.VAULT !== "true")
+        return;
+    const vaultAddr = process.env.VAULT_ADDR || VAULT_ADDR_DEFAULT;
+    const basePath = process.env.VAULT_BASE_PATH || VAULT_BASE_PATH_DEFAULT;
+    process.env.VAULT_ADDR = vaultAddr;
+    // Check vault CLI is installed
+    const whichResult = await vaultCmd `command -v vault`;
+    if (whichResult.exitCode !== 0) {
+        throw new Error("vault CLI not found. Install from https://developer.hashicorp.com/vault/downloads");
+    }
+    // Check if already logged in
+    const tokenCheck = await vaultCmd `vault token lookup`;
+    if (tokenCheck.exitCode !== 0) {
+        console.log("Vault: not logged in, starting OIDC login...");
+        // vault login needs inherited stdio for browser-based OIDC flow
+        await $ `vault login -no-print -method=oidc`;
+        const retryCheck = await vaultCmd `vault token lookup`;
+        if (retryCheck.exitCode !== 0) {
+            throw new Error("Vault login failed. Run manually:\n  export VAULT_ADDR='" +
+                vaultAddr +
+                "'\n  vault login -method=oidc");
+        }
+    }
+    // Check access by fetching global secrets first
+    const globalResult = await vaultCmd `vault kv get -format=json -mount=kv ${basePath}/global`;
+    if (globalResult.stderr.includes("permission denied")) {
+        console.log("Vault: permission denied. Request access in Slack: #rhdh-e2e-tests");
+        return;
+    }
+    console.log("Loading secrets from vault...");
+    // Load global secrets
+    loadSecretsFromResult(globalResult, "global");
+    // List and fetch per-workspace secrets
+    const listResult = await vaultCmd `vault kv list -format=json -mount=kv ${basePath}/workspaces`;
+    if (listResult.exitCode === 0) {
+        const workspaces = JSON.parse(listResult.stdout);
+        await Promise.all(workspaces.map((ws) => {
+            const name = ws.replace(/\/$/, "");
+            return exportSecretsFromPath(`${basePath}/workspaces/${name}`, name);
+        }));
+    }
+    else {
+        console.log("  No workspace-specific secrets found");
+    }
+    console.log("Vault secrets loaded successfully.");
+}
+/** Runs a shell command with piped stdio and nothrow, for capturing vault CLI output. */
+const vaultCmd = $({
+    stdio: ["pipe", "pipe", "pipe"],
+    nothrow: true,
+});
+async function exportSecretsFromPath(vaultPath, label) {
+    const result = await vaultCmd `vault kv get -format=json -mount=kv ${vaultPath}`;
+    loadSecretsFromResult(result, label);
+}
+function loadSecretsFromResult(result, label) {
+    if (result.exitCode !== 0) {
+        console.log(`  No secrets at: ${label}`);
+        return;
+    }
+    const json = JSON.parse(result.stdout);
+    const secrets = json?.data?.data;
+    if (!secrets) {
+        console.log(`  No secrets at: ${label}`);
+        return;
+    }
+    console.log(`  From: ${label}`);
+    for (const [key, value] of Object.entries(secrets)) {
+        if (key.startsWith("secretsync/"))
+            continue;
+        if (!key.startsWith("VAULT_"))
+            continue;
+        const safeKey = key.replace(/[.\-/]/g, "_");
+        process.env[safeKey] = value;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/e2e-test-utils",
-  "version": "1.1.31",
+  "version": "1.1.33",
   "description": "Test utilities for RHDH E2E tests",
   "license": "Apache-2.0",
   "repository": {
@@ -107,6 +107,7 @@
     "@eslint/js": "10.0.1",
     "@keycloak/keycloak-admin-client": "26.5.6",
     "@kubernetes/client-node": "1.4.0",
+    "dotenv": "17.4.2",
     "eslint": "10.2.0",
     "eslint-plugin-check-file": "3.3.1",
     "eslint-plugin-playwright": "2.10.1",