Tests for filesystem and disk allocated size metrics

[OhadRevah]

Short description:

Test for filesystem and disk allocated size metrics for windwos vms:
kubevirt_vm_disk_allocated_size_bytes
kubevirt_vmi_filesystem_used_bytes
kubevirt_vmi_filesystem_capacity_bytes

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

• Refactor
  • Tests for file system and disk metrics are now separated for Linux and Windows virtual machines, improving clarity and maintainability.
  • Memory metric validation in tests is now centralized for consistency.
  • Filesystem info fixtures reorganized to separate Linux and Windows variants; redundant memory-related fixtures removed.
• Tests
  • Enhanced test coverage for both Linux and Windows VM file system and disk allocation metrics.
  • Improved validation logic for VM memory metrics in test cases.
• New Features
  • Added utilities for retrieving VM storage size and memory metrics to support improved metric validation.
• Bug Fixes
  • Improved robustness of filesystem metric validations by filtering incomplete data and refining metric comparisons with tolerance.

[coderabbitai]

## Walkthrough

This change refactors VM observability metrics tests and utilities by separating Linux and Windows test cases, updating and removing related fixtures, and introducing new utility functions for memory and storage metric validation. It enhances test clarity, improves metric validation robustness, and centralizes logic for retrieving and comparing VM metrics.

## Changes

| Files / Grouped Files                                         | Change Summary |
|--------------------------------------------------------------|----------------|
| tests/observability/metrics/conftest.py                      | Removed unused imports and multiple VM memory/PodMetrics fixtures; renamed and split filesystem info fixtures for Linux and Windows; updated dependent fixture signatures; changed scope of Windows VM fixture. |
| tests/observability/metrics/test_vms_metrics.py              | Refactored to separate Linux and Windows test classes for filesystem and disk size metrics; updated test method signatures; centralized free memory metric validation via a new helper function; replaced PVC size fixture with utility call. |
| tests/observability/metrics/utils.py                         | Refined regex and filtering in filesystem info; improved metric comparison logic with `math.isclose`; added functions for PVC size retrieval, pod requested memory, working set and RSS memory retrieval, and metric validation with tolerance and timeout. |
| tests/observability/metrics/constants.py                     | Added new constant `KUBEVIRT_VM_DISK_ALLOCATED_SIZE_BYTES` for VM disk allocated size metric template. |

## Possibly related PRs

- [RedHatQE/openshift-virtualization-tests#1023](https://github.com/RedHatQE/openshift-virtualization-tests/pull/1023): Modifies the `vm_memory_working_set_bytes` fixture with retry logic; directly related as this PR removes and replaces that fixture with new abstractions for VM free memory metric testing.

## Suggested labels

`verified`, `size/M`, `can-be-merged`, `lgtm-rnetser`, `approved-rnetser`, `lgtm-vsibirsk`, `lgtm-dshchedr`

## Suggested reviewers

- rnetser
- vsibirsk
- dshchedr
- hmeir
- RoniKishner

---

📜 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 ffd3c6f and e141dc5.

📒 Files selected for processing (3)

• tests/observability/metrics/conftest.py (3 hunks)
• tests/observability/metrics/constants.py (1 hunks)
• tests/observability/metrics/utils.py (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• tests/observability/metrics/constants.py
• tests/observability/metrics/conftest.py

🔇 Additional comments (10)

tests/observability/metrics/utils.py (10)

15-15: LGTM! Imports align with new functionality.

The new imports (PersistentVolumeClaim, PodMetrics, ContainerNotFound, TIMEOUT_5SEC) are all appropriately used in the new utility functions added later in the file.

Also applies to: 17-17, 24-24, 52-52

---

1177-1192: Good improvements to filesystem data validation.

The enhanced filtering logic and assertion ensure only complete filesystem entries are processed, which improves robustness. The regex pattern correctly uses \d+ to match filesystem IDs.

---

1195-1200: LGTM! Function signature reformatted for better readability.

The parameter formatting improves code readability while maintaining the same functionality.

---

1218-1218: Excellent enhancement to metric comparison logic.

The improvements include:

• Smart handling of Windows mount points with trailing backslashes
• Robust parsing using bitmath for non-numeric values
• Superior comparison using math.isclose with 5% tolerance instead of manual range checking

This addresses previous review feedback and makes the comparison more reliable.

Also applies to: 1222-1224

---

1503-1516: Well-implemented PVC size retrieval function.

The function properly validates the presence of DataVolume templates and safely accesses the storage size. Good defensive programming with the assertion.

---

1518-1522: Proper use of walrus operator and error handling.

The function correctly uses the walrus operator for assignment and conditional checking, with appropriate exception handling for missing containers.

---

1524-1539: Good waiting pattern implementation.

The function properly waits for the PodMetrics resource with appropriate timeout and error handling. The logging provides useful feedback for debugging.

---

1541-1559: Robust working set memory retrieval.

The function handles the complete workflow: waiting for PodMetrics resource, executing the oc adm top command, and parsing memory values with units. The regex pattern correctly captures different memory units (Ki, Mi, Gi).

---

1561-1563: Simple and effective RSS memory retrieval.

Clean implementation that delegates to the appropriate VM method.

---

1565-1591: Comprehensive metric validation function.

The function properly validates VM container memory metrics with:

• Flexible validation logic for both working set and RSS memory scenarios
• Appropriate use of math.isclose for floating-point comparison with 5% tolerance
• Good timeout handling and error reporting

This centralizes complex validation logic effectively.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

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
  • myakove
  • rnetser
  • vsibirsk

• Reviewers:

  • OhadRevah
  • RoniKishner
  • dshchedr
  • hmeir
  • rnetser
  • 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

[OhadRevah]

/build-and-push-container

[dbasunag1]

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

[OhadRevah]

/verified

[rnetser]

/approve
/lgtm