Skip to content

Commit 021ad8a

Browse files
zdrapelaclaude
andcommitted
docs: update rulesync CI rule with current refs and job handlers
- Fix function refs: run_tests() → testing::run_tests() in lib/testing.sh - Fix Slack channel name: #rhdh-e2e-test-alerts → #rhdh-e2e-alerts - Replace hardcoded cluster pools with link to OpenShift CI docs - Add all missing job handlers (aks/eks/gke-operator, osd-gcp, upgrade) - Add showcase-runtime-db to Playwright project list Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7a43bc1 commit 021ad8a

File tree

4 files changed

+46
-94
lines changed

4 files changed

+46
-94
lines changed

.claude/memories/ci-e2e-testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ Available cluster pools for different OCP versions:
297297
#### Nightly Tests
298298
- **Schedule**: Automated nightly runs
299299
- **Environments**: Multiple OCP versions, AKS, GKE
300-
- **Reporting**: Slack notifications to `#rhdh-e2e-test-alerts`
300+
- **Reporting**: Slack notifications to `#rhdh-e2e-alerts`
301301

302302
### Test Execution Environment
303303

.claude/rules/ci-e2e-testing.md

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ test.beforeAll(async ({ }, testInfo) => {
8080
- `showcase-operator`: General functionality tests with base deployment using Operator
8181
- `showcase-operator-rbac`: General functionality tests with RBAC-enabled deployment using Operator
8282
- `showcase-runtime`: Runtime environment tests
83+
- `showcase-runtime-db`: Runtime database tests
8384
- `showcase-sanity-plugins`: Plugin sanity checks
8485
- `showcase-upgrade`: Upgrade scenario tests
8586
- `showcase-localization-fr`: French localization tests
@@ -128,18 +129,18 @@ test.beforeAll(async ({ }, testInfo) => {
128129

129130
#### CI/CD Pipeline Execution
130131

131-
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via the `run_tests()` function in `.ci/pipelines/utils.sh`:
132+
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via `testing::run_tests()` in `.ci/pipelines/lib/testing.sh`:
132133

133134
```bash
134135
yarn playwright test --project="${playwright_project}"
135136
```
136137

137-
The namespace and Playwright project are decoupled, allowing flexible reuse. The `check_and_test()` and `run_tests()` functions accept an explicit `playwright_project` argument:
138+
The namespace and Playwright project are decoupled, allowing flexible reuse. The `testing::check_and_test()` and `testing::run_tests()` functions accept an explicit `playwright_project` argument:
138139

139140
```bash
140141
# Function signatures:
141-
check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
142-
run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
142+
testing::check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
143+
testing::run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
143144
```
144145

145146
#### Local Development Scripts
@@ -269,25 +270,7 @@ Check the readme at `.ci/pipelines/README.md`
269270

270271
### Cluster Pools
271272

272-
Available cluster pools for different OCP versions:
273-
274-
- **RHDH-4-19-US-EAST-2**
275-
- Usage: OCP v4.19 nightly jobs
276-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-19-0-amd64-aws-us-east-2_clusterpool.yaml)
277-
278-
- **RHDH-4-18-US-EAST-2**
279-
- Usage: OCP v4.18 nightly jobs
280-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-18-0-amd64-aws-us-east-2_clusterpool.yaml)
281-
282-
- **RHDH-4-17-US-EAST-2**
283-
- Usage: PR checks on main branch and OCP v4.17 nightly jobs
284-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-17-0-amd64-aws-us-east-2_clusterpool.yaml)
285-
286-
- **RHDH-4-16-US-EAST-2**
287-
- Usage: OCP v4.16 nightly jobs
288-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-16-0-amd64-aws-us-east-2_clusterpool.yaml)
289-
290-
**Note:** This is subject to change. Use `.ci/pipelines/README.md` as a source of truth.
273+
RHDH uses dedicated Hive cluster pools with the `rhdh` prefix on AWS `us-east-2`. Pool versions rotate as new OCP releases come out. Find the current list by filtering for `rhdh` in the [existing cluster pools](https://docs.ci.openshift.org/how-tos/cluster-claim/#existing-cluster-pools) page. See also `.ci/pipelines/README.md`.
291274

292275
### CI Job Types
293276

@@ -300,7 +283,7 @@ Available cluster pools for different OCP versions:
300283
#### Nightly Tests
301284
- **Schedule**: Automated nightly runs
302285
- **Environments**: Multiple OCP versions, AKS, GKE
303-
- **Reporting**: Slack notifications to `#rhdh-e2e-test-alerts`
286+
- **Reporting**: Slack notifications to `#rhdh-e2e-alerts`
304287

305288
### Test Execution Environment
306289

@@ -350,14 +333,15 @@ yarn prettier:fix # Fix formatting for shell, markdown, and YAML file
350333
- Functions may temporarily disable/re-enable error handling with `set +e` / `set -e` pattern
351334

352335
#### Job Handlers
353-
The main script handles different job types:
354-
- `handle_aks_helm`: AKS Helm deployment
355-
- `handle_eks_helm`: EKS Helm deployment
356-
- `handle_gke_helm`: GKE Helm deployment
357-
- `handle_ocp_operator`: OCP Operator deployment
358-
- `handle_ocp_nightly`: OCP nightly tests
359-
- `handle_ocp_pull`: OCP PR tests
336+
The main script dispatches to job-specific handlers in `.ci/pipelines/jobs/`:
337+
- `handle_aks_helm` / `handle_aks_operator`: AKS Helm/Operator deployment
338+
- `handle_eks_helm` / `handle_eks_operator`: EKS Helm/Operator deployment
339+
- `handle_gke_helm` / `handle_gke_operator`: GKE Helm/Operator deployment
340+
- `handle_ocp_nightly`: OCP Helm nightly tests (also handles OSD-GCP Helm)
341+
- `handle_ocp_operator`: OCP Operator nightly tests (also handles OSD-GCP Operator)
342+
- `handle_ocp_pull`: OCP PR checks
360343
- `handle_auth_providers`: Auth provider tests
344+
- `handle_ocp_helm_upgrade`: Upgrade scenario tests
361345

362346
#### Special Case: showcase-auth-providers Deployment
363347

.cursor/rules/ci-e2e-testing.mdc

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ test.beforeAll(async ({ }, testInfo) => {
8383
- `showcase-operator`: General functionality tests with base deployment using Operator
8484
- `showcase-operator-rbac`: General functionality tests with RBAC-enabled deployment using Operator
8585
- `showcase-runtime`: Runtime environment tests
86+
- `showcase-runtime-db`: Runtime database tests
8687
- `showcase-sanity-plugins`: Plugin sanity checks
8788
- `showcase-upgrade`: Upgrade scenario tests
8889
- `showcase-localization-fr`: French localization tests
@@ -131,18 +132,18 @@ test.beforeAll(async ({ }, testInfo) => {
131132

132133
#### CI/CD Pipeline Execution
133134

134-
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via the `run_tests()` function in `.ci/pipelines/utils.sh`:
135+
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via `testing::run_tests()` in `.ci/pipelines/lib/testing.sh`:
135136

136137
```bash
137138
yarn playwright test --project="${playwright_project}"
138139
```
139140

140-
The namespace and Playwright project are decoupled, allowing flexible reuse. The `check_and_test()` and `run_tests()` functions accept an explicit `playwright_project` argument:
141+
The namespace and Playwright project are decoupled, allowing flexible reuse. The `testing::check_and_test()` and `testing::run_tests()` functions accept an explicit `playwright_project` argument:
141142

142143
```bash
143144
# Function signatures:
144-
check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
145-
run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
145+
testing::check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
146+
testing::run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
146147
```
147148

148149
#### Local Development Scripts
@@ -272,25 +273,7 @@ Check the readme at `.ci/pipelines/README.md`
272273

273274
### Cluster Pools
274275

275-
Available cluster pools for different OCP versions:
276-
277-
- **RHDH-4-19-US-EAST-2**
278-
- Usage: OCP v4.19 nightly jobs
279-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-19-0-amd64-aws-us-east-2_clusterpool.yaml)
280-
281-
- **RHDH-4-18-US-EAST-2**
282-
- Usage: OCP v4.18 nightly jobs
283-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-18-0-amd64-aws-us-east-2_clusterpool.yaml)
284-
285-
- **RHDH-4-17-US-EAST-2**
286-
- Usage: PR checks on main branch and OCP v4.17 nightly jobs
287-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-17-0-amd64-aws-us-east-2_clusterpool.yaml)
288-
289-
- **RHDH-4-16-US-EAST-2**
290-
- Usage: OCP v4.16 nightly jobs
291-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-16-0-amd64-aws-us-east-2_clusterpool.yaml)
292-
293-
**Note:** This is subject to change. Use `.ci/pipelines/README.md` as a source of truth.
276+
RHDH uses dedicated Hive cluster pools with the `rhdh` prefix on AWS `us-east-2`. Pool versions rotate as new OCP releases come out. Find the current list by filtering for `rhdh` in the [existing cluster pools](https://docs.ci.openshift.org/how-tos/cluster-claim/#existing-cluster-pools) page. See also `.ci/pipelines/README.md`.
294277

295278
### CI Job Types
296279

@@ -303,7 +286,7 @@ Available cluster pools for different OCP versions:
303286
#### Nightly Tests
304287
- **Schedule**: Automated nightly runs
305288
- **Environments**: Multiple OCP versions, AKS, GKE
306-
- **Reporting**: Slack notifications to `#rhdh-e2e-test-alerts`
289+
- **Reporting**: Slack notifications to `#rhdh-e2e-alerts`
307290

308291
### Test Execution Environment
309292

@@ -353,14 +336,15 @@ yarn prettier:fix # Fix formatting for shell, markdown, and YAML file
353336
- Functions may temporarily disable/re-enable error handling with `set +e` / `set -e` pattern
354337

355338
#### Job Handlers
356-
The main script handles different job types:
357-
- `handle_aks_helm`: AKS Helm deployment
358-
- `handle_eks_helm`: EKS Helm deployment
359-
- `handle_gke_helm`: GKE Helm deployment
360-
- `handle_ocp_operator`: OCP Operator deployment
361-
- `handle_ocp_nightly`: OCP nightly tests
362-
- `handle_ocp_pull`: OCP PR tests
339+
The main script dispatches to job-specific handlers in `.ci/pipelines/jobs/`:
340+
- `handle_aks_helm` / `handle_aks_operator`: AKS Helm/Operator deployment
341+
- `handle_eks_helm` / `handle_eks_operator`: EKS Helm/Operator deployment
342+
- `handle_gke_helm` / `handle_gke_operator`: GKE Helm/Operator deployment
343+
- `handle_ocp_nightly`: OCP Helm nightly tests (also handles OSD-GCP Helm)
344+
- `handle_ocp_operator`: OCP Operator nightly tests (also handles OSD-GCP Operator)
345+
- `handle_ocp_pull`: OCP PR checks
363346
- `handle_auth_providers`: Auth provider tests
347+
- `handle_ocp_helm_upgrade`: Upgrade scenario tests
364348

365349
#### Special Case: showcase-auth-providers Deployment
366350

.rulesync/rules/ci-e2e-testing.md

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ test.beforeAll(async ({ }, testInfo) => {
9494
- `showcase-operator`: General functionality tests with base deployment using Operator
9595
- `showcase-operator-rbac`: General functionality tests with RBAC-enabled deployment using Operator
9696
- `showcase-runtime`: Runtime environment tests
97+
- `showcase-runtime-db`: Runtime database tests
9798
- `showcase-sanity-plugins`: Plugin sanity checks
9899
- `showcase-upgrade`: Upgrade scenario tests
99100
- `showcase-localization-fr`: French localization tests
@@ -142,18 +143,18 @@ test.beforeAll(async ({ }, testInfo) => {
142143

143144
#### CI/CD Pipeline Execution
144145

145-
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via the `run_tests()` function in `.ci/pipelines/utils.sh`:
146+
In the CI/CD pipeline, tests are executed directly using Playwright's `--project` flag via `testing::run_tests()` in `.ci/pipelines/lib/testing.sh`:
146147

147148
```bash
148149
yarn playwright test --project="${playwright_project}"
149150
```
150151

151-
The namespace and Playwright project are decoupled, allowing flexible reuse. The `check_and_test()` and `run_tests()` functions accept an explicit `playwright_project` argument:
152+
The namespace and Playwright project are decoupled, allowing flexible reuse. The `testing::check_and_test()` and `testing::run_tests()` functions accept an explicit `playwright_project` argument:
152153

153154
```bash
154155
# Function signatures:
155-
check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
156-
run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
156+
testing::check_and_test "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}" [max_attempts] [wait_seconds]
157+
testing::run_tests "${RELEASE_NAME}" "${NAMESPACE}" "${PLAYWRIGHT_PROJECT}" "${URL}"
157158
```
158159

159160
#### Local Development Scripts
@@ -283,25 +284,7 @@ Check the readme at `.ci/pipelines/README.md`
283284

284285
### Cluster Pools
285286

286-
Available cluster pools for different OCP versions:
287-
288-
- **RHDH-4-19-US-EAST-2**
289-
- Usage: OCP v4.19 nightly jobs
290-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-19-0-amd64-aws-us-east-2_clusterpool.yaml)
291-
292-
- **RHDH-4-18-US-EAST-2**
293-
- Usage: OCP v4.18 nightly jobs
294-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-18-0-amd64-aws-us-east-2_clusterpool.yaml)
295-
296-
- **RHDH-4-17-US-EAST-2**
297-
- Usage: PR checks on main branch and OCP v4.17 nightly jobs
298-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-17-0-amd64-aws-us-east-2_clusterpool.yaml)
299-
300-
- **RHDH-4-16-US-EAST-2**
301-
- Usage: OCP v4.16 nightly jobs
302-
- [Cluster Pool Configuration](https://github.com/openshift/release/blob/master/clusters/hosted-mgmt/hive/pools/rhdh/rhdh-ocp-4-16-0-amd64-aws-us-east-2_clusterpool.yaml)
303-
304-
**Note:** This is subject to change. Use `.ci/pipelines/README.md` as a source of truth.
287+
RHDH uses dedicated Hive cluster pools with the `rhdh` prefix on AWS `us-east-2`. Pool versions rotate as new OCP releases come out. Find the current list by filtering for `rhdh` in the [existing cluster pools](https://docs.ci.openshift.org/how-tos/cluster-claim/#existing-cluster-pools) page. See also `.ci/pipelines/README.md`.
305288

306289
### CI Job Types
307290

@@ -314,7 +297,7 @@ Available cluster pools for different OCP versions:
314297
#### Nightly Tests
315298
- **Schedule**: Automated nightly runs
316299
- **Environments**: Multiple OCP versions, AKS, GKE
317-
- **Reporting**: Slack notifications to `#rhdh-e2e-test-alerts`
300+
- **Reporting**: Slack notifications to `#rhdh-e2e-alerts`
318301

319302
### Test Execution Environment
320303

@@ -364,14 +347,15 @@ yarn prettier:fix # Fix formatting for shell, markdown, and YAML file
364347
- Functions may temporarily disable/re-enable error handling with `set +e` / `set -e` pattern
365348

366349
#### Job Handlers
367-
The main script handles different job types:
368-
- `handle_aks_helm`: AKS Helm deployment
369-
- `handle_eks_helm`: EKS Helm deployment
370-
- `handle_gke_helm`: GKE Helm deployment
371-
- `handle_ocp_operator`: OCP Operator deployment
372-
- `handle_ocp_nightly`: OCP nightly tests
373-
- `handle_ocp_pull`: OCP PR tests
350+
The main script dispatches to job-specific handlers in `.ci/pipelines/jobs/`:
351+
- `handle_aks_helm` / `handle_aks_operator`: AKS Helm/Operator deployment
352+
- `handle_eks_helm` / `handle_eks_operator`: EKS Helm/Operator deployment
353+
- `handle_gke_helm` / `handle_gke_operator`: GKE Helm/Operator deployment
354+
- `handle_ocp_nightly`: OCP Helm nightly tests (also handles OSD-GCP Helm)
355+
- `handle_ocp_operator`: OCP Operator nightly tests (also handles OSD-GCP Operator)
356+
- `handle_ocp_pull`: OCP PR checks
374357
- `handle_auth_providers`: Auth provider tests
358+
- `handle_ocp_helm_upgrade`: Upgrade scenario tests
375359

376360
#### Special Case: showcase-auth-providers Deployment
377361

0 commit comments

Comments
 (0)