dockerutil

Feb 1, 2024

Changes in this version

+ const CleanupLabel

+ const LabelPrefix

+ const NodeOwnerLabel

+ var KeepVolumesOnFailure = os.Getenv("IBCTEST_SKIP_FAILURE_CLEANUP") != ""

+ func CondenseHostName(name string) string

+ func CopyFile(src, dst string) (int64, error)

+ func DockerSetup(t DockerSetupTestingT) (*client.Client, string)

+ func GetDockerUserString() string

+ func GetHeighlinerUserString() string

+ func GetHostPort(cont types.ContainerJSON, portID string) string

+ func GetRootUserString() string

+ func NewLocalKeyringFromDockerContainer(ctx context.Context, dc *client.Client, ...) (keyring.Keyring, error)

+ func RandLowerCaseLetterString(length int) string

+ func SanitizeContainerName(name string) string

+ func SetVolumeOwner(ctx context.Context, opts VolumeOwnerOptions) error

+ func StartContainer(ctx context.Context, cli *client.Client, id string) error

+ type Container struct

+ Hostname string

+ Name string

+ func (c *Container) Stop(timeout time.Duration) error

+ func (c *Container) Wait(ctx context.Context, logTail uint64) ContainerExecResult

+ type ContainerExecResult struct

+ Err error

+ ExitCode int

+ Stderr []byte

+ Stdout []byte

+ type ContainerLifecycle struct

+ func NewContainerLifecycle(log *zap.Logger, client *dockerclient.Client, containerName string) *ContainerLifecycle

+ func (c *ContainerLifecycle) ContainerID() string

+ func (c *ContainerLifecycle) CreateContainer(ctx context.Context, testName string, networkID string, image ibc.DockerImage, ...) error

+ func (c *ContainerLifecycle) GetHostPorts(ctx context.Context, portIDs ...string) ([]string, error)

+ func (c *ContainerLifecycle) PauseContainer(ctx context.Context) error

+ func (c *ContainerLifecycle) RemoveContainer(ctx context.Context) error

+ func (c *ContainerLifecycle) Running(ctx context.Context) error

+ func (c *ContainerLifecycle) StartContainer(ctx context.Context) error

+ func (c *ContainerLifecycle) StopContainer(ctx context.Context) error

+ func (c *ContainerLifecycle) UnpauseContainer(ctx context.Context) error

+ type ContainerOptions struct

+ Binds []string

+ Env []string

+ LogTail uint64

+ User string

+ type DockerSetupTestingT interface

+ Cleanup func(func())

+ Failed func() bool

+ Helper func()

+ Logf func(format string, args ...any)

+ Name func() string

+ type FileRetriever struct

+ func NewFileRetriever(log *zap.Logger, cli *client.Client, testName string) *FileRetriever

+ func (r *FileRetriever) SingleFileContent(ctx context.Context, volumeName, relPath string) ([]byte, error)

+ type FileWriter struct

+ func NewFileWriter(log *zap.Logger, cli *client.Client, testName string) *FileWriter

+ func (w *FileWriter) WriteFile(ctx context.Context, volumeName, relPath string, content []byte) error

+ type Image struct

+ func NewImage(logger *zap.Logger, cli *client.Client, networkID string, testName string, ...) *Image

+ func (image *Image) Run(ctx context.Context, cmd []string, opts ContainerOptions) ContainerExecResult

+ func (image *Image) Start(ctx context.Context, cmd []string, opts ContainerOptions) (*Container, error)

+ type Listeners []net.Listener

+ func GeneratePortBindings(portSet nat.PortSet) (nat.PortMap, Listeners, error)

+ func (l Listeners) CloseAll()

+ type VolumeOwnerOptions struct

+ Client *client.Client

+ ImageRef string

+ Log *zap.Logger

+ TestName string

+ UidGid string

+ VolumeName string