(fix): Bump control-plane for multi-resource catalog by jenniferubah · Pull Request #32 · dcm-project/cli

jenniferubah · 2026-09-16T20:07:54Z

Summary

Bump github.com/dcm-project/control-plane to a version with the multi-resource catalog schema
Remove top level service type field from catalog item schema
Add create tests that assert those fields reach the API

Fixes:
https://redhat.atlassian.net/browse/FLPATH-4853
https://redhat.atlassian.net/browse/FLPATH-4854

Assisted-By: Cursor AI

qodo-code-review · 2026-09-16T20:08:46Z

PR Summary by Qodo

Support multi-resource catalog payloads

🐞 Bug fix 🧪 Tests ⚙️ Configuration changes 🕐 10-20 Minutes

AI Description

• Upgrade control-plane schemas to support multi-resource catalog items and instances.
• Verify resource definitions and resource-scoped user values reach the catalog API.

Diagram

sequenceDiagram
  actor User
  participant CLI as Catalog CLI
  participant Schema as Generated Schema
  participant Client as API Client
  participant API as Control Plane
  User->>CLI: Create from YAML
  CLI->>Schema: Parse resource fields
  Schema-->>CLI: Typed request
  CLI->>Client: Submit request
  Client->>API: POST catalog payload
  API-->>Client: Creation response
  Client-->>CLI: Return result

High-Level Assessment

Upgrading the generated control-plane contract is the appropriate approach because the CLI already parses and submits its generated request types directly. Manually adding parallel payload structures or sending untyped maps would duplicate the API schema and risk future contract drift; focused serialization assertions appropriately guard the dependency-driven fix.

Files changed (4) +43 / -23

Tests (2) +22 / -2

catalog_instance_test.goVerify resource-scoped instance values are serialized +13/-2

Verify resource-scoped instance values are serialized
• Extends instance creation fixtures with a resource-scoped user value. The create test now verifies that catalog item ID, resource, path, and value fields reach the API request body.
internal/commands/catalog_instance_test.go

catalog_item_test.goVerify catalog item resources reach the API +9/-0

Verify catalog item resources reach the API
• Extends the catalog item create test to assert the generated request contains the resource name and service type under spec.resources.
internal/commands/catalog_item_test.go

Other (2) +21 / -21

go.modUpgrade control-plane schema dependency +7/-7

Upgrade control-plane schema dependency

• Bumps the control-plane module to a revision containing multi-resource catalog request schemas. Updates related golang.org/x indirect dependencies selected by the module graph.

go.mod

go.sumRefresh checksums for upgraded modules +14/-14

Refresh checksums for upgraded modules

• Replaces checksums for the previous control-plane revision and records the updated indirect golang.org/x module versions.

go.sum

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

qodo-code-review · 2026-09-16T20:11:10Z

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

1. ~~Multi-resource items hide service types~~ ⊘ Outdated 🐞 Bug ≡ Correctness

Description

catalogItemTableDef.RowFunc reads only spec.resources[0].service_type and emits a single
service-type cell. When the newly supported schema returns multiple resources, create, list, and get
table output omit every service type after the first while structured output retains them.

Code

go.mod[7]

+	github.com/dcm-project/control-plane v0.0.0-20260805143143-76ca1d7a6639

Evidence
The upgraded dependency activates multi-resource catalog items, while the shared table formatter
explicitly indexes only the first resource. All catalog-item table commands use this formatter, and
the added test fixture contains only one resource, so the omission remains untested.
go.mod[5-8]
internal/commands/catalog_item.go[15-35]
internal/commands/catalog_item.go[61-100]
internal/commands/catalog_item.go[123-170]
internal/commands/catalog_item.go[188-216]
internal/commands/catalog_item_test.go[23-30]
internal/commands/catalog_item_test.go[89-102]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The upgraded catalog schema supports multiple resources, but default catalog-item table output displays only the first resource's service type.

## Fix Focus Areas
- internal/commands/catalog_item.go[15-35]
- internal/commands/catalog_item_test.go[23-30]

## Recommended Fix
Update the catalog-item table row formatter to collect and render the service type from every resource, using an unambiguous plural header or formatted summary. Add create, list, and get coverage using an item with at least two resources.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

2. ~~Catalog examples show the old schema~~ ✓ Resolved 📘 Rule violation ⚙ Maintainability

Description

README.md still places catalog-item service_type and fields directly under spec and omits
resource from catalog-instance user values, while the upgraded create tests send spec.resources
entries and resource-qualified values. Users preparing --from-file input from either example
therefore submit the obsolete single-resource shape instead of the multi-resource payload exercised
against the API.

Code

internal/commands/catalog_item_test.go[R91-92]

+				resources, ok := spec["resources"].([]any)
+				Expect(ok).To(BeTrue(), "request body must include spec.resources")

Evidence
Compliance rule 2696907 requires behavior and API specification changes to be reflected in README or
AI documentation. The new assertions in the catalog-item create test establish that items serialize
a spec.resources array whose entries include resource names, service types, and fields, while the
catalog-instance create test establishes that user values serialize a resource field; the
corresponding README examples still show top-level item fields and resource-less user values.
Rule 2696907: Update AI documentation when changing behavior, config, or architecture
internal/commands/catalog_item_test.go[89-97]
internal/commands/catalog_instance_test.go[85-95]
README.md[425-444]
README.md[508-520]
internal/commands/catalog_item_test.go[89-102]
internal/commands/catalog_instance_test.go[85-100]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The dependency bump and updated create tests use multi-resource catalog payloads, but the catalog-item and catalog-instance README examples still document the previous single-resource structure.

## Fix Focus Areas
- README.md[425-444]
- README.md[508-520]
- internal/commands/catalog_item_test.go[89-102]
- internal/commands/catalog_instance_test.go[85-100]

## Recommended Fix
Rewrite the catalog-item example to use `spec.resources` entries containing resource names, service types, and their fields. Add the matching `resource` identifier to every catalog-instance `user_values` entry, preferably demonstrating values for multiple resources so both examples match the payloads exercised by the create tests.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Context sources

⚠️ Tickets: not configured — ticket URL found in PR but could not be fetched — check ticket provider credentials

✅ Compliance rules (platform): 16 rules

Review mode: ⚖️ Balanced: This is a localized dependency and test change, but it alters runtime dependency resolution and API payload coverage, warranting a careful single-pass review.

Tip of the day

💡 Did you know, you can type 'qodo, fix this' on a finding and the fix lands right on your PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jordigilh · 2026-09-17T15:27:48Z

 require (
 	github.com/coreos/go-oidc/v3 v3.20.0
-	github.com/dcm-project/control-plane v0.0.0-20260814135831-7c173134e932
+	github.com/dcm-project/control-plane v0.0.0-20260805143143-76ca1d7a6639


This change downgrades github.com/dcm-project/control-plane from the base branch’s 2026-08-14 commit to the older 2026-08-05 commit. The intervening history includes pagination, Helm credential/RBAC, and runtime-output changes, so this is not a dependency bump and may regress behavior already present on main. Please pin the current or a newer control-plane version.

Updated it to 2026-08-17 commit (ef5cf90) and not the latest version because the provider API is removed. That will be fixed in another PR

That will be fixed in another PR

another PR? Could you include it in this PR? At this point we should be mindful to reduce PRs and not expand. As of today I've calculated still open around 48 PRs across all dcm repos. Each PR require 2 engineers to review and approve plus address the changes (if found).

Repository Open PRs PR numbers

cli 1 #32

cnpg-database-service-provider 2 #2, #3

control-plane 8 #61, #62, #63, #64, #65, #66, #68, #70

dcm 9 #109–#117

dcm-project.github.io 2 #8, #22

enhancements 10 #43, #57, #58, #60, #94, #99, #104, #106, #107, #108

environment-agent 7 #34–#40

k8s-network-service-provider 2 #2, #3

k8s-storage-service-provider 2 #8, #9

shared-workflows 1 #37

utilities 4 #37, #44, #45, #49

Total 48

Okay, I can expand the scope of this PR. Will update it.
From your PR list, I don't think these repos should not be included:

dcm (used and managed by Chris)

k8s-network-service-provider - embedded, in-flight

k8s-storage-service-provider - embedded

cnpg-database-service-provider - embedded

Either way, I agree, we have a lot

So I checked the changes involved to update it to the latest and replace the provider API with the agent. It is a lot of changes that touches a lot of files which will slow down the review of this bugfix and block QE. So I'd rather do the changes in another PR, I won't create ithe PR right now as it is non blocking, while we reduce our PR backlog. Opened a jira ticket to track this: https://redhat.atlassian.net/browse/FLPATH-4895

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jordigilh

Second review summary

Substantive findings are posted inline below. The existing approval targets an older commit and does not establish approval of the current head. No direct cross-PR conflict was identified; the control-plane dependency and CLI examples must be validated together.

Verdict: Not GA-ready

jordigilh · 2026-09-18T00:55:27Z

 ```
-ID                UID                                   DISPLAY NAME      CREATED
-my-catalog-item   b2c3d4e5-f6a7-8901-bcde-f12345678901  Small Container   2026-03-09T10:00:00Z
+ID                UID                                   DISPLAY NAME        CREATED


The documented catalog-item table includes an ID column, but catalog_item.go emits UID, DISPLAY NAME, and CREATED without ID. Please update the example to match the actual CLI output or change the formatter and add an output-contract test.

Updated and added test: 654d515 and 0ad2494

jordigilh · 2026-09-18T00:55:27Z

 				Expect(body["display_name"]).To(Equal("Small Container"))
+				spec, ok := body["spec"].(map[string]any)
+				Expect(ok).To(BeTrue(), "request body must include spec")
+				resources, ok := spec["resources"].([]any)


This new test asserts exactly one resource, so a regression that drops additional resources or resource-specific values can still pass. Please add a two-resource case with distinct values.

+1
and the catalog item example in the README already defines two resources (app, db), so the test can mirror that

Updated the tests 0ad2494

jordigilh · 2026-09-18T00:55:27Z

-        - path: memory.size
-          display_name: "Memory (GB)"
+            type: string
+            pattern: '^[1-9][0-9]*m?$' 


The current diff contains trailing whitespace on this line, so git diff --check fails. Please remove it before merge.

Removed 654d515

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah · 2026-09-21T13:34:49Z

@jordigilh, @gciavarrini please can you take a look

jenniferubah requested a review from a team as a code owner September 16, 2026 20:07

jenniferubah requested review from LinskId, NoamNakash, gpb88, machacekondra and tkiss28 September 16, 2026 20:07

Bump control plane version + update test

5f5d685

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah force-pushed the fix/update-deps branch from 8fc8dd6 to 5f5d685 Compare September 16, 2026 20:09

qodo-code-review Bot reviewed Sep 16, 2026

View reviewed changes

Comment thread internal/commands/catalog_item_test.go

Comment thread go.mod Outdated

Update doc + remove top level service type in catalog item

ecb0549

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah requested review from ddmitrie, gabriel-farache and gciavarrini September 16, 2026 20:40

gciavarrini reviewed Sep 17, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread internal/commands/catalog_item.go

gabriel-farache approved these changes Sep 17, 2026

View reviewed changes

Update examples in readme

3d850ed

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah requested a review from gciavarrini September 17, 2026 14:29

Merge branch 'main' into fix/update-deps

3bf7d4c

jordigilh reviewed Sep 17, 2026

View reviewed changes

Comment thread README.md

jenniferubah added 2 commits September 17, 2026 12:06

Update control plane version

ef5cf90

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

Update readme

5d9c332

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah requested a review from jordigilh September 17, 2026 16:32

jordigilh reviewed Sep 18, 2026

View reviewed changes

jenniferubah added 2 commits September 18, 2026 11:06

removed trailing space

654d515

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

Updated test to cover composite resource

0ad2494

Assisted-By: Cursor AI Signed-off-by: Jennifer Ubah <[email protected]>

jenniferubah requested a review from jordigilh September 18, 2026 16:13

Repository	Open PRs	PR numbers
cli	1	#32
cnpg-database-service-provider	2	#2, #3
control-plane	8	#61, #62, #63, #64, #65, #66, #68, #70
dcm	9	#109–#117
dcm-project.github.io	2	#8, #22
enhancements	10	#43, #57, #58, #60, #94, #99, #104, #106, #107, #108
environment-agent	7	#34–#40
k8s-network-service-provider	2	#2, #3
k8s-storage-service-provider	2	#8, #9
shared-workflows	1	#37
utilities	4	#37, #44, #45, #49
Total	48

Conversation

jenniferubah commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

qodo-code-review Bot commented Sep 16, 2026

PR Summary by Qodo

Uh oh!

qodo-code-review Bot commented Sep 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review by Qodo

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jordigilh Sep 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenniferubah Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenniferubah Sep 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jordigilh left a comment

Choose a reason for hiding this comment

Second review summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenniferubah commented Sep 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jenniferubah commented Sep 16, 2026 •

edited

Loading

qodo-code-review Bot commented Sep 16, 2026 •

edited

Loading

jordigilh Sep 17, 2026 •

edited

Loading

jenniferubah Sep 18, 2026 •

edited

Loading

jenniferubah Sep 18, 2026 •

edited

Loading