Documentation
¶
Index ¶
- func EnsureFrozenImagesLinux(testEnv *Execution) error
- func ProtectAll(t testingT, testEnv *Execution)
- func ProtectContainers(t testingT, testEnv *Execution)
- func ProtectImages(t testingT, testEnv *Execution)
- func ProtectNetworks(t testingT, testEnv *Execution)
- func ProtectPlugins(t testingT, testEnv *Execution)
- func ProtectVolumes(t testingT, testEnv *Execution)
- type Execution
- func (e *Execution) APIClient() client.APIClient
- func (e *Execution) Clean(t testingT)
- func (e *Execution) DaemonAPIVersion() string
- func (e *Execution) IsLocalDaemon() bool
- func (e *Execution) IsRemoteDaemon() bool
- func (e *Execution) Print()
- func (e *Execution) ProtectContainer(t testingT, containers ...string)
- func (e *Execution) ProtectImage(t testingT, images ...string)
- func (e *Execution) ProtectNetwork(t testingT, networks ...string)
- func (e *Execution) ProtectPlugin(t testingT, plugins ...string)
- func (e *Execution) ProtectVolume(t testingT, volumes ...string)
- type PlatformDefaults
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnsureFrozenImagesLinux ¶
EnsureFrozenImagesLinux loads frozen test images into the daemon if they aren't already loaded
func ProtectAll ¶
func ProtectAll(t testingT, testEnv *Execution)
ProtectAll protects the existing environment (containers, images, networks, volumes, and, on Linux, plugins) from being cleaned up at the end of test runs
func ProtectContainers ¶
func ProtectContainers(t testingT, testEnv *Execution)
ProtectContainers protects existing containers from being cleaned up at the end of test runs
func ProtectImages ¶
func ProtectImages(t testingT, testEnv *Execution)
ProtectImages protects existing images and on linux frozen images from being cleaned up at the end of test runs
func ProtectNetworks ¶
func ProtectNetworks(t testingT, testEnv *Execution)
ProtectNetworks protects existing networks from being cleaned up at the end of test runs
func ProtectPlugins ¶
func ProtectPlugins(t testingT, testEnv *Execution)
ProtectPlugins protects existing plugins from being cleaned up at the end of test runs
func ProtectVolumes ¶
func ProtectVolumes(t testingT, testEnv *Execution)
ProtectVolumes protects existing volumes from being cleaned up at the end of test runs
Types ¶
type Execution ¶
type Execution struct { DaemonInfo types.Info OSType string PlatformDefaults PlatformDefaults // contains filtered or unexported fields }
Execution contains information about the current test execution and daemon under test
func (*Execution) Clean ¶
func (e *Execution) Clean(t testingT)
Clean the environment, preserving protected objects (images, containers, ...) and removing everything else. It's meant to run after any tests so that they don't depend on each others.
func (*Execution) DaemonAPIVersion ¶
DaemonAPIVersion returns the negociated daemon api version
func (*Execution) IsLocalDaemon ¶
IsLocalDaemon is true if the daemon under test is on the same host as the test process.
Deterministically working out the environment in which CI is running to evaluate whether the daemon is local or remote is not possible through a build tag.
For example Windows to Linux CI under Jenkins tests the 64-bit Windows binary build with the daemon build tag, but calls a remote Linux daemon.
We can't just say if Windows then assume the daemon is local as at some point, we will be testing the Windows CLI against a Windows daemon.
Similarly, it will be perfectly valid to also run CLI tests from a Linux CLI (built with the daemon tag) against a Windows daemon.
func (*Execution) IsRemoteDaemon ¶
IsRemoteDaemon is true if the daemon under test is on different host as the test process.
func (*Execution) Print ¶
func (e *Execution) Print()
Print the execution details to stdout TODO: print everything
func (*Execution) ProtectContainer ¶
ProtectContainer adds the specified container(s) to be protected in case of clean
func (*Execution) ProtectImage ¶
ProtectImage adds the specified image(s) to be protected in case of clean
func (*Execution) ProtectNetwork ¶
ProtectNetwork adds the specified network(s) to be protected in case of clean
func (*Execution) ProtectPlugin ¶
ProtectPlugin adds the specified plugin(s) to be protected in case of clean
func (*Execution) ProtectVolume ¶
ProtectVolume adds the specified volume(s) to be protected in case of clean
type PlatformDefaults ¶
type PlatformDefaults struct { BaseImage string VolumesConfigPath string ContainerStoragePath string }
PlatformDefaults are defaults values for the platform of the daemon under test