Skip to content

docs(test-plans): replace removed /providers API with /agents and /catalog-items - #38

Merged
vkolodny merged 2 commits into
dcm-project:mainfrom
vkolodny:docs/tc08-provider-to-agent
Aug 21, 2026
Merged

docs(test-plans): replace removed /providers API with /agents and /catalog-items#38
vkolodny merged 2 commits into
dcm-project:mainfrom
vkolodny:docs/tc08-provider-to-agent

Conversation

@vkolodny

@vkolodny vkolodny commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Summary

control-plane#51 removed
the /providers endpoint entirely (replaced by agent-based architecture over NATS).

  • TC-08: rewrite from "Provider CRUD" to "Agent CRUD" (POST/GET /agents)
  • TC-02, TC-34: replace provider create/delete with agent registration
  • All other TCs: /providers/catalog-items as generic protected endpoint
  • TC-37/38: clarify step titles for SP-as-agent context
  • Add migration note documenting the API change

No functional test coverage lost — agent DELETE doesn't exist by design
(FK constraints preserve resource→agent history).

Test plan

  • N/A (documentation only)
  • Verified /catalog-items and /agents return 200 on live stack

@qodo-code-review

qodo-code-review Bot commented Aug 20, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can copy the agent prompt from any finding and feed it to your IDE agent

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Previous reviews

Review updated until commit 9c3e00d ⏭️ Skipped

Results up to commit 2ea37fb ⏭️ Skipped


No changes from previous review

Grey Divider

Qodo Logo

@vkolodny
vkolodny marked this pull request as draft August 20, 2026 01:24
@qodo-code-review

qodo-code-review Bot commented Aug 20, 2026

Copy link
Copy Markdown

PR Summary by Qodo

Migrate authentication test plan from providers to agents

📝 Documentation 🧪 Tests 🕐 10-20 Minutes

Grey Divider

AI Description

• Replaces removed /providers calls with /catalog-items for authentication checks.
• Reworks provider lifecycle scenarios around agent registration, listing, retrieval, and idempotent
 updates.
• Documents the agent API migration and intentional absence of agent deletion.
Diagram

graph TD
  A["Auth test cases"] --> B{"Validation goal"}
  B -->|Auth behavior| C["Catalog items API"] --> D["Auth responses"]
  B -->|Agent lifecycle| E["Agents API"] --> F["Agent records"]
Loading
High-Level Assessment

The endpoint split is appropriate: /catalog-items provides a stable protected read endpoint for generic authentication checks, while /agents directly covers the replacement management lifecycle. Reusing /agents everywhere would introduce unnecessary registration side effects, and retaining provider terminology would document a removed API. Omitting deletion checks correctly reflects the intentional lack of an agent DELETE endpoint.

Files changed (1) +90 / -105

Documentation (1) +90 / -105
FLPATH-3254-dcm-authentication-test-plan.mdMigrate authentication scenarios to catalog-items and agents APIs +90/-105

Migrate authentication scenarios to catalog-items and agents APIs

• Updates generic authentication checks to use '/catalog-items' instead of the removed '/providers' endpoint. Rewrites provider CRUD and service-provider scenarios around agent registration, listing, retrieval, and idempotent updates, while documenting that agents have no DELETE endpoint. Also advances the test plan to version 1.9 and records the API migration history.

test-plans/FLPATH-3254-dcm-authentication-test-plan.md

@vkolodny
vkolodny force-pushed the docs/tc08-provider-to-agent branch from 2ea37fb to 59d0c14 Compare August 20, 2026 01:44
@vkolodny vkolodny changed the title docs(test-plans): update TC-08 from Provider CRUD to Agent CRUD docs(test-plans): replace removed /providers API with /agents and /catalog-items Aug 20, 2026
…talog-items

control-plane#51 removed the /providers endpoint entirely (replaced by
agent-based architecture over NATS). Update the FLPATH-3254 auth test plan:

- TC-08: rewrite from "Provider CRUD" to "Agent CRUD" (POST/GET /agents)
- TC-02, TC-34: replace provider create/delete with agent registration
- All other TCs: /providers → /catalog-items as generic protected endpoint
- TC-37/38: clarify step titles for SP-as-agent context
- Add migration note documenting the API change

Signed-off-by: Vladislav Kolodny <vkolodny@redhat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Signed-off-by: Vladislav Kolodny <vkolodny@redhat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@vkolodny
vkolodny force-pushed the docs/tc08-provider-to-agent branch from 59d0c14 to 9c3e00d Compare August 20, 2026 01:53
@vkolodny
vkolodny marked this pull request as ready for review August 20, 2026 01:54
@qodo-code-review

Copy link
Copy Markdown

Code review by qodo was updated up to the latest commit 9c3e00d

#### Cleanup

None - provider deleted in step 5.
No DELETE endpoint for agents. Test agent remains in DB; subsystem tests use a fresh Postgres volume per run.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

However, this is a MANUAL test case (not just subsystem), so testers running this locally will accumulate test agents. The cleanup should provide a SQL DELETE statement or explain that running make compose-down -v removes the agent. The current text only addresses automated subsystem test runs. Can you double check?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

**Expected:** Token obtained.

**Step 2: Create a provider**
**Step 2: Register an agent**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This step egisters an agent named 'helm-smoke-agent' but doesn't verify whether an agent with that name already exists from a previous test run. Since there's no DELETE endpoint and agents persist, re-running this test will trigger the idempotent update path (HTTP 200) instead of creation (HTTP 201), causing the expected result to be wrong. Can you please double check?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

curl -s -H "Authorization: Bearer $TOKEN" http://localhost:8080/api/v1alpha1/agents | jq '.agents[] | {name, health_status}'
```

**Expected:** Registered SPs report ready/healthy via `health_status` (or documented known-unhealthy exceptions such as ACM SP GVK scheme issues tracked separately).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the description should be updated to reflect that we're polling agent health status, not provider health directly no?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

done

- TC-08 cleanup: add SQL DELETE for manual testers + compose-down note
- TC-08/TC-34: expected accepts 201 or 200 (idempotent re-registration)
- TC-38: fix expected text to say "agents" not "SPs"

Signed-off-by: Vladislav Kolodny <vkolodny@redhat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@vkolodny
vkolodny requested a review from gciavarrini August 20, 2026 14:39
@chadcrum

Copy link
Copy Markdown
Contributor

TC-02 Step 2 needs a quick update to match TC-08 and TC-34. Expected result currently only shows HTTP 201, but agent registration is idempotent by name — re-running returns HTTP 200. TC-08 and TC-34 already document this from earlier review feedback. Manual testers re-running TC-02 will see 200 and think it failed.

@chadcrum chadcrum left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@testetson22
testetson22 self-requested a review August 21, 2026 15:49
@vkolodny
vkolodny merged commit ec48b14 into dcm-project:main Aug 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants