v2

Documentation

Index

• type CommandTest
  • func (ct *CommandTest) CheckOutput(result *types.TestResult, stdout string, stderr string, exitCode int)
  • func (ct *CommandTest) LogName() string
  • func (ct *CommandTest) Run(driver drivers.Driver) *types.TestResult
  • func (ct *CommandTest) Validate() error
• type FileContentTest
  • func (ft FileContentTest) LogName() string
  • func (ft FileContentTest) Run(driver drivers.Driver) *types.TestResult
  • func (ft FileContentTest) Validate() error
• type FileExistenceTest
  • func (ft FileExistenceTest) LogName() string
  • func (ft FileExistenceTest) Run(driver drivers.Driver) *types.TestResult
  • func (ft FileExistenceTest) Validate() error
• type LicenseTest
  • func (lt LicenseTest) LogName() string
  • func (lt LicenseTest) Run(driver drivers.Driver) *types.TestResult
• type MetadataTest
  • func (mt MetadataTest) LogName() string
  • func (mt MetadataTest) Run(driver drivers.Driver) *types.TestResult
• type StructureTest
  • func (st *StructureTest) NewDriver() (drivers.Driver, error)
  • func (st *StructureTest) RunAll() []*types.TestResult
  • func (st *StructureTest) RunCommandTests() []*types.TestResult
  • func (st *StructureTest) RunFileContentTests() []*types.TestResult
  • func (st *StructureTest) RunFileExistenceTests() []*types.TestResult
  • func (st *StructureTest) RunLicenseTests() []*types.TestResult
  • func (st *StructureTest) RunMetadataTests() *types.TestResult
  • func (st *StructureTest) SetDriverImpl(f func(drivers.DriverConfig) (drivers.Driver, error), ...)

Types

type CommandTest

type CommandTest struct {
	Name           string         `yaml:"name"`
	Setup          [][]string     `yaml:"setup"`
	Teardown       [][]string     `yaml:"teardown"`
	EnvVars        []types.EnvVar `yaml:"envVars"`
	ExitCode       int            `yaml:"exitCode"`
	Command        string         `yaml:"command"`
	Args           []string       `yaml:"args"`
	ExpectedOutput []string       `yaml:"expectedOutput"`
	ExcludedOutput []string       `yaml:"excludedOutput"`
	ExpectedError  []string       `yaml:"expectedError"`
	ExcludedError  []string       `yaml:"excludedError"` // excluded error from running command
}

func (*CommandTest) CheckOutput

func (ct *CommandTest) CheckOutput(result *types.TestResult, stdout string, stderr string, exitCode int)

func (*CommandTest) LogName

func (ct *CommandTest) LogName() string

func (*CommandTest) Run

func (ct *CommandTest) Run(driver drivers.Driver) *types.TestResult

func (*CommandTest) Validate

func (ct *CommandTest) Validate() error

type FileContentTest

type FileContentTest struct {
	Name             string   `yaml:"name"`             // name of test
	Path             string   `yaml:"path"`             // file to check existence of
	ExpectedContents []string `yaml:"expectedContents"` // list of expected contents of file
	ExcludedContents []string `yaml:"excludedContents"` // list of excluded contents of file
}

func (FileContentTest) LogName

func (ft FileContentTest) LogName() string

func (FileContentTest) Run

func (ft FileContentTest) Run(driver drivers.Driver) *types.TestResult

func (FileContentTest) Validate

func (ft FileContentTest) Validate() error

type FileExistenceTest

type FileExistenceTest struct {
	Name        string `yaml:"name"`        // name of test
	Path        string `yaml:"path"`        // file to check existence of
	ShouldExist bool   `yaml:"shouldExist"` // whether or not the file should exist
	Permissions string `yaml:"permissions"` // expected Unix permission string of the file, e.g. drwxrwxrwx
}

func (FileExistenceTest) LogName

func (ft FileExistenceTest) LogName() string

func (FileExistenceTest) Run

func (ft FileExistenceTest) Run(driver drivers.Driver) *types.TestResult

func (FileExistenceTest) Validate

func (ft FileExistenceTest) Validate() error

type LicenseTest

type LicenseTest struct {
	Debian bool     `yaml:"debian"`
	Files  []string `yaml:"files"`
}

Not currently used, but leaving the possibility open

func (LicenseTest) LogName

func (lt LicenseTest) LogName() string

func (LicenseTest) Run

func (lt LicenseTest) Run(driver drivers.Driver) *types.TestResult

type MetadataTest

type MetadataTest struct {
	Env          []types.EnvVar `yaml:"env"`
	ExposedPorts []string       `yaml:"exposedPorts"`
	Entrypoint   *[]string      `yaml:"entrypoint"`
	Cmd          *[]string      `yaml:"cmd"`
	Workdir      string         `yaml:"workdir"`
	Volumes      []string       `yaml:"volumes"`
}

func (MetadataTest) LogName

func (mt MetadataTest) LogName() string

func (MetadataTest) Run

func (mt MetadataTest) Run(driver drivers.Driver) *types.TestResult

type StructureTest

type StructureTest struct {
	DriverImpl         func(drivers.DriverConfig) (drivers.Driver, error)
	DriverArgs         drivers.DriverConfig
	GlobalEnvVars      []types.EnvVar      `yaml:"globalEnvVars"`
	CommandTests       []CommandTest       `yaml:"commandTests"`
	FileExistenceTests []FileExistenceTest `yaml:"fileExistenceTests"`
	FileContentTests   []FileContentTest   `yaml:"fileContentTests"`
	MetadataTest       MetadataTest        `yaml:"metadataTest"`
	LicenseTests       []LicenseTest       `yaml:"licenseTests"`
}

func (*StructureTest) NewDriver

func (st *StructureTest) NewDriver() (drivers.Driver, error)

func (*StructureTest) RunAll

func (st *StructureTest) RunAll() []*types.TestResult

func (*StructureTest) RunCommandTests

func (st *StructureTest) RunCommandTests() []*types.TestResult

func (*StructureTest) RunFileContentTests

func (st *StructureTest) RunFileContentTests() []*types.TestResult

func (*StructureTest) RunFileExistenceTests

func (st *StructureTest) RunFileExistenceTests() []*types.TestResult

func (*StructureTest) RunLicenseTests

func (st *StructureTest) RunLicenseTests() []*types.TestResult

func (*StructureTest) RunMetadataTests

func (st *StructureTest) RunMetadataTests() *types.TestResult

func (*StructureTest) SetDriverImpl

func (st *StructureTest) SetDriverImpl(f func(drivers.DriverConfig) (drivers.Driver, error), args drivers.DriverConfig)