@red-hat-developer-hub/e2e-test-utils 1.1.23 → 1.1.25

package/dist/utils/workspace-paths.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Static utility for resolving paths relative to a workspace's e2e-tests directory.
+ * Uses `test.info().project.testDir` to determine the workspace location —
+ * works correctly whether Playwright runs from the workspace or from the repo root.
+ *
+ * @example
+ * ```typescript
+ * import { WorkspacePaths } from '@red-hat-developer-hub/e2e-test-utils/utils';
+ *
+ * // One-liner to resolve a config file path
+ * const configPath = WorkspacePaths.resolve("tests/config/rbac-configmap.yaml");
+ *
+ * // Access well-known directories
+ * WorkspacePaths.e2eRoot;       // /abs/path/workspaces/acr/e2e-tests
+ * WorkspacePaths.workspaceRoot; // /abs/path/workspaces/acr
+ * WorkspacePaths.metadataDir;   // /abs/path/workspaces/acr/metadata
+ * WorkspacePaths.configDir;     // /abs/path/workspaces/acr/e2e-tests/tests/config
+ * ```
+ */
+export declare class WorkspacePaths {
+    private constructor();
+    /** The workspace's e2e-tests directory, derived from the current test's project testDir. */
+    static get e2eRoot(): string;
+    /** Resolve a relative path from the e2e-tests directory. */
+    static resolve(relativePath: string): string;
+    /** The workspace root directory (parent of e2e-tests). */
+    static get workspaceRoot(): string;
+    /** The metadata directory. e.g., `workspaces/acr/metadata` */
+    static get metadataDir(): string;
+    /** The tests/config directory. e.g., `workspaces/acr/e2e-tests/tests/config` */
+    static get configDir(): string;
+    /** Default app-config path: `tests/config/app-config-rhdh.yaml` */
+    static get appConfig(): string;
+    /** Default secrets path: `tests/config/rhdh-secrets.yaml` */
+    static get secrets(): string;
+    /** Default dynamic plugins path: `tests/config/dynamic-plugins.yaml` */
+    static get dynamicPlugins(): string;
+    /** Default Helm value file path: `tests/config/value_file.yaml` */
+    static get valueFile(): string;
+    /** Default operator subscription path: `tests/config/subscription.yaml` */
+    static get subscription(): string;
+}
+//# sourceMappingURL=workspace-paths.d.ts.map

package/dist/utils/workspace-paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspace-paths.d.ts","sourceRoot":"","sources":["../../src/utils/workspace-paths.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc;IACzB,OAAO;IAEP,4FAA4F;IAC5F,MAAM,KAAK,OAAO,IAAI,MAAM,CAE3B;IAED,4DAA4D;IAC5D,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM;IAI5C,0DAA0D;IAC1D,MAAM,KAAK,aAAa,IAAI,MAAM,CAEjC;IAED,8DAA8D;IAC9D,MAAM,KAAK,WAAW,IAAI,MAAM,CAE/B;IAED,gFAAgF;IAChF,MAAM,KAAK,SAAS,IAAI,MAAM,CAE7B;IAID,mEAAmE;IACnE,MAAM,KAAK,SAAS,IAAI,MAAM,CAE7B;IAED,6DAA6D;IAC7D,MAAM,KAAK,OAAO,IAAI,MAAM,CAE3B;IAED,wEAAwE;IACxE,MAAM,KAAK,cAAc,IAAI,MAAM,CAElC;IAED,mEAAmE;IACnE,MAAM,KAAK,SAAS,IAAI,MAAM,CAE7B;IAED,2EAA2E;IAC3E,MAAM,KAAK,YAAY,IAAI,MAAM,CAEhC;CACF"}

package/dist/utils/workspace-paths.js

@@ -0,0 +1,65 @@
+import path from "path";
+import { test } from "@playwright/test";
+/**
+ * Static utility for resolving paths relative to a workspace's e2e-tests directory.
+ * Uses `test.info().project.testDir` to determine the workspace location —
+ * works correctly whether Playwright runs from the workspace or from the repo root.
+ *
+ * @example
+ * ```typescript
+ * import { WorkspacePaths } from '@red-hat-developer-hub/e2e-test-utils/utils';
+ *
+ * // One-liner to resolve a config file path
+ * const configPath = WorkspacePaths.resolve("tests/config/rbac-configmap.yaml");
+ *
+ * // Access well-known directories
+ * WorkspacePaths.e2eRoot;       // /abs/path/workspaces/acr/e2e-tests
+ * WorkspacePaths.workspaceRoot; // /abs/path/workspaces/acr
+ * WorkspacePaths.metadataDir;   // /abs/path/workspaces/acr/metadata
+ * WorkspacePaths.configDir;     // /abs/path/workspaces/acr/e2e-tests/tests/config
+ * ```
+ */
+export class WorkspacePaths {
+    constructor() { } // Static-only class
+    /** The workspace's e2e-tests directory, derived from the current test's project testDir. */
+    static get e2eRoot() {
+        return path.resolve(test.info().project.testDir, "..");
+    }
+    /** Resolve a relative path from the e2e-tests directory. */
+    static resolve(relativePath) {
+        return path.resolve(this.e2eRoot, relativePath);
+    }
+    /** The workspace root directory (parent of e2e-tests). */
+    static get workspaceRoot() {
+        return path.resolve(this.e2eRoot, "..");
+    }
+    /** The metadata directory. e.g., `workspaces/acr/metadata` */
+    static get metadataDir() {
+        return path.resolve(this.e2eRoot, "../metadata");
+    }
+    /** The tests/config directory. e.g., `workspaces/acr/e2e-tests/tests/config` */
+    static get configDir() {
+        return path.resolve(this.e2eRoot, "tests/config");
+    }
+    // ── Default config file paths ────────────────────────────────────────────
+    /** Default app-config path: `tests/config/app-config-rhdh.yaml` */
+    static get appConfig() {
+        return path.resolve(this.e2eRoot, "tests/config/app-config-rhdh.yaml");
+    }
+    /** Default secrets path: `tests/config/rhdh-secrets.yaml` */
+    static get secrets() {
+        return path.resolve(this.e2eRoot, "tests/config/rhdh-secrets.yaml");
+    }
+    /** Default dynamic plugins path: `tests/config/dynamic-plugins.yaml` */
+    static get dynamicPlugins() {
+        return path.resolve(this.e2eRoot, "tests/config/dynamic-plugins.yaml");
+    }
+    /** Default Helm value file path: `tests/config/value_file.yaml` */
+    static get valueFile() {
+        return path.resolve(this.e2eRoot, "tests/config/value_file.yaml");
+    }
+    /** Default operator subscription path: `tests/config/subscription.yaml` */
+    static get subscription() {
+        return path.resolve(this.e2eRoot, "tests/config/subscription.yaml");
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/e2e-test-utils",
-  "version": "1.1.23",
+  "version": "1.1.25",
   "description": "Test utilities for RHDH E2E tests",
   "license": "Apache-2.0",
   "repository": {

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

@@ -1 +0,0 @@
-{"version":3,"file":"plugin-metadata.test.d.ts","sourceRoot":"","sources":["../../src/utils/plugin-metadata.test.ts"],"names":[],"mappings":""}

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

@@ -1,39 +0,0 @@
-import { describe, it } from "node:test";
-import assert from "node:assert";
-import { extractPluginName, getNormalizedPluginMergeKey, } from "./plugin-metadata.js";
-describe("getNormalizedPluginMergeKey", () => {
-    it("returns same key for OCI keycloak and local keycloak-dynamic (same logical plugin)", () => {
-        const oci = getNormalizedPluginMergeKey({
-            package: "oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-keycloak:pr_1980__3.16.0!backstage-community-plugin-catalog-backend-module-keycloak",
-        });
-        const local = getNormalizedPluginMergeKey({
-            package: "./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic",
-        });
-        assert.strictEqual(oci, local, "same logical plugin has same merge key");
-        assert.strictEqual(oci, "backstage-community-plugin-catalog-backend-module-keycloak");
-    });
-    it("returns different keys for different plugins", () => {
-        const keycloak = getNormalizedPluginMergeKey({
-            package: "./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic",
-        });
-        const techRadar = getNormalizedPluginMergeKey({
-            package: "./dynamic-plugins/dist/backstage-community-plugin-tech-radar-dynamic",
-        });
-        assert.notStrictEqual(keycloak, techRadar);
-    });
-    it("returns empty string for missing or empty package", () => {
-        assert.strictEqual(getNormalizedPluginMergeKey({}), "");
-        assert.strictEqual(getNormalizedPluginMergeKey({ package: "" }), "");
-        assert.strictEqual(getNormalizedPluginMergeKey({ package: undefined }), "");
-    });
-});
-describe("extractPluginName", () => {
-    it("extracts name from OCI URL with tag and alias", () => {
-        const name = extractPluginName("oci://ghcr.io/org/repo/backstage-community-plugin-catalog-backend-module-keycloak:pr_1__1.0!alias");
-        assert.strictEqual(name, "backstage-community-plugin-catalog-backend-module-keycloak");
-    });
-    it("extracts name from local path with -dynamic suffix", () => {
-        const name = extractPluginName("./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic");
-        assert.strictEqual(name, "backstage-community-plugin-catalog-backend-module-keycloak-dynamic");
-    });
-});