Skip to content

utils: add client to create_dv and assert_pvc_snapshot_clone_annotation#5120

Open
RoniKishner wants to merge 1 commit into
RedHatQE:mainfrom
RoniKishner:client-util
Open

utils: add client to create_dv and assert_pvc_snapshot_clone_annotation#5120
RoniKishner wants to merge 1 commit into
RedHatQE:mainfrom
RoniKishner:client-util

Conversation

@RoniKishner

@RoniKishner RoniKishner commented Jun 3, 2026

Copy link
Copy Markdown
Contributor
What this PR does / why we need it:

Missing client on files causes warning:

openshift-virtualization-tests/.venv/lib64/python3.14/site-packages/ocp_resources/resource.py:1636: FutureWarning: 'client' arg will be mandatory in the next major release. `config_file` and `context` args will be removed.
    super().__init__(

This PR fixes the warning for create_dv and assert_pvc_snapshot_clone_annotation

Which issue(s) this PR fixes:

FutureWarning showing

Special notes for reviewer:
jira-ticket:

NONE

Summary by CodeRabbit

  • Tests

    • Updated test utilities to use the test cluster client when validating storage-related behavior, improving consistency and reliability.
  • Chores

    • Adjusted storage helper logic to retrieve secrets and config from the provided test client/namespace, ensuring correct cluster-scoped configuration handling.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 8b80bace-63e7-438e-9ff0-c2bb49c4db22

📥 Commits

Reviewing files that changed from the base of the PR and between e77c27d and 9618a26.

📒 Files selected for processing (2)
  • tests/storage/utils.py
  • utilities/storage.py
📜 Recent review details
🧰 Additional context used
📓 Path-based instructions (4)
**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

**/*.py: Never add linter suppressions like # noqa, # type: ignore, or # pylint: disable. Fix the code instead. If you believe a rule is wrong, ask the user for explicit approval.
Search the codebase for existing implementations before writing new code. Check utilities/, libs/, tests/, and pyproject.toml dependencies. Never duplicate logic—extract to shared modules. Use pyhelper_utils.shell.run_command for shell commands instead of subprocess.run, and use ocp-resources classes instead of raw YAML dicts.
Type hints are MANDATORY. Use mypy strict mode in libs/ and all new public functions under utilities. Use TYPE_CHECKING for type-only imports to avoid runtime overhead and circular imports.
Write Google-format docstrings for all public functions with non-obvious return values or side effects.
Always use uv run to execute commands. Never execute python, pip, pytest, tox, or pre-commit directly. Use uv run python, uv run pytest, uv run tox, uv run pre-commit, and uv add for package installation.
Always use absolute imports. Never use relative imports.
Prefer specific imports using from module import func for functions and constants. Use from package import module (then module.Name) when retaining the module name meaningfully improves readability. Never use bare import module without a from clause.
Always use named arguments for function calls with more than one argument.
Never use single-letter variable names. Always use descriptive, meaningful names.
No dead code. Every function, variable, and fixture must be used or removed. Code marked with # skip-unused-code is excluded from dead code analysis (enforced via custom ruff plugin).
Prefer direct attribute access using foo.attr. Save to variables only when reusing the same attribute multiple times improves readability or extracting clarifies intent.
Imports must always be at the top of the module. Do not import inside functions.
No defensive programming. Fail...

Files:

  • tests/storage/utils.py
  • utilities/storage.py
tests/**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

Use pytest assertions: assert actual == expected. Never use self.assertEqual(). Include failure messages: assert condition, 'descriptive message explaining failure'.

Files:

  • tests/storage/utils.py
**

⚙️ CodeRabbit configuration file

**: ## PR Template Validation
Check the PR description for required sections from .github/pull_request_template.md.
Required sections (must be present, even if empty):

  • ##### What this PR does / why we need it: — MUST be present AND have meaningful content.
    Flag as HIGH if the section is missing, empty, whitespace-only, contains only HTML comments,
    or contains only placeholder tokens such as TBD, TBA, N/A, -, , none, or ..
  • ##### Which issue(s) this PR fixes: — must be present (may be empty)
  • ##### Special notes for reviewer: — must be present (may be empty)
  • ##### jira-ticket: — must be present (may be empty)
    If any required section is absent, or What this PR does / why we need it: has no content,
    flag it as HIGH severity and ask the author to restore the missing template section(s).

Approval Policy

You may approve the PR when ALL of the following are true:

  • All your review comments have been addressed with either:
    • a code/doc change that fixes the issue, or
    • a substantive author response that justifies no code change.
      Thread "resolved" state alone is not sufficient.
      OR you had no review comments.
  • If you posted a test execution plan comment requesting tests, and the PR author replied
    with a comment explaining why the requested tests are not needed or were already covered,
    treat that as an acceptable response — do not block approval on the test plan alone.
  • The author's explanation must be reasonable and specific (not just "N/A" or "not needed").
    Accept explanations like: "these tests were already run in CI", "this change is docs-only",
    "the affected tests are quarantined", or "verified manually on cluster X".

Files:

  • tests/storage/utils.py
  • utilities/storage.py

⚙️ CodeRabbit configuration file

**: # AI Review and Development Standards

Assisted-by: Claude noreply@anthropic.com

Coding standards, conventions, and review guidelines for openshift-virtualization-tests.

These rules apply to ALL contributors and review tools — human and AI alike.

Strict Rules (MANDATORY)

Linter Suppressions PROHIBITED

  • NEVER add # noqa, # type: ignore, # pylint: disable
  • NEVER disable linter/mypy rules to work around issues
  • FIX THE CODE - If linter complains, the code is wrong
  • If you think a rule is wrong: ASK the user for explicit approval

Code Reuse (Search-First Development)

Before writing ANY new code:

  1. SEARCH codebase for existing implementations
  2. CHECK utilities/ for shared functions
  3. CHECK libs/ for shared libraries
  4. CHECK tests/ for shared fixtures and helper functions
  5. CHECK pyproject.toml dependencies — project packages (e.g., pyhelper-utils, ocp-resources, openshift-python-wrapper) may already provide the functionality
  6. VERIFY no similar logic exists elsewhere
  7. NEVER duplicate logic - extract to shared module
  8. REUSE existing code and patterns — only write new when nothing exists

External package examples:

  • Shell commands — use pyhelper_utils.shell.run_command, NEVER use subprocess.run directly in test/utility code
  • OpenShift resources — use ocp-resources classes, NEVER construct raw YAML dicts

Python Requirements

  • Type hints MANDATORY - mypy strict mode in libs/, all new public functions under utilities MUST be typed
  • Use TYPE_CHECKING for type-only imports - wrap imports needed solely for type hints in if TYPE_CHECKING: to avoid runtime overhead and circular imports
  • Google-format docstrings REQUIRED - for all public functions with non-obvious return values OR side effects
  • No defensive programming - fail-fast, don't hide bugs with fake defaults (see exceptions below)
  • ALWAYS use uv run -...

Files:

  • tests/storage/utils.py
  • utilities/storage.py
utilities/storage.py

📄 CodeRabbit inference engine (AGENTS.md)

Place storage operations (PVC, DataVolume, StorageClass) in utilities/storage.py.

Files:

  • utilities/storage.py
🔇 Additional comments (5)
tests/storage/utils.py (3)

333-333: LGTM!


443-449: LGTM!


454-454: LGTM!

utilities/storage.py (2)

145-148: LGTM!


572-572: Ensure data_volume_template_with_source_ref_dict(..., storage_class=None) results in the expected spec.storage.storageClassName (or omits it) for CDI DataVolumeTemplates.

utilities/storage.py:data_volume_template_with_source_ref_dict forwards storage_class=None directly to ocp_resources.datavolume.DataVolume and does not populate spec.storage.storageClassName itself when storage_class isn’t provided.

Call sites that pass the raw template without setting a default:

  • tests/virt/upgrade/conftest.py: data_volume_template=data_volume_template_with_source_ref_dict(data_source=...)
  • tests/infrastructure/golden_images/update_boot_source/conftest.py: data_volume_template=data_volume_template_with_source_ref_dict(data_source=...)

Action: confirm how ocp_resources renders storage_class=None in the generated template (storageClassName omitted vs storageClassName: null). If it can render null, update these fixtures to pass storage_class explicitly (or to use tests/virt/utils.py:get_data_volume_template_dict_with_default_storage_class() which sets the default).


📝 Walkthrough

Walkthrough

Tests and the DataVolume HTTP/HTTPS path now explicitly pass the Kubernetes client (and namespace for Artifactory helpers). Tests construct StorageProfile/StorageClass with client=pvc.client; create_dv passes namespace and client to Artifactory secret and config map retrieval.

Changes

Client and namespace parameter passing

Layer / File(s) Summary
Test assertions use PVC client
tests/storage/utils.py
assert_pvc_snapshot_clone_annotation and assert_use_populator instantiate StorageProfile/StorageClass with client=pvc.client before reading cluster-backed fields.
create_dv: pass client to Artifactory helpers
utilities/storage.py
create_dv HTTP/HTTPS path now calls utilities.artifactory.get_artifactory_secret(namespace=namespace, client=client) and get_artifactory_config_map(namespace=namespace, client=client) to populate secret and cert_configmap.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • kbidarkar
  • geetikakay
  • yossisegev
  • SamAlber
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the specific changes: adding the client argument to create_dv and assert_pvc_snapshot_clone_annotation functions to address a FutureWarning.
Description check ✅ Passed The description covers all required sections with relevant details: what the PR does (fixes FutureWarning by adding missing client), which issue it fixes, notes for reviewer (though empty), and jira-ticket (NONE).
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stp Link Required ✅ Passed No new test files or test functions added; PR only modifies existing utility helper functions in non-test files (tests/storage/utils.py and utilities/storage.py).

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

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

@openshift-virtualization-qe-bot-2

Copy link
Copy Markdown
Contributor

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

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

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
  • jpeimer
  • myakove
  • rnetser
  • vsibirsk

Reviewers:

  • Ahmad-Hafe
  • RoniKishner
  • acinko-rh
  • dalia-frank
  • dshchedr
  • ema-aka-young
  • geetikakay
  • josemacassan
  • jpeimer
  • kgoldbla
  • kshvaika
  • rnetser
  • vsibirsk
Available Labels
  • hold
  • verified
  • wip
  • lgtm
  • approve
AI Features
  • Cherry-Pick Conflict Resolution: Enabled (claude/claude-opus-4-6[1m])

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

@codecov

codecov Bot commented Jun 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.65%. Comparing base (a2dc143) to head (9618a26).
⚠️ Report is 93 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5120      +/-   ##
==========================================
- Coverage   98.67%   98.65%   -0.02%     
==========================================
  Files          25       25              
  Lines        2487     2461      -26     
==========================================
- Hits         2454     2428      -26     
  Misses         33       33              
Flag Coverage Δ
utilities 98.65% <ø> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/storage/utils.py`:
- Around line 451-453: The assertion comparing pvc.use_populator to
expected_use_populator_value should include a descriptive failure message;
update the assert near StorageClass(name=storage_class,
client=pvc.client).instance.get("provisioner") ... to read assert
pvc.use_populator == expected_use_populator_value,
f"StorageClass={storage_class} (client={pvc.client}): expected
use_populator={expected_use_populator_value}, got {pvc.use_populator}" so the
message shows the storage class, client scope, and actual vs expected values for
easier CI debugging.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c2ce74ec-308b-4b6a-90a9-dc7550ff6671

📥 Commits

Reviewing files that changed from the base of the PR and between c0e6a28 and e77c27d.

📒 Files selected for processing (2)
  • tests/storage/utils.py
  • utilities/storage.py

Comment thread tests/storage/utils.py
@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

Clean rebase detected — no code changes compared to previous head (e77c27d).
The following labels were preserved: commented-RoniKishner, commented-coderabbitai[bot], changes-requested-coderabbitai[bot].

@RoniKishner

Copy link
Copy Markdown
Contributor Author

/verified

smoke
tests/storage/cdi_clone/test_clone.py::test_successful_vm_restart_with_cloned_dv
tests/storage/cdi_clone/test_clone.py::test_successful_snapshot_clone 
tests/storage/cdi_import/test_import_http.py::test_successful_import_image 
tests/storage/cdi_upload/test_upload_virtctl.py::TestVirtctlUploadExistingDV::test_virtctl_image_upload_to_existing_dv_and_validate_populator 
tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning.py::test_user_permissions_positive 
tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning_vms.py::test_create_vm_with_cloned_data_volume_positive 
tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning_vms.py::test_create_vm_with_cloned_data_volume_permissions_for_pods_positive 
tests/storage/cdi_import/test_import_http.py 
tests/storage/test_libguestfs.py

Comment thread tests/storage/utils.py
@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

/retest all

Auto-triggered: Files in this PR were modified by merged PR #4985.

Overlapping files

utilities/storage.py

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

/retest all

Auto-triggered: Files in this PR were modified by merged PR #5099.

Overlapping files

tests/storage/utils.py

@jpeimer

jpeimer commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

/approve
/lgtm

@RoniKishner

Copy link
Copy Markdown
Contributor Author

/verified
Rebased due to CI failure

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

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

Comment thread tests/storage/utils.py
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Tip

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
PR_NUMBER=5120
REPO="RedHatQE/openshift-virtualization-tests"

echo "=== Latest commit SHA ==="
gh pr view $PR_NUMBER --repo $REPO --json commits --jq '.commits[-1].oid'

echo ""
echo "=== PR files changed ==="
gh api repos/$REPO/pulls/$PR_NUMBER/files --jq '[.[] | {filename, patch: .patch[0:300]}]'

Length of output: 1162


🏁 Script executed:

#!/bin/bash
PR_NUMBER=5120
REPO="RedHatQE/openshift-virtualization-tests"
COMMIT_SHA="9618a26f0488e44e1246d3b80e8d64084fdd8e60"

BODY="## Test Execution Plan

**Run smoke tests: True**
- \`tests/storage/cdi_clone/test_clone.py\` (smoke) → calls \`assert_pvc_snapshot_clone_annotation\` + \`assert_use_populator\`\`StorageProfile(client=pvc.client)\` / \`StorageClass(client=pvc.client)\` in \`tests/storage/utils.py\`
- \`tests/storage/cdi_upload/test_upload_virtctl.py\` (smoke) → calls \`assert_use_populator\`\`StorageClass(client=pvc.client)\` in \`tests/storage/utils.py\`

**Run gating tests: True**
- \`tests/storage/cdi_clone/test_clone.py\` (gating) → \`assert_pvc_snapshot_clone_annotation\` / \`assert_use_populator\`\`tests/storage/utils.py\`
- \`tests/storage/cdi_import/test_import_http.py\` (gating) → \`assert_use_populator\`\`tests/storage/utils.py\`; HTTP path also calls \`create_dv\`\`get_artifactory_secret(client=...)\` in \`utilities/storage.py\`
- \`tests/storage/cdi_upload/test_upload_virtctl.py\` (gating) → \`assert_use_populator\`\`tests/storage/utils.py\`
- \`tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning.py\` (gating) → \`assert_pvc_snapshot_clone_annotation\`\`tests/storage/utils.py\`
- \`tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning_vms.py\` (gating) → \`assert_pvc_snapshot_clone_annotation\`\`tests/storage/utils.py\`

**Affected tests to run:**
- \`tests/storage/cdi_clone/test_clone.py\` (smoke, gating)
- \`tests/storage/cdi_upload/test_upload_virtctl.py\` (smoke, gating)
- \`tests/storage/cdi_import/test_import_http.py\` (gating)
- \`tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning.py\` (gating)
- \`tests/storage/restricted_namespace_cloning/test_restricted_namespace_cloning_vms.py\` (gating)"

gh api repos/$REPO/pulls/$PR_NUMBER/reviews \
  --method POST \
  --field commit_id="$COMMIT_SHA" \
  --field event="COMMENT" \
  --field "comments[][path]=tests/storage/utils.py" \
  --field "comments[][line]=333" \
  --field "comments[][side]=RIGHT" \
  --field "comments[][body]=$BODY"

echo "Exit code: $?"

Length of output: 3965



Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants