types

type Deployer interface {
	// Up should provision a new cluster for testing
	Up() error
	// Down should tear down the test cluster if any
	Down() error
	// IsUp should return true if a test cluster is successfully provisioned
	IsUp() (up bool, err error)
	// DumpClusterLogs should export logs from the cluster. It may be called
	// multiple times. Options for this should come from New(...)
	DumpClusterLogs() error
	// Build should build kubernetes and package it in whatever format
	// the deployer consumes
	Build() error
}

type DeployerWithFinish interface {
	Deployer

	// Finish finalizes the deployer. This will be called after any other deployer action and immediately before exit.
	Finish() error
}

type DeployerWithInit interface {
	Deployer

	// Init initializes the deployer. This will be called prior to any other lifecycle action.
	Init() error
}

type DeployerWithKubeconfig interface {
	Deployer

	// Kubeconfig returns a path to a kubeconfig file for the cluster.
	Kubeconfig() (string, error)
}

type DeployerWithPostTester interface {
	Deployer

	// PostTest runs after the tester completes.
	// testErr is the error returned from the tester's Run()
	PostTest(testErr error) error
}

type DeployerWithProvider interface {
	Deployer

	// Provider returns the kubernetes provider for legacy deployers.
	Provider() string
}

type DeployerWithVersion interface {
	Deployer

	// Version determines the version of the deployer binary
	Version() string
}

type IncorrectUsage interface {
	error
	HelpText() string
}

type NewDeployer func(opts Options) (deployer Deployer, flags *pflag.FlagSet)

type Options interface {
	// TODO(BenTheElder): provide getters to more common options
	// if this returns true, help text will be shown to the user after instancing
	// the deployer and tester
	HelpRequested() bool
	// if this is true, kubetest2 will be calling deployer.Build
	ShouldBuild() bool
	// if this is true, kubetest2 will be calling deployer.Up
	ShouldUp() bool
	// if this is true, kubetest2 will be calling deployer.Down
	ShouldDown() bool
	// if this is true, kubetest2 will be calling tester.Test
	ShouldTest() bool
	// if this is true, kubetest2 will be skipping reporting the test result as a JUnit test case.
	SkipTestJUnitReport() bool
	// RunID returns a unique identifier for a kubetest2 run.
	RunID() string
	// RunDir returns the directory to put run-specific output files.
	RunDir() string
	// if this is true, kubetest2 will copy the RunDIR to ARTIFACTS
	RundirInArtifacts() bool
}

type Tester struct {
	TesterPath string
	TesterArgs []string
}