Skip to content

[Storage] Add Velero backup hooks opt-out tests#5478

Open
ema-aka-young wants to merge 2 commits into
RedHatQE:mainfrom
ema-aka-young:velero-hooks-automation
Open

[Storage] Add Velero backup hooks opt-out tests#5478
ema-aka-young wants to merge 2 commits into
RedHatQE:mainfrom
ema-aka-young:velero-hooks-automation

Conversation

@ema-aka-young

@ema-aka-young ema-aka-young commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Signed-off-by: Emanuele Prella eprella@redhat.com

What this PR does / why we need it:

Implementing automation for "Remove pre and post hook velero annotations from virt-launcher"

Which issue(s) this PR fixes:

https://redhat.atlassian.net/browse/CNV-85597

Special notes for reviewer:

Assysted by Quality Flow AI Tool

jira-ticket:

https://redhat.atlassian.net/browse/CNV-88655

Summary by CodeRabbit

  • New Features

    • Added coverage for backup hook opt-out behavior during backup and restore workflows.
    • Introduced a new annotation-based setup for virtual machines that skip backup hooks.
    • Improved backup log access so tests can verify backup activity more directly.
  • Tests

    • Expanded automated checks to confirm hook-related backup steps are not triggered when opt-out is enabled.
    • Added end-to-end validation for backup and restore scenarios using the updated setup.

Signed-off-by: Emanuele Prella <eprella@redhat.com>
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds Velero backup "hooks opt-out" test coverage: a new annotation constant, three fixtures to provision/backup/restore an annotated RHEL VM, a utility function to fetch Velero backup pod logs, and updated tests asserting freeze-hook log entries are absent for paused-VM backup and full backup/restore cycles.

Changes

Velero hooks opt-out feature

Layer / File(s) Summary
Skip-backup-hooks annotation constant
utilities/constants/oadp.py
Adds SKIP_BACKUP_HOOKS_ANNOTATION constant set to kubevirt.io/skip-backup-hooks.
Fixtures for VM opt-out, backup, and restore
tests/data_protection/oadp/conftest.py
Imports VirtualMachine and expands OADP constants import; adds fixtures to run an annotated RHEL VM, create a Velero backup of its namespace, and delete/restore the namespace using TIMEOUT_15MIN.
Velero backup log retrieval utility
tests/data_protection/oadp/utils.py
Adds logging setup and get_velero_backup_logs(backup_name, client) which locates the Velero pod and runs the velero backup logs CLI command.
Hooks opt-out test assertions
tests/data_protection/oadp/test_velero_backup_hooks.py
Updates imports and adds HOOK_LOG_PATTERN/pytestmark; removes __test__ = False; updates test signatures to use new fixtures; pauses VM/creates backup for paused-VM test; waits for VM running state and asserts absence of freeze-pattern hook log entries in both tests.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • RedHatQE/openshift-virtualization-tests#5340: Both PRs modify tests/data_protection/oadp/test_velero_backup_hooks.py to validate Velero freeze-hook behavior being disabled via per-VM opt-out annotations during paused-VM backups and full backup/restore cycles.

Suggested labels: new-tests

Suggested reviewers: kgoldbla, kshvaika, Ahmad-Hafe, jpeimer, josemacassan

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stp Link Required ✅ Passed PASS: test_velero_backup_hooks.py already has a module-level STP link and Jira skip marker, so the newly added test functions are covered.
Description check ✅ Passed The description includes all required template sections and provides a valid issue link and Jira ticket.
Title check ✅ Passed The title is under 120 characters and clearly describes the added Velero backup hooks opt-out tests.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Review ran into problems

🔥 Problems

Linked repositories: Your configuration references 1 linked repositories, but your current plan allows 0. Analyzed ``, skipped RedHatQE/openshift-virtualization-tests-design-docs.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@openshift-virtualization-qe-bot-5

Copy link
Copy Markdown

Report bugs in Issues

Welcome! 🎉

This pull request will be automatically processed with the following features:

🔄 Automatic Actions

  • Reviewer Assignment: Reviewers are automatically assigned based on the OWNERS file in the repository root
  • Size Labeling: PR size labels (XS, S, M, L, XL, XXL) are automatically applied based on changes
  • Issue Creation: A tracking issue is created for this PR and will be closed when the PR is merged or closed
  • Branch Labeling: Branch-specific labels are applied to track the target branch
  • Auto-verification: Auto-verified users have their PRs automatically marked as verified
  • Labels: Enabled categories: branch, can-be-merged, cherry-pick, has-conflicts, hold, needs-rebase, size, verified, wip

📋 Available Commands

PR Status Management

  • /wip - Mark PR as work in progress (adds WIP: prefix to title)
  • /wip cancel - Remove work in progress status
  • /hold - Block PR merging (approvers only)
  • /hold cancel - Unblock PR merging
  • /verified - Mark PR as verified
  • /verified cancel - Remove verification status
  • /reprocess - Trigger complete PR workflow reprocessing (useful if webhook failed or configuration changed)
  • /regenerate-welcome - Regenerate this welcome message
  • /security-override - Set security check runs to pass (maintainers only)
  • /security-override cancel - Re-run security checks

Review & Approval

  • /lgtm - Approve changes (looks good to me)
  • /approve - Approve PR (approvers only)
  • /assign-reviewers - Assign reviewers based on OWNERS file
  • /assign-reviewer @username - Assign specific reviewer
  • /check-can-merge - Check if PR meets merge requirements

Testing & Validation

  • /retest tox - Run Python test suite with tox
  • /retest build-container - Rebuild and test container image
  • /retest verify-bugs-are-open - verify-bugs-are-open
  • /retest all - Run all available tests

Container Operations

  • /build-and-push-container - Build and push container image (tagged with PR number)
    • Supports additional build arguments: /build-and-push-container --build-arg KEY=value

Cherry-pick Operations

  • /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
    • Multiple branches: /cherry-pick branch1 branch2 branch3
  • /cherry-pick-retry <branch> - Retry a failed cherry-pick (merged PRs only)

Branch Management

  • /rebase - Rebase this PR branch onto its base branch

Custom Commands

  • /test-plan - Triggers CodeRabbit to analyze the PR's changed files and post a test execution plan
  • /rerun-smoke - Adds `retest-smoke` label on the PR to trigger smoke tests exectuion

Label Management

  • /<label-name> - Add a label to the PR
  • /<label-name> cancel - Remove a label from the PR

✅ Merge Requirements

This PR will be automatically approved when the following conditions are met:

  1. Approval: /approve from at least one approver
  2. LGTM Count: Minimum 2 /lgtm from reviewers
  3. Status Checks: All required status checks must pass
  4. No Blockers: No wip, hold, has-conflicts labels and PR must be mergeable (no conflicts)
  5. Verified: PR must be marked as verified

📊 Review Process

Approvers and Reviewers

Approvers:

  • dshchedr
  • jpeimer
  • myakove
  • rnetser
  • vsibirsk

Reviewers:

  • Acedus
  • Ahmad-Hafe
  • Dsanatar
  • RoniKishner
  • acinko-rh
  • akalenyu
  • awels
  • dalia-frank
  • dshchedr
  • ema-aka-young
  • geetikakay
  • josemacassan
  • jpeimer
  • kgoldbla
  • kshvaika
  • rnetser
  • vsibirsk
Available Labels
  • hold
  • verified
  • wip
  • lgtm
  • approve
AI Features
  • Cherry-Pick Conflict Resolution: Enabled (claude/claude-opus-4-6-1m)
Security Checks
  • Suspicious Path Detection: Monitors paths: .claude/, .vscode/, .cursor/, .devcontainer/, .pi/, .github/workflows/, .github/actions/
  • Committer Identity Check: Verifies last committer matches PR author
  • Mandatory: Security checks block merge (use /security-override to bypass — maintainers only)

💡 Tips

  • WIP Status: Use /wip when your PR is not ready for review
  • Verification: The verified label is removed on new commits unless the push is detected as a clean rebase
  • Cherry-picking: Cherry-pick labels are processed when the PR is merged
  • Container Builds: Container images are automatically tagged with the PR number
  • Permission Levels: Some commands require approver permissions
  • Auto-verified Users: Certain users have automatic verification and merge privileges

For more information, please refer to the project documentation or contact the maintainers.

@ema-aka-young

Copy link
Copy Markdown
Contributor Author

/wip

@openshift-virtualization-qe-bot openshift-virtualization-qe-bot changed the title [Storage] Add Velero backup hooks opt-out tests WIP: [Storage] Add Velero backup hooks opt-out tests Jul 2, 2026
…tions and parameters

Signed-off-by: Emanuele Prella <eprella@redhat.com>
@ema-aka-young

Copy link
Copy Markdown
Contributor Author

/wip cancel

@openshift-virtualization-qe-bot-5 openshift-virtualization-qe-bot-5 changed the title WIP: [Storage] Add Velero backup hooks opt-out tests [Storage] Add Velero backup hooks opt-out tests Jul 3, 2026
@openshift-virtualization-qe-bot

Copy link
Copy Markdown

/build-and-push-container

@openshift-virtualization-qe-bot-2

Copy link
Copy Markdown
Contributor

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

@openshift-virtualization-qe-bot

Copy link
Copy Markdown

/verified

All tests passed for PR #5478.
Job: openshift-virtualization-tests-runner #5861

Execution details
pytest -s -o log_cli=true -m tier2 --jira tests/data_protection/oadp/test_velero_backup_hooks.py
Image: openshift-virtualization-tests:pr-5478

@openshift-virtualization-qe-bot-3

Copy link
Copy Markdown
Contributor

@coderabbitai

Test execution plan request details

CRITICAL: You MUST post an inline review comment on the first changed line of the first file.
The inline comment should contain the full Test Execution Plan (smoke decision, gating decision, and specific affected tests).
Do NOT submit a blocking review event (REQUEST_CHANGES/APPROVE).
Post a single inline PR comment on Files Changed (non-blocking COMMENT flow).

As an expert software testing engineer, analyze all modified files in this PR and create a targeted test execution plan.
You will post an inline review comment with the test execution plan on the first changed file.
If you fail to run or post a comment, retry.

Analysis Requirements:

  1. Examine code changes in each modified file

  2. Identify affected code paths, functions, and classes

  3. Analyze pytest-specific elements: fixtures (scope, dependencies), parametrization, markers, conftest changes

  4. Trace test dependencies through imports, shared utilities, fixture inheritance, fixture teardown, and yield from cleanup in conftest

  5. Detect new tests introduced in the PR

  6. Utilities and libs impact (when utilities/ or libs/ changes):
    You MUST use shell scripts (rg, git diff) to trace the full impact.
    Follow these sub-steps in order:

    6a. Identify modified symbols: For each changed file under utilities/ or libs/,
    list every modified function or method.
    Example: git diff HEAD~1 --unified=0 -- utilities/hco.py | grep '^[+-]def '

    6b. Find direct callers: Search tests and conftest for each symbol from 6a.
    Example: rg -l 'get_hco_version' tests/

    6c. Trace fixture teardown and cleanup: Find fixtures that reach
    the modified symbol through yield from or context-manager wrappers.
    Example: rg -l 'yield from.*enable_common_boot|def.*enable_common_boot' tests/

    6d. Trace same-file callers: In each changed file, find other functions
    whose body calls a modified symbol (including code after yield
    in @contextmanager helpers).
    Example: rg 'get_hco_version|enable_common_boot' utilities/hco.py

    6e. Expand transitively: If function A calls modified B, then
    tests/fixtures that call A are affected — even when the test body
    never imports B directly.

    Do NOT limit impact to tests that import the modified symbol only.

  7. Smoke test impact: Intersect the affected set from step 6 with smoke-marked tests.
    Run: rg -l '@pytest.mark.smoke' tests/
    VERIFY the above command returned actual file paths before concluding False.
    Set True if either condition is met:

    • a smoke-marked file appears in the affected set from 6b-6e, OR
    • any conftest.py in the smoke test's parent-directory hierarchy (up to repo root)
      imports or calls a modified utilities/libs symbol — including autouse fixtures
      that depend on modified functions. ALL tests in that directory and below are affected.
      Example check: for each smoke_file, scan dirname(smoke_file)/conftest.py,
      dirname(dirname(smoke_file))/conftest.py, etc. for modified symbol imports
      and autouse fixtures that depend on modified symbols.
  8. Gating test impact: Intersect the affected set from step 6 with gating-marked tests.
    Run: rg -l '@pytest.mark.gating' tests/
    Set True if a gating-marked file also appears in the affected set from 6b-6e.
    Utilities/libs changes often affect gating tests without affecting smoke tests.
    Do NOT stop analysis after concluding Run smoke tests: False.

Output rules:
Do NOT include analysis step numbers (1-8) in your visible output.

Your deliverable:
Your inline informational comment will be based on the following requirements:

Test Execution Plan

  • Run smoke tests: True / False — If True, state the dependency path (test → fixture → changed symbol). True ONLY with a verified path.
  • Run gating tests: True / False — If True, state the dependency path. True if any gating-marked test is in the affected set.
  • Affected tests to run (required when utilities/, libs/, or shared conftest changes — list concrete paths even when smoke is False)

Use these formats:

  • path/to/test_file.py - When the entire test file needs verification
  • path/to/test_file.py::TestClass::test_method - When specific test(s) needed
  • path/to/test_file.py::test_function - When specific test(s) needed
  • -m marker - When a marker covers multiple affected tests (e.g. -m gating only if ALL gating tests in scope need run)
  • Tag each listed test or group with its marker when not obvious, e.g. (gating) or (smoke)

Real test commands (MANDATORY when changes affect session/runtime code):

When the affected code runs at session/collection time (conftest fixtures, pytest plugins,
config hooks, session-scoped setup) or modifies runtime behavior that unit tests mock away,
you MUST include concrete pytest commands the PR author must run on a real cluster
to verify the change works end-to-end. Include:

  • A command for the error/fix path (the scenario the PR fixes)
  • A command for the happy path (regression: the normal case still works)
  • Use lightweight tests (e.g., --collect-only for startup failures,
    a single small test for runtime behavior)
    If the PR only changes test logic (not utilities/libs/conftest), the affected test
    paths themselves serve as the real test commands — no separate section needed.

Example output for a session-startup fix:

**Real tests (cluster required)**
Error path (the fix):
`pytest tests/storage/.../test_foo.py --storage-class-matrix=nonexistent-sc --collect-only`
Expected: ValueError with clear message, not IndexError

Happy path (regression):
`pytest tests/storage/.../test_foo.py --storage-class-matrix=<valid-sc> -k test_bar`
Expected: session starts normally

Guidelines:

  • Include tests affected directly OR via fixture setup/teardown, yield from cleanup, or transitive utility call chains (caller calls modified helper)
  • Use a full file path only if ALL tests in that file require verification
  • Use file path + test name when only specific tests use an affected fixture or utility wrapper (preferred for partial file impact)
  • If a test marker can cover multiple files/tests, provide the marker
  • Balance coverage vs over-testing - Keep descriptions minimal
  • Example: if leaf helper foo() changes, include tests whose fixture teardown calls wrapper bar() where bar() calls foo(), even when the test body only imports an unrelated symbol from the same utilities module

Hardware-Related Checks (SR-IOV, GPU, DPDK):

When PR modifies fixtures for hardware-specific resources:

  • Collection Safety: Fixtures MUST have existence checks (return None when hardware unavailable)
  • Test Plan: MUST verify both WITH and WITHOUT hardware:
    • Run affected tests on cluster WITH hardware
    • Verify collection succeeds on cluster WITHOUT hardware

CRITICAL WORKFLOW COMPLETION RULES:

When responding to this test execution plan request, you MUST follow these rules EXACTLY:

  1. YOUR ONLY DELIVERABLE: Post one non-blocking inline comment containing the test execution plan on the first changed line
  2. THEN STOP IMMEDIATELY - Do NOT generate any additional response
  3. FALLBACK ONLY: If inline comment API calls fail after retrying, post as a regular PR comment
  4. SILENCE = SUCCESS: After successfully submitting the review, your task is complete. No confirmation needed.

ABSOLUTE PROHIBITIONS (violating these creates empty/meaningless reviews):

  • ❌ Do NOT post acknowledgment messages like "Test execution plan posted", "Review posted successfully", "I've successfully posted"
  • ❌ Do NOT mention review IDs, URLs, or confirmation of posting in the PR thread
  • ❌ Do NOT add any follow-up comments after submitting the review
  • ❌ Do NOT reply to confirm task completion
  • ❌ Do NOT explain what you did - just do it and stop

Remember: The pull request review is visible to users. Additional comments are redundant noise.

CRITICAL — Verification rules for smoke and gating decisions:
- For each True decision, you must have traced a concrete path: test file → fixture → utility function → modified symbol.
- Do NOT assume impact based on scope, file proximity, or infrastructure-sounding names.
Only set True when you trace a concrete path through steps 6a-6e, then 7 or 8.
WRONG: "utilities/hco.py changed → run smoke" (no traced dependency path)
WRONG: "Run smoke tests: False" with no affected-test list when gating tests use the changed utility
RIGHT: "Run smoke tests: False, Run gating tests: True" plus tests/.../test_foo.py::TestBar::test_baz (gating)
RIGHT: "Smoke test X uses fixture Y → wrapper Z → changed function W in utilities/hco.py"

@coderabbitai

coderabbitai Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail
echo "== smoke marked tests in repo =="
rg -l '`@pytest.mark.smoke`' tests/ | head -50 || true
echo "== gating marked tests in repo =="
rg -l '`@pytest.mark.gating`' tests/ | head -50 || true
echo "== oadp dir markers =="
rg -n 'pytestmark|`@pytest.mark`' tests/data_protection/oadp/test_velero_backup_hooks.py
echo "== usages of SKIP_BACKUP_HOOKS_ANNOTATION =="
rg -n 'SKIP_BACKUP_HOOKS_ANNOTATION' -r . 2>/dev/null
echo "== usages of get_velero_backup_logs =="
rg -n 'get_velero_backup_logs' -r .
echo "== conftest.py in oadp dir and parents =="
fd conftest.py tests/data_protection
echo "== full new/changed conftest fixtures =="
cat -n tests/data_protection/oadp/conftest.py

Length of output: 4722


🏁 Script executed:

#!/bin/bash
set -euo pipefail
echo "== usages of SKIP_BACKUP_HOOKS_ANNOTATION =="
rg -n 'SKIP_BACKUP_HOOKS_ANNOTATION' .
echo "== usages of get_velero_backup_logs =="
rg -n 'get_velero_backup_logs' .
echo "== conftest.py content =="
cat -n tests/data_protection/oadp/conftest.py
echo "== test_velero_backup_hooks.py content =="
cat -n tests/data_protection/oadp/test_velero_backup_hooks.py
echo "== utils.py content =="
cat -n tests/data_protection/oadp/utils.py
echo "== oadp constants file =="
cat -n utilities/constants/oadp.py
echo "== any smoke/gating in data_protection dir =="
rg -n '`@pytest.mark`.(smoke|gating)' tests/data_protection || echo "none"

Length of output: 24677


@openshift-virtualization-qe-bot-3, here is the test execution plan for PR #5478. Note: inline-comment posting on a specific diff line isn't something I can perform directly in this context — posting this as a regular PR comment (per the fallback instructions).

Test Execution Plan

  • Run smoke tests: False — No test file under tests/data_protection/oadp/ carries @pytest.mark.smoke, and repo-wide @pytest.mark.smoke files (e.g. tests/storage/cdi_upload/test_upload_virtctl.py, tests/virt/...) do not import SKIP_BACKUP_HOOKS_ANNOTATION or get_velero_backup_logs, nor do any conftest.py files in their directory hierarchies reference these new symbols.
  • Run gating tests: False — Same trace: SKIP_BACKUP_HOOKS_ANNOTATION is used only in tests/data_protection/oadp/conftest.py (new fixture rhel_vm_with_hooks_opt_out), and get_velero_backup_logs is used only in tests/data_protection/oadp/test_velero_backup_hooks.py. No gating-marked file references either symbol.
  • Affected tests to run:
    • tests/data_protection/oadp/test_velero_backup_hooks.py::TestVeleroBackupHookOptOut::test_backup_paused_vm_hooks_disabled (new test; fixture chain: namespace_for_backuprhel_vm_with_hooks_opt_outVeleroBackupget_velero_backup_logs)
    • tests/data_protection/oadp/test_velero_backup_hooks.py::TestVeleroBackupHookOptOut::test_full_backup_restore_hooks_disabled (new test; fixture chain: rhel_vm_with_hooks_opt_outvelero_backup_vm_with_hooks_opt_outvelero_restore_vm_with_hooks_opt_outwait_for_running_vmget_velero_backup_logs)

Since the change is confined to a new OADP test module (utilities/constants/oadp.py addition is only consumed within tests/data_protection/oadp/), no separate real-cluster commands beyond the two tests above are required; they inherently exercise the new fixtures/utility end-to-end.

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.

6 participants