OPRUN-4612: Add E2E tests for ExperimentalListPackageCustomSchemas gRPC endpoint

[perdasilva]

Summary

• Adds E2E tests for the new api.ExperimentalRegistry/ExperimentalListPackageCustomSchemas streaming gRPC endpoint introduced in operator-registry#1981
• Builds custom FBC catalog images in-cluster using the opm base image from the catalog-operator deployment, following the opm-example.Dockerfile pattern (pre-populated cache with --cache-only)
• Tests the endpoint via port-forward to the CatalogSource pod using a lightweight Go gRPC client (protowire request encoding + structpb.Struct response decoding, no operator-registry dependency)

Test scenarios

• Schema + package returns expected custom schema FBC blobs (multiple results)
• Schema + nonexistent package returns empty stream
• Nonexistent schema returns empty stream
• Schema + empty package returns packageless custom schema blobs
• Missing x-acknowledge-experimental header returns empty stream

Test plan

• make bindata && make build && make update-metadata && make verify — all pass
• Ran against a live OpenShift cluster — all 5 scenarios pass (110s total)

🤖 Generated with Claude Code

Summary by CodeRabbit

• Tests
  • Added an end-to-end OLMv0 test suite covering the custom schema gRPC endpoint, asserting correct results for valid queries and empty results for nonexistent packages/schemas.
  • Added coverage for packageless (global) custom schema results and verified behavior when the experimental header is omitted.
  • Introduced supporting custom-schema fixtures and catalog image templates used by the test suite.
• Chores
  • Updated module dependency declarations (no functional behavior changes).

[openshift-ci-robot]

@perdasilva: This pull request explicitly references no jira issue.

Details

In response to this:

Summary

• Adds E2E tests for the new api.ExperimentalRegistry/ExperimentalListPackageCustomSchemas streaming gRPC endpoint introduced in operator-registry#1981
• Builds custom FBC catalog images in-cluster using the opm base image from the catalog-operator deployment, following the opm-example.Dockerfile pattern (pre-populated cache with --cache-only)
• Tests the endpoint via port-forward to the CatalogSource pod using a lightweight Go gRPC client (protowire request encoding + structpb.Struct response decoding, no operator-registry dependency)

Test scenarios

• Schema + package returns expected custom schema FBC blobs (multiple results)
• Schema + nonexistent package returns empty stream
• Nonexistent schema returns empty stream
• Schema + empty package returns packageless custom schema blobs
• Missing x-acknowledge-experimental header returns empty stream

Test plan

• make bindata && make build && make update-metadata && make verify — all pass
• Ran against a live OpenShift cluster — all 5 scenarios pass (110s total)

🤖 Generated with 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.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fe69ce1c-a5d5-4489-bb35-cec08ca53358

📥 Commits

Reviewing files that changed from the base of the PR and between 643a139 and 5c9d10a.

📒 Files selected for processing (8)

• tests-extension/.openshift-tests-extension/openshift_payload_olmv0.json
• tests-extension/go.mod
• tests-extension/pkg/bindata/qe/bindata.go
• tests-extension/test/qe/specs/olmv0_custom_schema.go
• tests-extension/test/qe/testdata/custom-schema/index.json
• tests-extension/test/qe/testdata/olm/custom-schema-buildconfig.yaml
• tests-extension/test/qe/testdata/olm/custom-schema-imagestream.yaml
• tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go

✅ Files skipped from review due to trivial changes (2)

• tests-extension/go.mod
• tests-extension/pkg/bindata/qe/bindata.go

🚧 Files skipped from review as they are similar to previous changes (5)

• tests-extension/test/qe/testdata/olm/custom-schema-buildconfig.yaml
• tests-extension/test/qe/testdata/olm/custom-schema-imagestream.yaml
• tests-extension/.openshift-tests-extension/openshift_payload_olmv0.json
• tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go
• tests-extension/test/qe/specs/olmv0_custom_schema.go

---

Walkthrough

This PR adds end-to-end testing for OLMv0 custom schema gRPC endpoints. It establishes gRPC as a direct dependency, embeds test fixtures in bindata, implements utilities for in-cluster catalog image building and gRPC port forwarding with a custom codec, and defines a test suite that validates custom schema queries across multiple scenarios including the requirement for the experimental header.

Changes

Custom Schema gRPC Testing

Layer / File(s)	Summary
Dependency and test case registration tests-extension/go.mod, .openshift-tests-extension/openshift_payload_olmv0.json	Promote google.golang.org/grpc and google.golang.org/protobuf from indirect to direct dependencies; register custom schema gRPC test case as a blocking Extended NonHyperShiftHOST test excluding external topology.
Test data fixtures tests-extension/test/qe/testdata/custom-schema/index.json, tests-extension/test/qe/testdata/olm/custom-schema-buildconfig.yaml, tests-extension/test/qe/testdata/olm/custom-schema-imagestream.yaml	Create OLM custom schema index with package, channel, bundle, and custom metadata entries (two package-scoped, one packageless/global); define parameterized OpenShift BuildConfig and ImageStream templates for catalog image construction.
Bindata asset embedding tests-extension/pkg/bindata/qe/bindata.go	Embed test fixtures as byte-slice payloads with accessor functions, registry entries in _bindata map, and bintree hierarchy nodes for runtime asset resolution.
gRPC codec and encoding tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go (lines 1–73)	Implement custom gRPC codec for raw request and struct response marshaling; provide protobuf wire-format encoding for ExperimentalListPackageCustomSchemasRequest with conditional schema and packageName fields.
gRPC infrastructure utilities tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go (lines 75–280)	Discover OPM base image from catalog-operator Deployment with fallback chain (JSON parsing, env var, container image); build in-cluster catalog images by applying templates, writing FBC, generating Dockerfile with opm serve and cache pre-warm, starting binary build, and polling until Complete; implement port-forwarding utility that discovers catalog pod, binds ephemeral port, and waits for readiness signal.
gRPC client operations tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go (lines 282–349)	Provide exported gRPC helpers for listing package custom schemas with optional experimental header support; implement streaming client that creates insecure gRPC connection, sends encoded requests via custom codec, receives and aggregates structpb.Struct responses, and wraps errors across connection, stream, send, close, and recv phases.
E2E test suite tests-extension/test/qe/specs/olmv0_custom_schema.go	Define Ginkgo test suite with per-spec initialization, environment skipping, and IR resource cleanup; implement slow test that builds custom catalog image with FBC fixture, deploys gRPC CatalogSource, port-forwards to endpoint, queries custom schemas across valid packages (expecting two results with blob names custom-metadata-1/custom-metadata-2), nonexistent schema/package (expecting empty), and packageless scenarios (expecting one result with global data["key"]), validates experimental header requirement, and operates within 60-second timeout.

Sequence Diagrams

sequenceDiagram
  participant Test as E2E Test
  participant OPMUtil as OPM Utilities
  participant BuildAPI as Build API
  participant CatalogPod as Catalog Pod
  participant gRPCNet as gRPC Network
  Test->>OPMUtil: GetOPMBaseImage()
  OPMUtil-->>Test: base image
  Test->>BuildAPI: BuildCustomCatalogImage()
  BuildAPI->>BuildAPI: Apply templates, write FBC,<br/>generate Dockerfile
  BuildAPI->>BuildAPI: Start build & poll until Complete
  BuildAPI-->>Test: image reference
  Test->>CatalogPod: PortForwardToCatalogPod()
  CatalogPod->>CatalogPod: Discover pod, bind port,<br/>wait for readiness
  CatalogPod-->>Test: localhost:port
  Test->>gRPCNet: ListPackageCustomSchemas()
  gRPCNet->>CatalogPod: insecure gRPC, custom codec
  gRPCNet->>CatalogPod: ExperimentalListPackageCustomSchemasRequest
  CatalogPod-->>gRPCNet: structpb.Struct stream
  gRPCNet->>gRPCNet: convert & aggregate results
  gRPCNet-->>Test: map[string]interface{} results
  Test->>gRPCNet: ListPackageCustomSchemasWithoutExperimentalHeader()
  gRPCNet-->>Test: empty results (header required)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~28 minutes

🚥 Pre-merge checks | ✅ 12 | ❌ 3

❌ Failed checks (3 warnings)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 42.86% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Test Structure And Quality	⚠️ Warning	Test has missing assertion messages: Line 50 o.Expect(baseImage).NotTo(o.BeEmpty()) lacks context message. Lines 54, 83, 100, 105, 121 also lack messages. Additionally, some assertions like lines...	Add descriptive messages to all error-checking Expect calls (e.g., o.Expect(baseImage).NotTo(o.BeEmpty(), "failed to retrieve opm base image from catalog-operator")). Ensure assertions on lines 54, 83, 92, 93, 100, 105, 121 include con...
Ipv6 And Disconnected Network Test Compatibility	⚠️ Warning	Test contains hardcoded IPv4 loopback: line 215 of custom_schema_grpc.go uses net.Listen("tcp", "127.0.0.1:0") instead of supporting both IPv4 and IPv6.	Replace net.Listen("tcp", "127.0.0.1:0") with net.Listen("tcp", "[::1]:0") for IPv6 or dynamically detect IP family. Alternatively, use net.Listen("tcp", ":0") to auto-bind to available loopback (IPv4 or IPv6).

✅ Passed checks (12 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly describes the main change: adding E2E tests for a specific gRPC endpoint (ExperimentalListPackageCustomSchemas).
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names	✅ Passed	All Ginkgo test names are stable and deterministic. The Describe block uses "[sig-operator][Jira:OLM] OLMv0 custom schema gRPC endpoint" and the It block uses "ExperimentalListPackageCustomSchemas...
Microshift Test Compatibility	✅ Passed	Test is protected from MicroShift via exutil.SkipMicroshift(oc) call in BeforeEach hook (line 29 of olmv0_custom_schema.go), preventing it from running on MicroShift clusters despite using unavaila...
Single Node Openshift (Sno) Test Compatibility	✅ Passed	The test makes no multi-node assumptions: it builds an image, creates a single CatalogSource pod, and port-forwards to it for gRPC queries—all compatible with Single Node OpenShift.
Topology-Aware Scheduling Compatibility	✅ Passed	PR adds test code only without modifying operator deployments or introducing scheduling constraints. Test fixtures (BuildConfig, ImageStream) contain no affinity/nodeSelector/tolerations. Test meta...
Ote Binary Stdout Contract	✅ Passed	No process-level stdout violations found. All new Go files follow OTE contract: no main/init/TestMain, no fmt.Print/klog to stdout, test logging via e2e.Logf (framework-captured).
No-Weak-Crypto	✅ Passed	No weak cryptographic algorithms (MD5, SHA1, DES, RC4, 3DES, Blowfish, ECB), custom crypto implementations, or non-constant-time secret comparisons found in the PR changes.
Container-Privileges	✅ Passed	No privileged container settings found in PR changes; manifests contain only BuildConfig, ImageStream templates, and test code without privilege-related configurations.
No-Sensitive-Data-In-Logs	✅ Passed	No sensitive data logging found. Logs contain image references, resource names, port-forward info, and test query results—all appropriate for E2E test debugging without exposing credentials, secret...

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Biome (2.5.0)

tests-extension/test/qe/testdata/custom-schema/index.json

File contains syntax errors that prevent linting: Line 2: End of file expected; Line 3: End of file expected; Line 4: End of file expected; Line 5: End of file expected; Line 6: End of file expected

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 5

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests-extension/.openshift-tests-extension/openshift_payload_olmv0.json`:
- Around line 645-659: The "name" field in the JSON entry currently contains a
placeholder Polarion ID ("PolarionID:XXXXX"); replace "XXXXX" with the actual
Polarion case identifier in the "name" value (e.g., PolarionID:12345 or your
project's canonical Polarion format) so downstream test tracking can correlate
this payload entry; update the string that begins with "[sig-operator][Jira:OLM]
OLMv0 custom schema gRPC endpoint PolarionID:XXXXX-..." to include the real ID
and verify the final name still follows existing naming conventions and escaping
(no extra brackets or quotes).

In `@tests-extension/test/qe/specs/olmv0_custom_schema.go`:
- Around line 43-53: The logs currently print full image references (baseImage
and imageRef) which can expose internal hostnames; update the logging around
olmv0util.GetOPMBaseImage (baseImage) and olmv0util.BuildCustomCatalogImage
(imageRef) to avoid emitting full refs — instead log the catalogName or a
redacted form (e.g., strip registry/host portion or replace with
"<redacted-registry>") and include contextual text; change the two e2e.Logf
calls that reference baseImage and imageRef to print only the safe identifier or
redacted string.
- Line 38: The test title string in the g.It call currently uses the placeholder
"PolarionID:XXXXX" — update that placeholder to the actual Polarion case ID
(e.g. replace "PolarionID:XXXXX" with "PolarionID:12345" or the correct
alphanumeric ID) while leaving the rest of the description
("-[Skipped:Disconnected]ExperimentalListPackageCustomSchemas returns custom
schema FBC [Slow]") intact so the test title meets the required
"PolarionID:xxxxx" format.

In `@tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go`:
- Around line 218-249: The port-forward readiness logic only watches scanner
output and a 30s timer, so early failures from cmd (exec.Command/Start) or
scanner errors are hidden; modify the code that creates and starts the
port-forward (the cmd variable and its Start call) to use a context (derive ctx
with timeout) and bind cmd to that context, and add channels to capture
cmd.Wait() errors and scanner.Scan() errors (e.g., an errCh alongside ready)
then change the select to wait on ready, errCh (receiving scanner or cmd.Wait
errors) and the time.After case so failures are surfaced immediately with the
real error instead of a generic timeout. Ensure you still kill/cleanup the
process on errors/timeouts.
- Around line 122-190: Change BuildCustomCatalogImage to accept a
context.Context and return an error instead of hard-asserting inside it: remove
o.Expect(...) calls and propagate errors from ApplyResourceFromTemplate,
os.MkdirTemp, os.WriteFile, the start-build Output() call, and the
wait.PollUntilContextTimeout call by returning them to the caller; use the
passed-in ctx for polling/timeout (replace wait.PollUntilContextTimeout with a
ctx-aware wait call, e.g., wait.PollUntilContext or use context.WithTimeout(ctx,
...)) and for any command execution
(oc.AsAdmin().WithoutNamespace().Run(...)).Output() error handling so the caller
can register cleanup before invoking BuildCustomCatalogImage and can
cancel/timeout the whole build lifecycle.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 716dc4ad-8e46-4b1c-b239-87cc49d6a8a2

📥 Commits

Reviewing files that changed from the base of the PR and between 3eb1354 and a1949bc.

📒 Files selected for processing (8)

• tests-extension/.openshift-tests-extension/openshift_payload_olmv0.json
• tests-extension/go.mod
• tests-extension/pkg/bindata/qe/bindata.go
• tests-extension/test/qe/specs/olmv0_custom_schema.go
• tests-extension/test/qe/testdata/custom-schema/index.json
• tests-extension/test/qe/testdata/olm/custom-schema-buildconfig.yaml
• tests-extension/test/qe/testdata/olm/custom-schema-imagestream.yaml
• tests-extension/test/qe/util/olmv0util/custom_schema_grpc.go

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-4.22-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1 5

[openshift-ci-robot]

@perdasilva: This pull request references OPRUN-4612 which is a valid jira issue.

Details

In response to this:

Summary

• Adds E2E tests for the new api.ExperimentalRegistry/ExperimentalListPackageCustomSchemas streaming gRPC endpoint introduced in operator-registry#1981
• Builds custom FBC catalog images in-cluster using the opm base image from the catalog-operator deployment, following the opm-example.Dockerfile pattern (pre-populated cache with --cache-only)
• Tests the endpoint via port-forward to the CatalogSource pod using a lightweight Go gRPC client (protowire request encoding + structpb.Struct response decoding, no operator-registry dependency)

Test scenarios

• Schema + package returns expected custom schema FBC blobs (multiple results)
• Schema + nonexistent package returns empty stream
• Nonexistent schema returns empty stream
• Schema + empty package returns packageless custom schema blobs
• Missing x-acknowledge-experimental header returns empty stream

Test plan

• make bindata && make build && make update-metadata && make verify — all pass
• Ran against a live OpenShift cluster — all 5 scenarios pass (110s total)

🤖 Generated with Claude Code

Summary by CodeRabbit

• Tests
• Added an end-to-end test suite covering the OLMv0 custom schema gRPC endpoint, including validation for valid schema/package queries and expected empty results for missing or omitted experimental headers.
• Added supporting test fixtures and templates (catalog image buildconfig, imagestream, and custom-schema index data).
• Extended bundled test assets to include the new custom-schema templates and index.
• Added a new test-case entry to the OLMv0 payload for “OLMv0 custom schema gRPC endpoint”.
• Chores
• Updated module dependency declarations.

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.

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-4.23-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1 5

[openshift-ci]

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

• periodic-ci-openshift-operator-framework-olm-release-4.23-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/5e4bb090-6968-11f1-8793-d0e475f5b38e-0

[pedjak]

/lgtm

[fgiudici]

/lgtm

[fgiudici]

/lgtm

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fgiudici, perdasilva

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• DOWNSTREAM_OWNERS [perdasilva]

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

[perdasilva]

/retest

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-4.23-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1

[openshift-ci]

@perdasilva: it appears that you have attempted to use some version of the payload command, but your comment was incorrectly formatted and cannot be acted upon. See the docs for usage info.

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-4.23-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1 5

[openshift-ci]

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

• periodic-ci-openshift-operator-framework-olm-release-4.23-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/80e2a970-6b06-11f1-982e-48bf0d2c8aae-0

[perdasilva]

/retest

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-5.0-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1 5

[openshift-ci]

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

• periodic-ci-openshift-operator-framework-olm-release-5.0-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/015222e0-6b28-11f1-9caf-7b16c2a0784f-0

[perdasilva]

/retest

[perdasilva]

/retest

[perdasilva]

/retest

[perdasilva]

/retest

[perdasilva]

/payload-aggregate periodic-ci-openshift-operator-framework-olm-release-5.0-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1 10

[openshift-ci]

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

• periodic-ci-openshift-operator-framework-olm-release-5.0-periodics-e2e-gcp-ovn-ipi-disconnected-extended-f1

See details on https://pr-payload-tests.ci.openshift.org/runs/ci/d3bb32b0-6edb-11f1-9922-4fe9053d891e-0

[openshift-ci]

New changes are detected. LGTM label has been removed.

[openshift-ci]

@perdasilva: 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-gcp-ovn	5c9d10a	link	true	/test e2e-gcp-ovn

Full PR test history. Your PR dashboard.

Details

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.