@red-hat-developer-hub/e2e-test-utils 1.1.10

package/dist/playwright/base-config.js

@@ -0,0 +1,47 @@
+import { defineConfig as baseDefineConfig, } from "@playwright/test";
+import { resolve } from "path";
+/**
+ * Base Playwright configuration that can be extended by workspace-specific configs.
+ * Provides sensible defaults for RHDH plugin e2e testing.
+ */
+export const baseConfig = {
+    testDir: "./tests",
+    forbidOnly: !!process.env.CI,
+    retries: Number(process.env.PLAYWRIGHT_RETRIES ?? 0),
+    workers: process.env.PLAYWRIGHT_WORKERS || "50%",
+    outputDir: "node_modules/.cache/e2e-test-results",
+    timeout: 90_000,
+    reporter: [
+        ["list"],
+        ["html", { outputFolder: "playwright-report", open: "on-failure" }],
+        ["json", { outputFile: "playwright-report/results.json" }],
+    ],
+    use: {
+        ignoreHTTPSErrors: true,
+        trace: "retain-on-failure",
+        screenshot: "only-on-failure",
+        viewport: { width: 1920, height: 1080 },
+        video: {
+            mode: "retain-on-failure",
+            size: { width: 1280, height: 720 },
+        },
+        actionTimeout: 10_000,
+        navigationTimeout: 50_000,
+    },
+    expect: {
+        timeout: 10_000,
+    },
+    globalSetup: resolve(import.meta.dirname, "../playwright/global-setup.js"),
+};
+/**
+ * Defines a workspace-specific config by merging with base config.
+ * Only allows overriding the projects configuration.
+ * @param overrides - Object containing projects to override
+ * @returns Merged Playwright configuration
+ */
+export function defineConfig(overrides = {}) {
+    return baseDefineConfig({
+        ...baseConfig,
+        projects: overrides.projects,
+    });
+}

package/dist/playwright/fixtures/test.d.ts

@@ -0,0 +1,13 @@
+import { RHDHDeployment } from "../../deployment/rhdh/index.js";
+import { LoginHelper, UIhelper } from "../helpers/index.js";
+type RHDHDeploymentTestFixtures = {
+    rhdh: RHDHDeployment;
+    uiHelper: UIhelper;
+    loginHelper: LoginHelper;
+};
+type RHDHDeploymentWorkerFixtures = {
+    rhdhDeploymentWorker: RHDHDeployment;
+};
+export * from "@playwright/test";
+export declare const test: import("playwright/test").TestType<import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & RHDHDeploymentTestFixtures, import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions & RHDHDeploymentWorkerFixtures>;
+//# sourceMappingURL=test.d.ts.map

package/dist/playwright/fixtures/test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.d.ts","sourceRoot":"","sources":["../../../src/playwright/fixtures/test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE5D,KAAK,0BAA0B,GAAG;IAChC,IAAI,EAAE,cAAc,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF,KAAK,4BAA4B,GAAG;IAClC,oBAAoB,EAAE,cAAc,CAAC;CACtC,CAAC;AAEF,cAAc,kBAAkB,CAAC;AAEjC,eAAO,MAAM,IAAI,oSAkDf,CAAC"}

package/dist/playwright/fixtures/test.js

@@ -0,0 +1,48 @@
+import { RHDHDeployment } from "../../deployment/rhdh/index.js";
+import { test as base } from "@playwright/test";
+import { LoginHelper, UIhelper } from "../helpers/index.js";
+export * from "@playwright/test";
+export const test = base.extend({
+    rhdhDeploymentWorker: [
+        // eslint-disable-next-line no-empty-pattern
+        async ({}, use, workerInfo) => {
+            console.log(`Deploying rhdh for plugin ${workerInfo.project.name} in namespace ${workerInfo.project.name}`);
+            const rhdhDeployment = new RHDHDeployment(workerInfo.project.name);
+            try {
+                await rhdhDeployment.configure();
+                await use(rhdhDeployment);
+            }
+            finally {
+                if (process.env.CI) {
+                    console.log(`Deleting namespace ${workerInfo.project.name}`);
+                    await rhdhDeployment.teardown();
+                }
+            }
+        },
+        { scope: "worker", auto: true },
+    ],
+    rhdh: [
+        async ({ rhdhDeploymentWorker }, use) => {
+            await use(rhdhDeploymentWorker);
+        },
+        { auto: true, scope: "test" },
+    ],
+    uiHelper: [
+        async ({ page }, use) => {
+            await use(new UIhelper(page));
+        },
+        { scope: "test" },
+    ],
+    loginHelper: [
+        async ({ page }, use) => {
+            await use(new LoginHelper(page));
+        },
+        { scope: "test" },
+    ],
+    baseURL: [
+        async ({ rhdhDeploymentWorker }, use) => {
+            await use(rhdhDeploymentWorker.rhdhUrl);
+        },
+        { scope: "test" },
+    ],
+});

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

@@ -0,0 +1,6 @@
+/**
+ * Global setup for Playwright tests.
+ * This file runs once before all tests.
+ */
+export default function globalSetup(): Promise<void>;
+//# sourceMappingURL=global-setup.d.ts.map

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

@@ -0,0 +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"}

package/dist/playwright/global-setup.js

@@ -0,0 +1,67 @@
+/**
+ * Global setup for Playwright tests.
+ * This file runs once before all tests.
+ */
+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";
+const REQUIRED_BINARIES = ["oc", "kubectl", "helm"];
+async function checkRequiredBinaries() {
+    const missingBinaries = [];
+    for (const binary of REQUIRED_BINARIES) {
+        try {
+            await $ `command -v ${binary} > /dev/null 2>&1`;
+        }
+        catch {
+            missingBinaries.push(binary);
+        }
+    }
+    if (missingBinaries.length > 0) {
+        throw new Error(`ERROR: Missing required binaries: ${missingBinaries.join(", ")}. Please install them before running tests.`);
+    }
+}
+async function setClusterRouterBaseEnv() {
+    const k8sClient = new KubernetesClientHelper();
+    process.env.K8S_CLUSTER_ROUTER_BASE =
+        await k8sClient.getClusterIngressDomain();
+    console.log(`Cluster router base: ${process.env.K8S_CLUSTER_ROUTER_BASE}`);
+}
+async function deployKeycloak() {
+    if (process.env.SKIP_KEYCLOAK_DEPLOYMENT === "true") {
+        console.log("Skipping Keycloak deployment");
+        return;
+    }
+    console.log("Set SKIP_KEYCLOAK_DEPLOYMENT=true if test doesn't require keycloak/oidc as auth provider");
+    const keycloak = new KeycloakHelper({ namespace: "rhdh-keycloak" });
+    // Check if Keycloak is already running
+    if (await keycloak.isRunning()) {
+        console.log("Keycloak is already running, skipping deployment");
+    }
+    else {
+        await keycloak.deploy();
+        await keycloak.configureForRHDH();
+    }
+    // Set environment variables for RHDH integration
+    const realm = DEFAULT_KEYCLOAK_CONFIG.realm;
+    process.env.KEYCLOAK_CLIENT_SECRET = DEFAULT_RHDH_CLIENT.clientSecret;
+    process.env.KEYCLOAK_CLIENT_ID = DEFAULT_RHDH_CLIENT.clientId;
+    process.env.KEYCLOAK_REALM = realm;
+    process.env.KEYCLOAK_LOGIN_REALM = realm;
+    process.env.KEYCLOAK_METADATA_URL = `${keycloak.keycloakUrl}/realms/${realm}`;
+    process.env.KEYCLOAK_BASE_URL = keycloak.keycloakUrl;
+    console.table({
+        keycloakURL: keycloak.keycloakUrl,
+        adminUser: keycloak.deploymentConfig.adminUser,
+        adminPassword: keycloak.deploymentConfig.adminPassword,
+        testUsername: DEFAULT_USERS[0].username,
+        testPassword: DEFAULT_USERS[0].password,
+    });
+}
+export default async function globalSetup() {
+    console.log("Running global setup...");
+    await checkRequiredBinaries();
+    await setClusterRouterBaseEnv();
+    await deployKeycloak();
+    console.log("Global setup completed successfully");
+}

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

@@ -0,0 +1,13 @@
+import type { Page } from "@playwright/test";
+export interface AccessibilityTestOptions {
+    /** Custom name for the attached results file. Defaults to "accessibility-scan-results.violations.json" */
+    attachName?: string;
+    /** Whether to assert that there are no violations. Defaults to true */
+    assertNoViolations?: boolean;
+    /** WCAG tags to test against. Defaults to ["wcag2a", "wcag2aa", "wcag21a", "wcag21aa"] */
+    wcagTags?: string[];
+    /** Rules to disable during the scan. Defaults to ["color-contrast"] */
+    disabledRules?: string[];
+}
+export declare function runAccessibilityTests(page: Page, options?: AccessibilityTestOptions): Promise<import("axe-core").AxeResults>;
+//# sourceMappingURL=accessibility.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"accessibility.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/accessibility.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAG7C,MAAM,WAAW,wBAAwB;IACvC,0GAA0G;IAC1G,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B;AASD,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,wBAA6B,0CAuBvC"}

package/dist/playwright/helpers/accessibility.js

@@ -0,0 +1,24 @@
+import AxeBuilder from "@axe-core/playwright";
+import { expect, test } from "@playwright/test";
+const DEFAULT_OPTIONS = {
+    attachName: "accessibility-scan-results.violations.json",
+    assertNoViolations: true,
+    wcagTags: ["wcag2a", "wcag2aa", "wcag21a", "wcag21aa"],
+    disabledRules: ["color-contrast"],
+};
+export async function runAccessibilityTests(page, options = {}) {
+    const config = { ...DEFAULT_OPTIONS, ...options };
+    const testInfo = test.info();
+    const accessibilityScanResults = await new AxeBuilder({ page })
+        .withTags(config.wcagTags)
+        .disableRules(config.disabledRules)
+        .analyze();
+    await testInfo.attach(config.attachName, {
+        body: JSON.stringify(accessibilityScanResults.violations, null, 2),
+        contentType: "application/json",
+    });
+    if (config.assertNoViolations) {
+        expect(accessibilityScanResults.violations, `Found ${accessibilityScanResults.violations.length} accessibility violation(s)`).toHaveLength(0);
+    }
+    return accessibilityScanResults;
+}

package/dist/playwright/helpers/api-endpoints.d.ts

@@ -0,0 +1,11 @@
+export declare const GITHUB_API_ENDPOINTS: {
+    pull: (owner: string, repo: string, state: "open" | "closed" | "all") => string;
+    issues: (state: string) => string;
+    workflowRuns: string;
+    deleteRepo: (owner: string, repo: string) => string;
+    mergePR: (owner: string, repoName: string, pullNumber: number) => string;
+    createRepo: (owner: string) => string;
+    pullFiles: (owner: string, repoName: string, pr: number) => string;
+    contents: (owner: string, repoName: string) => string;
+};
+//# sourceMappingURL=api-endpoints.d.ts.map

package/dist/playwright/helpers/api-endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-endpoints.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/api-endpoints.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,oBAAoB;kBACjB,MAAM,QAAQ,MAAM,SAAS,MAAM,GAAG,QAAQ,GAAG,KAAK;oBAGpD,MAAM;;wBAVG,MAAM,QAAQ,MAAM;qBAiB5B,MAAM,YAAY,MAAM,cAAc,MAAM;wBAGzC,MAAM;uBAEP,MAAM,YAAY,MAAM,MAAM,MAAM;sBAGrC,MAAM,YAAY,MAAM;CAE3C,CAAC"}

package/dist/playwright/helpers/api-endpoints.js

@@ -0,0 +1,15 @@
+const baseApiUrl = "https://api.github.com";
+const perPage = 100;
+const getRepoUrl = (owner, repo) => `${baseApiUrl}/repos/${owner}/${repo}`;
+const getOrgUrl = (owner) => `${baseApiUrl}/orgs/${owner}`;
+const backstageShowcaseAPI = getRepoUrl("janus-idp", "backstage-showcase");
+export const GITHUB_API_ENDPOINTS = {
+    pull: (owner, repo, state) => `${getRepoUrl(owner, repo)}/pulls?per_page=${perPage}&state=${state}`,
+    issues: (state) => `${backstageShowcaseAPI}/issues?per_page=${perPage}&sort=updated&state=${state}`,
+    workflowRuns: `${backstageShowcaseAPI}/actions/runs?per_page=${perPage}`,
+    deleteRepo: getRepoUrl,
+    mergePR: (owner, repoName, pullNumber) => `${getRepoUrl(owner, repoName)}/pulls/${pullNumber}/merge`,
+    createRepo: (owner) => `${getOrgUrl(owner)}/repos`,
+    pullFiles: (owner, repoName, pr) => `${getRepoUrl(owner, repoName)}/pulls/${pr}/files`,
+    contents: (owner, repoName) => `${getRepoUrl(owner, repoName)}/contents`,
+};

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

@@ -0,0 +1,77 @@
+import type { APIResponse } from "@playwright/test";
+export declare class APIHelper {
+    private static githubAPIVersion;
+    private staticToken;
+    private baseUrl;
+    useStaticToken: boolean;
+    static githubRequest(method: string, url: string, body?: string | object): Promise<APIResponse>;
+    static getGithubPaginatedRequest(url: string, pageNo?: number, response?: unknown[]): Promise<unknown[]>;
+    static createGitHubRepo(owner: string, repoName: string): Promise<void>;
+    static createGitHubRepoWithFile(owner: string, repoName: string, filename: string, fileContent: string): Promise<void>;
+    static createFileInRepo(owner: string, repoName: string, filePath: string, content: string, commitMessage: string, branch?: string): Promise<void>;
+    static initCommit(owner: string, repo: string, branch?: string): Promise<void>;
+    static deleteGitHubRepo(owner: string, repoName: string): Promise<void>;
+    static mergeGitHubPR(owner: string, repoName: string, pullNumber: number): Promise<void>;
+    static getGitHubPRs(owner: string, repoName: string, state: "open" | "closed" | "all", paginated?: boolean): Promise<any>;
+    static getfileContentFromPR(owner: string, repoName: string, pr: number, filename: string): Promise<string>;
+    getGuestToken(): Promise<string>;
+    getGuestAuthHeader(): Promise<{
+        [key: string]: string;
+    }>;
+    setStaticToken(token: string): Promise<void>;
+    setBaseUrl(url: string): Promise<void>;
+    static apiRequestWithStaticToken(method: string, url: string, staticToken: string, body?: string | object): Promise<APIResponse>;
+    getAllCatalogUsersFromAPI(): Promise<any>;
+    getAllCatalogLocationsFromAPI(): Promise<any>;
+    getAllCatalogGroupsFromAPI(): Promise<any>;
+    getGroupEntityFromAPI(group: string): Promise<any>;
+    getCatalogUserFromAPI(user: string): Promise<any>;
+    deleteUserEntityFromAPI(user: string): Promise<(() => string) | undefined>;
+    getCatalogGroupFromAPI(group: string): Promise<any>;
+    deleteGroupEntityFromAPI(group: string): Promise<() => string>;
+    scheduleEntityRefreshFromAPI(entity: string, kind: string, token: string): Promise<number>;
+    /**
+     * Fetches the UID of an entity by its name from the Backstage catalog.
+     *
+     * @param name - The name of the entity (e.g., 'hello-world-2').
+     * @returns The UID string if found, otherwise undefined.
+     */
+    static getEntityUidByName(name: string): Promise<string | undefined>;
+    /**
+     * Deletes a location from the Backstage catalog by its UID.
+     *
+     * @param uid - The UID of the location to delete.
+     * @returns The status code of the delete operation.
+     */
+    static deleteLocationByUid(uid: string): Promise<number>;
+    /**
+     * Fetches the UID of a Template entity by its name and namespace from the Backstage catalog.
+     *
+     * @param name - The name of the template entity (e.g., 'hello-world-2').
+     * @param namespace - The namespace of the template entity (default: 'default').
+     * @returns The UID string if found, otherwise undefined.
+     */
+    static getTemplateEntityUidByName(name: string, namespace?: string): Promise<string | undefined>;
+    /**
+     * Deletes an entity location from the Backstage catalog by its ID.
+     *
+     * @param id - The ID of the entity to delete.
+     * @returns The status code of the delete operation.
+     */
+    static deleteEntityLocationById(id: string): Promise<number>;
+    /**
+     * Registers a new location in the Backstage catalog.
+     *
+     * @param target - The target URL of the location to register.
+     * @returns The status code of the registration operation.
+     */
+    static registerLocation(target: string): Promise<number>;
+    /**
+     * Fetches the ID of a location from the Backstage catalog by its target URL.
+     *
+     * @param target - The target URL of the location to search for.
+     * @returns The ID string if found, otherwise undefined.
+     */
+    static getLocationIdByTarget(target: string): Promise<string | undefined>;
+}
+//# sourceMappingURL=api-helper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-helper.d.ts","sourceRoot":"","sources":["../../../src/playwright/helpers/api-helper.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAKpD,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAgB;IAC/C,OAAO,CAAC,WAAW,CAAc;IACjC,OAAO,CAAC,OAAO,CAAc;IAC7B,cAAc,UAAS;WAEV,aAAa,CACxB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GACrB,OAAO,CAAC,WAAW,CAAC;WAuBV,yBAAyB,CACpC,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,MAAU,EAClB,QAAQ,GAAE,OAAO,EAAO,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC;WAmBR,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;WAYhD,wBAAwB,CACnC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM;WAeR,gBAAgB,CAC3B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,MAAM,SAAS;WAeJ,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,SAAS;WAgBvD,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;WAOhD,aAAa,CACxB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM;WAQP,YAAY,CACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,EAChC,SAAS,UAAQ;WAUN,oBAAoB,CAC/B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC;IAcZ,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAQhC,kBAAkB,IAAI,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAQxD,cAAc,CAAC,KAAK,EAAE,MAAM;IAK5B,UAAU,CAAC,GAAG,EAAE,MAAM;WAIf,yBAAyB,CACpC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,EACnB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GACrB,OAAO,CAAC,WAAW,CAAC;IAejB,yBAAyB;IAWzB,6BAA6B;IAW7B,0BAA0B;IAW1B,qBAAqB,CAAC,KAAK,EAAE,MAAM;IAWnC,qBAAqB,CAAC,IAAI,EAAE,MAAM;IAWlC,uBAAuB,CAAC,IAAI,EAAE,MAAM;IAepC,sBAAsB,CAAC,KAAK,EAAE,MAAM;IAWpC,wBAAwB,CAAC,KAAK,EAAE,MAAM;IAYtC,4BAA4B,CAChC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM;IAaf;;;;;OAKG;WACU,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAY1E;;;;;OAKG;WACU,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ9D;;;;;;OAMG;WACU,0BAA0B,CACrC,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,MAAkB,GAC5B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAe9B;;;;;OAKG;WACU,wBAAwB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQlE;;;;;OAKG;WACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB9D;;;;;OAKG;WACU,qBAAqB,CAChC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAe/B"}

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

@@ -0,0 +1,285 @@
+import { request, expect } from "@playwright/test";
+import { GITHUB_API_ENDPOINTS } from "./api-endpoints.js";
+export class APIHelper {
+    static githubAPIVersion = "2022-11-28";
+    staticToken = "";
+    baseUrl = "";
+    useStaticToken = false;
+    static async githubRequest(method, url, body) {
+        const context = await request.newContext();
+        const options = {
+            method: method,
+            headers: {
+                Accept: "application/vnd.github+json",
+                Authorization: `Bearer ${process.env.GH_RHDH_QE_USER_TOKEN}`,
+                "X-GitHub-Api-Version": this.githubAPIVersion,
+            },
+        };
+        if (body) {
+            options.data = body;
+        }
+        const response = await context.fetch(url, options);
+        return response;
+    }
+    static async getGithubPaginatedRequest(url, pageNo = 1, response = []) {
+        const fullUrl = `${url}&page=${pageNo}`;
+        const result = await this.githubRequest("GET", fullUrl);
+        const body = await result.json();
+        if (!Array.isArray(body)) {
+            throw new Error(`Expected array but got ${typeof body}: ${JSON.stringify(body)}`);
+        }
+        if (body.length === 0) {
+            return response;
+        }
+        response = [...response, ...body];
+        return await this.getGithubPaginatedRequest(url, pageNo + 1, response);
+    }
+    static async createGitHubRepo(owner, repoName) {
+        const response = await APIHelper.githubRequest("POST", GITHUB_API_ENDPOINTS.createRepo(owner), {
+            name: repoName,
+            private: false,
+        });
+        expect(response.status() === 201 || response.ok()).toBeTruthy();
+    }
+    static async createGitHubRepoWithFile(owner, repoName, filename, fileContent) {
+        // Create the repository
+        await APIHelper.createGitHubRepo(owner, repoName);
+        // Add the specified file
+        await APIHelper.createFileInRepo(owner, repoName, filename, fileContent, `Add ${filename} file`);
+    }
+    static async createFileInRepo(owner, repoName, filePath, content, commitMessage, branch = "main") {
+        const encodedContent = Buffer.from(content).toString("base64");
+        const response = await APIHelper.githubRequest("PUT", `${GITHUB_API_ENDPOINTS.contents(owner, repoName)}/${filePath}`, {
+            message: commitMessage,
+            content: encodedContent,
+            branch: branch,
+        });
+        expect(response.status() === 201 || response.ok()).toBeTruthy();
+    }
+    static async initCommit(owner, repo, branch = "main") {
+        const content = Buffer.from("This is the initial commit for the repository.").toString("base64");
+        const response = await APIHelper.githubRequest("PUT", `${GITHUB_API_ENDPOINTS.contents(owner, repo)}/initial-commit.md`, {
+            message: "Initial commit",
+            content: content,
+            branch: branch,
+        });
+        expect(response.status() === 201 || response.ok()).toBeTruthy();
+    }
+    static async deleteGitHubRepo(owner, repoName) {
+        await APIHelper.githubRequest("DELETE", GITHUB_API_ENDPOINTS.deleteRepo(owner, repoName));
+    }
+    static async mergeGitHubPR(owner, repoName, pullNumber) {
+        await APIHelper.githubRequest("PUT", GITHUB_API_ENDPOINTS.mergePR(owner, repoName, pullNumber));
+    }
+    static async getGitHubPRs(owner, repoName, state, paginated = false) {
+        const url = GITHUB_API_ENDPOINTS.pull(owner, repoName, state);
+        if (paginated) {
+            return await APIHelper.getGithubPaginatedRequest(url);
+        }
+        const response = await APIHelper.githubRequest("GET", url);
+        return response.json();
+    }
+    static async getfileContentFromPR(owner, repoName, pr, filename) {
+        const response = await APIHelper.githubRequest("GET", GITHUB_API_ENDPOINTS.pullFiles(owner, repoName, pr));
+        const fileRawUrl = (await response.json()).find((file) => file.filename === filename).raw_url;
+        const rawFileContent = await (await APIHelper.githubRequest("GET", fileRawUrl)).text();
+        return rawFileContent;
+    }
+    async getGuestToken() {
+        const context = await request.newContext();
+        const response = await context.post("/api/auth/guest/refresh");
+        expect(response.status()).toBe(200);
+        const data = await response.json();
+        return data.backstageIdentity.token;
+    }
+    async getGuestAuthHeader() {
+        const token = await this.getGuestToken();
+        const headers = {
+            Authorization: `Bearer ${token}`,
+        };
+        return headers;
+    }
+    async setStaticToken(token) {
+        this.useStaticToken = true;
+        this.staticToken = "Bearer " + token;
+    }
+    async setBaseUrl(url) {
+        this.baseUrl = url;
+    }
+    static async apiRequestWithStaticToken(method, url, staticToken, body) {
+        const context = await request.newContext();
+        const options = {
+            method: method,
+            headers: {
+                Accept: "application/json",
+                Authorization: `${staticToken}`,
+            },
+            ...(body && { data: body }),
+        };
+        const response = await context.fetch(url, options);
+        return response;
+    }
+    async getAllCatalogUsersFromAPI() {
+        const url = `${this.baseUrl}/api/catalog/entities/by-query?orderField=metadata.name%2Casc&filter=kind%3Duser`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async getAllCatalogLocationsFromAPI() {
+        const url = `${this.baseUrl}/api/catalog/entities/by-query?orderField=metadata.name%2Casc&filter=kind%3Dlocation`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async getAllCatalogGroupsFromAPI() {
+        const url = `${this.baseUrl}/api/catalog/entities/by-query?orderField=metadata.name%2Casc&filter=kind%3Dgroup`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async getGroupEntityFromAPI(group) {
+        const url = `${this.baseUrl}/api/catalog/entities/by-name/group/default/${group}`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async getCatalogUserFromAPI(user) {
+        const url = `${this.baseUrl}/api/catalog/entities/by-name/user/default/${user}`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async deleteUserEntityFromAPI(user) {
+        const r = await this.getCatalogUserFromAPI(user);
+        if (!r.metadata || !r.metadata.uid) {
+            return;
+        }
+        const url = `${this.baseUrl}/api/catalog/entities/by-uid/${r.metadata.uid}`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("DELETE", url, token);
+        return response.statusText;
+    }
+    async getCatalogGroupFromAPI(group) {
+        const url = `${this.baseUrl}/api/catalog/entities/by-name/group/default/${group}`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("GET", url, token);
+        return response.json();
+    }
+    async deleteGroupEntityFromAPI(group) {
+        const r = await this.getCatalogGroupFromAPI(group);
+        const url = `${this.baseUrl}/api/catalog/entities/by-uid/${r.metadata.uid}`;
+        const token = this.useStaticToken ? this.staticToken : "";
+        const response = await APIHelper.apiRequestWithStaticToken("DELETE", url, token);
+        return response.statusText;
+    }
+    async scheduleEntityRefreshFromAPI(entity, kind, token) {
+        const url = `${this.baseUrl}/api/catalog/refresh`;
+        const reqBody = { entityRef: `${kind}:default/${entity}` };
+        const responseRefresh = await APIHelper.apiRequestWithStaticToken("POST", url, token, reqBody);
+        return responseRefresh.status();
+    }
+    /**
+     * Fetches the UID of an entity by its name from the Backstage catalog.
+     *
+     * @param name - The name of the entity (e.g., 'hello-world-2').
+     * @returns The UID string if found, otherwise undefined.
+     */
+    static async getEntityUidByName(name) {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/entities/by-name/template/default/${name}`;
+        const context = await request.newContext();
+        const response = await context.get(url);
+        if (response.status() !== 200) {
+            return undefined;
+        }
+        const data = await response.json();
+        return data?.metadata?.uid;
+    }
+    /**
+     * Deletes a location from the Backstage catalog by its UID.
+     *
+     * @param uid - The UID of the location to delete.
+     * @returns The status code of the delete operation.
+     */
+    static async deleteLocationByUid(uid) {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/locations/${uid}`;
+        const context = await request.newContext();
+        const response = await context.delete(url);
+        return response.status();
+    }
+    /**
+     * Fetches the UID of a Template entity by its name and namespace from the Backstage catalog.
+     *
+     * @param name - The name of the template entity (e.g., 'hello-world-2').
+     * @param namespace - The namespace of the template entity (default: 'default').
+     * @returns The UID string if found, otherwise undefined.
+     */
+    static async getTemplateEntityUidByName(name, namespace = "default") {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/locations/by-entity/template/${namespace}/${name}`;
+        const context = await request.newContext();
+        const response = await context.get(url);
+        if (response.status() === 200) {
+            const data = await response.json();
+            return data?.metadata?.uid;
+        }
+        if (response.status() === 404) {
+            return undefined;
+        }
+        return undefined;
+    }
+    /**
+     * Deletes an entity location from the Backstage catalog by its ID.
+     *
+     * @param id - The ID of the entity to delete.
+     * @returns The status code of the delete operation.
+     */
+    static async deleteEntityLocationById(id) {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/locations/${id}`;
+        const context = await request.newContext();
+        const response = await context.delete(url);
+        return response.status();
+    }
+    /**
+     * Registers a new location in the Backstage catalog.
+     *
+     * @param target - The target URL of the location to register.
+     * @returns The status code of the registration operation.
+     */
+    static async registerLocation(target) {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/locations`;
+        const context = await request.newContext();
+        const response = await context.post(url, {
+            data: {
+                type: "url",
+                target,
+            },
+            headers: {
+                "Content-Type": "application/json",
+            },
+        });
+        return response.status();
+    }
+    /**
+     * Fetches the ID of a location from the Backstage catalog by its target URL.
+     *
+     * @param target - The target URL of the location to search for.
+     * @returns The ID string if found, otherwise undefined.
+     */
+    static async getLocationIdByTarget(target) {
+        const baseUrl = process.env.BASE_URL;
+        const url = `${baseUrl}/api/catalog/locations`;
+        const context = await request.newContext();
+        const response = await context.get(url);
+        if (response.status() !== 200) {
+            return undefined;
+        }
+        const data = await response.json();
+        // data is expected to be an array of objects with a 'data' property
+        const location = (Array.isArray(data) ? data : []).find((entry) => entry?.data?.target === target);
+        return location?.data?.id;
+    }
+}