Documentation
¶
Overview ¶
Package environments contains the definitions of the different environments that can be used in a test.
Package environments contains the definitions of the different environments that can be used in a test.
Index ¶
- func CreateEnv[Env any]() (*Env, []reflect.StructField, []reflect.Value, error)
- type CoverageTargetSpec
- type DockerHost
- func (e *DockerHost) Coverage(outputDir string) (string, error)
- func (e *DockerHost) Diagnose(outputDir string) (string, error)
- func (e *DockerHost) DisableAgent()
- func (e *DockerHost) DisableFakeIntake()
- func (e *DockerHost) DockerAgentOutput() *agent.DockerAgentOutput
- func (e *DockerHost) DockerOutput() *docker.ManagerOutput
- func (e *DockerHost) FakeIntakeOutput() *fakeintake.FakeintakeOutput
- func (e *DockerHost) Init(_ common.Context) error
- func (e *DockerHost) RemoteHostOutput() *remote.HostOutput
- type ECS
- type Host
- func (e *Host) AgentOutput() *agent.HostAgentOutput
- func (e *Host) Coverage(outputDir string) (string, error)
- func (e *Host) Diagnose(outputDir string) (string, error)
- func (e *Host) DisableAgent()
- func (e *Host) DisableFakeIntake()
- func (e *Host) DisableUpdater()
- func (e *Host) FakeIntakeOutput() *fakeintake.FakeintakeOutput
- func (e *Host) Init(_ common.Context) error
- func (e *Host) RemoteHostOutput() *remote.HostOutput
- func (e *Host) SetAgentClientOptions(options ...agentclientparams.Option)
- func (e *Host) UpdaterOutput() *updater.HostUpdaterOutput
- type Kubernetes
- func (e *Kubernetes) Coverage(outputDir string) (string, error)
- func (e *Kubernetes) Diagnose(outputDir string) (string, error)
- func (e *Kubernetes) DisableAgent()
- func (e *Kubernetes) DisableFakeIntake()
- func (e *Kubernetes) FakeIntakeOutput() *fakeintake.FakeintakeOutput
- func (e *Kubernetes) KubernetesAgentOutput() *agent.KubernetesAgentOutput
- func (e *Kubernetes) KubernetesClusterOutput() *kubernetes.ClusterOutput
- type WindowsHost
- func (e *WindowsHost) ActiveDirectoryOutput() *activedirectory.Output
- func (e *WindowsHost) AgentOutput() *agent.HostAgentOutput
- func (e *WindowsHost) Diagnose(outputDir string) (string, error)
- func (e *WindowsHost) DisableActiveDirectory()
- func (e *WindowsHost) DisableAgent()
- func (e *WindowsHost) DisableFakeIntake()
- func (e *WindowsHost) FakeIntakeOutput() *fakeintake.FakeintakeOutput
- func (e *WindowsHost) Init(_ common.Context) error
- func (e *WindowsHost) RemoteHostOutput() *remote.HostOutput
- func (e *WindowsHost) SetAgentClientOptions(options ...agentclientparams.Option)
- func (e *WindowsHost) SetEnvironment(env config.Env)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CoverageTargetSpec ¶
CoverageTargetSpec defines the name of the agent, the command to run to generate the coverage and if the coverage is required
type DockerHost ¶
type DockerHost struct {
// Components
RemoteHost *components.RemoteHost
FakeIntake *components.FakeIntake
Agent *components.DockerAgent
Docker *components.RemoteHostDocker
}
DockerHost is an environment that contains a Docker VM, FakeIntake and Agent configured to talk to each other.
func (*DockerHost) Coverage ¶
func (e *DockerHost) Coverage(outputDir string) (string, error)
Coverage generates a coverage report for the Docker agent
func (*DockerHost) Diagnose ¶
func (e *DockerHost) Diagnose(outputDir string) (string, error)
Diagnose returns a string containing the diagnosis of the environment
func (*DockerHost) DisableAgent ¶
func (e *DockerHost) DisableAgent()
DisableAgent implements outputs.DockerHostOutputs
func (*DockerHost) DisableFakeIntake ¶
func (e *DockerHost) DisableFakeIntake()
DisableFakeIntake implements outputs.DockerHostOutputs
func (*DockerHost) DockerAgentOutput ¶
func (e *DockerHost) DockerAgentOutput() *agent.DockerAgentOutput
DockerAgentOutput implements outputs.DockerHostOutputs
func (*DockerHost) DockerOutput ¶
func (e *DockerHost) DockerOutput() *docker.ManagerOutput
DockerOutput implements outputs.DockerHostOutputs
func (*DockerHost) FakeIntakeOutput ¶
func (e *DockerHost) FakeIntakeOutput() *fakeintake.FakeintakeOutput
FakeIntakeOutput implements outputs.DockerHostOutputs
func (*DockerHost) Init ¶
func (e *DockerHost) Init(_ common.Context) error
Init initializes the environment
func (*DockerHost) RemoteHostOutput ¶
func (e *DockerHost) RemoteHostOutput() *remote.HostOutput
RemoteHostOutput implements outputs.DockerHostOutputs
type ECS ¶
type ECS struct {
// Components
ECSCluster *components.ECSCluster
FakeIntake *components.FakeIntake
}
ECS is an environment that contains a ECS deployed in a cluster, FakeIntake and Agent configured to talk to each other.
func (*ECS) DisableFakeIntake ¶
func (e *ECS) DisableFakeIntake()
DisableFakeIntake implements outputs.ECSOutputs
func (*ECS) ECSClusterOutput ¶
func (e *ECS) ECSClusterOutput() *ecs.ClusterOutput
ECSClusterOutput implements outputs.ECSOutputs
func (*ECS) FakeIntakeOutput ¶
func (e *ECS) FakeIntakeOutput() *fakeintake.FakeintakeOutput
FakeIntakeOutput implements outputs.ECSOutputs
type Host ¶
type Host struct {
RemoteHost *components.RemoteHost
FakeIntake *components.FakeIntake
Agent *components.RemoteHostAgent
Updater *components.RemoteHostUpdater
}
Host is an environment that contains a Host, FakeIntake and Agent configured to talk to each other.
func (*Host) AgentOutput ¶
func (e *Host) AgentOutput() *agent.HostAgentOutput
AgentOutput implements outputs.HostOutputs
func (*Host) Coverage ¶
Coverage runs the coverage command for each agent and downloads the coverage folders to the output directory
func (*Host) DisableAgent ¶
func (e *Host) DisableAgent()
DisableAgent implements outputs.HostOutputs
func (*Host) DisableFakeIntake ¶
func (e *Host) DisableFakeIntake()
DisableFakeIntake implements outputs.HostOutputs
func (*Host) DisableUpdater ¶
func (e *Host) DisableUpdater()
DisableUpdater implements outputs.HostOutputs
func (*Host) FakeIntakeOutput ¶
func (e *Host) FakeIntakeOutput() *fakeintake.FakeintakeOutput
FakeIntakeOutput implements outputs.HostOutputs
func (*Host) RemoteHostOutput ¶
func (e *Host) RemoteHostOutput() *remote.HostOutput
RemoteHostOutput implements outputs.HostOutputs
func (*Host) SetAgentClientOptions ¶
func (e *Host) SetAgentClientOptions(options ...agentclientparams.Option)
SetAgentClientOptions implements outputs.HostOutputs
func (*Host) UpdaterOutput ¶
func (e *Host) UpdaterOutput() *updater.HostUpdaterOutput
UpdaterOutput implements outputs.HostOutputs
type Kubernetes ¶
type Kubernetes struct {
// Components
KubernetesCluster *components.KubernetesCluster
FakeIntake *components.FakeIntake
Agent *components.KubernetesAgent
}
Kubernetes is an environment that contains a Kubernetes cluster, the Agent and a FakeIntake.
func (*Kubernetes) Coverage ¶
func (e *Kubernetes) Coverage(outputDir string) (string, error)
Coverage generates a coverage report for each pod and container
func (*Kubernetes) Diagnose ¶
func (e *Kubernetes) Diagnose(outputDir string) (string, error)
Diagnose generates a diagnose for the Kubernetes environment, creating a flare for each agent and cluster-agent pod.
func (*Kubernetes) DisableAgent ¶
func (e *Kubernetes) DisableAgent()
DisableAgent implements eks.KubernetesOutputs
func (*Kubernetes) DisableFakeIntake ¶
func (e *Kubernetes) DisableFakeIntake()
DisableFakeIntake implements eks.KubernetesOutputs
func (*Kubernetes) FakeIntakeOutput ¶
func (e *Kubernetes) FakeIntakeOutput() *fakeintake.FakeintakeOutput
FakeIntakeOutput implements eks.KubernetesOutputs
func (*Kubernetes) KubernetesAgentOutput ¶
func (e *Kubernetes) KubernetesAgentOutput() *agent.KubernetesAgentOutput
KubernetesAgentOutput implements eks.KubernetesOutputs
func (*Kubernetes) KubernetesClusterOutput ¶
func (e *Kubernetes) KubernetesClusterOutput() *kubernetes.ClusterOutput
KubernetesClusterOutput implements eks.KubernetesOutputs
type WindowsHost ¶
type WindowsHost struct {
Environment config.Env
// Components
RemoteHost *components.RemoteHost
FakeIntake *components.FakeIntake
Agent *components.RemoteHostAgent
ActiveDirectory *components.RemoteActiveDirectory
}
WindowsHost is an environment based on environments.Host but that is specific to Windows.
func (*WindowsHost) ActiveDirectoryOutput ¶
func (e *WindowsHost) ActiveDirectoryOutput() *activedirectory.Output
ActiveDirectoryOutput implements outputs.WindowsHostOutputs
func (*WindowsHost) AgentOutput ¶
func (e *WindowsHost) AgentOutput() *agent.HostAgentOutput
AgentOutput implements outputs.WindowsHostOutputs
func (*WindowsHost) Diagnose ¶
func (e *WindowsHost) Diagnose(outputDir string) (string, error)
Diagnose returns a string containing the diagnosis of the environment
func (*WindowsHost) DisableActiveDirectory ¶
func (e *WindowsHost) DisableActiveDirectory()
DisableActiveDirectory implements outputs.WindowsHostOutputs
func (*WindowsHost) DisableAgent ¶
func (e *WindowsHost) DisableAgent()
DisableAgent implements outputs.WindowsHostOutputs
func (*WindowsHost) DisableFakeIntake ¶
func (e *WindowsHost) DisableFakeIntake()
DisableFakeIntake implements outputs.WindowsHostOutputs
func (*WindowsHost) FakeIntakeOutput ¶
func (e *WindowsHost) FakeIntakeOutput() *fakeintake.FakeintakeOutput
FakeIntakeOutput implements outputs.WindowsHostOutputs
func (*WindowsHost) Init ¶
func (e *WindowsHost) Init(_ common.Context) error
Init initializes the environment
func (*WindowsHost) RemoteHostOutput ¶
func (e *WindowsHost) RemoteHostOutput() *remote.HostOutput
RemoteHostOutput implements outputs.WindowsHostOutputs
func (*WindowsHost) SetAgentClientOptions ¶
func (e *WindowsHost) SetAgentClientOptions(options ...agentclientparams.Option)
func (*WindowsHost) SetEnvironment ¶
func (e *WindowsHost) SetEnvironment(env config.Env)
SetEnvironment implements outputs.WindowsHostOutputs