Skip to content

SRVOCF-1070: Update TESTING.md and AGILE.md documentation - #175

Merged
openshift-merge-bot[bot] merged 1 commit into
openshift:masterfrom
twoGiants:SRVOCF-1070-update-testingmd-and-agilemd-documentation
Sep 2, 2026
Merged

SRVOCF-1070: Update TESTING.md and AGILE.md documentation#175
openshift-merge-bot[bot] merged 1 commit into
openshift:masterfrom
twoGiants:SRVOCF-1070-update-testingmd-and-agilemd-documentation

Conversation

@twoGiants

@twoGiants twoGiants commented Sep 1, 2026

Copy link
Copy Markdown

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:

  • Add cross-cutting test double terminology table (stub, fake, mock, spy) with frontend and backend examples
  • Document the page-first testing approach: no test doubles for components or hooks, only for external boundaries
  • Document shared test infrastructure in src/common/testing/ and backend stubs next to their interfaces
  • Document the two-boundary test double strategy (MSW for backend API, self-written stubs for OCP SDK)
  • Add allowed/forbidden vi.mock patterns with real examples from FunctionsListPage.test.tsx
  • Add AAA example, renderHook usage for hook tests, server.boundary() for infinite delays
  • Update e2e section: fake GitHub server, new helpers, updated file structure, removed stale page.route section
  • Fix incorrect backend stub type names (scmStub to scm.ClientStub, add functions.ClientStub)

Changes to AGILE.md:

  • Replace old ceremony schedule with: Tue+Thu weekly syncs, biweekly backlog grooming, review+planning on iteration-end Thu, retrospective on iteration-start Tue
  • Simplify facilitator duties to match

Fixes SRVOCF-1070

Checklist

  • Updated docs/ARCHITECTURE.md (if there are relevant changes to our layered architecture)
  • Updated docs/TESTING.md (if there are relevant changes to our testing framework or setup)

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>
@openshift-merge-bot

Copy link
Copy Markdown

Pipeline controller notification
This repo is configured to use the pipeline controller. Second-stage tests will be triggered either automatically or after lgtm label is added, depending on the repository configuration. The pipeline controller will automatically detect which contexts are required and will utilize /test Prow commands to trigger the second stage.

For optional jobs, comment /test ? to see a list of all defined jobs. To trigger manually all jobs from second stage use /pipeline required command.

This repository is configured in: LGTM mode

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 1, 2026
@openshift-ci-robot

openshift-ci-robot commented Sep 1, 2026

Copy link
Copy Markdown

@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.

Details

In response to this:

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:

  • Add cross-cutting test double terminology table (stub, fake, mock, spy) with frontend and backend examples
  • Document the page-first testing approach: no test doubles for components or hooks, only for external boundaries
  • Document shared test infrastructure in src/common/testing/ and backend stubs next to their interfaces
  • Document the two-boundary test double strategy (MSW for backend API, self-written stubs for OCP SDK)
  • Add allowed/forbidden vi.mock patterns with real examples from FunctionsListPage.test.tsx
  • Add AAA example, renderHook usage for hook tests, server.boundary() for infinite delays
  • Update e2e section: fake GitHub server, new helpers, updated file structure, removed stale page.route section
  • Fix incorrect backend stub type names (scmStub to scm.ClientStub, add functions.ClientStub)

Changes to AGILE.md:

  • Replace old ceremony schedule with: Tue+Thu weekly syncs, biweekly backlog grooming, review+planning on iteration-end Thu, retrospective on iteration-start Tue
  • Simplify facilitator duties to match

Fixes SRVOCF-1070

Checklist

  • Updated docs/ARCHITECTURE.md (if there are relevant changes to our layered architecture)
  • Updated docs/TESTING.md (if there are relevant changes to our testing framework or setup)

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.

@twoGiants
twoGiants requested review from Cragsmann and a lite review from Copilot and removed request for matejvasek September 2, 2026 10:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 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.md with updated test double terminology, frontend and backend testing strategy, and current e2e structure.
  • Update docs/AGILE.md to match the new ceremony schedule and simplified facilitator duties.
  • Add a docs/TESTING.md checklist 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.

Comment thread docs/AGILE.md
- 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.
Comment thread docs/TESTING.md

## 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.
@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Sep 2, 2026
@openshift-merge-bot

Copy link
Copy Markdown

Pipeline controller notification

No second-stage tests were triggered for this PR.

This can happen when:

  • The changed files don't match any pipeline_run_if_changed patterns
  • All files match pipeline_skip_if_only_changed patterns
  • No pipeline-controlled jobs are defined for the master branch

Use /test ? to see all available tests.

@openshift-ci

openshift-ci Bot commented Sep 2, 2026

Copy link
Copy Markdown

[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

Details 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 Sep 2, 2026
@openshift-ci

openshift-ci Bot commented Sep 2, 2026

Copy link
Copy Markdown

@twoGiants: all tests passed!

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.

@openshift-merge-bot
openshift-merge-bot Bot merged commit 0f94cd1 into openshift:master Sep 2, 2026
4 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants