Skip to content

docs: simplify copy-offload test guide#495

Open
rgolangh wants to merge 1 commit into
RedHatQE:mainfrom
rgolangh:simplify-copyoffload-doc
Open

docs: simplify copy-offload test guide#495
rgolangh wants to merge 1 commit into
RedHatQE:mainfrom
rgolangh:simplify-copyoffload-doc

Conversation

@rgolangh
Copy link
Copy Markdown
Contributor

@rgolangh rgolangh commented May 18, 2026

Signed-off-by: Roy Golan rgolan@redhat.com

Summary by CodeRabbit

  • Documentation
    • Rewrote guide to focus on running MTV API tests via the mtv-api-tests CLI workflow
    • Added steps to generate manifests, run tests locally or as OpenShift Jobs, and retrieve JUnit reports
    • Added guidance for selecting tests by category or name and non-interactive flags
    • Condensed troubleshooting to common failure modes and debug options
    • Removed extensive provider templates and manual manifest/secret construction instructions

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: b64108d8-c475-4b40-8594-3d2f2a5ae2d1

📥 Commits

Reviewing files that changed from the base of the PR and between 2c57092 and 6e68505.

📒 Files selected for processing (1)
  • guides/copyoffload/how-to-run-copyoffload-tests.md

Walkthrough

This PR rewrites the copy-offload testing guide into a CLI-centric "How to Run MTV API Tests" document focused on mtv-api-tests generate and mtv-api-tests run, covering local and OpenShift Job execution, test selection/filtering, condensed copy-offload requirements, and streamlined troubleshooting.

Changes

How to Run MTV API Tests Guide

Layer / File(s) Summary
Introduction and Prerequisites
guides/copyoffload/how-to-run-copyoffload-tests.md
Document retitled from "Accelerated Migrations Guide" to "How to Run MTV API Tests." Prerequisites simplified to OpenShift, vSphere test VM, uv, oc, and shared block storage.
Quick Start Workflow
guides/copyoffload/how-to-run-copyoffload-tests.md
Core workflow using mtv-api-tests generate to discover configuration and produce manifests, then mtv-api-tests run for local execution (--mode local) or OpenShift Job deployment (--mode job). Includes oc apply, log following, status checks, and JUnit report retrieval.
Running Specific Tests
guides/copyoffload/how-to-run-copyoffload-tests.md
Test selection by category, test-name filtering (including regex), non-interactive CI mode with explicit source provider and storage class flags, and pytest --collect-only for discovery.
Copy-Offload Context and Troubleshooting
guides/copyoffload/how-to-run-copyoffload-tests.md
Condensed "What's Different" explanation with extra requirements checklist (shared block storage, VAAI, clone method, MTV < 2.11 feature gate). Troubleshooting reduced to targeted checks (storage connection, clone method verification, migration stuck), and debug flags (--skip-teardown, -s -vv).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: simplify copy-offload test guide' directly and accurately reflects the main change in the changeset—a substantial rewrite that simplifies documentation by removing extensive configuration details and replacing them with a streamlined workflow guide.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@redhat-qe-bot
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: Disabled for this repository
  • 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: All label categories are enabled (default configuration)

📋 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

Review & Approval

  • /lgtm - Approve changes (looks good to me)
  • /approve - Approve PR (approvers only)
  • /automerge - Enable automatic merging when all requirements are met (maintainers and 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 conventional-title - Validate commit message format
  • /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

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. Status Checks: All required status checks must pass
  3. No Blockers: No wip, hold, has-conflicts labels and PR must be mergeable (no conflicts)
  4. Verified: PR must be marked as verified

📊 Review Process

Approvers and Reviewers

Approvers:

  • myakove
  • solenoci

Reviewers:

  • krcmarik
  • myakove
  • solenoci
Available Labels
  • hold
  • verified
  • wip
  • lgtm
  • approve
  • automerge
AI Features
  • Conventional Title: Mode: fix (claude/claude-opus-4-6[1m])
  • Cherry-Pick Conflict Resolution: Enabled (claude/claude-opus-4-6[1m])
  • Test Oracle: Triggers: approved (cursor/gpt-5.4-xhigh-fast); /test-oracle can be used anytime

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

@redhat-qe-bot redhat-qe-bot requested a review from myakove May 18, 2026 07:23
@redhat-qe-bot redhat-qe-bot requested a review from solenoci May 18, 2026 07:23
@redhat-qe-bot redhat-qe-bot requested a review from krcmarik May 18, 2026 07:23
@redhat-qe-bot redhat-qe-bot changed the title Simplified copyoffload doc docs: simplify copy-offload test guide May 18, 2026
@myakove
Copy link
Copy Markdown
Collaborator

myakove commented May 18, 2026

/lgtm
/approve

Signed-off-by: Roy Golan <rgolan@redhat.com>
auto-merge was automatically disabled May 18, 2026 12:46

Head branch was pushed to by a user without write access

@rgolangh rgolangh force-pushed the simplify-copyoffload-doc branch from 2c57092 to 6e68505 Compare May 18, 2026 12:46
@rh-bot-1
Copy link
Copy Markdown

Clean rebase detected — no code changes compared to previous head (2c57092).
The following labels were preserved: approved-myakove, lgtm-myakove, lgtm-coderabbitai[bot].

@redhat-qe-bot1
Copy link
Copy Markdown

Clean rebase detected — no code changes compared to previous head (2c57092).
The following labels were preserved: approved-myakove, lgtm-myakove, lgtm-coderabbitai[bot].

@rgolangh
Copy link
Copy Markdown
Contributor Author

@myakove can you merge this please?

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