orchestrator

Documentation

Overview

Package orchestrator defines the interface for managing end-to-end test lifecycles.

Index

• type Orchestrator
• type Result

Types

type Orchestrator

type Orchestrator interface {
	// PreProcess validates configuration and environment prerequisites before
	// heavy operations like cluster provisioning. Implementations should fail
	// fast with clear error messages for invalid user inputs.
	PreProcess(ctx context.Context) error

	// Provision prepares the test environment by provisioning or reusing a cluster,
	// loading kubeconfig, and installing required addons.
	Provision(ctx context.Context) error

	// Execute runs the configured test suites including install phase tests and
	// optional upgrade tests with their respective phases.
	Execute(ctx context.Context) error

	// AnalyzeLogs performs AI-powered log analysis when tests fail,
	// providing insights into failure root causes. Results are cached
	// internally for use by Report.
	AnalyzeLogs(ctx context.Context, testErr error) error

	// Report saves artifacts and/or sends notifications for generated results.
	Report(ctx context.Context) error

	// Cleanup performs post-test cleanup including resource cleanup and
	// optionally destroys the cluster based on configuration.
	Cleanup(ctx context.Context) error

	// PostProcessCluster performs optional post-processing on the cluster
	// after test execution but before cleanup (e.g., extending expiration,
	// updating metadata). Implementations can return nil to skip processing.
	PostProcessCluster(ctx context.Context) error

	// Result returns the outcome of the test run including exit code and status.
	Result() *Result
}

Orchestrator manages the complete lifecycle of e2e test execution including cluster provisioning, test execution, failure analysis, and reporting.

type Result

type Result struct {
	ExitCode      int     // Exit code: 0 for success, non-zero for failure
	TestsPassed   bool    // Whether install phase tests passed
	UpgradePassed bool    // Whether upgrade phase tests passed (if run)
	ClusterID     string  // ID of the cluster used for testing
	Errors        []error // Collection of errors encountered during execution
}

Result encapsulates the outcome of an e2e test run.