rhdh-e2e-test-utils 1.0.0 → 1.0.1

package/README.md

@@ -21,6 +21,7 @@ A comprehensive test utility package for Red Hat Developer Hub (RHDH) end-to-end
 - [Environment Variables](#environment-variables)
 - [Examples](#examples)
 - [Development](#development)
+  - [Testing Local Changes in Consumer Projects](#testing-local-changes-in-consumer-projects)
 
 ## Overview
 
@@ -562,6 +563,80 @@ yarn build
 | `yarn prettier:check` | Check code formatting |
 | `yarn prettier:fix` | Auto-fix code formatting |
 
+### Testing Local Changes in Consumer Projects
+
+When developing features or fixes in `rhdh-e2e-test-utils`, you can test your local changes in a consumer project (e.g., a plugin's e2e-tests) before publishing.
+
+#### 1. Build your local changes
+
+```bash
+cd /path/to/rhdh-e2e-test-utils
+yarn build
+```
+
+#### 2. Update the consumer project's package.json
+
+In your e2e-tests project, update the dependency to point to your local package using the `file:` protocol:
+
+```json
+"rhdh-e2e-test-utils": "file:/path/to/rhdh-e2e-test-utils"
+```
+
+Example:
+```json
+"rhdh-e2e-test-utils": "file:/Users/yourname/Documents/rhdh/rhdh-e2e-test-utils"
+```
+
+#### 3. Install dependencies in the consumer project
+
+```bash
+yarn install
+```
+
+#### 4. Run tests with NODE_PRESERVE_SYMLINKS
+
+When running tests with a local symlinked package, you **must** set the `NODE_PRESERVE_SYMLINKS` environment variable:
+
+```bash
+NODE_PRESERVE_SYMLINKS=1 yarn test
+NODE_PRESERVE_SYMLINKS=1 yarn test:headed
+NODE_PRESERVE_SYMLINKS=1 yarn test:ui
+```
+
+> **Why is NODE_PRESERVE_SYMLINKS needed?**
+>
+> When using local packages via `file:` protocol, the package manager creates a symlink. Node.js follows symlinks by default and tries to resolve peer dependencies (like `@playwright/test`) from the original package location. This causes duplicate Playwright instances which fails with:
+> ```
+> Error: Requiring @playwright/test second time
+> ```
+> Setting `NODE_PRESERVE_SYMLINKS=1` tells Node.js to resolve dependencies from the symlink location (your project's `node_modules`) instead of the original package location.
+
+#### 5. Rebuild after making changes
+
+When you make further changes to `rhdh-e2e-test-utils`, rebuild before running tests:
+
+```bash
+cd /path/to/rhdh-e2e-test-utils
+yarn build
+```
+
+Then run your tests again in the consumer project (no need to reinstall).
+
+#### 6. Restore the published version
+
+After testing, restore the published version in the consumer project's `package.json`:
+
+```json
+"rhdh-e2e-test-utils": "^1.0.0"
+```
+
+Then run:
+```bash
+yarn install
+```
+
+You can now run tests normally without `NODE_PRESERVE_SYMLINKS`.
+
 ### CI/CD
 
 The project includes GitHub Actions workflows:

package/dist/deployment/rhdh/config/app-config-rhdh.yaml

@@ -0,0 +1,6 @@
+app:
+  baseUrl: "${RHDH_BASE_URL}"
+backend:
+  baseUrl: "${RHDH_BASE_URL}"
+  cors:
+    origin: "${RHDH_BASE_URL}"

package/dist/deployment/rhdh/config/dynamic-plugins.yaml

@@ -0,0 +1,2 @@
+includes:
+  - dynamic-plugins.default.yaml

package/dist/deployment/rhdh/config/rhdh-secrets.yaml

@@ -0,0 +1,7 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: rhdh-secrets
+type: Opaque
+stringData:
+  RHDH_BASE_URL: $RHDH_BASE_URL

package/dist/deployment/rhdh/constants.js

@@ -2,9 +2,9 @@ import path from "path";
 // Navigate from dist/deployment/rhdh/ to package root
 const PACKAGE_ROOT = path.resolve(import.meta.dirname, "../../..");
 export const DEFAULT_CONFIG_PATHS = {
-    appConfig: path.join(PACKAGE_ROOT, "src/deployment/rhdh/config/app-config-rhdh.yaml"),
-    secrets: path.join(PACKAGE_ROOT, "src/deployment/rhdh/config/rhdh-secrets.yaml"),
-    dynamicPlugins: path.join(PACKAGE_ROOT, "src/deployment/rhdh/config/dynamic-plugins.yaml"),
+    appConfig: path.join(PACKAGE_ROOT, "dist/deployment/rhdh/config/app-config-rhdh.yaml"),
+    secrets: path.join(PACKAGE_ROOT, "dist/deployment/rhdh/config/rhdh-secrets.yaml"),
+    dynamicPlugins: path.join(PACKAGE_ROOT, "dist/deployment/rhdh/config/dynamic-plugins.yaml"),
     helm: {
         valueFile: path.join(PACKAGE_ROOT, "src/deployment/rhdh/helm/value_file.yaml"),
     },

package/dist/deployment/rhdh/helm/value_file.yaml

@@ -0,0 +1,7 @@
+upstream:
+  backstage:
+    extraAppConfig:
+      - configMapRef: app-config-rhdh
+        filename: app-config-rhdh.yaml
+    extraEnvVarsSecrets:
+      - rhdh-secrets

package/dist/deployment/rhdh/operator/subscription.yaml

@@ -0,0 +1,21 @@
+apiVersion: rhdh.redhat.com/v1alpha3
+kind: Backstage
+metadata:
+  name: developer-hub
+spec:
+  application:
+    appConfig:
+      configMaps:
+        - name: app-config-rhdh
+      mountPath: /opt/app-root/src
+    extraFiles:
+      mountPath: /opt/app-root/src
+    replicas: 1
+    route:
+      enabled: true
+    dynamicPluginsConfigMapName: dynamic-plugins
+    extraEnvs:
+      secrets:
+        - name: rhdh-secrets
+  database:
+    enableLocalDb: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rhdh-e2e-test-utils",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Test utilities for RHDH E2E tests",
   "license": "Apache-2.0",
   "type": "module",
@@ -31,13 +31,10 @@
   },
   "files": [
     "dist",
-    "tsconfig.base.json",
-    "src/deployment/rhdh/config",
-    "src/deployment/rhdh/helm",
-    "src/deployment/rhdh/operator"
+    "tsconfig.base.json"
   ],
   "scripts": {
-    "build": "yarn clean && tsc -p tsconfig.build.json",
+    "build": "yarn clean && tsc -p tsconfig.build.json && cp -r src/deployment/rhdh/config src/deployment/rhdh/helm src/deployment/rhdh/operator dist/deployment/rhdh/",
     "check": "yarn typecheck && yarn lint:check && yarn prettier:check",
     "clean": "rm -rf dist",
     "lint:check": "eslint . --ignore-pattern dist --ignore-pattern README.md",