mtv-api-tests

Explain what mtv-api-tests is, who it is for, and how it validates MTV migrations across real providers and OpenShift environments.

Map the repository layout, including test suites, provider adapters, shared utilities, exceptions, tooling, and automation/configuration files.

Describe the end-to-end flow from provider setup and Forklift inventory discovery to StorageMap, NetworkMap, Plan, Migration, validation, and teardown.

Summarize supported source providers, migration modes, pytest markers, and major scenarios such as tier0, warm, remote, comprehensive, and copy-offload tests.

Document the required OpenShift, MTV, OpenShift Virtualization, storage, network, provider, and permission prerequisites for running the suite safely.

Cover Python and uv requirements, dependency installation, local environment preparation, and how virtctl is discovered or downloaded from the cluster.

Show how to create provider config, pass runtime settings with pytest-testconfig, start with collect-only or setup-plan, and launch a first targeted test run.

Explain how to run the suite from the project container image or inside an OpenShift Job, including mounted config, credentials, and result collection.

Document global pytest-testconfig values, command-line overrides, and custom pytest options such as data collection, teardown control, debug logging, and AI analysis.

Reference the .providers.json schema for vSphere, RHV, OpenStack, OpenShift, and OVA sources, including guest credentials, SSL behavior, and provider-specific fields.

Explain the tests_params structure, per-VM settings, cloning and disk options, plan-level flags, and how prepared plans are derived from raw config.

Cover JIRA integration, AI failure-analysis environment variables, copy-offload credential overrides, and practical guidance for handling sensitive values.

Walk through the standard cold migration test pattern, from map creation to execution and post-migration validation.

Explain warm migration behavior, precopy interval tuning, cutover timing, supported providers, and the extra validation path for warm tests.

Document VMware copy-offload prerequisites, storage secrets, offload plugin settings, supported vendors, SSH or VIB clone methods, fallback modes, and advanced copy-offload scenarios.

Describe the remote migration path, destination provider handling, remote-specific config, and how remote scenarios differ from the default local destination flow.

Show how pre and post hooks are configured, how predefined and custom playbooks work, and how expected-failure tests are validated.

Cover advanced plan options such as target power state, static IP preservation, PVC naming templates, custom VM namespaces, node selectors, labels, affinity, and Multus setup.

Reference the suite's markers, default pytest settings, xdist behavior, incremental semantics, and supported selection and dry-run modes.

Explain the custom resources and mappings the suite creates, including Provider, StorageMap, NetworkMap, Plan, Migration, Hook, and related naming and readiness rules.

Document the BaseProvider abstraction, provider-specific behaviors, Forklift inventory adapters, and how source network and storage mappings are resolved.

Provide a module-level reference for shared utilities such as SSH access, virtctl management, resource creation, teardown, diagnostics, and post-migration checks.

Describe common failure points, JUnit output, collected resource artifacts, must-gather support, AI enrichment, and the best places to inspect when migrations fail.

Explain automatic cleanup, session teardown behavior, leftover detection, the skip-teardown workflow for debugging, and manual cleanup helpers.

Show how to add new test configs, follow the repository's five-step class pattern, reuse fixtures, and extend provider or validation coverage.

Document the local developer workflow, including dependency sync, linting, typing, pre-commit checks, tox targets, and container builds.

Explain the repository's automation surface, including pre-commit, release-it, Renovate, container image build inputs, AI review bots, and the fact that CI orchestration is external to this repo.