type Cluster interface {
    fmt.Stringer

    // Index of this Cluster within the Environment
    Index() ClusterIndex

    // IsControlPlaneCluster indicates whether or not a control plane has/should have a control plane deployed.
    IsControlPlaneCluster() bool
}

type ClusterIndex int

type Context interface {
    // TrackResource tracks a resource in this context. If the context is closed, then the resource will be
    // cleaned up.
    TrackResource(r Resource) ID

    // The Environment in which the tests run
    Environment() Environment

    // Settings returns common settings
    Settings() *Settings

    // CreateDirectory creates a new subdirectory within this context.
    CreateDirectory(name string) (string, error)

    // CreateTmpDirectory creates a new temporary directory within this context.
    CreateTmpDirectory(prefix string) (string, error)
}

type Dumper interface {
    Dump()
}

type Environment interface {
    Resource

    EnvironmentName() environment.Name

    // IsMulticluster is a utility method that indicates whether there are multiple Clusters available.
    IsMulticluster() bool

    // Clusters in this Environment. There will always be at least one.
    Clusters() []Cluster

    // Case calls the given function if this environment has the given name.
    Case(e environment.Name, fn func())
}

type EnvironmentFactory func(name string, ctx Context) (Environment, error)

type ID interface {
    fmt.Stringer
}

type Resource interface {

    // Debugging ID for the resource instance.
    ID() ID
}

type Settings struct {
    // Name of the test
    TestID string

    RunID uuid.UUID

    // Environment to run the tests in. By default, a local environment will be used.
    Environment string

    // Do not cleanup the resources after the test run.
    NoCleanup bool

    // Indicates that the tests are running in CI Mode
    CIMode bool

    // Should the tests fail if usage of deprecated stuff (e.g. Envoy flags) is detected
    FailOnDeprecation bool

    // Local working directory root for creating temporary directories / files in. If left empty,
    // os.TempDir() will be used.
    BaseDir string

    // The number of times to retry failed tests.
    // This should not be depended on as a primary means for reducing test flakes.
    Retries int

    // The label selector that the user has specified.
    SelectorString string

    // The label selector, in parsed form.
    Selector label.Selector

    // EnvironmentFactory allows caller to override the environment creation. If nil, a default is used based
    // on the known environment names.
    EnvironmentFactory EnvironmentFactory
}

type SetupFn func(ctx Context) error