Skip to content

[Docs]: Integration and E2E tests have no documented cluster prerequisites or setup instructions #13

Description

@mrhillsman

Documentation Type

Add missing documentation

Location

docs/development.md

Description

Integration tests (`//go:build integration`) and E2E tests (`//go:build e2e`) require a live OpenShift cluster with KubeVirt/CNV installed. While `docs/development.md` mentions build tags, there is no documentation on:

  • Minimum cluster requirements (OpenShift version, CNV version)
  • Required cluster state (operators installed, storage classes available)
  • How to configure kubeconfig for test execution
  • Expected test runtime or resource consumption
  • How to run integration tests in isolation vs full E2E

The E2E suite's `BeforeSuite` builds the binary but cluster setup is entirely undocumented.

Suggested Content

Add a "Cluster Prerequisites" section to `docs/development.md` covering:

  • Minimum OpenShift version and CNV operator version
  • Required storage classes and operators
  • Kubeconfig setup instructions
  • Example commands for running integration vs E2E tests separately
  • Expected resource consumption and test runtime estimates

Severity: Low

Files:

  • `docs/development.md` — testing section lacks cluster setup details
  • `tests/e2e/e2e_suite_test.go` — BeforeSuite assumes cluster access

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.size/SDenotes a PR that changes 10-29 lines, ignoring generated files.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions