client

Documentation

Overview

Package client contains the definitions of the different clients that can be used in a test.

Index

• func NewDockerAgentClient(t *testing.T, docker *Docker, agentContainerName string, ...) (agentclient.Agent, error)
• func NewHostAgentClient(t *testing.T, host *components.RemoteHost, waitForAgentReady bool) (agentclient.Agent, error)
• func NewHostAgentClientWithParams(t *testing.T, host *components.RemoteHost, options ...agentclientparams.Option) (agentclient.Agent, error)
• type Docker
  • func NewDocker(t *testing.T, host remote.HostOutput, privateKeyPath string) (*Docker, error)
  • func (docker *Docker) ExecuteCommand(containerName string, commands ...string) string
  • func (docker *Docker) ExecuteCommandStdoutStdErr(containerName string, commands ...string) (string, string, error)
  • func (docker *Docker) ExecuteCommandWithErr(containerName string, commands ...string) (string, error)
  • func (docker *Docker) GetClient() *client.Client
• type EC2Metadata
  • func NewEC2Metadata(h *components.RemoteHost) *EC2Metadata
  • func (m *EC2Metadata) Get(name string) string

Functions

func NewDockerAgentClient

func NewDockerAgentClient(t *testing.T, docker *Docker, agentContainerName string, waitForAgentReady bool) (agentclient.Agent, error)

NewDockerAgentClient creates an Agent client for a Docker install

func NewHostAgentClient

func NewHostAgentClient(t *testing.T, host *components.RemoteHost, waitForAgentReady bool) (agentclient.Agent, error)

NewHostAgentClient creates an Agent client for host install

func NewHostAgentClientWithParams

func NewHostAgentClientWithParams(t *testing.T, host *components.RemoteHost, options ...agentclientparams.Option) (agentclient.Agent, error)

NewHostAgentClientWithParams creates an Agent client for host install with custom parameters

Types

type Docker

type Docker struct {
	// contains filtered or unexported fields
}

A Docker client that is connected to an docker.Deamon.

func NewDocker

func NewDocker(t *testing.T, host remote.HostOutput, privateKeyPath string) (*Docker, error)

NewDocker creates a new instance of Docker NOTE: docker+ssh does not support password protected SSH keys.

func (*Docker) ExecuteCommand

func (docker *Docker) ExecuteCommand(containerName string, commands ...string) string

ExecuteCommand executes a command on containerName and returns the output.

func (*Docker) ExecuteCommandStdoutStdErr

func (docker *Docker) ExecuteCommandStdoutStdErr(containerName string, commands ...string) (string, string, error)

ExecuteCommandStdoutStdErr executes a command on containerName and returns the output, the error output and an error.

func (*Docker) ExecuteCommandWithErr

func (docker *Docker) ExecuteCommandWithErr(containerName string, commands ...string) (string, error)

ExecuteCommandWithErr executes a command on containerName and returns the output and an error.

func (*Docker) GetClient

func (docker *Docker) GetClient() *client.Client

GetClient gets the docker client.

type EC2Metadata

type EC2Metadata struct {
	// contains filtered or unexported fields
}

EC2Metadata contains a pointer to a VM and its AWS token

func NewEC2Metadata

func NewEC2Metadata(h *components.RemoteHost) *EC2Metadata

NewEC2Metadata creates a new EC2Metadata given an EC2 [VM]

func (*EC2Metadata) Get

func (m *EC2Metadata) Get(name string) string

Get returns EC2 instance name