testutil

Documentation

Index

• Constants
• Variables
• func DockerIncompatible(t testing.TB)
• func GetDaemonIsKillable() bool
• func GetTarget() string
• func Identifier(t testing.TB) string
• func M(m *testing.M)
• func RequireExecPlatform(t testing.TB, ss ...string)
• func RequiresBuild(t testing.TB)
• func WithStdin(r io.Reader) func(*Cmd)
• type Base
  • func NewBase(t *testing.T) *Base
  • func (b *Base) Cmd(args ...string) *Cmd
  • func (b *Base) CmdWithHelper(helper []string, args ...string) *Cmd
  • func (b *Base) ComposeCmd(args ...string) *Cmd
  • func (b *Base) DumpDaemonLogs(minutes int)
  • func (b *Base) EnsureDaemonActive()
  • func (b *Base) Info() dockercompat.Info
  • func (b *Base) InspectContainer(name string) dockercompat.Container
  • func (b *Base) InspectImage(name string) dockercompat.Image
  • func (b *Base) InspectNetwork(name string) dockercompat.Network
  • func (b *Base) InspectVolume(name string) native.Volume
  • func (b *Base) KillDaemon()
• type Cmd
  • func (c *Cmd) Assert(expected icmd.Expected)
  • func (c *Cmd) AssertExitCode(exitCode int)
  • func (c *Cmd) AssertFail()
  • func (c *Cmd) AssertNoOut(s string)
  • func (c *Cmd) AssertOK()
  • func (c *Cmd) AssertOutContains(s string)
  • func (c *Cmd) AssertOutExactly(s string)
  • func (c *Cmd) AssertOutNotContains(s string)
  • func (c *Cmd) AssertOutWithFunc(fn func(stdout string) error)
  • func (c *Cmd) CmdOption(cmdOptions ...func(*Cmd)) *Cmd
  • func (c *Cmd) Out() string
  • func (c *Cmd) OutLines() []string
  • func (c *Cmd) Run() *icmd.Result
• type ComposeDir
  • func NewComposeDir(t testing.TB, dockerComposeYAML string) *ComposeDir
  • func (cd *ComposeDir) CleanUp()
  • func (cd *ComposeDir) Dir() string
  • func (cd *ComposeDir) ProjectName() string
  • func (cd *ComposeDir) WriteFile(name, content string)
  • func (cd *ComposeDir) YAMLFullPath() string
• type Target

Constants

const (
	Nerdctl = Target("nerdctl")
	Docker  = Target("docker")
)

const (
	FedoraESGZImage = "ghcr.io/stargz-containers/fedora:30-esgz" // eStargz
)

const Namespace = "nerdctl-test"

Variables

var (
	AlpineImage                 = mirrorOf("alpine:3.13")
	NginxAlpineImage            = mirrorOf("nginx:1.19-alpine")
	NginxAlpineIndexHTMLSnippet = "<title>Welcome to nginx!</title>"
	RegistryImage               = mirrorOf("registry:2")
	WordpressImage              = mirrorOf("wordpress:5.7")
	WordpressIndexHTMLSnippet   = "<title>WordPress &rsaquo; Installation</title>"
	MariaDBImage                = mirrorOf("mariadb:10.5")
	DockerAuthImage             = mirrorOf("cesanta/docker_auth:1.7")

	CommonImage = AlpineImage
)

Functions

func DockerIncompatible

func DockerIncompatible(t testing.TB)

func GetDaemonIsKillable

func GetDaemonIsKillable() bool

func GetTarget

func GetTarget() string

func Identifier

func Identifier(t testing.TB) string

Identifier can be used as a name of container, image, volume, network, etc.

func M

func M(m *testing.M)

func RequireExecPlatform

func RequireExecPlatform(t testing.TB, ss ...string)

func RequiresBuild

func RequiresBuild(t testing.TB)

func WithStdin

func WithStdin(r io.Reader) func(*Cmd)

WithStdin sets the standard input of Cmd to the specified reader

Types

type Base

type Base struct {
	T                testing.TB
	Target           Target
	DaemonIsKillable bool
	Binary           string
	ComposeBinary    string // "docker-compose"
	Args             []string
	Env              []string
}

func NewBase

func NewBase(t *testing.T) *Base

func (*Base) Cmd

func (b *Base) Cmd(args ...string) *Cmd

func (*Base) CmdWithHelper

func (b *Base) CmdWithHelper(helper []string, args ...string) *Cmd

func (*Base) ComposeCmd

func (b *Base) ComposeCmd(args ...string) *Cmd

ComposeCmd executes `nerdctl -n nerdctl-test compose` or `docker-compose`

func (*Base) DumpDaemonLogs

func (b *Base) DumpDaemonLogs(minutes int)

func (*Base) EnsureDaemonActive

func (b *Base) EnsureDaemonActive()

func (*Base) Info

func (b *Base) Info() dockercompat.Info

func (*Base) InspectContainer

func (b *Base) InspectContainer(name string) dockercompat.Container

func (*Base) InspectImage

func (b *Base) InspectImage(name string) dockercompat.Image

func (*Base) InspectNetwork

func (b *Base) InspectNetwork(name string) dockercompat.Network

func (*Base) InspectVolume

func (b *Base) InspectVolume(name string) native.Volume

func (*Base) KillDaemon

func (b *Base) KillDaemon()

type Cmd

type Cmd struct {
	icmd.Cmd
	*Base
}

func (*Cmd) Assert

func (c *Cmd) Assert(expected icmd.Expected)

func (*Cmd) AssertExitCode

func (c *Cmd) AssertExitCode(exitCode int)

func (*Cmd) AssertFail

func (c *Cmd) AssertFail()

func (*Cmd) AssertNoOut

func (c *Cmd) AssertNoOut(s string)

func (*Cmd) AssertOK

func (c *Cmd) AssertOK()

func (*Cmd) AssertOutContains

func (c *Cmd) AssertOutContains(s string)

func (*Cmd) AssertOutExactly

func (c *Cmd) AssertOutExactly(s string)

func (*Cmd) AssertOutNotContains

func (c *Cmd) AssertOutNotContains(s string)

func (*Cmd) AssertOutWithFunc

func (c *Cmd) AssertOutWithFunc(fn func(stdout string) error)

func (*Cmd) CmdOption

func (c *Cmd) CmdOption(cmdOptions ...func(*Cmd)) *Cmd

func (*Cmd) Out

func (c *Cmd) Out() string

func (*Cmd) OutLines

func (c *Cmd) OutLines() []string

func (*Cmd) Run

func (c *Cmd) Run() *icmd.Result

type ComposeDir

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

func NewComposeDir

func NewComposeDir(t testing.TB, dockerComposeYAML string) *ComposeDir

func (*ComposeDir) CleanUp

func (cd *ComposeDir) CleanUp()

func (*ComposeDir) Dir

func (cd *ComposeDir) Dir() string

func (*ComposeDir) ProjectName

func (cd *ComposeDir) ProjectName() string

func (*ComposeDir) WriteFile

func (cd *ComposeDir) WriteFile(name, content string)

func (*ComposeDir) YAMLFullPath

func (cd *ComposeDir) YAMLFullPath() string

type Target

type Target = string