Skip to content

[Storage] Windows tests should all use vTPM - module CDI Clone#4571

Open
acinko-rh wants to merge 21 commits into
RedHatQE:mainfrom
acinko-rh:add_vtpm_to_cdi_clone
Open

[Storage] Windows tests should all use vTPM - module CDI Clone#4571
acinko-rh wants to merge 21 commits into
RedHatQE:mainfrom
acinko-rh:add_vtpm_to_cdi_clone

Conversation

@acinko-rh
Copy link
Copy Markdown
Contributor

@acinko-rh acinko-rh commented Apr 24, 2026

Short description:

PR merged to tier-2/3 that makes Windows test VMs in sig-storage use vTPM
(preferably through instancetypes, which should be the right and easy way to achieve this)

More details:
What this PR does / why we need it:
Which issue(s) this PR fixes:
Special notes for reviewer:

Co-Authored: Claude Code
https://redhat.atlassian.net/browse/CNV-51351

jira-ticket:

@acinko-rh
Copy link
Copy Markdown
Contributor Author

/wip

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 24, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Replaces a parametrized HTTP-based Windows DV clone test with a new tier3 test that builds a VM from a registry-backed cloned DV (Windows 2022) including vTPM. Adds fixtures to provision source and cloned DataVolumes from a registry and introduces a Windows 2K22 preference constant.

Changes

Cohort / File(s) Summary
Test Implementation
tests/storage/cdi_clone/test_clone.py
Removes test_successful_vm_from_cloned_dv_windows and adds test_successful_vm_from_cloned_dv_windows_with_vtpm. New test builds a VirtualMachineForTests from a registry-backed cloned Windows 2022 DV, sets Windows container-disk flavor, instance type U1_LARGE, applies WINDOWS_2K22_PREFERENCE, starts the VM, waits for readiness, and validates VMI OS info. Replaces use of the removed WINDOWS_CLONE_TIMEOUT with TIMEOUT_40MIN.
Test Fixtures
tests/storage/cdi_clone/conftest.py
Adds source_dv_windows_registry_scope_function and cloned_windows_dv_from_registry_scope_function fixtures that create a registry-backed source DataVolume (Windows container-disk artifact) and a cloned target DV (source=pvc) in the same namespace. Fixtures use Artifactory secret/configmap and wait for DV completion with TIMEOUT_40MIN.
Constants
utilities/constants.py
Adds WINDOWS_2K22_PREFERENCE = "windows.2k22" for preference/label selection in Windows 2K22 tests.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is largely incomplete, with most required template sections empty or only partially filled (What this PR does, Which issue(s) this PR fixes are blank), though the short description and Jira reference are provided. Complete the missing sections: add details about what changes were made and why, explicitly list the issues being fixed, and provide the full Jira ticket URL in the jira-ticket field.
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 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 The title clearly describes the main change: adding vTPM support to Windows tests in the CDI Clone module, matching the PR's objectives to update Windows test VMs.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@acinko-rh acinko-rh changed the title [Storage] Windows tests should all use vTPM [Storage] Windows tests should all use vTPM - module CDI Clone Apr 24, 2026
@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

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:

  • jpeimer

Reviewers:

  • Ahmad-Hafe
  • acinko-rh
  • 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])

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
tests/storage/utils.py (1)

541-584: ⚠️ Potential issue | 🟠 Major

[HIGH] Landing a helper already labeled "DEBUG ONLY - MARKED FOR DELETION" contradicts the dead-code policy.

The docstring and the trailing # TODO: Remove - debug only on Line 541 announce this function is scaffolding, yet it's imported and exercised by test_successful_vm_from_cloned_dv_windows_with_vtpm in tests/storage/cdi_clone/test_clone.py. Either the verification is part of the intended coverage (then drop the "debug only" labeling and keep it properly) or it isn't (then don't merge it). Shipping code pre-flagged for deletion is how dead code quietly permanents itself in the repo.

As per coding guidelines: "No dead code in Python. Every function, variable, fixture MUST be used or removed."

✂️ Suggested cleanup
-def verify_vtpm_in_windows_vm(vm, admin_client):  # TODO: Remove - debug only
+def verify_vtpm_in_windows_vm(vm, admin_client):
     """
     Verify vTPM is properly configured and detected in a Windows VM.
 
-    **DEBUG ONLY - MARKED FOR DELETION**
-
     Performs two-layer validation:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@tests/storage/utils.py` around lines 541 - 584, The helper
verify_vtpm_in_windows_vm is labelled "DEBUG ONLY - MARKED FOR DELETION" yet is
referenced by test_successful_vm_from_cloned_dv_windows_with_vtpm, so remove the
dead-code marker and make the function a first-class test utility: delete the "#
TODO: Remove - debug only" comment, update the docstring to reflect it is an
intentional test helper (remove "DEBUG ONLY"), and ensure any module
exports/imports remain correct so tests continue to import
verify_vtpm_in_windows_vm; alternatively, if you truly intend to delete it,
remove all imports/usages (notably in tests/storage/cdi_clone/test_clone.py) and
delete the function instead.
tests/storage/cdi_clone/test_clone.py (1)

1-3: ⚠️ Potential issue | 🟡 Minor

[MEDIUM] New feature test requires an STP (or RFE/Jira epic) link in the module docstring.

The module docstring is still just """Clone tests""", but this PR adds a new feature test (test_successful_vm_from_cloned_dv_windows_with_vtpm) covering vTPM on cloned Windows DVs. As per coding guidelines: "Every new feature test module MUST include an STP link in the module docstring. If there is no STP, the module docstring MUST include a link to the RFE or Jira epic (not support cases) for coverage tracking." The PR description also has an empty Jira ticket field, which needs to be filled in.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@tests/storage/cdi_clone/test_clone.py` around lines 1 - 3, The module
docstring currently just says "Clone tests" but this PR adds the new feature
test test_successful_vm_from_cloned_dv_windows_with_vtpm, so update the module
docstring to include the required STP link (or, if none, the RFE/Jira epic URL)
for coverage tracking and also populate the empty Jira ticket field in the PR
description; modify the top-of-file docstring in the test module to include a
one-line reference (e.g., "STP: <link>" or "RFE/Jira: <epic-link>") alongside
the existing summary so automated checks and reviewers can verify the
traceability.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@tests/storage/cdi_clone/test_clone.py`:
- Line 248: The test contains a placeholder Polarion ID in the pytest marker:
replace pytest.mark.polarion("CNV-XXXXX") in
tests/storage/cdi_clone/test_clone.py with the real Polarion/Jira ID for this
test (use the official ticket string), and update the PR description’s empty
Jira ticket field to the same ID so reporting and traceability are correct;
ensure the marker value is a non-placeholder string and re-run the
test/reporting to verify the ID appears properly.
- Around line 72-110: Move the helper
create_windows_vm_with_vtpm_validate_guest_agent_info out of the test module
into tests/storage/utils.py (next to
create_windows_vm_validate_guest_agent_info), make admin_client a required
positional argument (remove the =None default) so vTPM validation always runs,
relocate the imports to the top of the new module (import
validate_os_info_vmi_vs_windows_os from utilities.ssp, wait_for_windows_vm from
utilities.virt, and verify_vtpm_in_windows_vm from tests.storage.utils or the
correct canonical module), and remove the runtime None check (do not gate
verify_vtpm_in_windows_vm with if admin_client; call it directly). Ensure any
remaining None comparisons use identity (if x is None) when applicable.
- Line 103: The test creates the VM in a halted state
(VirtualMachine.RunStrategy.HALTED) so wait_for_windows_vm(vm=vm, ...) fails
because it immediately runs SSH; call running_vm(vm=vm) to transition the VM to
Running before calling wait_for_windows_vm. Insert a running_vm(vm=vm)
invocation inside the context manager just prior to wait_for_windows_vm
(mirroring create_windows19_vm) so the VM is started and SSH connectivity is
available.

---

Outside diff comments:
In `@tests/storage/cdi_clone/test_clone.py`:
- Around line 1-3: The module docstring currently just says "Clone tests" but
this PR adds the new feature test
test_successful_vm_from_cloned_dv_windows_with_vtpm, so update the module
docstring to include the required STP link (or, if none, the RFE/Jira epic URL)
for coverage tracking and also populate the empty Jira ticket field in the PR
description; modify the top-of-file docstring in the test module to include a
one-line reference (e.g., "STP: <link>" or "RFE/Jira: <epic-link>") alongside
the existing summary so automated checks and reviewers can verify the
traceability.

In `@tests/storage/utils.py`:
- Around line 541-584: The helper verify_vtpm_in_windows_vm is labelled "DEBUG
ONLY - MARKED FOR DELETION" yet is referenced by
test_successful_vm_from_cloned_dv_windows_with_vtpm, so remove the dead-code
marker and make the function a first-class test utility: delete the "# TODO:
Remove - debug only" comment, update the docstring to reflect it is an
intentional test helper (remove "DEBUG ONLY"), and ensure any module
exports/imports remain correct so tests continue to import
verify_vtpm_in_windows_vm; alternatively, if you truly intend to delete it,
remove all imports/usages (notably in tests/storage/cdi_clone/test_clone.py) and
delete the function instead.
🪄 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: 11e3ec8d-d6fa-4f0b-9a1f-4e1aa2980145

📥 Commits

Reviewing files that changed from the base of the PR and between 0feeb8f and 06bece3.

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

Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/utils.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
@acinko-rh
Copy link
Copy Markdown
Contributor Author

/wip cancel

@josemacassan
Copy link
Copy Markdown
Contributor

/lgtm

Comment thread tests/storage/cdi_clone/constants.py Outdated
Comment thread tests/storage/cdi_clone/test_clone.py Outdated
Comment thread tests/storage/test_hotplug.py
Comment thread utilities/constants.py Outdated
Comment thread tests/utils.py
@openshift-virtualization-qe-bot-3
Copy link
Copy Markdown
Contributor

Clean rebase detected — no code changes compared to previous head (b5fcc58).
The following labels were preserved: lgtm-josemacassan, commented-ema-aka-young.

acinko-rh and others added 18 commits May 22, 2026 08:35
Co-Authored: Claude Code
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
Signed-off-by: Adam Cinko <acinko@redhat.com>
@openshift-virtualization-qe-bot-3
Copy link
Copy Markdown
Contributor

/retest all

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

Overlapping files

tests/utils.py

@openshift-virtualization-qe-bot-3
Copy link
Copy Markdown
Contributor

Clean rebase detected — no code changes compared to previous head (8f95979).

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

Overlapping files

tests/utils.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.

10 participants