infra: Add pause unpause windows test#5612
Open
RoniKishner wants to merge 2 commits into
Open
Conversation
Contributor
|
Report bugs in Issues Welcome! 🎉This pull request will be automatically processed with the following features: 🔄 Automatic Actions
📋 Available CommandsPR Status Management
Review & Approval
Testing & Validation
Container Operations
Cherry-pick Operations
Branch Management
Label Management
✅ Merge RequirementsThis PR will be automatically approved when the following conditions are met:
📊 Review ProcessApprovers and ReviewersApprovers:
Reviewers:
Available Labels
AI Features
Security Checks
💡 Tips
📌 Additional InformationCustom Commands:
For more information, please refer to the project documentation or contact the maintainers. |
openshift-virtualization-qe-bot-2
requested review from
SamAlber,
dshchedr,
mijankow and
rnetser
Contributor
📝 WalkthroughWalkthroughThe Windows pause/unpause validation helper moves from test utilities to guest support utilities. Windows test imports and unit coverage are updated, and the infrastructure test receives a new marker, dependency, Polarion ID, class documentation, and dependency comment. ChangesWindows pause/unpause validation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
openshift-virtualization-qe-bot
added
the
tox:verify-tc-requirement-polarion:running
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5612 +/- ##
==========================================
+ Coverage 98.67% 98.68% +0.01%
==========================================
Files 25 42 +17
Lines 2487 2515 +28
==========================================
+ Hits 2454 2482 +28
Misses 33 33
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
openshift-virtualization-qe-bot
added
tox:verify-tc-requirement-polarion:failed
|
D/S test |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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/infrastructure/instance_types/supported_os/test_windows_os.py`:
- Line 47: Add an inline rationale comment immediately adjacent to the
`@pytest.mark.dependency` decorator for the test depending on start_vm, explicitly
stating why that test must run after start_vm. Keep the dependency declaration
and test behavior unchanged.
- Around line 49-50: Add a module-level docstring to test_windows_os.py
containing a valid STP:, RFE:, or Jira: traceability link for
test_pause_unpause_vm, while leaving the test implementation unchanged.
In `@utilities/guest_support.py`:
- Line 161: Update the conditional around pre_pause_pid to use an explicit None
identity check, changing the falsy check in the relevant function to distinguish
PID 0 from an omitted optional parameter while preserving the existing behavior
for None.
- Line 8: Move the kill_processes_by_name_windows helper from
tests/virt/utils.py into utilities/virt.py alongside the existing Linux process
helper, then update utilities/guest_support.py to import it from utilities.
Remove the test-only import and preserve the helper’s existing behavior and
callers.
🪄 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: 7b9133f9-3faa-411a-94cb-2231867921e5
📒 Files selected for processing (4)
tests/infrastructure/instance_types/supported_os/test_windows_os.pytests/virt/cluster/common_templates/windows/test_windows_os_support.pytests/virt/utils.pyutilities/guest_support.py
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
RedHatQE/openshift-virtualization-tests-design-docs(manual)
💤 Files with no reviewable changes (1)
- tests/virt/utils.py
openshift-virtualization-qe-bot
added
tox:verify-tc-requirement-polarion:running
openshift-virtualization-qe-bot-4
removed
the
changes-requested-coderabbitai[bot]
label
openshift-virtualization-qe-bot
added
tox:verify-tc-requirement-polarion:failed
|
D/S test |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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/infrastructure/instance_types/supported_os/test_windows_os.py`:
- Line 55: Replace the duplicate "CNV-3087" marker on the newly added test with
a unique Polarion ID not used elsewhere, while preserving the existing test and
decorator structure.
In `@utilities/guest_support.py`:
- Line 13: Restore the missing required sections in the pull request
description: “What this PR does / why we need it,” “Which issue(s) this PR
fixes,” “Special notes for reviewer,” and “jira-ticket.” Fill each section with
the relevant information so PR Template Validation passes.
- Line 170: Add type annotations to the public function
kill_processes_by_name_windows, annotating vm and process_name with their
appropriate input types and declaring its return type. Follow the existing
annotation conventions in utilities and preserve the function’s current
behavior.
🪄 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: b1a401d0-065f-401c-bf29-ae5aef08464b
📒 Files selected for processing (4)
tests/infrastructure/instance_types/supported_os/test_windows_os.pytests/virt/cluster/common_templates/windows/test_windows_os_support.pytests/virt/utils.pyutilities/guest_support.py
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
RedHatQE/openshift-virtualization-tests-design-docs(manual)
💤 Files with no reviewable changes (1)
- tests/virt/utils.py
Signed-off-by: rkishner <rkishner@redhat.com>
openshift-virtualization-qe-bot
added
tox:verify-tc-requirement-polarion:running
Signed-off-by: rkishner <rkishner@redhat.com>
openshift-virtualization-qe-bot
added
size/L
tox:verify-tc-requirement-polarion:running
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 `@utilities/unittests/test_guest_support.py`:
- Around line 14-15: Restore the required PR template sections in the pull
request body: “What this PR does / why we need it,” “Which issue(s) this PR
fixes,” “Special notes for reviewer,” and “jira-ticket.” Populate the first
section with a clear, specific summary of the change’s scope; retain the other
required sections with appropriate content or explicit values.
- Around line 563-574: Update
test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid to assert
mock_fetch_pid and mock_kill_processes were called with the expected vm and
process_name arguments; update
test_validate_pause_unpause_windows_vm_pid_mismatch to assert
mock_pause_unpause, mock_fetch_pid, and mock_kill_processes were called with
their expected arguments after the exception block. These changes should use
every injected mock and preserve the existing behavior assertions.
🪄 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: 2384dcb6-6a00-4398-831f-a937e341f122
📒 Files selected for processing (1)
utilities/unittests/test_guest_support.py
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
RedHatQE/openshift-virtualization-tests-design-docs(manual)
📜 Review details
🧰 Additional context used
📓 Path-based instructions (4)
**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
**/*.py: Never add linter suppressions such as# noqa,# type: ignore, or# pylint: disable; fix the underlying code instead.
UseTYPE_CHECKINGfor imports needed only by type hints.
Use Google-format docstrings for public functions with non-obvious return values or side effects.
Do not use defensive programming or fake defaults; fail fast, except for destructors/cleanup, explicitly optional parameters, lazy initialization, platform constants, and unversioned external libraries.
Use absolute imports, place imports at module top level, and prefer specific imports; do not use bareimport modulewithout afromclause.
Use named arguments for function calls with more than one argument and avoid single-letter variable names.
Remove unused functions, variables, and fixtures;# skip-unused-codeis the only permitted exclusion from dead-code analysis.
Prefer direct attribute access and only assign attributes to variables when reuse or clarity justifies it.
Use INFO for normal lifecycle and state events, WARNING for unusual or skipped operations, ERROR with full context for exceptions, never use DEBUG, never log secrets or PII, and use f-string formatting.
Re-raise exceptions with context usingraise ... from, catch specific exception types, never silently swallow exceptions, and provide specific error messages.
Do not hide side effects behind hardcoded behavior; control them through explicit arguments, and never useasyncin this codebase.
Use context managers for files, connections, and locks; fixtures with cleanup must useyield resourcefollowed by cleanup.
UseTimeoutSamplerfor condition waits and never usetime.sleep()in loops; avoid duplicating sampler timeout logs.
Use implicit boolean checks,is NoneforNone, and never compare values directly toTrueorFalse.
Files:
utilities/unittests/test_guest_support.py
utilities/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
utilities/**/*.py: All new public functions must have type hints.
Place utility functions in the domain-matching module, creating a correctly named domain module only when no suitable module exists.
Files:
utilities/unittests/test_guest_support.py
utilities/unittests/**
⚙️ CodeRabbit configuration file
utilities/unittests/**: ## Unit Tests — Relaxed Rules
Files underutilities/unittests/are unit tests for shared utilities.
Do NOT enforce:
- STD docstring format (Preconditions/Steps/Expected sections)
- STP link requirements
- RFE/Jira link requirements
- Coverage tracking rules
These rules apply only to feature/integration tests undertests/.
DO still enforce: code quality, type hints, naming conventions, and all other coding standards.
Files:
utilities/unittests/test_guest_support.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 asTBD,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, orWhat 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:
utilities/unittests/test_guest_support.py
🧠 Learnings (37)
📚 Learning: 2026-01-07T11:51:57.253Z
Learnt from: qwang1
Repo: RedHatQE/openshift-virtualization-tests PR: 3301
File: utilities/unittests/test_oadp.py:5-5
Timestamp: 2026-01-07T11:51:57.253Z
Learning: In utilities/unittests/test_oadp.py and similar test files in this repo, include a # flake8: noqa: E402 directive to suppress E402 warnings caused by pre-commit checks. This is needed because mock setup must precede imports to avoid circular dependencies, and Ruff may report unused imports. Apply this directive to all similar test files that require imports to guard against circular import issues.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-12T11:24:13.825Z
Learnt from: servolkov
Repo: RedHatQE/openshift-virtualization-tests PR: 3387
File: tests/network/provider_migration/libprovider.py:50-52
Timestamp: 2026-01-12T11:24:13.825Z
Learning: In the RedHatQE/openshift-virtualization-tests repository, when catching exceptions in Python, use LOGGER.error before re-raising and do not replace it with LOGGER.exception in except blocks. This follows the established pattern across the codebase.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-12T14:25:05.723Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 3366
File: tests/storage/cdi_clone/test_clone.py:5-9
Timestamp: 2026-01-12T14:25:05.723Z
Learning: In Python tests and utility code across the repository, bitmath.parse_string_unsafe correctly parses Kubernetes quantities (e.g., '4Gi', '512Mi', PVC storage requests) without supplying system=bitmath.NIST. There are 30+ usages indicating this is the standard behavior. Reviewers should verify that code that builds or compares quantity strings does not pass the NIST parameter, and if a new test relies on quantity parsing, assume no NIST parameter is required unless explicitly documented.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-20T01:03:13.139Z
Learnt from: servolkov
Repo: RedHatQE/openshift-virtualization-tests PR: 3387
File: tests/network/provider_migration/libprovider.py:1-8
Timestamp: 2026-01-20T01:03:13.139Z
Learning: In the openshift-virtualization-tests repository, Python imports should consistently use module-level imports for the logging module (i.e., import logging) rather than from logging import ... The established pattern spans 270+ files and should not be flagged for refactoring. Apply this guideline to Python files across the repo (e.g., tests/network/provider_migration/libprovider.py).
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-21T21:26:41.805Z
Learnt from: geetikakay
Repo: RedHatQE/openshift-virtualization-tests PR: 3559
File: utilities/infra.py:251-254
Timestamp: 2026-01-21T21:26:41.805Z
Learning: In the RedHatQE/openshift-virtualization-tests repository, when reviewing Python code, recognize that with Python 3.14 the syntax 'except ValueError, TypeError:' is valid if there is no 'as' clause, and should not be flagged as Python 2 syntax. If you use an 'as' binding (e.g., 'except (ValueError, TypeError) as e:'), parentheses are required. Ensure this pattern is version-consistent and not flagged as Python 2 syntax when 'as' is absent.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-25T13:18:21.675Z
Learnt from: jpeimer
Repo: RedHatQE/openshift-virtualization-tests PR: 3571
File: tests/storage/storage_migration/utils.py:158-167
Timestamp: 2026-01-25T13:18:21.675Z
Learning: In reviews of the openshift-virtualization-tests repo (and similar Python code), avoid suggesting minor stylistic changes that require extra verification (e.g., removing dict.keys() checks for membership) unless the change has clear correctness or maintainability impact. Focus on fixes with observable behavior, security, performance, or maintainability benefits; defer low-impact style tweaks that are costly to verify.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-02-18T06:35:39.536Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 3847
File: utilities/virt.py:2449-2453
Timestamp: 2026-02-18T06:35:39.536Z
Learning: In Python code, a function named clearly and self-descriptively can be deemed not to require a docstring. However, treat this as a context-specific guideline and not a universal rule. For public APIs or functions with side effects, prefer concise docstrings explaining behavior, inputs, outputs, and side effects. This guidance is based on the example in utilities/virt.py from RedHatQE/openshift-virtualization-tests where validate_libvirt_persistent_domain(vm, admin_client) was considered self-documenting.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-02-23T16:33:22.070Z
Learnt from: vsibirsk
Repo: RedHatQE/openshift-virtualization-tests PR: 3883
File: utilities/pytest_utils.py:441-463
Timestamp: 2026-02-23T16:33:22.070Z
Learning: In Python code reviews, the guideline to always use named arguments for multi-argument calls does not apply to built-ins or methods that have positional-only parameters (those defined with a / in their signature). Do not flag or require named arguments for calls like dict.get(key, default=None, /), list.pop(), str.split(sep, maxsplit) and similar built-ins that cannot accept keyword arguments. Apply the named-argument rule only to functions/methods that explicitly accept keyword arguments.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-03-17T01:32:02.617Z
Learnt from: dshchedr
Repo: RedHatQE/openshift-virtualization-tests PR: 4118
File: utilities/database.py:0-0
Timestamp: 2026-03-17T01:32:02.617Z
Learning: In RedHatQE/openshift-virtualization-tests, when reviewing Python files, post targeted inline comments on the Files changed tab at the exact location (file and line) of the issue rather than opening a single discussion thread for multiple issues. This should be done for each applicable location to improve traceability and clarity. If multiple issues exist in the same file, address them with separate inline comments pointing to the specific lines.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-03-17T01:32:02.617Z
Learnt from: dshchedr
Repo: RedHatQE/openshift-virtualization-tests PR: 4118
File: utilities/database.py:0-0
Timestamp: 2026-03-17T01:32:02.617Z
Learning: In the RedHatQE/openshift-virtualization-tests repository, CodeRabbit should post targeted inline comments at each applicable location in the Files Changed tab, rather than aggregating multiple issues into a single PR discussion thread reply. This guideline applies to all Python files (any file ending in .py) changed in a PR; for non-Python files, follow the same inline-comment-at-location principle if relevant.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-04T13:45:29.122Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4725
File: utilities/console.py:54-59
Timestamp: 2026-05-04T13:45:29.122Z
Learning: During review of RedHatQE/openshift-virtualization-tests “lint-cleanup” PRs (e.g., changes targeting lint issues like stale noqa/utf-8 headers), do not flag existing `# type: ignore` directives that were already present before the PR and were not introduced or modified by the PR. Only raise findings for `# type: ignore` suppressions that the PR itself adds, changes, or otherwise makes newly effective (i.e., they appear in the diff as additions/edits).
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-04T13:45:33.892Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4725
File: tests/virt/cluster/common_templates/centos/test_centos_os_support.py:78-83
Timestamp: 2026-05-04T13:45:33.892Z
Learning: When reviewing lint-cleanup or formatting-only pull requests in this repo (e.g., changes like removing/updating `# noqa` comments or UTF-8 headers), do not raise findings for code patterns that already existed before the PR. Specifically, if a problematic construct such as `.is_connective(tcp_timeout=120)` was present in the base branch, suppress that finding and only raise issues when the PR itself introduces or modifies that construct (i.e., the diff adds/changes the call or its arguments). Apply this rule across all Python files (`**/*.py`).
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-05T17:01:15.294Z
Learnt from: dshchedr
Repo: RedHatQE/openshift-virtualization-tests PR: 4739
File: tests/virt/node/descheduler/conftest.py:2-2
Timestamp: 2026-05-05T17:01:15.294Z
Learning: In this repo’s Python code, it’s acceptable (and preferred by convention) to build `run_command` inputs using `shlex.split(f"<command> {arg}")` rather than converting to direct list literals like `['oc', 'adm', 'uncordon', name]`. During code review, generally don’t flag `shlex.split(...)` usage for `run_command` calls and don’t suggest replacing it with list literals; the string-form pattern is used to keep commands readable and consistent with how they’re typed in a terminal.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-08T12:49:20.694Z
Learnt from: geetikakay
Repo: RedHatQE/openshift-virtualization-tests PR: 4788
File: utilities/os_utils.py:257-262
Timestamp: 2026-05-08T12:49:20.694Z
Learning: In RedHatQE/openshift-virtualization-tests, the Ruff flake8-boolean-trap rules FBT001/FBT002 are intentionally not enabled (pyproject.toml does not select the FBT rules; confirmed via `ruff check --show-settings`). Therefore, do not flag boolean positional parameters as FBT001/FBT002 violations in this repository. If Ruff configuration changes and starts selecting FBT rules, this exception should be reconsidered.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-12T05:10:24.601Z
Learnt from: acinko-rh
Repo: RedHatQE/openshift-virtualization-tests PR: 4780
File: tests/storage/utils.py:568-572
Timestamp: 2026-05-12T05:10:24.601Z
Learning: In this repository, Ruff rule UP043 ("unnecessary default type arguments") is enforced. When annotating `collections.abc.Generator` return types, prefer the single-parameter form `Generator[YieldType]` rather than `Generator[YieldType, None, None]`. Explicit `None, None` for the SendType and ReturnType are unnecessary defaults (per PEP 696) and will trigger UP043. Apply this consistently across all Python files.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-13T19:23:09.603Z
Learnt from: Anatw
Repo: RedHatQE/openshift-virtualization-tests PR: 4833
File: tests/network/localnet/migration_stuntime/libstuntime.py:25-25
Timestamp: 2026-05-13T19:23:09.603Z
Learning: In this repository, do not recommend adding `from __future__ import annotations` to fix forward-reference type annotation issues (e.g., Ruff UP037). Follow the established convention: use quoted string type annotations for forward references when the referenced class/type is defined later in the same file (e.g., `"ContinuousPing"`), and prefer `typing.Self` for self-referential return types.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T06:30:56.781Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4819
File: utilities/unittests/test_bitwarden.py:207-207
Timestamp: 2026-05-18T06:30:56.781Z
Learning: During Ruff/lint rule-enablement PRs in this repository (e.g., when introducing a new rule like PLC0415), it’s acceptable to keep CI green by adding per-line, targeted suppressions for pre-existing violations: add only `# noqa: <single-ruff-rule-id>` at the end of the specific violating line. In this PR context, reviewers should NOT flag these targeted `# noqa: PLC0415` comments as policy violations, assuming the suppression is for a pre-existing issue and is documented in the PR description as a candidate for follow-up cleanup. Do not allow blanket `# noqa` (without a specific rule) or `per-file-ignores`; those remain disallowed.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T06:31:12.015Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4819
File: utilities/unittests/test_pytest_utils.py:270-270
Timestamp: 2026-05-18T06:31:12.015Z
Learning: In RedHatQE/openshift-virtualization-tests, if a PR is a Ruff rule-enforcement PR and its “Special notes for reviewer” documents that pre-existing Ruff violations are being temporarily handled via per-line suppressions (e.g., `# noqa: PLC0415`) to keep CI green, reviewers should treat those specific `# noqa: <rule>` comments as an agreed, temporary mechanism. Do not flag them as code-quality issues and do not recommend removing, consolidating, or refactoring those suppressions within the same PR; cleanup/remediation is expected to happen in dedicated follow-up PRs instead.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T06:31:15.083Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4819
File: utilities/unittests/test_data_collector.py:304-304
Timestamp: 2026-05-18T06:31:15.083Z
Learning: When reviewing Python code in this repository for Ruff/linter rule rollouts, do not treat temporary suppression comments as violations in the specific migration scenario where a PR enables a new Ruff rule (e.g., PLC0415) and the PR description explicitly documents that all *pre-existing* violations are being annotated with `# noqa: <RULE>` as a short-lived measure. In that case, only flag `# noqa: <RULE>` suppressions that are newly introduced on code that did not previously violate the rule—i.e., verify via the PR diff against the prior state (and/or prior Ruff findings) that the suppressed line was already violating before the rule was enabled. Ignore suppressions that are covering violations that existed before the new rule rollout and were intentionally bulk-added for cleanup in follow-up PRs.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T06:31:20.848Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4819
File: utilities/unittests/test_hco.py:501-501
Timestamp: 2026-05-18T06:31:20.848Z
Learning: When reviewing Python code in RedHatQE/openshift-virtualization-tests, avoid flagging Ruff `# noqa: <RULE>` suppressions as issues if they were intentionally added as a temporary measure to keep CI green after a PR enables a new Ruff/lint rule (e.g., PLC0415) and the PR description documents this under "Special notes for reviewer". Treat these suppressions as deferred technical debt. Only flag `# noqa: PLC0415` (and similar rule-specific suppressions) when they are newly introduced without an accompanying documented intent in the PR (and thus appear to be masking a new violation rather than a pre-existing one).
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T09:09:09.479Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4878
File: utilities/unittests/test_pytest_utils.py:2194-2197
Timestamp: 2026-05-18T09:09:09.479Z
Learning: In this repository (RedHatQE/openshift-virtualization-tests), do not flag missing return type annotations or missing argument type annotations as Ruff “ANN” rule violations (e.g., ANN001/ANN002/ANN201/ANN202). The repo’s Ruff configuration does not enable ANN rules and only uses `extend-select = ["PLC0415"]`, so missing type annotations should not be treated as ANN lint failures during code review.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-19T07:48:17.119Z
Learnt from: azhivovk
Repo: RedHatQE/openshift-virtualization-tests PR: 4784
File: libs/vm/affinity.py:104-104
Timestamp: 2026-05-19T07:48:17.119Z
Learning: When using Kubernetes API models like `NodeSelectorRequirement` or `LabelSelectorRequirement` with operators `Exists` or `DoesNotExist`, the `values` field must not be non-empty. It is valid for `values` to be omitted / left as `None` (Python) / passed as `null`—Kubernetes rejects non-empty `values` for these operators, but does not require the field to be present or explicitly set to an empty list. In code reviews, do not treat missing `values=[]` for `Exists`/`DoesNotExist` as a validation issue; only flag cases where `values` is provided with actual elements.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-19T07:48:17.119Z
Learnt from: azhivovk
Repo: RedHatQE/openshift-virtualization-tests PR: 4784
File: libs/vm/affinity.py:104-104
Timestamp: 2026-05-19T07:48:17.119Z
Learning: When constructing Kubernetes `NodeSelectorRequirement` (or `LabelSelectorRequirement`) objects in code, do not treat `values` being omitted, `None`, or an empty list as an API-validation problem when the requirement’s operator is `Exists` or `DoesNotExist`. Per the Kubernetes API spec, these operators only require that the `values` array is not non-empty (i.e., it must be empty); they do not require the field to be explicitly present as `[]`. Therefore, reviewers should not flag `values=None`/missing `values` for `Exists`/`DoesNotExist`.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-26T15:52:31.613Z
Learnt from: rlobillo
Repo: RedHatQE/openshift-virtualization-tests PR: 4983
File: utilities/hco.py:376-378
Timestamp: 2026-05-26T15:52:31.613Z
Learning: For Python files in this repo, don’t raise review findings for missing type hints or missing/Google-style docstrings on an existing function when the PR’s only functional change is adding one or more new parameters to that function and the PR does not otherwise refactor or substantially rewrite its body/signature. Treat type-annotation/docstring improvements as out of scope for focused parameter-add PRs and defer them to a follow-up. Only raise missing type-hint or docstring issues when the PR introduces an entirely new function or substantially rewrites an existing one.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-06-21T20:28:07.727Z
Learnt from: Anatw
Repo: RedHatQE/openshift-virtualization-tests PR: 5283
File: tests/network/libs/service.py:14-16
Timestamp: 2026-06-21T20:28:07.727Z
Learning: When reviewing Python code in this repository targeting Python 3.14 with PEP 649 (deferred annotation evaluation using descriptors) enabled by default, do not flag annotations that reference types imported only under `if TYPE_CHECKING:` (e.g., `client: DynamicClient | None = None`) as potential runtime `NameError` problems. With PEP 649 enabled, annotations are not evaluated at function definition time, so these patterns are valid without `from __future__ import annotations`.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-07-09T12:58:50.301Z
Learnt from: yossisegev
Repo: RedHatQE/openshift-virtualization-tests PR: 5578
File: tests/network/l2_bridge/libl2bridge.py:9-9
Timestamp: 2026-07-09T12:58:50.301Z
Learning: In this repo, follow the established convention for type-only imports: do not require moving `ResourceField` imports from `kubernetes.dynamic.client` behind an `if TYPE_CHECKING:` guard when the imported symbol is used only for type annotations (e.g., in function/class annotations) and not referenced at runtime. Only raise/flag this if `ResourceField` is actually used in executable code (runtime values/calls), since then the import may need to be handled differently.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-01-19T07:53:55.780Z
Learnt from: qwang1
Repo: RedHatQE/openshift-virtualization-tests PR: 3301
File: utilities/unittests/test_oadp.py:48-57
Timestamp: 2026-01-19T07:53:55.780Z
Learning: Enforce that pytest markers (e.g., marker requirement for integration tests) apply only to integration/functional tests under the tests/ directory. Unit tests located in utilities/unittests/ must not use pytest markers, following repository convention. For all unit test files under utilities/unittests (and subdirectories), do not require or mandate markers; for integration tests under tests/ and its subdirectories, ensure markers are used as per the project rule.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-02-18T06:34:38.042Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 3847
File: tests/virt/cluster/common_templates/utils.py:58-58
Timestamp: 2026-02-18T06:34:38.042Z
Learning: In RedHatQE/openshift-virtualization-tests, treat 'public' functions as those defined in any Python files under libs/ or utilities/ (any depth). Functions inside nested test directories (e.g., tests/virt/cluster/common_templates/, tests/virt/node/, etc.) are test helpers and do not require Google-format docstrings unless explicitly requested. Use this rule during reviews to decide whether to enforce docstrings on public API functions in libs/utilities.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-02-23T21:16:51.920Z
Learnt from: vsibirsk
Repo: RedHatQE/openshift-virtualization-tests PR: 3883
File: utilities/unittests/test_os_utils.py:358-371
Timestamp: 2026-02-23T21:16:51.920Z
Learning: In the openshift-virtualization-tests repository, the guideline to require named arguments for function calls with more than one argument does not apply to unit tests under utilities/unittests/. For these tests, allow standard pytest patterns like pytest.raises(ExceptionType, match="pattern") without requiring named parameters. This exception applies specifically to files under utilities/unittests/ and does not generalize beyond that directory.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-03T15:38:22.954Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4701
File: utilities/unittests/test_database.py:12-12
Timestamp: 2026-05-03T15:38:22.954Z
Learning: In RedHatQE/openshift-virtualization-tests unit tests under `utilities/unittests/`, it’s intentional/pre-existing to use `sys.path.insert(0, ...)` in cases where tests need to import local modules. In lint-cleanup PRs, reviewers should not flag this `sys.path` manipulation as a violation. Also, don’t re-add `# noqa: E402` or other import-order suppressions if `ruff/flake8` no longer reports E402 for that import—handle any broader refactor (to remove the `sys.path` hack) in a dedicated follow-up.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T06:31:30.830Z
Learnt from: EdDev
Repo: RedHatQE/openshift-virtualization-tests PR: 4819
File: utilities/unittests/test_sanity.py:22-22
Timestamp: 2026-05-18T06:31:30.830Z
Learning: In this repo’s unit test files under `utilities/unittests/`, treat `# noqa: PLC0415` (import-outside-top-level) suppressions as intentional and do not flag them as violations when enabling Ruff’s PLC0415 rule incrementally. These suppressions are expected as temporary measures and are documented in the PR description; they should only be targeted for later cleanup follow-ups.
Also, allow imports placed inside unit test methods under `utilities/unittests/` when they are intentionally positioned to run after `patch` decorators are applied—especially when the imported module has import-time side effects.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-07-01T15:15:37.516Z
Learnt from: jpeimer
Repo: RedHatQE/openshift-virtualization-tests PR: 5443
File: utilities/unittests/test_storage.py:14-19
Timestamp: 2026-07-01T15:15:37.516Z
Learning: In this repository, within `utilities/unittests/**`, it is acceptable to use the established convention `module_obj.submodule = value # type: ignore[attr-defined]` (e.g., `utilities.storage = utilities.storage`, `utilities.hco = mock_hco`, `utilities.virt = mock_virt`) when reassigning/reloading submodules as attributes on the `utilities` package for test mocking/reload purposes. These assignments are intentionally suppressed for mypy’s `attr-defined` warning, and equivalent rebinding via local variables does not provide the required reload/rebind semantics for these tests. Code review should not treat this specific `# type: ignore[attr-defined]` pattern in `utilities/unittests/**/*.py` as a new linter/type-suppression violation.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-03T15:38:09.624Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4701
File: tests/virt/node/general/test_windows_vtpm_bitlocker.py:50-52
Timestamp: 2026-05-03T15:38:09.624Z
Learning: During review of PRs that are lint cleanups or tooling/version bumps, do not flag code-quality issues for patterns that pre-existed before the PR. Specifically, if the diff does not introduce/modify constructs such as nested `if` blocks or unnecessary list comprehensions, treat them as known/deferred and leave them for dedicated follow-up cleanup PRs. Only raise issues when the PR itself adds, changes, or refactors the problematic code.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-15T18:42:02.504Z
Learnt from: geetikakay
Repo: RedHatQE/openshift-virtualization-tests PR: 4860
File: utilities/hco.py:385-389
Timestamp: 2026-05-15T18:42:02.504Z
Learning: In this repository, under the Python `utilities/` directory (utility/helper modules, not tests), do not flag bare `assert` statements as correctness or style issues. The codebase conventionally uses `assert` in these utilities (e.g., `utilities/virt.py`, `utilities/infra.py`, etc.) and does not enforce running Python with `-O`/`PYTHONOPTIMIZE`, so the usual “asserts may be stripped” concern should not be treated as a review blocker here.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-05-18T10:38:33.820Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4884
File: .coderabbit.yaml:79-80
Timestamp: 2026-05-18T10:38:33.820Z
Learning: In this repo, pytest tests are expected to live only in files named `test_*.py`. When applying CodeRabbit STP case B (newly added `def test_*` inside an existing test file), scope the check to existing files that match `test_*.py` and do not broaden it to newly added `def test_*` found in other non-`test_*.py` Python files.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-06-01T06:43:07.271Z
Learnt from: rnetser
Repo: RedHatQE/openshift-virtualization-tests PR: 4908
File: utilities/unittests/test_pytest_utils.py:374-374
Timestamp: 2026-06-01T06:43:07.271Z
Learning: In RedHatQE/openshift-virtualization-tests, do not require STP/RFE/Jira traceability links in unit test function docstrings for any `test_*.py` file under `utilities/unittests/` (including subdirectories). Only integration/functional tests under the repository’s `tests/` directory should be checked for STP/RFE/Jira traceability links; therefore, missing STP/RFE/Jira docstring links in `utilities/unittests/**/test_*.py` should not be flagged.
Applied to files:
utilities/unittests/test_guest_support.py
📚 Learning: 2026-06-15T10:56:21.758Z
Learnt from: vsibirsk
Repo: RedHatQE/openshift-virtualization-tests PR: 4994
File: tests/network/user_defined_network/ip_specification/test_ip_specification.py:123-127
Timestamp: 2026-06-15T10:56:21.758Z
Learning: In this repository, do not require or flag missing `-> None` return type annotations on pytest test functions/methods (i.e., functions named `test_*`) located under `tests/**`. Return type annotations for `-> None` on these test functions are optional and should not be treated as inconsistent. Separately, in `utilities/**` and `libs/**`, enforce return type annotations for non-test public functions (e.g., functions that are not internal/private such as those not starting with `_`).
Applied to files:
utilities/unittests/test_guest_support.py
🪛 Ruff (0.15.21)
utilities/unittests/test_guest_support.py
[warning] 564-564: Unused method argument: mock_kill_processes
(ARG002)
[warning] 580-580: Unused method argument: mock_pause_unpause
(ARG002)
[warning] 580-580: Unused method argument: mock_kill_processes
(ARG002)
Comment on lines
+14
to
+15
| from utilities.constants.timeouts import TCP_TIMEOUT_30SEC | ||
| from utilities.constants.virt import OS_PROC_NAME |
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Verify PR description contains required sections
gh pr view --json body --jq '.body' | grep -q '##### What this PR does / why we need it:' || echo 'Missing: What this PR does'
gh pr view --json body --jq '.body' | grep -q '##### Which issue(s) this PR fixes:' || echo 'Missing: Which issue(s) this PR fixes'
gh pr view --json body --jq '.body' | grep -q '##### Special notes for reviewer:' || echo 'Missing: Special notes for reviewer'
gh pr view --json body --jq '.body' | grep -q '##### jira-ticket:' || echo 'Missing: jira-ticket'Repository: RedHatQE/openshift-virtualization-tests
Length of output: 591
HIGH: Restore the required PR template sections.
##### What this PR does / why we need it:, ##### Which issue(s) this PR fixes:, ##### Special notes for reviewer:, and ##### jira-ticket: are missing from the PR body. The first section also needs real content so reviewers can understand scope and trace the change.
🤖 Prompt for 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.
In `@utilities/unittests/test_guest_support.py` around lines 14 - 15, Restore the
required PR template sections in the pull request body: “What this PR does / why
we need it,” “Which issue(s) this PR fixes,” “Special notes for reviewer,” and
“jira-ticket.” Populate the first section with a clear, specific summary of the
change’s scope; retain the other required sections with appropriate content or
explicit values.
Source: Path instructions
Comment on lines
+563
to
+574
| def test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid( | ||
| self, mock_start_and_fetch_pid, mock_pause_unpause, mock_fetch_pid, mock_kill_processes | ||
| ): | ||
| """Test that the provided pre-pause PID is used instead of starting a new process""" | ||
| mock_vm = MagicMock() | ||
| mock_fetch_pid.return_value = 5678 | ||
|
|
||
| validate_pause_unpause_windows_vm(vm=mock_vm, pre_pause_pid=5678) | ||
|
|
||
| mock_start_and_fetch_pid.assert_not_called() | ||
| mock_pause_unpause.assert_called_once_with(vm=mock_vm) | ||
|
|
Contributor
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
HIGH: Utilize unused mock arguments by verifying their calls.
The coding guidelines mandate removing unused variables, and static analysis (Ruff ARG002) flags these unused mock arguments. In test code, unused mocks indicate incomplete coverage where side effects are not fully verified. Utilize these variables by asserting that the mocked functions were called with the expected arguments.
utilities/unittests/test_guest_support.py#L563-L574: Assertmock_fetch_pidandmock_kill_processeswere called with the correctvmandprocess_name.utilities/unittests/test_guest_support.py#L579-L588: Assertmock_pause_unpause,mock_fetch_pid, andmock_kill_processeswere called with the correct arguments after the exception block.
🛠️ Proposed fixes
For test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid:
mock_start_and_fetch_pid.assert_not_called()
mock_pause_unpause.assert_called_once_with(vm=mock_vm)
+ mock_fetch_pid.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"])
+ mock_kill_processes.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"])For test_validate_pause_unpause_windows_vm_pid_mismatch:
with pytest.raises(AssertionError, match="PID mismatch"):
validate_pause_unpause_windows_vm(vm=mock_vm)
+
+ mock_pause_unpause.assert_called_once_with(vm=mock_vm)
+ mock_fetch_pid.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"])
+ mock_kill_processes.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"])📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| def test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid( | |
| self, mock_start_and_fetch_pid, mock_pause_unpause, mock_fetch_pid, mock_kill_processes | |
| ): | |
| """Test that the provided pre-pause PID is used instead of starting a new process""" | |
| mock_vm = MagicMock() | |
| mock_fetch_pid.return_value = 5678 | |
| validate_pause_unpause_windows_vm(vm=mock_vm, pre_pause_pid=5678) | |
| mock_start_and_fetch_pid.assert_not_called() | |
| mock_pause_unpause.assert_called_once_with(vm=mock_vm) | |
| def test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid( | |
| self, mock_start_and_fetch_pid, mock_pause_unpause, mock_fetch_pid, mock_kill_processes | |
| ): | |
| """Test that the provided pre-pause PID is used instead of starting a new process""" | |
| mock_vm = MagicMock() | |
| mock_fetch_pid.return_value = 5678 | |
| validate_pause_unpause_windows_vm(vm=mock_vm, pre_pause_pid=5678) | |
| mock_start_and_fetch_pid.assert_not_called() | |
| mock_pause_unpause.assert_called_once_with(vm=mock_vm) | |
| mock_fetch_pid.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"]) | |
| mock_kill_processes.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"]) | |
| def test_validate_pause_unpause_windows_vm_pid_mismatch( | |
| self, mock_start_and_fetch_pid, mock_pause_unpause, mock_fetch_pid, mock_kill_processes | |
| ): | |
| """Test assertion failure when the PID before and after pause/unpause differ""" | |
| mock_vm = MagicMock() | |
| mock_start_and_fetch_pid.return_value = 1234 | |
| mock_fetch_pid.return_value = 4321 | |
| with pytest.raises(AssertionError, match="PID mismatch"): | |
| validate_pause_unpause_windows_vm(vm=mock_vm) | |
| mock_pause_unpause.assert_called_once_with(vm=mock_vm) | |
| mock_fetch_pid.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"]) | |
| mock_kill_processes.assert_called_once_with(vm=mock_vm, process_name=OS_PROC_NAME["windows"]) |
🧰 Tools
🪛 Ruff (0.15.21)
[warning] 564-564: Unused method argument: mock_kill_processes
(ARG002)
📍 Affects 1 file
utilities/unittests/test_guest_support.py#L563-L574(this comment)utilities/unittests/test_guest_support.py#L579-L588
🤖 Prompt for 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.
In `@utilities/unittests/test_guest_support.py` around lines 563 - 574, Update
test_validate_pause_unpause_windows_vm_uses_provided_pre_pause_pid to assert
mock_fetch_pid and mock_kill_processes were called with the expected vm and
process_name arguments; update
test_validate_pause_unpause_windows_vm_pid_mismatch to assert
mock_pause_unpause, mock_fetch_pid, and mock_kill_processes were called with
their expected arguments after the exception block. These changes should use
every injected mock and preserve the existing behavior assertions.
Sources: Coding guidelines, Linters/SAST tools
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Adds a new
test_pause_unpause_vmtest to the Windows instance types supported OS suite, and movesvalidate_pause_unpause_windows_vmfromtests/virt/utils.pytoutilities/guest_support.pyso it can be shared across both test modules.Which issue(s) this PR fixes:
Special notes for reviewer:
jira-ticket:
https://redhat.atlassian.net/browse/CNV-86485
Summary by CodeRabbit
Bug Fixes
Tests