Skip to content

[Virt] Add suffix for s390x template names for Common templates tests #921

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 29 commits into
base: main
Choose a base branch
from

Conversation

jdao-rh
Copy link

@jdao-rh jdao-rh commented May 8, 2025

Short description:

Adds support of test on s390x by adding correct template names for virt/cluster/commontemplate/general tests

More details:
  • checks node arch
  • Adds "-s390x" suffix to common templates when run on s390x
What this PR does / why we need it:

Allows virt/cluster/commontemplate/general to be run against s390x arch

Which issue(s) this PR fixes:
Special notes for reviewer:
jira-ticket:

Summary by CodeRabbit

  • Tests
    • Enhanced test coverage to dynamically handle template lists based on cluster CPU architecture, including architecture-specific template naming and restrictions.
  • New Features
    • Added support for the s390x CPU architecture in template selections and constants.

Copy link

coderabbitai bot commented May 8, 2025

## Walkthrough

Architecture-awareness is added to template list generation functions by introducing a required `cluster_arch` parameter. Template lists and names are adapted based on architecture, particularly for "s390x". The pytest fixture dynamically determines the node CPU architecture for accurate template expectations. A new constant `S390X` is added to CPU architecture constants.

## Changes

| File(s)                                                   | Change Summary                                                                                                                                                                                                                      |
|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| tests/virt/cluster/common_templates/general/test_base_template.py | Updated template list functions to accept `cluster_arch`, adapted template naming and filtering for "s390x" architecture, and modified pytest fixture to detect node CPU architecture dynamically and pass it to these functions.    |
| utilities/constants.py                                    | Added new CPU architecture constant `S390X = "s390x"` and `S390X_TEMPLATE_SUFFIX = "-s390x"` alongside existing constants.                                                                                                        |

## Suggested labels

`verified`, `size/XS`, `can-be-merged`

## Suggested reviewers

- vsibirsk
- dshchedr
- kbidarkar
- akri3i
- 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 5a8209e and 32d2ec6.

📒 Files selected for processing (2)
  • tests/virt/cluster/common_templates/general/test_base_template.py (4 hunks)
  • utilities/constants.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • utilities/constants.py
🧰 Additional context used
🧬 Code Graph Analysis (1)
tests/virt/cluster/common_templates/general/test_base_template.py (1)
utilities/infra.py (1)
  • get_nodes_cpu_architecture (1546-1549)
🪛 Pylint (3.3.7)
tests/virt/cluster/common_templates/general/test_base_template.py

[error] 145-145: No value for argument 'nodes' in function call

(E1120)

⏰ 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
🔇 Additional comments (6)
tests/virt/cluster/common_templates/general/test_base_template.py (6)

20-21: LGTM: Import statements are correct.

The new imports for infra module and architecture constants (S390X, S390X_TEMPLATE_SUFFIX) are properly added to support the architecture-aware functionality.


93-103: LGTM: RHEL template logic correctly handles s390x architecture.

The implementation correctly:

  • Removes RHEL 7 templates for s390x architecture with appropriate logging
  • Applies the s390x template suffix when needed
  • Maintains the existing template generation logic for other architectures

106-111: LGTM: Fedora template logic properly implements architecture awareness.

The function correctly applies the s390x template suffix while maintaining the original template generation structure.


114-117: LGTM: Windows template logic correctly excludes s390x architecture.

The implementation appropriately returns an empty list for s390x architecture with informative logging, which aligns with the fact that Windows is not supported on s390x.


133-140: LGTM: CentOS template logic properly implements architecture awareness.

The function correctly applies the s390x template suffix for CentOS templates while maintaining the existing logic.


146-149: LGTM: Template list aggregation correctly uses architecture parameter.

The fixture properly passes the detected architecture to all template generation functions, ensuring consistency across all template types.

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

@dbasunag1
Copy link

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

@rabin-io
Copy link
Contributor

rabin-io commented May 8, 2025

/build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT=06faf24b83a33dec0cd228b9b690a1d440f240f2

@dbasunag1
Copy link

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

@ghost ghost added the lgtm-dshchedr label May 27, 2025
@jdao-rh
Copy link
Author

jdao-rh commented May 28, 2025

/retest build-container

@rnetser
Copy link
Collaborator

rnetser commented May 28, 2025

/retest build-container

@jdao-rh
Copy link
Author

jdao-rh commented May 30, 2025

@rnetser is there a way to run the verified check? It has been waiting to run for a few days now

@rnetser
Copy link
Collaborator

rnetser commented May 31, 2025

@rnetser is there a way to run the verified check? It has been waiting to run for a few days now

@jdao-rh the verified check is executed when the PR is marked as verified, If the PR is verified, please add a comment with /verified

@RoniKishner @geetikakay please review this PR

rhel_major_releases_list = ["7", "8", "9"]
template_suffix = ""
if cluster_arch == S390X:
template_suffix = f"-{S390X}"
Copy link
Contributor

Choose a reason for hiding this comment

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

This string appears also in line 109 and 137, why not doing it as const?

def get_fedora_templates_list(cluster_arch):
template_suffix = f"-{S390X}" if cluster_arch == S390X else ""
return [
f"fedora-{workload}-{flavor}{template_suffix}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Make template suffix as const and with f"-{S390X}" as value and then remove the template_suffix var and use it directly:

Suggested change
f"fedora-{workload}-{flavor}{template_suffix}"
f"fedora-{workload}-{flavor}{S390_TEMPLATE_SUFFIX if cluster_arch == S390X else ''}"

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the suggestion, will update the PR with your suggested changes 👍



def get_windows_templates_list():
def get_windows_templates_list(cluster_arch):
if cluster_arch == "s390x":
Copy link
Contributor

Choose a reason for hiding this comment

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

You have const for that.

centos_releases_list = ["-stream9"]
return [
f"centos{release}-{workload}-{flavor}"
f"centos{release}-{workload}-{flavor}{template_suffix}"
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto, use directly:

Suggested change
f"centos{release}-{workload}-{flavor}{template_suffix}"
f"centos{release}-{workload}-{flavor}{-{S390_TEMPLATE_SUFFIX if cluster_arch == S390X else ''}"

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/12399

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