chore(ci): decouple namespace from Playwright project name #3796

zdrapela · 2025-12-03T10:42:58Z

Description

This PR refactors the CI pipeline scripts to decouple the Kubernetes namespace from the Playwright project name, centralizes project names in a single source of truth, and fixes status reporting for the showcase-runtime test scenario.

This enables more flexible use of namespaces and test projects, allowing them to be configured and reused independently.

Changes

1. Decouple namespace from Playwright project name

Previously, the CI scripts implicitly tied the namespace name to the Playwright project name (e.g., namespace showcase-ci-nightly always ran project showcase). This created unnecessary coupling and prevented flexible reuse of namespaces with different test projects.

Now, check_and_test() and run_tests() accept an explicit playwright_project argument separate from the namespace, allowing:

Same namespace to run different test projects
Same test project to run in different namespaces
Independent configuration of deployment target and test suite

Tests are executed directly via npx playwright test --project="${playwright_project}" following Playwright's recommended approach.

2. Single source of truth for Playwright project names

Created e2e-tests/playwright/projects.json as the single source of truth for all Playwright project names. This file is consumed by:

TypeScript (playwright.config.ts) via e2e-tests/playwright/projects.ts import
CI/CD scripts via .ibm/pipelines/playwright-projects.sh which exports $PW_PROJECT_* environment variables

All CI job scripts now use these variables (e.g., ${PW_PROJECT_SHOWCASE}) instead of hardcoded strings.

3. Fix status saving for showcase-runtime

Moved the deployment status tracking (CURRENT_DEPLOYMENT increment and save_status_deployment_namespace) to the beginning of run_tests() instead of only in check_and_test(). This ensures tests like showcase-runtime that call run_tests() directly correctly report their deployment status.

4. Clean up e2e-tests/package.json

Removed redundant *-nightly and *-ci-nightly yarn script aliases that were only used for CI naming conventions.

Which issue(s) does this PR fix

Decouples namespace from Playwright project name for flexible reuse
Centralizes Playwright project names in a single source of truth
Fixes status reporting for showcase-runtime in the fine-grained CI reporter

PR acceptance criteria

GitHub Actions are completed and successful
Unit Tests are updated and passing
E2E Tests are updated and passing
Documentation is updated if necessary

How to test changes / Special notes to the reviewer

Key decoupling: Namespace and Playwright project are now independent:

# Old: namespace implicitly determined test project
check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${URL}"

# New: namespace and project are explicitly separate
check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PW_PROJECT_SHOWCASE}" "${URL}"

Files modified:
- .ibm/pipelines/utils.sh - Core functions updated with explicit project argument
- .ibm/pipelines/jobs/*.sh - All job handlers updated
- e2e-tests/playwright/projects.json - Single source of truth for project names
- e2e-tests/playwright/projects.ts - TypeScript exports
- .ibm/pipelines/playwright-projects.sh - Shell script to load project names as env vars
- e2e-tests/package.json - Removed redundant script aliases

issues.redhat.com/browse/RHIDP-11056

openshift-ci · 2025-12-03T10:43:05Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

zdrapela · 2025-12-03T10:43:06Z

/review
-i

rhdh-qodo-merge · 2025-12-03T10:43:30Z

PR Reviewer Guide 🔍

(Review updated until commit `b8f81ec`)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🔒 No security concerns identified
⚡ Recommended focus areas for review Artifact Paths Change Artifacts are now stored under the namespace path instead of project. Downstream consumers parsing artifacts or junit by project may break. Confirm all reporting/collection tooling and links expect the new "${ARTIFACT_DIR}/${namespace}/..." layout and not the previous project-based paths. mkdir -p "${ARTIFACT_DIR}/${namespace}/test-results" mkdir -p "${ARTIFACT_DIR}/${namespace}/attachments/screenshots" cp -a "${e2e_tests_dir}/test-results/"* "${ARTIFACT_DIR}/${namespace}/test-results" \|\| true cp -a "${e2e_tests_dir}/${JUNIT_RESULTS}" "${ARTIFACT_DIR}/${namespace}/${JUNIT_RESULTS}" \|\| true cp -a "${e2e_tests_dir}/screenshots/"* "${ARTIFACT_DIR}/${namespace}/attachments/screenshots/" \|\| true ansi2html < "/tmp/${LOGFILE}" > "/tmp/${LOGFILE}.html" cp -a "/tmp/${LOGFILE}.html" "${ARTIFACT_DIR}/${namespace}" \|\| true cp -a "${e2e_tests_dir}/playwright-report/"* "${ARTIFACT_DIR}/${namespace}" \|\| true save_data_router_junit_results "${namespace}" echo "Playwright project '${playwright_project}' in namespace '${namespace}' RESULT: ${RESULT}"
📚 Focus areas based on broader codebase context Robustness The script uses jq to parse JSON without verifying jq is installed, which will cause a runtime failure. Add a prerequisite check similar to other scripts and fail fast with a clear message if missing. (Ref 7) log::section "Loading Playwright Project Names" log::info "Source: ${PROJECTS_JSON}" # Read project names from JSON and export as environment variables while IFS='=' read -r key value; do export "PW_PROJECT_${key}=${value}" log::info " PW_PROJECT_${key}=${value}" done < <(jq -r 'to_entries[] \| "\(.key)=\(.value)"' "${PROJECTS_JSON}") log::success "Playwright project variables loaded successfully" Reference reasoning: Other bash utilities in the codebase proactively validate required CLIs and exit with helpful errors (e.g., checking for oc in scripts). Mirroring that pattern here to check for jq aligns with established practices and prevents hard-to-trace failures.
📄 References redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/plugin-infra.sh [1-49] redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/plugin-infra.sh [50-75] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [1-55] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [104-145] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [71-103] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [146-157] redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/gitops-secret-setup.sh [133-182] redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/gitops-secret-setup.sh [199-222]

zdrapela · 2025-12-03T10:54:45Z

/test e2e-ocp-helm

github-actions · 2025-12-03T11:37:52Z

The image is available at:

zdrapela · 2025-12-03T13:35:05Z

/test e2e-ocp-helm

gustavolira · 2025-12-03T17:31:12Z

Consider updating documentation in .cursor/rules/ci-e2e-testing.mdc that references the old script names (showcase-ci-nightly, etc.) in a follow-up PR.

.ibm/pipelines/utils.sh

.ibm/pipelines/jobs/aks-helm.sh

github-actions · 2025-12-04T14:29:19Z

The image is available at:

rhdh-qodo-merge · 2025-12-04T15:08:46Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🔒 No security concerns identified
⚡ Recommended focus areas for review Possible Issue In check_and_test() and check_upgrade_and_test(), CURRENT_DEPLOYMENT and deployment namespace are saved only on failure paths; run_tests() now increments CURRENT_DEPLOYMENT and saves namespace on success paths. Verify that each call site results in exactly one increment and consistent namespace/status saving in both success and failure cases, avoiding skipped increments or double-counting across mixed code paths. check_and_test() { local release_name=$1 local namespace=$2 local playwright_project=$3 local url=$4 local max_attempts=${5:-30} # Default to 30 if not set local wait_seconds=${6:-30} # Default to 30 if not set if check_backstage_running "${release_name}" "${namespace}" "${url}" "${max_attempts}" "${wait_seconds}"; then echo "Display pods for verification..." oc get pods -n "${namespace}" run_tests "${release_name}" "${namespace}" "${playwright_project}" "${url}" else echo "Backstage is not running. Exiting..." CURRENT_DEPLOYMENT=$((CURRENT_DEPLOYMENT + 1)) save_status_deployment_namespace $CURRENT_DEPLOYMENT "$namespace" save_status_failed_to_deploy $CURRENT_DEPLOYMENT true save_status_test_failed $CURRENT_DEPLOYMENT true save_overall_result 1 fi save_all_pod_logs $namespace } check_upgrade_and_test() { local deployment_name="$1" local release_name="$2" local namespace="$3" local playwright_project="$4" local url=$5 local timeout=${6:-600} # Timeout in seconds (default: 600 seconds) if check_helm_upgrade "${deployment_name}" "${namespace}" "${timeout}"; then check_and_test "${release_name}" "${namespace}" "${playwright_project}" "${url}" else echo "Helm upgrade encountered an issue or timed out. Exiting..." CURRENT_DEPLOYMENT=$((CURRENT_DEPLOYMENT + 1)) save_status_deployment_namespace $CURRENT_DEPLOYMENT "$namespace" save_status_failed_to_deploy $CURRENT_DEPLOYMENT true save_status_test_failed $CURRENT_DEPLOYMENT true save_overall_result 1 fi Robustness The grep-based validation of the Playwright project assumes a specific formatting in playwright.config.ts and returns 1 immediately on mismatch, which marks deployment as failed in callers. Consider making this check non-fatal or more resilient to formatting/whitespace differences, or log a warning while still running to avoid false negatives. if ! grep -q "name: \"${playwright_project}\"" "${DIR}/../../e2e-tests/playwright.config.ts" 2> /dev/null; then logging::warn "Playwright project '${playwright_project}' may not exist in config" return 1 fi CURRENT_DEPLOYMENT=$((CURRENT_DEPLOYMENT + 1)) save_status_deployment_namespace $CURRENT_DEPLOYMENT "$namespace" save_status_failed_to_deploy $CURRENT_DEPLOYMENT false
📄 References redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/plugin-infra.sh [1-49] redhat-developer/rhdh-operator/config/profile/rhdh/plugin-infra/plugin-infra.sh [50-75] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [1-55] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [104-145] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [146-157] redhat-developer/rhdh-operator/hack/validate-image-digests.sh [159-190] redhat-developer/rhdh-chart/hack/merge_secrets.sh [1-47] redhat-developer/rhdh-chart/hack/merge_secrets.sh [49-52]

rhdh-qodo-merge · 2025-12-04T15:08:58Z

PR Type

Enhancement

Description

Decouple Kubernetes namespace from Playwright project name in CI pipeline
- check_and_test() and run_tests() now accept explicit playwright_project argument
- Tests executed directly via npx playwright test --project=<name> instead of yarn aliases
Fix status reporting for showcase-runtime test scenario
- Move deployment status tracking to beginning of run_tests() function
- Ensures all test scenarios correctly report deployment status to fine-grained reporter
Update all CI job handlers with explicit Playwright project names
- 10 job files updated with new function signatures across AKS, EKS, GKE, OCP deployments
Clean up redundant yarn script aliases in e2e-tests/package.json
- Remove *-nightly and *-ci-nightly aliases no longer needed by CI pipeline
Update documentation and rules to reflect new CI execution approach

File Walkthrough

Relevant files

Enhancement

12 files

utils.sh `Refactor test execution functions with explicit Playwright project` `argument`	+38/-23
aks-helm.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
aks-operator.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
auth-providers.sh `Update run_tests call with explicit Playwright project name`	+1/-1
eks-helm.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
eks-operator.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
gke-helm.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
gke-operator.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
ocp-nightly.sh `Update test execution calls with explicit Playwright project names`	+4/-4
ocp-operator.sh `Update test execution calls with explicit Playwright project names`	+3/-3
ocp-pull.sh `Update check_and_test calls with explicit Playwright project names`	+2/-2
upgrade.sh `Update check_upgrade_and_test call with explicit Playwright project` `name`	+1/-1

Configuration changes

1 files

package.json `Remove redundant nightly and ci-nightly yarn script aliases`	+5/-7

Documentation

4 files

ci-e2e-testing.md `Document new CI pipeline execution approach and function signatures`	+28/-10
ci-e2e-testing.mdc `Document new CI pipeline execution approach and function signatures`	+28/-10
ci-e2e-testing.md `Document new CI pipeline execution approach and function signatures`	+28/-10
CI.md `Update documentation to reflect direct Playwright execution in CI`	+4/-4

rhdh-qodo-merge · 2025-12-04T15:10:08Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Improve robustness of Playwright project check Improve the robustness of the Playwright project check by using a more flexible regular expression that handles variations in quoting and spacing in the configuration file. .ibm/pipelines/utils.sh [631-634] -if ! grep -q "name: \"${playwright_project}\"" "${DIR}/../../e2e-tests/playwright.config.ts" 2> /dev/null; then +if ! grep -qE "^\sname:\s['\"]${playwright_project}['\"],?\s$" "${DIR}/../../e2e-tests/playwright.config.ts" 2> /dev/null; then logging::warn "Playwright project '${playwright_project}' may not exist in config" return 1 fi Apply / Chat* Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the new `grep` check is brittle and provides a more robust regex, preventing potential failures from minor formatting changes in the config file.	Low
Update

github-actions · 2025-12-04T16:04:12Z

The image is available at:

gustavolira · 2025-12-08T14:43:02Z

/approve
/lgtm

github-actions · 2025-12-08T15:25:11Z

The image is available at:

github-actions · 2025-12-09T08:23:12Z

The image is available at:

sonarqubecloud · 2025-12-09T09:05:43Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2025-12-09T09:59:39Z

The image is available at:

zdrapela · 2025-12-09T11:25:35Z

/test e2e-ocp-helm-nightly

zdrapela · 2025-12-09T13:00:55Z

/override ci/prow/e2e-ocp-helm

openshift-ci · 2025-12-09T13:01:01Z

@zdrapela: zdrapela unauthorized: /override is restricted to Repo administrators, approvers in top level OWNERS file, and the following github teams:.

In response to this:

/override ci/prow/e2e-ocp-helm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

gustavolira · 2025-12-09T13:05:56Z

/approve
/lgtm

zdrapela · 2025-12-09T13:37:23Z

/assign albarbaro

albarbaro · 2025-12-09T13:42:20Z

/lgtm

openshift-ci · 2025-12-09T13:42:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: albarbaro, gustavolira

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [albarbaro]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2025-12-09T14:38:43Z

@zdrapela: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-ocp-helm	`86b590c`	link	unknown	`/test e2e-ocp-helm`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci bot added the do-not-merge/work-in-progress label Dec 3, 2025

zdrapela temporarily deployed to internal December 3, 2025 10:43 — with GitHub Actions Inactive

rhdh-qodo-merge bot added the Review effort 2/5 label Dec 3, 2025

gustavolira reviewed Dec 3, 2025

View reviewed changes

.ibm/pipelines/utils.sh Show resolved Hide resolved

gustavolira reviewed Dec 3, 2025

View reviewed changes

.ibm/pipelines/utils.sh Show resolved Hide resolved

gustavolira reviewed Dec 3, 2025

View reviewed changes

.ibm/pipelines/jobs/aks-helm.sh Outdated Show resolved Hide resolved

zdrapela force-pushed the namespace-project-decouple branch from d406e5b to d7f5e75 Compare December 4, 2025 13:34

zdrapela temporarily deployed to internal December 4, 2025 13:34 — with GitHub Actions Inactive

zdrapela temporarily deployed to internal December 4, 2025 15:06 — with GitHub Actions Inactive

zdrapela force-pushed the namespace-project-decouple branch from 625f91d to 4a1362b Compare December 4, 2025 15:08

zdrapela marked this pull request as ready for review December 4, 2025 15:08

openshift-ci bot removed the do-not-merge/work-in-progress label Dec 4, 2025

openshift-ci bot requested review from gustavolira and subhashkhileri December 4, 2025 15:08

zdrapela temporarily deployed to internal December 4, 2025 15:08 — with GitHub Actions Inactive

rhdh-qodo-merge bot added the Enhancement label Dec 4, 2025

zdrapela force-pushed the namespace-project-decouple branch from 4a1362b to ec72a2b Compare December 5, 2025 10:50

Use yarn instead of npx

2630c2f

zdrapela force-pushed the namespace-project-decouple branch from b8f81ec to 2630c2f Compare December 8, 2025 14:18

openshift-ci bot removed the lgtm label Dec 8, 2025

openshift-merge-robot removed the needs-rebase label Dec 8, 2025

zdrapela temporarily deployed to internal December 8, 2025 14:19 — with GitHub Actions Inactive

Prettier

d40a18c

zdrapela temporarily deployed to internal December 8, 2025 14:25 — with GitHub Actions Inactive

openshift-ci bot added the lgtm label Dec 8, 2025

Update utils.sh

ebfe5f2

openshift-ci bot removed the lgtm label Dec 9, 2025

zdrapela temporarily deployed to internal December 9, 2025 07:29 — with GitHub Actions Inactive

Update utils.sh

86b590c

zdrapela temporarily deployed to internal December 9, 2025 09:05 — with GitHub Actions Inactive

openshift-ci bot added the lgtm label Dec 9, 2025

openshift-ci bot assigned albarbaro Dec 9, 2025

openshift-ci bot added the approved label Dec 9, 2025

openshift-merge-bot bot merged commit ade4324 into redhat-developer:main Dec 9, 2025
24 checks passed

chore(ci): decouple namespace from Playwright project name #3796

chore(ci): decouple namespace from Playwright project name #3796

Uh oh!

Conversation

zdrapela commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changes

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

Uh oh!

openshift-ci bot commented Dec 3, 2025

Uh oh!

zdrapela commented Dec 3, 2025

Uh oh!

rhdh-qodo-merge bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Reviewer Guide 🔍

(Review updated until commit b8f81ec)

Uh oh!

zdrapela commented Dec 3, 2025

Uh oh!

github-actions bot commented Dec 3, 2025

Uh oh!

zdrapela commented Dec 3, 2025

Uh oh!

gustavolira commented Dec 3, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 4, 2025

Uh oh!

rhdh-qodo-merge bot commented Dec 4, 2025

PR Reviewer Guide 🔍

Uh oh!

rhdh-qodo-merge bot commented Dec 4, 2025

PR Type

Description

File Walkthrough

Uh oh!

rhdh-qodo-merge bot commented Dec 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

github-actions bot commented Dec 4, 2025

Uh oh!

gustavolira commented Dec 8, 2025

Uh oh!

github-actions bot commented Dec 8, 2025

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

sonarqubecloud bot commented Dec 9, 2025

Quality Gate passed

Uh oh!

github-actions bot commented Dec 9, 2025

Uh oh!

zdrapela commented Dec 9, 2025

Uh oh!

zdrapela commented Dec 9, 2025

Uh oh!

openshift-ci bot commented Dec 9, 2025

Uh oh!

gustavolira commented Dec 9, 2025

Uh oh!

zdrapela commented Dec 9, 2025

Uh oh!

albarbaro commented Dec 9, 2025

Uh oh!

openshift-ci bot commented Dec 9, 2025

Uh oh!

Uh oh!

openshift-ci bot commented Dec 9, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

zdrapela commented Dec 3, 2025 •

edited

Loading

rhdh-qodo-merge bot commented Dec 3, 2025 •

edited

Loading

(Review updated until commit `b8f81ec`)

rhdh-qodo-merge bot commented Dec 4, 2025 •

edited

Loading