type Cluster interface {
    fmt.Stringer
    kube.ExtendedClient

    // Name of this cluster
    Name() string

    // NetworkName the cluster is on
    NetworkName() string

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

type ClusterIndex int

type Clusters []Cluster

type ConfigManager interface {
    // ApplyYAML applies the given config yaml text via Galley.
    ApplyYAML(ns string, yamlText ...string) error

    // ApplyYAMLOrFail applies the given config yaml text via Galley.
    ApplyYAMLOrFail(t test.Failer, ns string, yamlText ...string)

    // DeleteYAML deletes the given config yaml text via Galley.
    DeleteYAML(ns string, yamlText ...string) error

    // DeleteYAMLOrFail deletes the given config yaml text via Galley.
    DeleteYAMLOrFail(t test.Failer, ns string, yamlText ...string)

    // ApplyYAMLDir recursively applies all the config files in the specified directory
    ApplyYAMLDir(ns string, configDir string) error

    // DeleteYAMLDir recursively deletes all the config files in the specified directory
    DeleteYAMLDir(ns string, configDir string) error

    // WithFilePrefix sets the prefix used for intermediate files.
    WithFilePrefix(prefix string) ConfigManager
}

type Context interface {
    yml.FileWriter

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

    // GetResource accepts either a *T or *[]*T where T implements Resource.
    // For a non-slice pointer, the value will be assigned to the first matching resource.
    // For a slice pointer, the matching resources from this scope and its parent(s) will be appended.
    // If ref is not a pointer, an error will be returned.
    // If there is no match for a non-slice pointer, an error will be returned.
    GetResource(ref interface{}) error

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

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

    // 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)

    // Config returns a ConfigManager that writes config to the provide clusers. If
    // no clusters are provided, writes to all clusters.
    Config(clusters ...Cluster) ConfigManager
}

type Dumper interface {
    Dump()
}

type Environment interface {
    Resource

    EnvironmentName() string

    // Clusters in this Environment. There will always be at least one.
    Clusters() Clusters
}

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

type FakeCluster struct {
    kube.ExtendedClient

    NameValue        string
    NetworkNameValue string
    IndexValue       int
}

type FakeEnvironment struct {
    Name        string
    NumClusters int
    IDValue     string
}

type FakeID string

type FakeResource struct {
    IDValue    string
    OtherValue string
}

type ID interface {
    fmt.Stringer
}

type Resource interface {
    // ID used for debugging the resource instance.
    ID() ID
}

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

    RunID uuid.UUID

    // 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

    // If enabled, namespaces will be reused rather than created with dynamic names each time.
    // This is useful when combined with NoCleanup, to allow quickly iterating on tests.
    StableNamespaces bool

    // 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