SRVOCF-1070: Update TESTING.md and AGILE.md documentation - #175
Conversation
TESTING.md was out of date after the SRVOCF-822 test infrastructure refactoring (PRs openshift#144, openshift#149, openshift#155). The doc still described mocking components and hooks with vi.mock, referenced deleted files (testing/msw/, mocks/github.ts), and used "mock" as a catch-all term for all test doubles. Restructure the doc around how we actually test now: page tests render real components and hooks, replacing only external boundaries (backend API via MSW, OCP SDK via self-written stubs). Add a cross-cutting terminology table (stub, fake, mock, spy) with examples from both frontend and backend. Document the shared test infrastructure in src/common/testing/ and the backend stubs next to their interfaces. Remove the component mocking examples and state that mocking components or hooks is a design issue. Update the e2e section to reflect the fake GitHub server, new helpers, and removed page.route patterns. AGILE.md sync ceremonies replaced with the new schedule: Tue+Thu weekly syncs, biweekly backlog grooming, review before planning on iteration-end Thu, retrospective on iteration-start Tue. Issue SRVOCF-1070 Signed-off-by: Stanislav Jakuschevskij <sjakusch@redhat.com>
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
|
@twoGiants: This pull request references SRVOCF-1070 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 story to target the "5.1.0" version, but no target version was set. DetailsIn response to this:
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. |
There was a problem hiding this comment.
🟡 Changes recommended
There are documentation inconsistencies that can mislead contributors about the current e2e GitHub boundary and refinement ceremony handling.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates project documentation to reflect the post SRVOCF-822 testing infrastructure and current team sync cadence, and it adds a docs checklist item to the PR template.
Changes:
- Refresh
docs/TESTING.mdwith updated test double terminology, frontend and backend testing strategy, and current e2e structure. - Update
docs/AGILE.mdto match the new ceremony schedule and simplified facilitator duties. - Add a
docs/TESTING.mdchecklist item to.github/pull_request_template.md.
File summaries
| File | Description |
|---|---|
| docs/TESTING.md | Updates testing guidance to match the current shared test infrastructure and e2e approach. |
| docs/AGILE.md | Updates ceremony schedule details and facilitator duties. |
| .github/pull_request_template.md | Adds a checklist item prompting updates to docs/TESTING.md when relevant. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - Each engineer selects refined stories from the backlog for the upcoming 3 weeks. | ||
| - Stories must be refined before entering an iteration; otherwise, they return to refinement. | ||
| - Engineers volunteer to take unrefined stories for refinement during the upcoming iteration. | ||
| - Status sync first, then technical discussion. |
|
|
||
| ## E2E Tests | ||
|
|
||
| E2E tests run against a real OpenShift cluster. GitHub API calls are intercepted with `page.route()` mocks, while K8s API calls go to the real cluster. Each test file covers a single use case, exercising a flow from start to finish with `test.step` for structure. |
|
Pipeline controller notification No second-stage tests were triggered for this PR. This can happen when:
Use |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Cragsmann The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@twoGiants: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
Summary
TESTING.md was out of date after the SRVOCF-822 test refactoring. It still described mocking components and hooks with vi.mock, referenced deleted files (testing/msw/, mocks/github.ts), and used "mock" as a catch-all term for all test doubles.
Changes to TESTING.md:
Changes to AGILE.md:
Fixes SRVOCF-1070
Checklist
docs/ARCHITECTURE.md(if there are relevant changes to our layered architecture)docs/TESTING.md(if there are relevant changes to our testing framework or setup)