Skip to content

[virt] tests for mass machine type transition #1210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

akri3i
Copy link
Contributor

@akri3i akri3i commented Jun 13, 2025

Short description:

tests for mass machine type transition

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

Summary by CodeRabbit

  • Tests
    • Introduced automated tests validating machine type transitions and scheduling for virtual machines in Kubernetes.
    • Added scenarios covering VM scheduling based on machine type, node labeling, and machine type changes with and without VM restarts.
    • Enhanced test coverage for resource setup, job execution, and VM state verification in KubeVirt environments.
  • Chores
    • Centralized machine type name constants for virtualization tests by relocating them to a common module and removing redundant definitions.

Copy link

coderabbitai bot commented Jun 13, 2025

"""

Walkthrough

A new test module for KubeVirt virtual machine lifecycle automation has been introduced. It adds multiple pytest fixtures and parameterized test cases to validate machine type transitions, scheduling behavior, and lifecycle automation jobs for VMs in a Kubernetes cluster. The module covers resource setup, job execution, and VM state validation. Additionally, a new class defining machine type name constants was added, an old constants file was deleted, and import paths for this class were corrected in existing test files.

Changes

Files/Paths Change Summary
tests/virt/cluster/general/test_mass_machine_type_transition.py Added a new test module with pytest fixtures and parameterized tests for machine type labeling, VM scheduling, lifecycle automation jobs, and machine type transitions.
tests/virt/constants.py Added MachineTypesNames class with string constants for base and RHEL-specific machine type names.
tests/virt/node/general/constants.py Deleted the file containing the old MachineTypesNames class and its string constants.
tests/virt/node/general/test_machinetype.py Updated import of MachineTypesNames from tests.virt.node.general.constants to tests.virt.constants.
tests/virt/node/general/test_legacy_machinetype.py Updated import of MachineTypesNames from tests.virt.node.general.constants to tests.virt.constants.

Possibly related PRs

  • update machine type test for pc-q35-rhel9.6.0 #975: Added a new machine type constant pc_q35_rhel9_6 in the old constants file, which was later removed and moved to tests/virt/constants.py. This PR extends those changes with new test logic for machine type transitions and lifecycle automation.

Suggested labels

can-be-merged, lgtm-dshchedr, approved-rnetser, lgtm-rnetser

Suggested reviewers

  • jerry7z
  • kbidarkar
  • dshchedr
  • vsibirsk
  • SiboWang1997
  • rnetser
    """

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d3b661 and 3eda52f.

📒 Files selected for processing (1)
  • tests/virt/cluster/general/test_mass_machine_type_transition.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • tests/virt/cluster/general/test_mass_machine_type_transition.py
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: build-container
  • GitHub Check: tox
  • GitHub Check: can-be-merged
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@openshift-virtualization-qe-bot

Report bugs in Issues

The following are automatically added:

  • Add reviewers from OWNER file (in the root of the repository) under reviewers section.
  • Set PR size label.
  • New issue is created for the PR. (Closed when PR is merged/closed)
  • Run pre-commit if .pre-commit-config.yaml exists in the repo.

Available user actions:

  • To mark PR as WIP comment /wip to the PR, To remove it from the PR comment /wip cancel to the PR.
  • To block merging of PR comment /hold, To un-block merging of PR comment /hold cancel.
  • To mark PR as verified comment /verified to the PR, to un-verify comment /verified cancel to the PR.
    verified label removed on each new commit push.
  • To cherry pick a merged PR comment /cherry-pick <target branch to cherry-pick to> in the PR.
    • Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2)
    • Cherry-pick will be started when PR is merged
  • To build and push container image command /build-and-push-container in the PR (tag will be the PR number).
    • You can add extra args to the Podman build command
      • Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=<commit_hash>
  • To add a label by comment use /<label name>, to remove, use /<label name> cancel
  • To assign reviewers based on OWNERS file use /assign-reviewers
  • To check if PR can be merged use /check-can-merge
  • to assign reviewer to PR use /assign-reviewer @<reviewer>

PR will be approved when the following conditions are met:

  • /approve from one of the approvers.
  • Minimum number of required /lgtm (2) is met.
Approvers and Reviewers
  • Approvers:

    • dshchedr
    • vsibirsk
  • Reviewers:

    • SiboWang1997
    • akri3i
    • dshchedr
    • jerry7z
    • kbidarkar
    • vsibirsk
Supported /retest check runs
  • /retest tox: Retest tox
  • /retest build-container: Retest build-container
  • /retest all: Retest all
Supported labels
  • hold
  • verified
  • wip
  • lgtm
  • approve

@akri3i
Copy link
Contributor Author

akri3i commented Jun 13, 2025

/verified

Copy link

@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: 1

🧹 Nitpick comments (5)
tests/virt/cluster/general/test_mass_machine_type_transition.py (5)

25-34: Reduce fixture signature complexity

run_kubevirt_api_lifecycle_automation_job takes eight positional arguments, breaching Pylint’s R0913/R0917 limits and making the fixture hard to read/maintain.
Consider wrapping the optional values (name, service_account, delete_after) into a small dataclass or a simple **kwargs dict so the signature only exposes the injected fixtures.

🧰 Tools
🪛 Pylint (3.3.7)

[refactor] 25-25: Too many arguments (8/5)

(R0913)


[refactor] 25-25: Too many positional arguments (8/5)

(R0917)


41-44: Normalise RESTART_REQUIRED to a predictable value

restart_required arrives from the parametrisation as free-form text.
A mix of "TRUE", "True", "true" (or even bools) would silently break the equality check at line 191.

-            {"name": "RESTART_REQUIRED", "value": params.get("restart_required")},
+            {"name": "RESTART_REQUIRED", "value": str(params.get("restart_required")).lower()},

and compare with "true" / "false" everywhere.


80-84: Use the resolved namespace instead of the constant

add_scc_to_service_account() should use the actual namespace name coming from the fixture for clarity and to avoid accidental drift if the constant ever changes.

-        add_scc_to_service_account(
-            namespace=KUBEVIRT_API_LIFECYCLE_AUTOMATION,
+        add_scc_to_service_account(
+            namespace=kubevirt_api_lifecycle_namespace.name,

200-202: Fix typo in assertion message

smaesame.

-            f"VM {vm_with_schedulable_machine_type.name} should have smae machine type as before transition"
+            f"VM {vm_with_schedulable_machine_type.name} should have same machine type as before transition"

13-13: Constant should be upper-case

pc_q35_rhel8_4 represents a constant value and should follow all-caps naming (PC_Q35_RHEL8_4) to stay in line with PEP-8.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aab20c0 and 51a637b.

📒 Files selected for processing (1)
  • tests/virt/cluster/general/test_mass_machine_type_transition.py (1 hunks)
🧰 Additional context used
🪛 Pylint (3.3.7)
tests/virt/cluster/general/test_mass_machine_type_transition.py

[refactor] 25-25: Too many arguments (8/5)

(R0913)


[refactor] 25-25: Too many positional arguments (8/5)

(R0917)

⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: can-be-merged
  • GitHub Check: tox
  • GitHub Check: build-container
🔇 Additional comments (1)
tests/virt/cluster/general/test_mass_machine_type_transition.py (1)

151-153: Guard against missing VMI when VM is unschedulable

If the VM never spawns a VMI, vm_with_unschedulable_machine_type.instance may be None, raising AttributeError.
Consider:

vmi = vm_with_unschedulable_machine_type.instance
assert vmi is not None and vmi.status.get("printableStatus") == "ErrorUnschedulable", ...

Copy link
Collaborator

@dshchedr dshchedr left a comment

Choose a reason for hiding this comment

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

looks good, just a nit

Copy link

Choose a reason for hiding this comment

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

D/S test tox -e verify-bugs-are-open failed: cnv-tests-tox-executor/12895

@@ -0,0 +1,260 @@
import pytest
Copy link
Collaborator

Choose a reason for hiding this comment

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

please follow the readme and split into different files, contest, test file and if needed utils.
should be placed under a dir with the feature name

yield job


@pytest.fixture(scope="session")
Copy link
Collaborator

Choose a reason for hiding this comment

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

why is this scoped session?

yield from create_ns(name=KUBEVIRT_API_LIFECYCLE_AUTOMATION, admin_client=admin_client)


@pytest.fixture(scope="session")
Copy link
Collaborator

Choose a reason for hiding this comment

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

ditto


@pytest.fixture(scope="session")
def kubevirt_api_lifecycle_service_account(kubevirt_api_lifecycle_namespace):
with ServiceAccount(name=KUBEVIRT_API_LIFECYCLE_AUTOMATION, namespace=kubevirt_api_lifecycle_namespace.name) as sa:
Copy link
Collaborator

Choose a reason for hiding this comment

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

please add client in all resources

if not any(label.startswith("machine-type.node.kubevirt") for label in node.labels.keys())
]
assert not nodes_without_machine_type_label, (
f"Node {nodes_without_machine_type_label} does not have 'machine-type' label"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
f"Node {nodes_without_machine_type_label} does not have 'machine-type' label"
f"Nodes {nodes_without_machine_type_label} do not have 'machine-type' label"


@pytest.mark.polarion("CNV-12003")
def test_vm_with_unschedulable_machine_type_fails_to_schedule(vm_with_unschedulable_machine_type):
vm_with_unschedulable_machine_type.wait_for_specific_status(status=VirtualMachine.Status.ERROR_UNSCHEDULABLE)
Copy link
Collaborator

Choose a reason for hiding this comment

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

ERROR_UNSCHEDULABLE is a generic error, i recommend checking the actual reason to make sure it is the expected one (and not, for example, failed cluster)

class TestMachineTypeTransition:
@pytest.mark.dependency(name=f"{TESTS_CLASS_NAME}::vm_running_with_schedulable_machine_type")
@pytest.mark.polarion("CNV-11989")
def test_vm_running_with_schedulable_machine_type(
Copy link
Collaborator

Choose a reason for hiding this comment

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

based on the class name, this should be in setup, no?


KUBEVIRT_API_LIFECYCLE_AUTOMATION = "kubevirt-api-lifecycle-automation"
TESTS_CLASS_NAME = "TestMachineTypeTransition"
ERROR_MESSAGE = "VM {} should have machine type {}, current machine type: {}"
Copy link
Collaborator

Choose a reason for hiding this comment

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

please add arg names so it is clear what is expected, e.g "VM {vm_name} ..."

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.

9 participants