Documentation
¶
Index ¶
- Constants
- Variables
- func Fatal(err error)
- func GetDefaultGenerator() *generate.Generator
- func PrepareBundle() (string, error)
- func RuntimeInsideValidate(g *generate.Generator, f PreFunc) (err error)
- func RuntimeLifecycleValidate(config LifecycleConfig) error
- func RuntimeOutsideValidate(g *generate.Generator, f AfterFunc) error
- func Skip(message string, diagnostic interface{})
- func ValidateLinuxResourcesBlockIO(config *rspec.Spec, state *rspec.State) error
- func ValidateLinuxResourcesMemory(config *rspec.Spec, state *rspec.State) error
- func ValidateLinuxResourcesNetwork(config *rspec.Spec, state *rspec.State) error
- func ValidateLinuxResourcesPids(config *rspec.Spec, state *rspec.State) error
- func WaitingForStatus(r Runtime, status LifecycleStatus, retryTimeout time.Duration, ...) error
- type AfterFunc
- type LifecycleAction
- type LifecycleConfig
- type LifecycleStatus
- type PreFunc
- type Runtime
- func (r *Runtime) Clean(removeBundle bool, forceRemoveBundle bool) error
- func (r *Runtime) Create() (err error)
- func (r *Runtime) Delete() (err error)
- func (r *Runtime) ReadStandardStreams() (stdout []byte, stderr []byte, err error)
- func (r *Runtime) SetConfig(g *generate.Generator) error
- func (r *Runtime) SetID(id string)
- func (r *Runtime) Start() (err error)
- func (r *Runtime) State() (rspecs.State, error)
Constants ¶
const ( // LifecycleActionNone does nothing LifecycleActionNone = 0 // LifecycleActionCreate creates a container LifecycleActionCreate = 1 << iota // LifecycleActionStart starts a container LifecycleActionStart // LifecycleActionDelete deletes a container LifecycleActionDelete )
const ( // LifecycleStatusCreating "creating" LifecycleStatusCreating = 1 << iota // LifecycleStatusCreated "created" LifecycleStatusCreated // LifecycleStatusRunning "running" LifecycleStatusRunning // LifecycleStatusStopped "stopped" LifecycleStatusStopped )
Variables ¶
var (
// RuntimeCommand is the default runtime command.
RuntimeCommand = "runc"
)
Functions ¶
func GetDefaultGenerator ¶
GetDefaultGenerator creates a default configuration generator.
func PrepareBundle ¶
PrepareBundle creates a test bundle in a temporary directory.
func RuntimeInsideValidate ¶
RuntimeInsideValidate runs runtimetest inside a container.
func RuntimeLifecycleValidate ¶ added in v0.5.0
func RuntimeLifecycleValidate(config LifecycleConfig) error
RuntimeLifecycleValidate validates runtime lifecycle.
func RuntimeOutsideValidate ¶
RuntimeOutsideValidate validate runtime outside a container.
func ValidateLinuxResourcesBlockIO ¶
ValidateLinuxResourcesBlockIO validates linux.resources.blockIO.
func ValidateLinuxResourcesMemory ¶
ValidateLinuxResourcesMemory validates linux.resources.memory.
func ValidateLinuxResourcesNetwork ¶
ValidateLinuxResourcesNetwork validates linux.resources.network.
func ValidateLinuxResourcesPids ¶
ValidateLinuxResourcesPids validates linux.resources.pids.
Types ¶
type AfterFunc ¶
AfterFunc validate container's outside environment after created
type LifecycleAction ¶ added in v0.5.0
type LifecycleAction int
LifecycleAction defines the phases will be called.
type LifecycleConfig ¶ added in v0.5.0
type LifecycleConfig struct {
Config *generate.Generator
BundleDir string
Actions LifecycleAction
PreCreate func(runtime *Runtime) error
PostCreate func(runtime *Runtime) error
PreDelete func(runtime *Runtime) error
PostDelete func(runtime *Runtime) error
}
LifecycleConfig includes 1. Config to set the 'config.json' 2. BundleDir to set the bundle directory 3. Actions to define the default running lifecycles 4. Four phases for user to add his/her own operations
type LifecycleStatus ¶ added in v0.5.0
type LifecycleStatus int
LifecycleStatus follows https://github.com/opencontainers/runtime-spec/blob/master/runtime.md#state
type PreFunc ¶
PreFunc initializes the test environment after preparing the bundle but before creating the container.
type Runtime ¶
type Runtime struct {
RuntimeCommand string
BundleDir string
PidFile string
ID string
// contains filtered or unexported fields
}
Runtime represents the basic requirement of a container runtime
func NewRuntime ¶
NewRuntime create a runtime by command and the bundle directory
func (*Runtime) Clean ¶
Clean deletes the container. If removeBundle is set, the bundle directory is removed after the container is deleted succesfully or, if forceRemoveBundle is true, after the deletion attempt regardless of whether it was successful or not.
func (*Runtime) ReadStandardStreams ¶
ReadStandardStreams collects content from the stdout and stderr buffers.
func (*Runtime) SetConfig ¶
SetConfig creates a 'config.json' by the generator
Source Files
¶
- container.go
- linux_resources_blkio.go
- linux_resources_memory.go
- linux_resources_network.go
- linux_resources_pids.go
- test.go