Skip to content

[Storage] Fix names in the hotplug module#5300

Open
acinko-rh wants to merge 1 commit into
RedHatQE:mainfrom
acinko-rh:rename_hotplug_fixtures_and_functions_correctly
Open

[Storage] Fix names in the hotplug module#5300
acinko-rh wants to merge 1 commit into
RedHatQE:mainfrom
acinko-rh:rename_hotplug_fixtures_and_functions_correctly

Conversation

@acinko-rh

@acinko-rh acinko-rh commented Jun 22, 2026

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

Reviewers asked to change the names of fixtures/functions in the hotplug module to reflect the reality.

Which issue(s) this PR fixes:

https://redhat.atlassian.net/browse/CNV-51351
#4844 (comment)
#4844 (comment)

Special notes for reviewer:
jira-ticket:

Summary by CodeRabbit

  • Tests
    • Updated Windows hotplug test suite infrastructure to enhance test coverage and reliability for storage operations.

Signed-off-by: Adam Cinko <acinko@redhat.com>
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Windows hotplug tests in tests/storage/test_hotplug.py are rewired to use an instance-type VM fixture instead of a template VM fixture. The DataVolume fixture is renamed from windows_dv_from_registry_scope_class to windows_dv_template_from_registry_scope_class, yielding dv_template. The VM fixture and all downstream test assertions and migration calls are updated accordingly.

Changes

Windows Hotplug Fixture Rewire

Layer / File(s) Summary
DV template fixture rename and VM fixture switch
tests/storage/test_hotplug.py
windows_dv_from_registry_scope_class is renamed to windows_dv_template_from_registry_scope_class (yielding dv_template); the VM fixture is renamed from vm_instance_from_template_multi_storage_scope_class to vm_instance_from_instance_type_multi_storage_scope_class consuming the renamed DV fixture; the hotplug volume fixture target is updated to the instance-type VM.
Test assertions and migration updated to instance-type VM
tests/storage/test_hotplug.py
Serial verification, hotplug-volume nonexistence assertion, and migration call in test_windows_hotplug/test_windows_hotplug_migrate reference vm_instance_from_instance_type_multi_storage_scope_class instead of the former template VM.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • RedHatQE/openshift-virtualization-tests#4761: Directly related — this PR completes the fixture migration started there by renaming windows_dv_from_registry_scope_class and switching all Windows hotplug VM references to the instance-type/vTPM-based path introduced in that PR.

Suggested reviewers

  • rnetser
  • kgoldbla
  • dshchedr

Caution

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

  • Ignore

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Stp Link Required ❌ Error New test file tests/storage/test_hotplug.py lacks required STP/RFE/Jira link in module/class/function docstrings. @pytest.mark.polarion decorators do not satisfy the requirement. Add STP, RFE, or Jira link to module, class, or test function docstring in tests/storage/test_hotplug.py. Example: add "STP: " or "Jira: # " to the module docstring.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Title check ✅ Passed Title clearly describes the change: renaming fixtures/functions in the hotplug module. It meets length requirement (41 chars < 120 chars) and directly reflects the core modification.
Description check ✅ Passed Description includes required sections: change rationale, linked issues (Jira + GitHub discussions), and special notes. Jira ticket field contains a comment rather than closure directive, which is acceptable.
✨ 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

Copy link
Copy Markdown

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:

  • jpeimer

Reviewers:

  • Acedus
  • Ahmad-Hafe
  • Dsanatar
  • acinko-rh
  • akalenyu
  • awels
  • dalia-frank
  • ema-aka-young
  • josemacassan
  • jpeimer
  • kgoldbla
  • kshvaika
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.

@openshift-virtualization-qe-bot

Copy link
Copy Markdown

/build-and-push-container

@openshift-virtualization-qe-bot-5

Copy link
Copy Markdown

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

@openshift-virtualization-qe-bot

Copy link
Copy Markdown

/verified

All tests passed for PR #5300.
Job: openshift-virtualization-tests-runner #5747

Execution details
pytest -s -o log_cli=true --jira tests/storage/test_hotplug.py
Image: openshift-virtualization-tests:pr-5300

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

@@ -63,12 +63,15 @@ def enabled_feature_gate_for_declarative_hotplug_volumes(

@pytest.fixture(scope="class")
def hotplug_volume_windows_scope_class(

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.

Test Execution Plan

Run smoke tests: False
No smoke-marked tests in tests/storage/test_hotplug.py use the modified fixtures (hotplug_volume_windows_scope_class, windows_dv_template_from_registry_scope_class, vm_instance_from_instance_type_multi_storage_scope_class).

Run gating tests: False
Gating-marked classes (TestHotPlugWithPersist, TestHotPlugWithSerialPersist) depend on hotplug_volume_scope_class — not the modified Windows fixtures.

Affected tests to run

tests/storage/test_hotplug.py::TestHotPlugWindows

The renamed/rewired fixtures feed exclusively into TestHotPlugWindows. Run:

pytest -s tests/storage/test_hotplug.py -k TestHotPlugWindows

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Tip

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

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the PR diff to find the first changed line
gh pr diff 5300 --repo RedHatQE/openshift-virtualization-tests | head -60

# Check for smoke/gating markers in test_hotplug.py
rg '`@pytest.mark.smoke`|`@pytest.mark.gating`' tests/storage/test_hotplug.py -n

# Check smoke/gating across the repo for reference
rg -l '`@pytest.mark.smoke`' tests/ | head -20
rg -l '`@pytest.mark.gating`' tests/ | head -20

Length of output: 4391


🏁 Script executed:

#!/bin/bash
# Get the PR head commit SHA
gh pr view 5300 --repo RedHatQE/openshift-virtualization-tests --json headRefOid -q '.headRefOid'

# Get smoke and gating test names in test_hotplug.py
rg '`@pytest.mark.smoke`|`@pytest.mark.gating`' tests/storage/test_hotplug.py -n -A2

# Check which class the gating tests belong to
sed -n '180,245p' tests/storage/test_hotplug.py

Length of output: 3262


🏁 Script executed:

#!/bin/bash
# Check smoke markers specifically in test_hotplug.py
rg '`@pytest.mark.smoke`' tests/storage/test_hotplug.py -n -A3

# Look at TestHotPlugWindows class definition and its fixtures
sed -n '275,320p' tests/storage/test_hotplug.py

# Post the inline review comment on first changed line (line 65 of new file)
COMMIT_SHA="ae82538a733130351fe2d40a3773dcf092991bcc"

COMMENT_BODY="## Test Execution Plan

**Run smoke tests: False**
No smoke-marked tests in \`tests/storage/test_hotplug.py\` use the modified fixtures (\`hotplug_volume_windows_scope_class\`, \`windows_dv_template_from_registry_scope_class\`, \`vm_instance_from_instance_type_multi_storage_scope_class\`).

**Run gating tests: False**
Gating-marked classes (\`TestHotPlugWithPersist\`, \`TestHotPlugWithSerialPersist\`) depend on \`hotplug_volume_scope_class\` — not the modified Windows fixtures.

**Affected tests to run**
\`\`\`
tests/storage/test_hotplug.py::TestHotPlugWindows
\`\`\`
The renamed/rewired fixtures feed exclusively into \`TestHotPlugWindows\`. Run:
\`\`\`bash
pytest -s tests/storage/test_hotplug.py -k TestHotPlugWindows
\`\`\`"

gh api \
  --method POST \
  repos/RedHatQE/openshift-virtualization-tests/pulls/5300/reviews \
  --field commit_id="$COMMIT_SHA" \
  --field event="COMMENT" \
  --field body="" \
  --field "comments[][path]=tests/storage/test_hotplug.py" \
  --field "comments[][line]=65" \
  --field "comments[][side]=RIGHT" \
  --field "comments[][body]=$COMMENT_BODY"

Length of output: 4848



@josemacassan

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

/retest all

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

Overlapping files

tests/storage/test_hotplug.py

@Ahmad-Hafe

Copy link
Copy Markdown
Contributor

/lgtm

@Ahmad-Hafe

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

/retest all

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

Overlapping files

tests/storage/test_hotplug.py

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

/retest all

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

Overlapping files

tests/storage/test_hotplug.py

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