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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,5 +2,6 @@
2
2
  * Global setup for Playwright tests.
3
3
  * This file runs once before all tests.
4
4
  */
5
- export default function globalSetup(): Promise<void>;
5
+ import { type FullConfig } from "@playwright/test";
6
+ export default function globalSetup(config: FullConfig): Promise<void>;
6
7
  //# sourceMappingURL=global-setup.d.ts.map
@@ -1 +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"}
1
+ {"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"}
@@ -2,10 +2,13 @@
2
2
  * Global setup for Playwright tests.
3
3
  * This file runs once before all tests.
4
4
  */
5
+ import dotenv from "dotenv";
6
+ import { resolve } from "path";
5
7
  import { KubernetesClientHelper } from "../utils/kubernetes-client.js";
6
8
  import { $ } from "../utils/bash.js";
7
9
  import { KeycloakHelper } from "../deployment/keycloak/index.js";
8
10
  import { DEFAULT_KEYCLOAK_CONFIG, DEFAULT_RHDH_CLIENT, DEFAULT_USERS, } from "../deployment/keycloak/constants.js";
11
+ import { loadLocalVaultSecrets } from "../utils/vault.js";
9
12
  const REQUIRED_BINARIES = ["oc", "kubectl", "helm"];
10
13
  async function checkRequiredBinaries() {
11
14
  const missingBinaries = [];
@@ -58,10 +61,27 @@ async function deployKeycloak() {
58
61
  testPassword: DEFAULT_USERS[0].password,
59
62
  });
60
63
  }
61
- export default async function globalSetup() {
64
+ export default async function globalSetup(config) {
62
65
  console.log("Running global setup...");
63
66
  await checkRequiredBinaries();
67
+ await loadLocalVaultSecrets();
68
+ loadDotenvFromProjects(config);
64
69
  await setClusterRouterBaseEnv();
65
70
  await deployKeycloak();
66
71
  console.log("Global setup completed successfully");
67
72
  }
73
+ /**
74
+ * Loads .env files from each project's e2e-tests directory.
75
+ * Uses `override: true` so local .env values take priority over Vault secrets.
76
+ */
77
+ function loadDotenvFromProjects(config) {
78
+ const seen = new Set();
79
+ for (const project of config.projects) {
80
+ // testDir points to e2e-tests/tests, go up one level to e2e-tests/
81
+ const e2eRoot = resolve(project.testDir, "..");
82
+ if (seen.has(e2eRoot))
83
+ continue;
84
+ seen.add(e2eRoot);
85
+ dotenv.config({ path: resolve(e2eRoot, ".env"), override: true });
86
+ }
87
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Loads secrets from HashiCorp Vault into process.env.
3
+ * Only runs when `VAULT=1` or `VAULT=true` is set. Handles OIDC login automatically.
4
+ *
5
+ * Fetches secrets from:
6
+ * - Global path: `<basePath>/global`
7
+ * - Per-workspace paths: `<basePath>/workspaces/<name>`
8
+ *
9
+ * Configure via env vars:
10
+ * - `VAULT_ADDR` — Vault server URL (default: https://vault.ci.openshift.org)
11
+ * - `VAULT_BASE_PATH` — Base path in Vault (default: selfservice/rhdh-plugin-export-overlays)
12
+ *
13
+ * Security: Only key names are logged, never secret values.
14
+ */
15
+ export declare function loadLocalVaultSecrets(): Promise<void>;
16
+ //# sourceMappingURL=vault.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,94 @@
1
+ import { $ } from "./bash.js";
2
+ const VAULT_ADDR_DEFAULT = "https://vault.ci.openshift.org";
3
+ const VAULT_BASE_PATH_DEFAULT = "selfservice/rhdh-plugin-export-overlays";
4
+ /**
5
+ * Loads secrets from HashiCorp Vault into process.env.
6
+ * Only runs when `VAULT=1` or `VAULT=true` is set. Handles OIDC login automatically.
7
+ *
8
+ * Fetches secrets from:
9
+ * - Global path: `<basePath>/global`
10
+ * - Per-workspace paths: `<basePath>/workspaces/<name>`
11
+ *
12
+ * Configure via env vars:
13
+ * - `VAULT_ADDR` — Vault server URL (default: https://vault.ci.openshift.org)
14
+ * - `VAULT_BASE_PATH` — Base path in Vault (default: selfservice/rhdh-plugin-export-overlays)
15
+ *
16
+ * Security: Only key names are logged, never secret values.
17
+ */
18
+ export async function loadLocalVaultSecrets() {
19
+ if (process.env.VAULT !== "1" && process.env.VAULT !== "true")
20
+ return;
21
+ const vaultAddr = process.env.VAULT_ADDR || VAULT_ADDR_DEFAULT;
22
+ const basePath = process.env.VAULT_BASE_PATH || VAULT_BASE_PATH_DEFAULT;
23
+ process.env.VAULT_ADDR = vaultAddr;
24
+ // Check vault CLI is installed
25
+ const whichResult = await vaultCmd `command -v vault`;
26
+ if (whichResult.exitCode !== 0) {
27
+ throw new Error("vault CLI not found. Install from https://developer.hashicorp.com/vault/downloads");
28
+ }
29
+ // Check if already logged in
30
+ const tokenCheck = await vaultCmd `vault token lookup`;
31
+ if (tokenCheck.exitCode !== 0) {
32
+ console.log("Vault: not logged in, starting OIDC login...");
33
+ // vault login needs inherited stdio for browser-based OIDC flow
34
+ await $ `vault login -no-print -method=oidc`;
35
+ const retryCheck = await vaultCmd `vault token lookup`;
36
+ if (retryCheck.exitCode !== 0) {
37
+ throw new Error("Vault login failed. Run manually:\n export VAULT_ADDR='" +
38
+ vaultAddr +
39
+ "'\n vault login -method=oidc");
40
+ }
41
+ }
42
+ // Check access by fetching global secrets first
43
+ const globalResult = await vaultCmd `vault kv get -format=json -mount=kv ${basePath}/global`;
44
+ if (globalResult.stderr.includes("permission denied")) {
45
+ console.log("Vault: permission denied. Request access in Slack: #rhdh-e2e-tests");
46
+ return;
47
+ }
48
+ console.log("Loading secrets from vault...");
49
+ // Load global secrets
50
+ loadSecretsFromResult(globalResult, "global");
51
+ // List and fetch per-workspace secrets
52
+ const listResult = await vaultCmd `vault kv list -format=json -mount=kv ${basePath}/workspaces`;
53
+ if (listResult.exitCode === 0) {
54
+ const workspaces = JSON.parse(listResult.stdout);
55
+ await Promise.all(workspaces.map((ws) => {
56
+ const name = ws.replace(/\/$/, "");
57
+ return exportSecretsFromPath(`${basePath}/workspaces/${name}`, name);
58
+ }));
59
+ }
60
+ else {
61
+ console.log(" No workspace-specific secrets found");
62
+ }
63
+ console.log("Vault secrets loaded successfully.");
64
+ }
65
+ /** Runs a shell command with piped stdio and nothrow, for capturing vault CLI output. */
66
+ const vaultCmd = $({
67
+ stdio: ["pipe", "pipe", "pipe"],
68
+ nothrow: true,
69
+ });
70
+ async function exportSecretsFromPath(vaultPath, label) {
71
+ const result = await vaultCmd `vault kv get -format=json -mount=kv ${vaultPath}`;
72
+ loadSecretsFromResult(result, label);
73
+ }
74
+ function loadSecretsFromResult(result, label) {
75
+ if (result.exitCode !== 0) {
76
+ console.log(` No secrets at: ${label}`);
77
+ return;
78
+ }
79
+ const json = JSON.parse(result.stdout);
80
+ const secrets = json?.data?.data;
81
+ if (!secrets) {
82
+ console.log(` No secrets at: ${label}`);
83
+ return;
84
+ }
85
+ console.log(` From: ${label}`);
86
+ for (const [key, value] of Object.entries(secrets)) {
87
+ if (key.startsWith("secretsync/"))
88
+ continue;
89
+ if (!key.startsWith("VAULT_"))
90
+ continue;
91
+ const safeKey = key.replace(/[.\-/]/g, "_");
92
+ process.env[safeKey] = value;
93
+ }
94
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@red-hat-developer-hub/e2e-test-utils",
3
- "version": "1.1.32",
3
+ "version": "1.1.33",
4
4
  "description": "Test utilities for RHDH E2E tests",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -107,6 +107,7 @@
107
107
  "@eslint/js": "10.0.1",
108
108
  "@keycloak/keycloak-admin-client": "26.5.6",
109
109
  "@kubernetes/client-node": "1.4.0",
110
+ "dotenv": "17.4.2",
110
111
  "eslint": "10.2.0",
111
112
  "eslint-plugin-check-file": "3.3.1",
112
113
  "eslint-plugin-playwright": "2.10.1",