fix: enforce # <skip-jira-utils-check> on Jira lines in CodeRabbit config

[rnetser]

What this PR does / why we need it:

The project's jira-utils checker validates Jira IDs across the codebase. When test docstrings include Jira: lines for traceability (not quarantine/xfail), those references trigger false positives unless they have a # <skip-jira-utils-check> inline comment.

This PR:

1. Adds a Jira skip-marker enforcement instruction to the .coderabbit.yaml "STP link required" custom check, so CodeRabbit flags any Jira: line in test docstrings that is missing # <skip-jira-utils-check> (HIGH severity). Only applies to Jira: lines — STP: and RFE: lines are unaffected.
2. Fixes the one existing violation in tests/observability/metrics/test_vms_metrics.py.

Which issue(s) this PR fixes:

Fixes #5257

Special notes for reviewer:

jira-ticket:

NONE

Co-authored-by: Claude noreply@anthropic.com

Summary by CodeRabbit

• Chores
  • Updated the code review configuration to strengthen documentation/traceability enforcement for newly added test docstrings, specifically requiring a Jira inline “skip” marker when a Jira traceability line is present.
• Documentation
  • Added the required Jira skip directive to a test docstring to satisfy the updated traceability rule.

[coderabbitai]

Warning

Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0f731b3d-b311-49b9-91dc-4d11471f31e3

📥 Commits

Reviewing files that changed from the base of the PR and between 710e386 and e9c6bc8.

📒 Files selected for processing (2)

• .coderabbit.yaml
• tests/observability/metrics/test_vms_metrics.py

---

📝 Walkthrough

Walkthrough

The PR extends the CodeRabbit "STP link required" custom check with a new HIGH-severity rule: any Jira: reference in test docstrings must include # <skip-jira-utils-check> inline. The rule does not apply to STP: or RFE: lines. A pre-existing violation in TestVmiSyncTotal is fixed by adding the required marker.

Changes

Jira Skip-Marker Rule and Compliance Fix

Layer / File(s)

Summary

Jira skip-marker rule definition and test fix .coderabbit.yaml, tests/observability/metrics/test_vms_metrics.py

Adds the Jira: skip-marker enforcement sub-rule (HIGH severity) to the STP link required custom check in .coderabbit.yaml, requiring # <skip-jira-utils-check> on the same line as any Jira: docstring reference in newly added tests. Simultaneously fixes the pre-existing violation on line 554 of test_vms_metrics.py by appending the skip marker to the CNV-80580 Jira reference in the TestVmiSyncTotal docstring.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• RedHatQE/openshift-virtualization-tests#4884: Both PRs update the .coderabbit.yaml custom "STP link required" CodeRabbit check for newly added test content—main PR extends it with a Jira-specific # <skip-jira-utils-check> marker requirement, so the changes are directly related at the same configuration/code-check level.
• RedHatQE/openshift-virtualization-tests#4980: Both PRs add/align the # <skip-jira-utils-check> inline marker on Jira: traceability lines in test/docstrings so the same Jira-utils linting rule treats those Jira annotations as skippable.
• RedHatQE/openshift-virtualization-tests#5122: Both PRs modify .coderabbit.yaml's STP/RFE/Jira docstring enforcement logic in CodeRabbit custom checks (the retrieved PR scopes/adjusts when STP/RFE/Jira requirements apply to newly added tests, while the main PR adds a Jira-specific # <skip-jira-utils-check> marker requirement on Jira: lines).

Suggested reviewers

• dshchedr
• vsibirsk
• RoniKishner

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title clearly describes the change (enforcing skip-jira-utils-check on Jira lines) and meets length requirement (<120 chars).
Description check	✅ Passed	Description includes all required sections: what/why, issue reference (#5257), special notes, and jira-ticket field (NONE). Content is detailed and substantive.
Linked Issues check	✅ Passed	PR addresses both objectives from #5257: adds Jira skip-marker enforcement to .coderabbit.yaml and fixes existing violation in test_vms_metrics.py.
Out of Scope Changes check	✅ Passed	All changes are scoped to linked issue #5257: two files modified, both directly addressing the enforcement requirement and existing violation.
Stp Link Required	✅ Passed	No new test files or test functions are added in this PR—only an existing test's docstring is modified to fix a Jira skip-marker compliance issue.

_{✏️ 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

Review ran into problems

🔥 Problems

Linked repositories: Your configuration references 1 linked repositories, but your current plan allows 0. Analyzed ``, skipped RedHatQE/openshift-virtualization-tests-design-docs.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[openshift-virtualization-qe-bot-5]

Report bugs in Issues

Welcome! 🎉

This pull request will be automatically processed with the following features:

🔄 Automatic Actions

• Reviewer Assignment: Reviewers are automatically assigned based on the OWNERS file in the repository root
• Size Labeling: PR size labels (XS, S, M, L, XL, XXL) are automatically applied based on changes
• Issue Creation: A tracking issue is created for this PR and will be closed when the PR is merged or closed
• Branch Labeling: Branch-specific labels are applied to track the target branch
• Auto-verification: Auto-verified users have their PRs automatically marked as verified
• Labels: Enabled categories: branch, can-be-merged, cherry-pick, has-conflicts, hold, needs-rebase, size, verified, wip

📋 Available Commands

PR Status Management

• /wip - Mark PR as work in progress (adds WIP: prefix to title)
• /wip cancel - Remove work in progress status
• /hold - Block PR merging (approvers only)
• /hold cancel - Unblock PR merging
• /verified - Mark PR as verified
• /verified cancel - Remove verification status
• /reprocess - Trigger complete PR workflow reprocessing (useful if webhook failed or configuration changed)
• /regenerate-welcome - Regenerate this welcome message
• /security-override - Set security check runs to pass (maintainers only)
• /security-override cancel - Re-run security checks

Review & Approval

• /lgtm - Approve changes (looks good to me)
• /approve - Approve PR (approvers only)
• /assign-reviewers - Assign reviewers based on OWNERS file
• /assign-reviewer @username - Assign specific reviewer
• /check-can-merge - Check if PR meets merge requirements

Testing & Validation

• /retest tox - Run Python test suite with tox
• /retest build-container - Rebuild and test container image
• /retest verify-bugs-are-open - verify-bugs-are-open
• /retest all - Run all available tests

Container Operations

• /build-and-push-container - Build and push container image (tagged with PR number)
  • Supports additional build arguments: /build-and-push-container --build-arg KEY=value

Cherry-pick Operations

• /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
  • Multiple branches: /cherry-pick branch1 branch2 branch3
• /cherry-pick-retry <branch> - Retry a failed cherry-pick (merged PRs only)

Branch Management

• /rebase - Rebase this PR branch onto its base branch

Label Management

• /<label-name> - Add a label to the PR
• /<label-name> cancel - Remove a label from the PR

✅ Merge Requirements

This PR will be automatically approved when the following conditions are met:

1. Approval: /approve from at least one approver
2. LGTM Count: Minimum 2 /lgtm from reviewers
3. Status Checks: All required status checks must pass
4. No Blockers: No wip, hold, has-conflicts labels and PR must be mergeable (no conflicts)
5. Verified: PR must be marked as verified

📊 Review Process

Approvers and Reviewers

Approvers:

• dshchedr
• myakove
• rnetser
• vsibirsk

Reviewers:

• OhadRevah
• RoniKishner
• albarker-rh
• dshchedr
• hmeir
• rlobillo
• rnetser
• vsibirsk

Available Labels

• hold
• verified
• wip
• lgtm
• approve

AI Features

• Cherry-Pick Conflict Resolution: Enabled (claude/claude-opus-4-6[1m])

Security Checks

• Suspicious Path Detection: Monitors paths: .claude/, .vscode/, .cursor/, .devcontainer/, .pi/, .github/workflows/, .github/actions/
• Committer Identity Check: Verifies last committer matches PR author
• Mandatory: Security checks block merge (use /security-override to bypass — maintainers only)

💡 Tips

• WIP Status: Use /wip when your PR is not ready for review
• Verification: The verified label is removed on new commits unless the push is detected as a clean rebase
• Cherry-picking: Cherry-pick labels are processed when the PR is merged
• Container Builds: Container images are automatically tagged with the PR number
• Permission Levels: Some commands require approver permissions
• Auto-verified Users: Certain users have automatic verification and merge privileges

For more information, please refer to the project documentation or contact the maintainers.

[OhadRevah]

/lgtm

[openshift-virtualization-qe-bot-3]

Clean rebase detected — no code changes compared to previous head (710e386).
The following labels were preserved: lgtm-OhadRevah, lgtm-coderabbitai[bot].

[rnetser]

/approve
/verified

[openshift-virtualization-qe-bot-3]

@coderabbitai

Test execution plan request details

CRITICAL: You MUST post an inline review comment on the first changed line of the first file.
The inline comment should contain the full Test Execution Plan (smoke decision, gating decision, and specific affected tests).
Do NOT submit a blocking review event (REQUEST_CHANGES/APPROVE).
Post a single inline PR comment on Files Changed (non-blocking COMMENT flow).

As an expert software testing engineer, analyze all modified files in this PR and create a targeted test execution plan.
You will post an inline review comment with the test execution plan on the first changed file.
If you fail to run or post a comment, retry.

Analysis Requirements:

1. Examine code changes in each modified file

2. Identify affected code paths, functions, and classes

3. Analyze pytest-specific elements: fixtures (scope, dependencies), parametrization, markers, conftest changes

4. Trace test dependencies through imports, shared utilities, fixture inheritance, fixture teardown, and yield from cleanup in conftest

5. Detect new tests introduced in the PR

6. Utilities and libs impact (when utilities/ or libs/ changes):
   You MUST use shell scripts (rg, git diff) to trace the full impact.
   Follow these sub-steps in order:

   6a. Identify modified symbols: For each changed file under utilities/ or libs/,
   list every modified function or method.
   Example: git diff HEAD~1 --unified=0 -- utilities/hco.py | grep '^[+-]def '

   6b. Find direct callers: Search tests and conftest for each symbol from 6a.
   Example: rg -l 'get_hco_version' tests/

   6c. Trace fixture teardown and cleanup: Find fixtures that reach
   the modified symbol through yield from or context-manager wrappers.
   Example: rg -l 'yield from.*enable_common_boot|def.*enable_common_boot' tests/

   6d. Trace same-file callers: In each changed file, find other functions
   whose body calls a modified symbol (including code after yield
   in @contextmanager helpers).
   Example: rg 'get_hco_version|enable_common_boot' utilities/hco.py

   6e. Expand transitively: If function A calls modified B, then
   tests/fixtures that call A are affected — even when the test body
   never imports B directly.

   Do NOT limit impact to tests that import the modified symbol only.

7. Smoke test impact: Intersect the affected set from step 6 with smoke-marked tests.
   Run: rg -l '@pytest.mark.smoke' tests/
   VERIFY the above command returned actual file paths before concluding False.
   Set True if either condition is met:

   • a smoke-marked file appears in the affected set from 6b-6e, OR
   • any conftest.py in the smoke test's parent-directory hierarchy (up to repo root)
     imports or calls a modified utilities/libs symbol — including autouse fixtures
     that depend on modified functions. ALL tests in that directory and below are affected.
     Example check: for each smoke_file, scan dirname(smoke_file)/conftest.py,
     dirname(dirname(smoke_file))/conftest.py, etc. for modified symbol imports
     and autouse fixtures that depend on modified symbols.

8. Gating test impact: Intersect the affected set from step 6 with gating-marked tests.
   Run: rg -l '@pytest.mark.gating' tests/
   Set True if a gating-marked file also appears in the affected set from 6b-6e.
   Utilities/libs changes often affect gating tests without affecting smoke tests.
   Do NOT stop analysis after concluding Run smoke tests: False.

Output rules:
Do NOT include analysis step numbers (1-8) in your visible output.

Your deliverable:
Your inline informational comment will be based on the following requirements:

Test Execution Plan

• Run smoke tests: True / False — If True, state the dependency path (test → fixture → changed symbol). True ONLY with a verified path.
• Run gating tests: True / False — If True, state the dependency path. True if any gating-marked test is in the affected set.
• Affected tests to run (required when utilities/, libs/, or shared conftest changes — list concrete paths even when smoke is False)

Use these formats:

• path/to/test_file.py - When the entire test file needs verification
• path/to/test_file.py::TestClass::test_method - When specific test(s) needed
• path/to/test_file.py::test_function - When specific test(s) needed
• -m marker - When a marker covers multiple affected tests (e.g. -m gating only if ALL gating tests in scope need run)
• Tag each listed test or group with its marker when not obvious, e.g. (gating) or (smoke)

Real test commands (MANDATORY when changes affect session/runtime code):

When the affected code runs at session/collection time (conftest fixtures, pytest plugins,
config hooks, session-scoped setup) or modifies runtime behavior that unit tests mock away,
you MUST include concrete pytest commands the PR author must run on a real cluster
to verify the change works end-to-end. Include:

• A command for the error/fix path (the scenario the PR fixes)
• A command for the happy path (regression: the normal case still works)
• Use lightweight tests (e.g., --collect-only for startup failures,
  a single small test for runtime behavior)
  If the PR only changes test logic (not utilities/libs/conftest), the affected test
  paths themselves serve as the real test commands — no separate section needed.

Example output for a session-startup fix:

**Real tests (cluster required)**
Error path (the fix):
`pytest tests/storage/.../test_foo.py --storage-class-matrix=nonexistent-sc --collect-only`
Expected: ValueError with clear message, not IndexError

Happy path (regression):
`pytest tests/storage/.../test_foo.py --storage-class-matrix=<valid-sc> -k test_bar`
Expected: session starts normally

Guidelines:

• Include tests affected directly OR via fixture setup/teardown, yield from cleanup, or transitive utility call chains (caller calls modified helper)
• Use a full file path only if ALL tests in that file require verification
• Use file path + test name when only specific tests use an affected fixture or utility wrapper (preferred for partial file impact)
• If a test marker can cover multiple files/tests, provide the marker
• Balance coverage vs over-testing - Keep descriptions minimal
• Example: if leaf helper foo() changes, include tests whose fixture teardown calls wrapper bar() where bar() calls foo(), even when the test body only imports an unrelated symbol from the same utilities module

Hardware-Related Checks (SR-IOV, GPU, DPDK):

When PR modifies fixtures for hardware-specific resources:

• Collection Safety: Fixtures MUST have existence checks (return None when hardware unavailable)
• Test Plan: MUST verify both WITH and WITHOUT hardware:
  • Run affected tests on cluster WITH hardware
  • Verify collection succeeds on cluster WITHOUT hardware

CRITICAL WORKFLOW COMPLETION RULES:

When responding to this test execution plan request, you MUST follow these rules EXACTLY:

1. YOUR ONLY DELIVERABLE: Post one non-blocking inline comment containing the test execution plan on the first changed line
2. THEN STOP IMMEDIATELY - Do NOT generate any additional response
3. FALLBACK ONLY: If inline comment API calls fail after retrying, post as a regular PR comment
4. SILENCE = SUCCESS: After successfully submitting the review, your task is complete. No confirmation needed.

ABSOLUTE PROHIBITIONS (violating these creates empty/meaningless reviews):

• ❌ Do NOT post acknowledgment messages like "Test execution plan posted", "Review posted successfully", "I've successfully posted"
• ❌ Do NOT mention review IDs, URLs, or confirmation of posting in the PR thread
• ❌ Do NOT add any follow-up comments after submitting the review
• ❌ Do NOT reply to confirm task completion
• ❌ Do NOT explain what you did - just do it and stop

Remember: The pull request review is visible to users. Additional comments are redundant noise.

CRITICAL — Verification rules for smoke and gating decisions:
- For each True decision, you must have traced a concrete path: test file → fixture → utility function → modified symbol.
- Do NOT assume impact based on scope, file proximity, or infrastructure-sounding names.
Only set True when you trace a concrete path through steps 6a-6e, then 7 or 8.
WRONG: "utilities/hco.py changed → run smoke" (no traced dependency path)
WRONG: "Run smoke tests: False" with no affected-test list when gating tests use the changed utility
RIGHT: "Run smoke tests: False, Run gating tests: True" plus tests/.../test_foo.py::TestBar::test_baz (gating)
RIGHT: "Smoke test X uses fixture Y → wrapper Z → changed function W in utilities/hco.py"

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get PR details to find first changed file and first changed line
gh pr view 5258 --repo RedHatQE/openshift-virtualization-tests --json files,headRefOid,baseRefOid

# Get the diff to find the position of the first changed line in .coderabbit.yaml
gh api repos/RedHatQE/openshift-virtualization-tests/pulls/5258/files | jq '.[0] | {filename, patch}'

Length of output: 1791

---

🏁 Script executed:

#!/bin/bash
# Post non-blocking inline review comment on the first changed line of .coderabbit.yaml
gh api repos/RedHatQE/openshift-virtualization-tests/pulls/5258/reviews \
  --method POST \
  --field commit_id="e9c6bc8eef52f24540b062bf798beaac6935d80e" \
  --field event="COMMENT" \
  --field body="" \
  --field "comments[][path]=.coderabbit.yaml" \
  --field "comments[][position]=5" \
  --field "comments[][body]=**Test Execution Plan**

**Run smoke tests: False**
No smoke-marked tests are affected. The changes are a YAML config update (`.coderabbit.yaml`) and a docstring-only edit in a test file — no runtime code, fixtures, utilities, or conftest files were modified.

**Run gating tests: False**
No gating-marked tests are affected for the same reason.

**Affected tests to run**
- \`tests/observability/metrics/test_vms_metrics.py::TestVmiSyncTotal\` — docstring-only change (added \`# <skip-jira-utils-check>\` inline marker to \`Jira:\` line); no test logic changed, no cluster run required."

Length of output: 2847

---

---

[vsibirsk]

/approve

[openshift-virtualization-qe-bot-5]

New container for quay.io/openshift-cnv/openshift-virtualization-tests:latest published