@red-hat-developer-hub/e2e-test-utils 1.1.14 → 1.1.15

package/dist/playwright/helpers/auth-api-helper.d.ts

@@ -0,0 +1,7 @@
+import { Page } from "@playwright/test";
+export declare class AuthApiHelper {
+    private readonly page;
+    constructor(page: Page);
+    getToken(provider?: string, environment?: string): Promise<any>;
+}
+//# sourceMappingURL=auth-api-helper.d.ts.map

package/dist/playwright/helpers/auth-api-helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-api-helper.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/auth-api-helper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAGxC,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;gBAEhB,IAAI,EAAE,IAAI;IAIhB,QAAQ,CACZ,QAAQ,GAAE,MAAe,EACzB,WAAW,GAAE,MAAqB;CA8BrC"}

package/dist/playwright/helpers/auth-api-helper.js

@@ -0,0 +1,31 @@
+// here, we spy on the request to get the Backstage token to use APIs
+export class AuthApiHelper {
+    page;
+    constructor(page) {
+        this.page = page;
+    }
+    async getToken(provider = "oidc", environment = "production") {
+        try {
+            const response = await this.page.request.get(`/api/auth/${provider}/refresh?optional=&scope=&env=${environment}`, {
+                headers: {
+                    // eslint-disable-next-line @typescript-eslint/naming-convention
+                    "x-requested-with": "XMLHttpRequest",
+                },
+            });
+            if (!response.ok()) {
+                throw new Error(`HTTP error! Status: ${response.status()}`);
+            }
+            const body = await response.json();
+            if (typeof body?.backstageIdentity?.token === "string") {
+                return body.backstageIdentity.token;
+            }
+            else {
+                throw new TypeError("Token not found in response body");
+            }
+        }
+        catch (error) {
+            console.error("Failed to retrieve the token:", error);
+            throw error;
+        }
+    }
+}

package/dist/playwright/helpers/index.d.ts

@@ -2,4 +2,6 @@ export { GITHUB_API_ENDPOINTS } from "./api-endpoints.js";
 export { APIHelper } from "./api-helper.js";
 export { LoginHelper, setupBrowser } from "./common.js";
 export { UIhelper } from "./ui-helper.js";
+export { RbacApiHelper, Policy, Response } from "./rbac-api-helper.js";
+export { AuthApiHelper } from "./auth-api-helper.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/playwright/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/playwright/helpers/index.js

@@ -2,3 +2,5 @@ export { GITHUB_API_ENDPOINTS } from "./api-endpoints.js";
 export { APIHelper } from "./api-helper.js";
 export { LoginHelper, setupBrowser } from "./common.js";
 export { UIhelper } from "./ui-helper.js";
+export { RbacApiHelper, Response } from "./rbac-api-helper.js";
+export { AuthApiHelper } from "./auth-api-helper.js";

package/dist/playwright/helpers/rbac-api-helper.d.ts

@@ -0,0 +1,35 @@
+import type { PermissionAction, RoleConditionalPolicyDecision } from "@backstage-community/plugin-rbac-common";
+import { APIResponse } from "@playwright/test";
+export interface Policy {
+    entityReference: string;
+    permission: string;
+    policy: string;
+    effect: string;
+}
+/**
+ * Thin HTTP client for the RHDH RBAC permission API.
+ * Uses a static factory (`build`) because the Playwright `APIRequestContext`
+ * must be created asynchronously — a constructor cannot await it.
+ */
+export declare class RbacApiHelper {
+    private readonly token;
+    private readonly apiUrl;
+    private readonly authHeader;
+    private myContext;
+    private constructor();
+    /** Creates a fully-initialised instance with a live Playwright request context. */
+    static build(token: string): Promise<RbacApiHelper>;
+    getPoliciesByRole(policy: string): Promise<APIResponse>;
+    /** Fetches all conditional policies across all roles. */
+    getConditions(): Promise<APIResponse>;
+    /** Filters a full conditions list down to those belonging to a specific role entity ref. */
+    getConditionsByRole(role: string, remainingConditions: RoleConditionalPolicyDecision<PermissionAction>[]): Promise<RoleConditionalPolicyDecision<PermissionAction>[]>;
+    deleteRole(role: string): Promise<APIResponse>;
+    deletePolicy(policy: string, policies: Policy[]): Promise<APIResponse>;
+    /** `id` comes from the `RoleConditionalPolicyDecision.id` field returned by the API. */
+    deleteCondition(id: string): Promise<APIResponse>;
+}
+export declare class Response {
+    static removeMetadataFromResponse(response: APIResponse): Promise<unknown[]>;
+}
+//# sourceMappingURL=rbac-api-helper.d.ts.map

package/dist/playwright/helpers/rbac-api-helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rbac-api-helper.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/rbac-api-helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,6BAA6B,EAC9B,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAqB,WAAW,EAAW,MAAM,kBAAkB,CAAC;AAE3E,MAAM,WAAW,MAAM;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,qBAAa,aAAa;IAUJ,OAAO,CAAC,QAAQ,CAAC,KAAK;IAT1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkD;IACzE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAKzB;IACF,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO;IAOP,mFAAmF;WAC/D,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IASnD,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIpE,yDAAyD;IAC5C,aAAa,IAAI,OAAO,CAAC,WAAW,CAAC;IAIlD,4FAA4F;IAC/E,mBAAmB,CAC9B,IAAI,EAAE,MAAM,EACZ,mBAAmB,EAAE,6BAA6B,CAAC,gBAAgB,CAAC,EAAE,GACrE,OAAO,CAAC,6BAA6B,CAAC,gBAAgB,CAAC,EAAE,CAAC;IAMhD,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAI9C,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE;IAM5D,wFAAwF;IAC3E,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAG/D;AAED,qBAAa,QAAQ;WACN,0BAA0B,CACrC,QAAQ,EAAE,WAAW,GACpB,OAAO,CAAC,OAAO,EAAE,CAAC;CActB"}

package/dist/playwright/helpers/rbac-api-helper.js

@@ -0,0 +1,63 @@
+import { request } from "@playwright/test";
+/**
+ * Thin HTTP client for the RHDH RBAC permission API.
+ * Uses a static factory (`build`) because the Playwright `APIRequestContext`
+ * must be created asynchronously — a constructor cannot await it.
+ */
+export class RbacApiHelper {
+    token;
+    apiUrl = process.env.RHDH_BASE_URL + "/api/permission/";
+    authHeader;
+    myContext;
+    constructor(token) {
+        this.token = token;
+        this.authHeader = {
+            Accept: "application/json",
+            Authorization: `Bearer ${this.token}`,
+        };
+    }
+    /** Creates a fully-initialised instance with a live Playwright request context. */
+    static async build(token) {
+        const instance = new RbacApiHelper(token);
+        instance.myContext = await request.newContext({
+            baseURL: instance.apiUrl,
+            extraHTTPHeaders: instance.authHeader,
+        });
+        return instance;
+    }
+    async getPoliciesByRole(policy) {
+        return await this.myContext.get(`policies/role/default/${policy}`);
+    }
+    /** Fetches all conditional policies across all roles. */
+    async getConditions() {
+        return await this.myContext.get(`roles/conditions`);
+    }
+    /** Filters a full conditions list down to those belonging to a specific role entity ref. */
+    async getConditionsByRole(role, remainingConditions) {
+        return remainingConditions.filter((condition) => condition.roleEntityRef === role);
+    }
+    async deleteRole(role) {
+        return await this.myContext.delete(`roles/role/default/${role}`);
+    }
+    async deletePolicy(policy, policies) {
+        return await this.myContext.delete(`policies/role/default/${policy}`, {
+            data: policies,
+        });
+    }
+    /** `id` comes from the `RoleConditionalPolicyDecision.id` field returned by the API. */
+    async deleteCondition(id) {
+        return await this.myContext.delete(`roles/conditions/${id}`);
+    }
+}
+export class Response {
+    static async removeMetadataFromResponse(response) {
+        const responseJson = await response.json();
+        if (!Array.isArray(responseJson)) {
+            throw new TypeError(`Expected an array from policy response but received: ${JSON.stringify(responseJson)}`);
+        }
+        return responseJson.map((item) => {
+            delete item.metadata;
+            return item;
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@red-hat-developer-hub/e2e-test-utils",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "description": "Test utilities for RHDH E2E tests",
   "license": "Apache-2.0",
   "repository": {
@@ -93,6 +93,7 @@
   },
   "dependencies": {
     "@axe-core/playwright": "^4.11.0",
+    "@backstage-community/plugin-rbac-common": "1.23.0",
     "@eslint/js": "^9.39.1",
     "@keycloak/keycloak-admin-client": "^26.0.0",
     "@kubernetes/client-node": "^1.4.0",