Skip to content

Conversation

@kuiwang02
Copy link
Contributor

/cc @jianzhangbjz @Xia-Zhao-rh @bandrade

Add AI Agent Documentation for OLM v1 QE Test Extension

Summary

This PR adds comprehensive AI agent documentation to the OLM v1 QE test extension. The documentation enables AI coding assistants (particularly Claude Code) to effectively develop, debug, and maintain OLM v1 QE test cases by providing them with detailed context about the test framework, migration guidelines, suite definitions, and best practices.

Changes

New Files Created

1. AGENTS.md (587 lines)

Comprehensive guide for AI agents working with OLM v1 QE test code, including:

2. CLAUDE.md (1 line)

Auto-load directive for Claude Code:

@AGENTS.md

This tells Claude Code to automatically load AGENTS.md when working in the test/qe/ directory.

Modified Files

3. README.md (129 insertions, 71 deletions)

Added:

  • Title: "# OLM v1 QE Test Extension"
  • AI agent reference block at the top with Claude Code usage instructions
  • References README.md and cmd/main.go as source of truth for suite definitions

Optimized:

  • Suites for Custom Prow jobs section: Replaced detailed Go code (60+ lines) with:
    • Reference to cmd/main.go (lines 103-209) as source of truth
    • Suite hierarchy diagram
    • Key relationships explanation
    • Helper functions reference to filters.go
    • Saved: ~38 lines of duplicated code

Benefits:

  • Single source of truth: cmd/main.go
  • Easier maintenance: updates only needed in one place
  • Clearer structure: hierarchy diagram more readable than raw code

4. specs/olmv1_cc.go (1 line)

Minor formatting fix (unrelated to main changes)

Assisted-by: Claude Code

@openshift-ci-robot
Copy link

openshift-ci-robot commented Dec 2, 2025

@kuiwang02: This pull request references OCPQE-31063 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.21.0" version, but no target version was set.

In response to this:

/cc @jianzhangbjz @Xia-Zhao-rh @bandrade

Add AI Agent Documentation for OLM v1 QE Test Extension

Summary

This PR adds comprehensive AI agent documentation to the OLM v1 QE test extension. The documentation enables AI coding assistants (particularly Claude Code) to effectively develop, debug, and maintain OLM v1 QE test cases by providing them with detailed context about the test framework, migration guidelines, suite definitions, and best practices.

Changes

New Files Created

1. AGENTS.md (587 lines)

Comprehensive guide for AI agents working with OLM v1 QE test code, including:

2. CLAUDE.md (1 line)

Auto-load directive for Claude Code:

@AGENTS.md

This tells Claude Code to automatically load AGENTS.md when working in the test/qe/ directory.

Modified Files

3. README.md (129 insertions, 71 deletions)

Added:

  • Title: "# OLM v1 QE Test Extension"
  • AI agent reference block at the top with Claude Code usage instructions
  • References README.md and cmd/main.go as source of truth for suite definitions

Optimized:

  • Suites for Custom Prow jobs section: Replaced detailed Go code (60+ lines) with:
  • Reference to cmd/main.go (lines 103-209) as source of truth
  • Suite hierarchy diagram
  • Key relationships explanation
  • Helper functions reference to filters.go
  • Saved: ~38 lines of duplicated code

Benefits:

  • Single source of truth: cmd/main.go
  • Easier maintenance: updates only needed in one place
  • Clearer structure: hierarchy diagram more readable than raw code

4. specs/olmv1_cc.go (1 line)

Minor formatting fix (unrelated to main changes)

Assisted-by: Claude Code

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Dec 2, 2025
@kuiwang02
Copy link
Contributor Author

/payload-aggregate periodic-ci-openshift-operator-framework-operator-controller-release-4.21-periodics-e2e-aws-ovn-techpreview-extended-f1 5

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 2, 2025

@kuiwang02: trigger 1 job(s) for the /payload-(with-prs|job|aggregate|job-with-prs|aggregate-with-prs) command

  • periodic-ci-openshift-operator-framework-operator-controller-release-4.21-periodics-e2e-aws-ovn-techpreview-extended-f1

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/22524710-cf31-11f0-9cd8-2d3829e4d2c6-0

@kuiwang02
Copy link
Contributor Author

/verified by @kuiwang02

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Dec 2, 2025
@openshift-ci-robot
Copy link

@kuiwang02: This PR has been marked as verified by @kuiwang02.

In response to this:

/verified by @kuiwang02

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 openshift-eng/jira-lifecycle-plugin repository.

**Common Debugging Commands**:
```bash
# Check resource status
oc get clusterextension -A
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it need the -A?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. updated.

**Essential pattern for AI agents**:
1. Build: `make bindata && make build && make update-metadata`
2. Find test: `./bin/olmv1-tests-ext list -o names | grep <keyword>`
3. Run locally: `./bin/olmv1-tests-ext run-test "<full test name>"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess it should be ./bin/olmv1-tests-ext run-test -n "<full test name>".

jiazha-mac:tests-extension jiazha$ ./bin/olmv1-tests-ext run-test -h
Runs tests by name

Usage:
   run-test [-n NAME...] [NAME] [flags]

Flags:
      --component string      specify the component to enable (default "default")
  -h, --help                  help for run-test
  -c, --max-concurrency int   maximum number of tests to run in parallel (default 10)
  -n, --names stringArray     specify test name (can be specified multiple times)
  -o, --output string         output mode (default "json")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the command is correct. for example

kuiwang@kuiwang-mac tests-extension % ./bin/olmv1-tests-ext run-test "[sig-olmv1][Jira:OLM] OLM v1 for stress PolarionID:81509-[OTP][Skipped:Disconnected][OlmStress]olmv1 create mass operator to see if they all are installed successfully [Slow][Timeout:330m]"
  [INFO] [env] Using kubeconfig: /Users/kuiwang/work/bin/jb/kubeconf/kubeconfig
  [INFO] [env] Cluster environment initialized (OpenShift: true)
  I1118 13:58:33.916388 1680 test_context.go:567] The --provider flag is not set. Continuing as if --provider=skeleton had been used.
  Running Suite:  - /Users/kuiwang/GoProject/go-origin/src/github.com/openshift/operator-framework-operator-controller/openshift/tests-extension
  ==============================================================================================================================================
  Random Seed: 1763445510 - will randomize all specs

  Will run 1 of 1 specs
  ------------------------------
  [sig-olmv1][Jira:OLM] OLM v1 for stress PolarionID:81509-[OTP][Skipped:Disconnected][OlmStress]olmv1 create mass operator to see if they all are installed successfully [Slow][Timeout:330m] [StressTest, NonHyperShiftHOST]
  /Users/kuiwang/GoProject/go-origin/src/github.com/openshift/operator-framework-operator-controller/openshift/tests-extension/test/qe/specs/olmv1_stress.go:29
    STEP: Creating a kubernetes client @ 11/18/25 13:58:33.918
  I1118 13:58:38.927813 1680 client.go:729] Running 'oc --kubeconfig=/Users/kuiwang/work/bin/jb/kubeconf/kubeconfig explain template.apiVersion'
  I1118 13:58:44.197318 1680 olmv1_stress.go:58] Start time: 2025-11-18T05:58:44Z
...
  namespace "ns-81509-900" deleted
  • [120.296 seconds]
  ------------------------------

  Ran 1 of 1 Specs in 120.297 seconds
  SUCCESS! -- 1 Passed | 0 Failed | 0 Pending | 0 Skipped

@openshift-ci-robot openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Dec 2, 2025
@kuiwang02
Copy link
Contributor Author

/verified by @kuiwang02

@openshift-ci-robot openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Dec 2, 2025
@openshift-ci-robot
Copy link

@kuiwang02: This PR has been marked as verified by @kuiwang02.

In response to this:

/verified by @kuiwang02

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 openshift-eng/jira-lifecycle-plugin repository.

@jianzhangbjz
Copy link
Member

/approve
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 2, 2025
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 2, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jianzhangbjz, kuiwang02

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:

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 2, 2025
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Dec 2, 2025

@kuiwang02: all tests passed!

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-merge-bot openshift-merge-bot bot merged commit 496965e into openshift:main Dec 2, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. verified Signifies that the PR passed pre-merge verification criteria

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants