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

package/dist/deployment/rhdh/deployment.d.ts

@@ -0,0 +1,40 @@
+import { KubernetesClientHelper } from "../../utils/kubernetes-client.js";
+import type { DeploymentOptions, DeploymentConfig } from "./types.js";
+export declare class RHDHDeployment {
+    k8sClient: KubernetesClientHelper;
+    rhdhUrl: string;
+    deploymentConfig: DeploymentConfig;
+    constructor(namespace: string);
+    deploy(): Promise<void>;
+    private _applyAppConfig;
+    private _applySecrets;
+    /**
+     * Builds the merged dynamic plugins configuration.
+     * Merges: package defaults + auth config + user config + metadata (for PR builds).
+     */
+    private _buildDynamicPluginsConfig;
+    private _applyDynamicPlugins;
+    private _deployWithHelm;
+    private _deployWithOperator;
+    rolloutRestart(): Promise<void>;
+    /**
+     * Performs a clean restart by scaling down to 0 first, waiting for pods to terminate,
+     * then scaling back up. This prevents MigrationLocked errors by ensuring no pods
+     * hold database locks when new pods start.
+     */
+    scaleDownAndRestart(): Promise<void>;
+    waitUntilReady(timeout?: number): Promise<void>;
+    teardown(): Promise<void>;
+    private _resolveChartVersion;
+    /**
+     * Resolve the semantic version from the "next" tag by looking up the
+     * downstream image (rhdh-hub-rhel9) and finding tags with the same digest.
+     */
+    private _resolveVersionFromNextTag;
+    private _buildDeploymentConfig;
+    configure(deploymentOptions?: DeploymentOptions): Promise<void>;
+    private _buildBaseUrl;
+    private _log;
+    private _logBoxen;
+}
+//# sourceMappingURL=deployment.d.ts.map

package/dist/deployment/rhdh/deployment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployment.d.ts","sourceRoot":"","sources":["../../../src/deployment/rhdh/deployment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAiB1E,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAGjB,MAAM,YAAY,CAAC;AAEpB,qBAAa,cAAc;IAClB,SAAS,yBAAgC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,gBAAgB,CAAC;gBAE9B,SAAS,EAAE,MAAM;IAUvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;YAqBf,eAAe;YAgBf,aAAa;IAqB3B;;;OAGG;YACW,0BAA0B;YAuC1B,oBAAoB;YAWpB,eAAe;YAmCf,mBAAmB;IAiD3B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAWrC;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAOpC,cAAc,CAAC,OAAO,GAAE,MAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBpD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;YAIjB,oBAAoB;IAsClC;;;OAGG;YACW,0BAA0B;IAwCxC,OAAO,CAAC,sBAAsB;IAoCxB,SAAS,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAcrE,OAAO,CAAC,aAAa;IAUrB,OAAO,CAAC,IAAI;IAIZ,OAAO,CAAC,SAAS;CAMlB"}

package/dist/deployment/rhdh/deployment.js

@@ -0,0 +1,303 @@
+import { KubernetesClientHelper } from "../../utils/kubernetes-client.js";
+import { $ } from "../../utils/bash.js";
+import yaml from "js-yaml";
+import { test } from "@playwright/test";
+import { mergeYamlFilesIfExists, deepMerge } from "../../utils/merge-yamls.js";
+import { loadAndInjectPluginMetadata, generateDynamicPluginsConfigFromMetadata, } from "../../utils/plugin-metadata.js";
+import { envsubst } from "../../utils/common.js";
+import cloneDeepWith from "lodash.clonedeepwith";
+import fs from "fs-extra";
+import { DEFAULT_CONFIG_PATHS, AUTH_CONFIG_PATHS, CHART_URL, } from "./constants.js";
+export class RHDHDeployment {
+    k8sClient = new KubernetesClientHelper();
+    rhdhUrl;
+    deploymentConfig;
+    constructor(namespace) {
+        this.deploymentConfig = this._buildDeploymentConfig({ namespace });
+        this.rhdhUrl = this._buildBaseUrl();
+        this._log(`RHDH deployment initialized (namespace: ${this.deploymentConfig.namespace})`);
+        this._log("RHDH Base URL: " + this.rhdhUrl);
+        console.table(this.deploymentConfig);
+    }
+    async deploy() {
+        this._log("Starting RHDH deployment...");
+        test.setTimeout(600_000);
+        await this.k8sClient.createNamespaceIfNotExists(this.deploymentConfig.namespace);
+        await this._applyAppConfig();
+        await this._applySecrets();
+        if (this.deploymentConfig.method === "helm") {
+            await this._deployWithHelm(this.deploymentConfig.valueFile);
+            await this.scaleDownAndRestart(); // Restart as helm does not monitor config changes
+        }
+        else {
+            await this._applyDynamicPlugins();
+            await this._deployWithOperator(this.deploymentConfig.subscription);
+        }
+        await this.waitUntilReady();
+    }
+    async _applyAppConfig() {
+        const authConfig = AUTH_CONFIG_PATHS[this.deploymentConfig.auth];
+        const appConfigYaml = await mergeYamlFilesIfExists([
+            DEFAULT_CONFIG_PATHS.appConfig,
+            authConfig.appConfig,
+            this.deploymentConfig.appConfig,
+        ]);
+        this._logBoxen("App Config", appConfigYaml);
+        await this.k8sClient.applyConfigMapFromObject("app-config-rhdh", appConfigYaml, this.deploymentConfig.namespace);
+    }
+    async _applySecrets() {
+        const authConfig = AUTH_CONFIG_PATHS[this.deploymentConfig.auth];
+        const secretsYaml = await mergeYamlFilesIfExists([
+            DEFAULT_CONFIG_PATHS.secrets,
+            authConfig.secrets,
+            this.deploymentConfig.secrets,
+        ]);
+        // Use cloneDeepWith to substitute env vars in-place, avoiding JSON.parse issues
+        // with control characters in secrets (e.g., private keys with newlines)
+        const substituted = cloneDeepWith(secretsYaml, (value) => {
+            if (typeof value === "string")
+                return envsubst(value);
+        });
+        await this.k8sClient.applySecretFromObject("rhdh-secrets", substituted, this.deploymentConfig.namespace);
+    }
+    /**
+     * Builds the merged dynamic plugins configuration.
+     * Merges: package defaults + auth config + user config + metadata (for PR builds).
+     */
+    async _buildDynamicPluginsConfig() {
+        const userConfigPath = this.deploymentConfig.dynamicPlugins;
+        const userConfigExists = userConfigPath && fs.existsSync(userConfigPath);
+        const authConfig = AUTH_CONFIG_PATHS[this.deploymentConfig.auth];
+        // If user's dynamic-plugins config doesn't exist, auto-generate from metadata
+        if (!userConfigExists) {
+            this._log(`Dynamic plugins config not found at '${userConfigPath}', auto-generating from metadata...`);
+            const metadataConfig = await generateDynamicPluginsConfigFromMetadata();
+            // Merge with package defaults and auth config
+            const authPlugins = await mergeYamlFilesIfExists([DEFAULT_CONFIG_PATHS.dynamicPlugins, authConfig.dynamicPlugins], { arrayMergeStrategy: { byKey: "package" } });
+            return deepMerge(metadataConfig, authPlugins, {
+                arrayMergeStrategy: { byKey: "package" },
+            });
+        }
+        // User config exists - merge provided configs and inject metadata for listed plugins only
+        let dynamicPluginsConfig = await mergeYamlFilesIfExists([
+            DEFAULT_CONFIG_PATHS.dynamicPlugins,
+            authConfig.dynamicPlugins,
+            userConfigPath,
+        ], { arrayMergeStrategy: { byKey: "package" } });
+        // Inject plugin metadata configuration for plugins in the config
+        dynamicPluginsConfig =
+            await loadAndInjectPluginMetadata(dynamicPluginsConfig);
+        return dynamicPluginsConfig;
+    }
+    async _applyDynamicPlugins() {
+        const dynamicPluginsYaml = await this._buildDynamicPluginsConfig();
+        this._logBoxen("Dynamic Plugins", dynamicPluginsYaml);
+        await this.k8sClient.applyConfigMapFromObject("dynamic-plugins", dynamicPluginsYaml, this.deploymentConfig.namespace);
+    }
+    async _deployWithHelm(valueFile) {
+        const chartVersion = await this._resolveChartVersion(this.deploymentConfig.version);
+        this._log(`Helm chart version resolved to: ${chartVersion}`);
+        const valueFileObject = (await mergeYamlFilesIfExists([
+            DEFAULT_CONFIG_PATHS.helm.valueFile,
+            valueFile,
+        ]));
+        this._logBoxen("Value File", valueFileObject);
+        // Merge dynamic plugins into the values file (including auth-specific plugins)
+        if (!valueFileObject.global) {
+            valueFileObject.global = {};
+        }
+        valueFileObject.global.dynamic = await this._buildDynamicPluginsConfig();
+        this._logBoxen("Dynamic Plugins", valueFileObject.global.dynamic);
+        fs.writeFileSync(`/tmp/${this.deploymentConfig.namespace}-value-file.yaml`, yaml.dump(valueFileObject));
+        await $ `
+      helm upgrade redhat-developer-hub -i "${process.env.CHART_URL || CHART_URL}" --version "${chartVersion}" \
+        -f "/tmp/${this.deploymentConfig.namespace}-value-file.yaml" \
+        --set global.clusterRouterBase="${process.env.K8S_CLUSTER_ROUTER_BASE}" \
+        --namespace="${this.deploymentConfig.namespace}"
+    `;
+        this._log(`Helm deployment completed successfully`);
+    }
+    async _deployWithOperator(subscription) {
+        const subscriptionObject = await mergeYamlFilesIfExists([
+            DEFAULT_CONFIG_PATHS.operator.subscription,
+            subscription,
+        ]);
+        this._logBoxen("Subscription", subscriptionObject);
+        fs.writeFileSync(`/tmp/${this.deploymentConfig.namespace}-subscription.yaml`, yaml.dump(subscriptionObject));
+        const version = this.deploymentConfig.version;
+        const isSemanticVersion = /^\d+(\.\d+)?$/.test(version);
+        // Use main branch for non-semantic versions (e.g., "next", "latest")
+        const branch = isSemanticVersion ? `release-${version}` : "main";
+        // Build version argument based on version type
+        let versionArg;
+        if (isSemanticVersion) {
+            versionArg = `-v ${version}`;
+        }
+        else if (version === "next") {
+            versionArg = "--next";
+        }
+        else {
+            throw new Error(`Invalid RHDH version "${version}". Use semantic version (e.g., "1.5") or "next".`);
+        }
+        this._log(`Using operator branch: ${branch}, version arg: ${versionArg}`);
+        await $ `
+      set -e;
+      curl -sf https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/${branch}/.rhdh/scripts/install-rhdh-catalog-source.sh | bash -s -- ${versionArg} --install-operator rhdh
+
+      timeout 300 bash -c '
+        while ! oc get crd/backstages.rhdh.redhat.com -n "${this.deploymentConfig.namespace}" >/dev/null 2>&1; do
+          echo "Waiting for Backstage CRD to be created..."
+          sleep 20
+        done
+        echo "Backstage CRD is created."
+      ' || echo "Error: Timed out waiting for Backstage CRD creation."
+
+      oc apply -f "/tmp/${this.deploymentConfig.namespace}-subscription.yaml" -n "${this.deploymentConfig.namespace}"
+    `;
+        this._log("Operator deployment executed successfully.");
+    }
+    async rolloutRestart() {
+        this._log(`Restarting RHDH deployment in namespace ${this.deploymentConfig.namespace}...`);
+        await $ `oc rollout restart deployment -l 'app.kubernetes.io/instance in (redhat-developer-hub,developer-hub)' -n ${this.deploymentConfig.namespace}`;
+        this._log(`RHDH deployment restarted successfully in namespace ${this.deploymentConfig.namespace}`);
+        await this.waitUntilReady();
+    }
+    /**
+     * Performs a clean restart by scaling down to 0 first, waiting for pods to terminate,
+     * then scaling back up. This prevents MigrationLocked errors by ensuring no pods
+     * hold database locks when new pods start.
+     */
+    async scaleDownAndRestart() {
+        const namespace = this.deploymentConfig.namespace;
+        await $ `oc scale deployment -l 'app.kubernetes.io/instance in (redhat-developer-hub,developer-hub)' --replicas=0 -n ${namespace}`;
+        await $ `oc wait --for=delete pod -l 'app.kubernetes.io/instance in (redhat-developer-hub,developer-hub),app.kubernetes.io/name!=postgresql' -n ${namespace} --timeout=120s || true`;
+        await $ `oc scale deployment -l 'app.kubernetes.io/instance in (redhat-developer-hub,developer-hub)' --replicas=1 -n ${namespace}`;
+    }
+    async waitUntilReady(timeout = 500) {
+        this._log(`Waiting for RHDH deployment to be ready in namespace ${this.deploymentConfig.namespace}...`);
+        const labelSelector = "app.kubernetes.io/instance in (redhat-developer-hub,developer-hub)";
+        try {
+            await this.k8sClient.waitForPodsWithFailureDetection(this.deploymentConfig.namespace, labelSelector, timeout);
+            this._log(`RHDH deployment is ready in namespace ${this.deploymentConfig.namespace}`);
+        }
+        catch (error) {
+            throw new Error(`RHDH deployment failed in namespace ${this.deploymentConfig.namespace}: ${error instanceof Error ? error.message : error}`);
+        }
+    }
+    async teardown() {
+        await this.k8sClient.deleteNamespace(this.deploymentConfig.namespace);
+    }
+    async _resolveChartVersion(version) {
+        let resolvedVersion = version;
+        // Handle "next" tag by looking up the corresponding version from downstream image
+        if (version === "next") {
+            resolvedVersion = await this._resolveVersionFromNextTag();
+            this._log(`Resolved "next" tag to version: ${resolvedVersion}`);
+        }
+        // Semantic versions (e.g., 1.2, 1.10)
+        if (/^(\d+(\.\d+)?)$/.test(resolvedVersion)) {
+            const response = await fetch("https://quay.io/api/v1/repository/rhdh/chart/tag/?onlyActiveTags=true&limit=600");
+            if (!response.ok)
+                throw new Error(`Failed to fetch chart versions: ${response.statusText}`);
+            const data = (await response.json());
+            const matching = data.tags
+                .map((t) => t.name)
+                .filter((name) => name.startsWith(`${resolvedVersion}-`))
+                .sort((a, b) => a.localeCompare(b, undefined, { numeric: true }));
+            const latest = matching.at(-1);
+            if (!latest)
+                throw new Error(`No chart version found for ${resolvedVersion}`);
+            return latest;
+        }
+        // CI build versions (e.g., 1.2.3-CI)
+        if (resolvedVersion.endsWith("CI"))
+            return resolvedVersion;
+        throw new Error(`Invalid Helm chart version format: "${version}"`);
+    }
+    /**
+     * Resolve the semantic version from the "next" tag by looking up the
+     * downstream image (rhdh-hub-rhel9) and finding tags with the same digest.
+     */
+    async _resolveVersionFromNextTag() {
+        // Fetch all active tags in a single API call
+        const response = await fetch("https://quay.io/api/v1/repository/rhdh/rhdh-hub-rhel9/tag/?onlyActiveTags=true&limit=75");
+        if (!response.ok) {
+            throw new Error(`Failed to fetch image tags: ${response.statusText}`);
+        }
+        // Use Record to avoid snake_case linting issues with Quay API response
+        const data = (await response.json());
+        // Find the "next" tag and get its digest
+        const nextTag = data.tags.find((t) => t["name"] === "next");
+        if (!nextTag) {
+            throw new Error('No "next" tag found in rhdh-hub-rhel9 repository');
+        }
+        const digest = nextTag["manifest_digest"];
+        this._log(`"next" tag digest: ${digest}`);
+        // Find semantic version tag (e.g., "1.10") with the same digest
+        const semanticVersionTag = data.tags.find((t) => t["manifest_digest"] === digest &&
+            /^\d+\.\d+$/.test(t["name"]));
+        if (!semanticVersionTag) {
+            throw new Error(`Could not find semantic version tag for "next" (digest: ${digest})`);
+        }
+        return semanticVersionTag["name"];
+    }
+    _buildDeploymentConfig(input) {
+        // Default to "next" if RHDH_VERSION not set
+        const version = input.version ?? process.env.RHDH_VERSION ?? "next";
+        // Default to "helm" if INSTALLATION_METHOD not set
+        const method = input.method ??
+            process.env.INSTALLATION_METHOD ??
+            "helm";
+        const base = {
+            version,
+            namespace: input.namespace ?? this.deploymentConfig.namespace,
+            auth: input.auth ?? "keycloak",
+            appConfig: input.appConfig ?? `tests/config/app-config-rhdh.yaml`,
+            secrets: input.secrets ?? `tests/config/rhdh-secrets.yaml`,
+            dynamicPlugins: input.dynamicPlugins ?? `tests/config/dynamic-plugins.yaml`,
+        };
+        if (method === "helm") {
+            return {
+                ...base,
+                method,
+                valueFile: input.valueFile ?? `tests/config/value_file.yaml`,
+            };
+        }
+        else if (method === "operator") {
+            return {
+                ...base,
+                method,
+                subscription: input.subscription ?? `tests/config/subscription.yaml`,
+            };
+        }
+        else {
+            throw new Error(`Invalid RHDH installation method: ${method}`);
+        }
+    }
+    async configure(deploymentOptions) {
+        if (deploymentOptions) {
+            this.deploymentConfig = this._buildDeploymentConfig(deploymentOptions);
+            this.rhdhUrl = this._buildBaseUrl();
+            this._log(`RHDH deployment initialized (namespace: ${this.deploymentConfig.namespace})`);
+            console.table(this.deploymentConfig);
+        }
+        await this.k8sClient.createNamespaceIfNotExists(this.deploymentConfig.namespace);
+    }
+    _buildBaseUrl() {
+        const prefix = this.deploymentConfig.method === "helm"
+            ? "redhat-developer-hub"
+            : "backstage-developer-hub";
+        const baseUrl = `https://${prefix}-${this.deploymentConfig.namespace}.${process.env.K8S_CLUSTER_ROUTER_BASE}`;
+        process.env.RHDH_BASE_URL = baseUrl;
+        return baseUrl;
+    }
+    _log(...args) {
+        console.log("[RHDHDeployment]", ...args);
+    }
+    _logBoxen(title, data) {
+        const content = yaml.dump(data, { lineWidth: -1 });
+        console.log(`\n┌─ ${title} ${"─".repeat(60)}`);
+        console.log(content);
+        console.log(`└${"─".repeat(60 + title.length + 3)}\n`);
+    }
+}

package/dist/deployment/rhdh/index.d.ts

@@ -0,0 +1,2 @@
+export { RHDHDeployment } from "./deployment.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/deployment/rhdh/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deployment/rhdh/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/deployment/rhdh/index.js

@@ -0,0 +1 @@
+export { RHDHDeployment } from "./deployment.js";

package/dist/deployment/rhdh/types.d.ts

@@ -0,0 +1,31 @@
+export type DeploymentMethod = "helm" | "operator";
+export type AuthProvider = "guest" | "keycloak";
+export type DeploymentOptions = {
+    version?: string;
+    namespace?: string;
+    auth?: AuthProvider;
+    appConfig?: string;
+    secrets?: string;
+    dynamicPlugins?: string;
+    method?: DeploymentMethod;
+    valueFile?: string;
+    subscription?: string;
+};
+export type HelmDeploymentConfig = {
+    method: "helm";
+    valueFile: string;
+};
+export type OperatorDeploymentConfig = {
+    method: "operator";
+    subscription: string;
+};
+export type DeploymentConfigBase = {
+    version: string;
+    namespace: string;
+    auth: AuthProvider;
+    appConfig: string;
+    secrets: string;
+    dynamicPlugins: string;
+};
+export type DeploymentConfig = DeploymentConfigBase & (HelmDeploymentConfig | OperatorDeploymentConfig);
+//# sourceMappingURL=types.d.ts.map

package/dist/deployment/rhdh/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/deployment/rhdh/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,UAAU,CAAC;AACnD,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,UAAU,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,oBAAoB,GACjD,CAAC,oBAAoB,GAAG,wBAAwB,CAAC,CAAC"}

package/dist/deployment/rhdh/types.js

@@ -0,0 +1 @@
+export {};

package/dist/eslint/base.config.d.ts

@@ -0,0 +1,10 @@
+import type { Linter } from "eslint";
+/**
+ * Creates a base ESLint configuration for RHDH E2E tests.
+ * This configuration includes TypeScript, Playwright, and file naming conventions.
+ *
+ * @param tsconfigRootDir - The root directory for tsconfig.json resolution
+ * @returns ESLint flat config array
+ */
+export declare function createEslintConfig(tsconfigRootDir: string): Linter.Config[];
+//# sourceMappingURL=base.config.d.ts.map

package/dist/eslint/base.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.config.d.ts","sourceRoot":"","sources":["../../src/eslint/base.config.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CA4M3E"}

package/dist/eslint/base.config.js

@@ -0,0 +1,213 @@
+import js from "@eslint/js";
+import tseslint from "typescript-eslint";
+import checkFile from "eslint-plugin-check-file";
+import playwright from "eslint-plugin-playwright";
+/**
+ * Creates a base ESLint configuration for RHDH E2E tests.
+ * This configuration includes TypeScript, Playwright, and file naming conventions.
+ *
+ * @param tsconfigRootDir - The root directory for tsconfig.json resolution
+ * @returns ESLint flat config array
+ */
+export function createEslintConfig(tsconfigRootDir) {
+    return [
+        // Global ignores - must be first for ESLint flat config
+        {
+            ignores: [
+                "node_modules/**",
+                "playwright-report/**",
+                "test-results/**",
+                "blob-report/**",
+                "*.config.js",
+                "dist/**",
+            ],
+        },
+        js.configs.recommended,
+        ...tseslint.configs.recommended,
+        {
+            files: ["**/*.ts"],
+            languageOptions: {
+                parserOptions: {
+                    project: "./tsconfig.json",
+                    tsconfigRootDir,
+                },
+            },
+            rules: {
+                // TypeScript naming conventions
+                "@typescript-eslint/naming-convention": [
+                    "error",
+                    {
+                        selector: "variable",
+                        format: ["camelCase", "PascalCase"],
+                        leadingUnderscore: "allow",
+                    },
+                    {
+                        selector: "variable",
+                        modifiers: ["const"],
+                        format: ["camelCase", "PascalCase", "UPPER_CASE"],
+                    },
+                    {
+                        selector: "function",
+                        format: ["camelCase", "PascalCase"],
+                    },
+                    {
+                        selector: "parameter",
+                        format: ["camelCase", "PascalCase"],
+                        leadingUnderscore: "allow",
+                    },
+                    {
+                        selector: "typeLike",
+                        format: ["PascalCase"],
+                    },
+                    {
+                        selector: "enumMember",
+                        format: ["PascalCase"],
+                    },
+                    {
+                        selector: "memberLike",
+                        modifiers: ["private"],
+                        format: ["camelCase"],
+                        leadingUnderscore: "allow",
+                    },
+                    {
+                        selector: "memberLike",
+                        modifiers: ["public"],
+                        format: ["camelCase"],
+                    },
+                    // Allow HTTP headers in object literals which require specific formats
+                    {
+                        selector: "objectLiteralProperty",
+                        format: null,
+                        filter: {
+                            regex: "^(Accept|Authorization|Content-Type|X-GitHub-Api-Version|X-[A-Za-z-]+)$",
+                            match: true,
+                        },
+                    },
+                ],
+                // Promise handling
+                "@typescript-eslint/no-floating-promises": "error",
+                "@typescript-eslint/await-thenable": "error",
+                "@typescript-eslint/no-misused-promises": "error",
+                // Allow any type in tests (for mocking, test data)
+                "@typescript-eslint/no-explicit-any": "warn",
+                // Prefer modern syntax
+                "@typescript-eslint/prefer-optional-chain": "error",
+                // Allow unused vars starting with underscore
+                "@typescript-eslint/no-unused-vars": [
+                    "error",
+                    {
+                        argsIgnorePattern: "^_",
+                        varsIgnorePattern: "^_",
+                    },
+                ],
+                // Allow empty functions (for test stubs)
+                "@typescript-eslint/no-empty-function": "off",
+            },
+        },
+        {
+            files: ["**/*.{js,ts}"],
+            plugins: {
+                "check-file": checkFile,
+            },
+            rules: {
+                "check-file/filename-naming-convention": [
+                    "error",
+                    {
+                        "**/*.{js,ts}": "KEBAB_CASE",
+                    },
+                    {
+                        ignoreMiddleExtensions: true,
+                    },
+                ],
+                "check-file/folder-naming-convention": [
+                    "error",
+                    {
+                        "**": "KEBAB_CASE",
+                    },
+                ],
+            },
+        },
+        // Playwright test files
+        {
+            ...playwright.configs["flat/recommended"],
+            files: [
+                "**/*.spec.ts",
+                "**/*.test.ts",
+                "**/tests/**/*.ts",
+                "**/e2e/**/*.ts",
+            ],
+            rules: {
+                ...playwright.configs["flat/recommended"].rules,
+                // Playwright best practices
+                "playwright/expect-expect": "warn",
+                "playwright/max-nested-describe": ["warn", { max: 2 }],
+                "playwright/missing-playwright-await": "error",
+                "playwright/no-conditional-in-test": "warn",
+                "playwright/no-element-handle": "warn",
+                "playwright/no-eval": "error",
+                "playwright/no-focused-test": "error",
+                "playwright/no-force-option": "warn",
+                "playwright/no-page-pause": "warn",
+                "playwright/no-skipped-test": [
+                    "warn",
+                    {
+                        allowConditional: true,
+                    },
+                ],
+                "playwright/no-useless-await": "warn",
+                "playwright/no-useless-not": "warn",
+                "playwright/no-wait-for-selector": "warn",
+                "playwright/no-wait-for-timeout": "warn",
+                "playwright/prefer-web-first-assertions": "error",
+                "playwright/require-top-level-describe": "off",
+                "playwright/valid-describe-callback": "off",
+                "playwright/valid-expect": "error",
+                "playwright/valid-title": "warn",
+                // Custom restrictions
+                "no-restricted-syntax": [
+                    "error",
+                    {
+                        selector: "CallExpression[callee.property.name='fixme'][callee.object.property.name='describe'][callee.object.object.name='test']",
+                        message: "test.describe.fixme() is not valid. Use test.fixme() on individual tests instead.",
+                    },
+                ],
+                // Disallow console.log in tests (use test.info() instead)
+                "no-console": [
+                    "warn",
+                    {
+                        allow: ["warn", "error"],
+                    },
+                ],
+            },
+        },
+        // Page Object Models - require class suffix
+        {
+            files: ["**/page-objects/**/*.ts", "**/page/**/*.ts", "**/pages/**/*.ts"],
+            rules: {
+                "@typescript-eslint/naming-convention": [
+                    "error",
+                    {
+                        selector: "class",
+                        format: ["PascalCase"],
+                        suffix: ["Page", "Component", "PO"],
+                    },
+                ],
+            },
+        },
+        // Fixtures
+        {
+            files: ["**/fixtures/**/*.ts"],
+            rules: {
+                "@typescript-eslint/no-explicit-any": "off",
+            },
+        },
+        // Config files
+        {
+            files: ["playwright.config.ts", "**/*.config.ts"],
+            rules: {
+                "@typescript-eslint/naming-convention": "off",
+                "check-file/filename-naming-convention": "off",
+            },
+        },
+    ];
+}

package/dist/playwright/base-config.d.ts

@@ -0,0 +1,14 @@
+import { PlaywrightTestConfig } from "@playwright/test";
+/**
+ * Base Playwright configuration that can be extended by workspace-specific configs.
+ * Provides sensible defaults for RHDH plugin e2e testing.
+ */
+export declare const baseConfig: PlaywrightTestConfig;
+/**
+ * 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 declare function defineConfig(overrides?: Pick<PlaywrightTestConfig, "projects">): PlaywrightTestConfig;
+//# sourceMappingURL=base-config.d.ts.map

package/dist/playwright/base-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-config.d.ts","sourceRoot":"","sources":["../../src/playwright/base-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,oBAAoB,EACrB,MAAM,kBAAkB,CAAC;AAG1B;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,oBA4BxB,CAAC;AAEF;;;;;GAKG;AAEH,wBAAgB,YAAY,CAC1B,SAAS,GAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAM,GACrD,oBAAoB,CAKtB"}