oci

Documentation

Index

• func GetBundleDir(args []string) (string, error)
• func GetBundleDirFromArgs(args []string) (string, error)
• func GetSpecFilePath(bundleDir string) string
• func HasCreateSubcommand(args []string) bool
• func IsBundleFlag(arg string) bool
• func LoadFrom(reader io.Reader) (*specs.Spec, error)
• type Runtime
  • func NewLowLevelRuntime(logger *log.Logger, candidates []string) (Runtime, error)
  • func NewRuntimeForPath(logger *log.Logger, path string) (Runtime, error)
• type RuntimeMock
  • func (mock *RuntimeMock) Exec(strings []string) error
  • func (mock *RuntimeMock) ExecCalls() []struct{ ... }
• type Spec
  • func NewFileSpec(filepath string) Spec
  • func NewMemorySpec(spec *specs.Spec) Spec
  • func NewSpec(logger *logrus.Logger, args []string) (Spec, error)
• type SpecMock
  • func (mock *SpecMock) Flush() error
  • func (mock *SpecMock) FlushCalls() []struct{}
  • func (mock *SpecMock) Load() (*specs.Spec, error)
  • func (mock *SpecMock) LoadCalls() []struct{}
  • func (mock *SpecMock) LookupEnv(s string) (string, bool)
  • func (mock *SpecMock) LookupEnvCalls() []struct{ ... }
  • func (mock *SpecMock) Modify(specModifier SpecModifier) error
  • func (mock *SpecMock) ModifyCalls() []struct{ ... }
• type SpecModifier
• type State
  • func LoadContainerState(filename string) (*State, error)
  • func ReadContainerState(reader io.Reader) (*State, error)
  • func (s *State) GetContainerRoot() (string, error)
  • func (s *State) LoadSpec() (*specs.Spec, error)

Functions

func GetBundleDir

func GetBundleDir(args []string) (string, error)

GetBundleDir returns the bundle directory or default depending on the supplied command line arguments.

func GetBundleDirFromArgs

func GetBundleDirFromArgs(args []string) (string, error)

GetBundleDirFromArgs checks the specified slice of strings (argv) for a 'bundle' flag as allowed by runc. The following are supported: --bundle{{SEP}}BUNDLE_PATH -bundle{{SEP}}BUNDLE_PATH -b{{SEP}}BUNDLE_PATH where {{SEP}} is either ' ' or '='

func GetSpecFilePath

func GetSpecFilePath(bundleDir string) string

GetSpecFilePath returns the expected path to the OCI specification file for the given bundle directory.

func HasCreateSubcommand

func HasCreateSubcommand(args []string) bool

HasCreateSubcommand checks the supplied arguments for a 'create' subcommand

func IsBundleFlag

func IsBundleFlag(arg string) bool

IsBundleFlag is a helper function that checks wither the specified argument represents a bundle flag (--bundle or -b)

func LoadFrom

func LoadFrom(reader io.Reader) (*specs.Spec, error)

LoadFrom reads the contents of the OCI spec from the specified io.Reader.

Types

type Runtime

type Runtime interface {
	Exec([]string) error
}

Runtime is an interface for a runtime shim. The Exec method accepts a list of command line arguments, and returns an error / nil.

func NewLowLevelRuntime

func NewLowLevelRuntime(logger *log.Logger, candidates []string) (Runtime, error)

NewLowLevelRuntime creates a Runtime that wraps a low-level runtime executable. The executable specified is taken from the list of supplied candidates, with the first match present in the PATH being selected. A logger is also specified.

func NewRuntimeForPath

func NewRuntimeForPath(logger *log.Logger, path string) (Runtime, error)

NewRuntimeForPath creates a Runtime for the specified logger and path

type RuntimeMock

type RuntimeMock struct {
	// ExecFunc mocks the Exec method.
	ExecFunc func(strings []string) error
	// contains filtered or unexported fields
}

RuntimeMock is a mock implementation of Runtime.

func TestSomethingThatUsesRuntime(t *testing.T) {

	// make and configure a mocked Runtime
	mockedRuntime := &RuntimeMock{
		ExecFunc: func(strings []string) error {
			panic("mock out the Exec method")
		},
	}

	// use mockedRuntime in code that requires Runtime
	// and then make assertions.

}

func (*RuntimeMock) Exec

func (mock *RuntimeMock) Exec(strings []string) error

Exec calls ExecFunc.

func (*RuntimeMock) ExecCalls

func (mock *RuntimeMock) ExecCalls() []struct {
	Strings []string
}

ExecCalls gets all the calls that were made to Exec. Check the length with:

len(mockedRuntime.ExecCalls())

type Spec

type Spec interface {
	Load() (*specs.Spec, error)
	Flush() error
	Modify(SpecModifier) error
	LookupEnv(string) (string, bool)
}

Spec defines the operations to be performed on an OCI specification

func NewFileSpec

func NewFileSpec(filepath string) Spec

NewFileSpec creates an object that encapsulates a file-backed OCI spec. This can be used to read from the file, modify the spec, and write to the same file.

func NewMemorySpec

func NewMemorySpec(spec *specs.Spec) Spec

NewMemorySpec creates a Spec instance from the specified OCI spec

func NewSpec

func NewSpec(logger *logrus.Logger, args []string) (Spec, error)

NewSpec creates fileSpec based on the command line arguments passed to the application using the specified logger.

type SpecMock

type SpecMock struct {
	// FlushFunc mocks the Flush method.
	FlushFunc func() error

	// LoadFunc mocks the Load method.
	LoadFunc func() (*specs.Spec, error)

	// LookupEnvFunc mocks the LookupEnv method.
	LookupEnvFunc func(s string) (string, bool)

	// ModifyFunc mocks the Modify method.
	ModifyFunc func(specModifier SpecModifier) error
	// contains filtered or unexported fields
}

SpecMock is a mock implementation of Spec.

func TestSomethingThatUsesSpec(t *testing.T) {

	// make and configure a mocked Spec
	mockedSpec := &SpecMock{
		FlushFunc: func() error {
			panic("mock out the Flush method")
		},
		LoadFunc: func() (*specs.Spec, error) {
			panic("mock out the Load method")
		},
		LookupEnvFunc: func(s string) (string, bool) {
			panic("mock out the LookupEnv method")
		},
		ModifyFunc: func(specModifier SpecModifier) error {
			panic("mock out the Modify method")
		},
	}

	// use mockedSpec in code that requires Spec
	// and then make assertions.

}

func (*SpecMock) Flush

func (mock *SpecMock) Flush() error

Flush calls FlushFunc.

func (*SpecMock) FlushCalls

func (mock *SpecMock) FlushCalls() []struct {
}

FlushCalls gets all the calls that were made to Flush. Check the length with:

len(mockedSpec.FlushCalls())

func (*SpecMock) Load

func (mock *SpecMock) Load() (*specs.Spec, error)

Load calls LoadFunc.

func (*SpecMock) LoadCalls

func (mock *SpecMock) LoadCalls() []struct {
}

LoadCalls gets all the calls that were made to Load. Check the length with:

len(mockedSpec.LoadCalls())

func (*SpecMock) LookupEnv

func (mock *SpecMock) LookupEnv(s string) (string, bool)

LookupEnv calls LookupEnvFunc.

func (*SpecMock) LookupEnvCalls

func (mock *SpecMock) LookupEnvCalls() []struct {
	S string
}

LookupEnvCalls gets all the calls that were made to LookupEnv. Check the length with:

len(mockedSpec.LookupEnvCalls())

func (*SpecMock) Modify

func (mock *SpecMock) Modify(specModifier SpecModifier) error

Modify calls ModifyFunc.

func (*SpecMock) ModifyCalls

func (mock *SpecMock) ModifyCalls() []struct {
	SpecModifier SpecModifier
}

ModifyCalls gets all the calls that were made to Modify. Check the length with:

len(mockedSpec.ModifyCalls())

type SpecModifier

type SpecModifier interface {
	// Modify is a method that accepts a pointer to an OCI Srec and returns an
	// error. The intention is that the function would modify the spec in-place.
	Modify(*specs.Spec) error
}

SpecModifier defines an interace for modifying a (raw) OCI spec

type State

type State specs.State

State stores an OCI container state. This includes the spec path and the environment

func LoadContainerState

func LoadContainerState(filename string) (*State, error)

LoadContainerState loads the container state from the specified filename. If the filename is empty or '-' the state is loaded from STDIN

func ReadContainerState

func ReadContainerState(reader io.Reader) (*State, error)

ReadContainerState reads the container state from the specified reader

func (*State) GetContainerRoot

func (s *State) GetContainerRoot() (string, error)

GetContainerRoot returns the root for the container from the associated spec. If the spec is not yet loaded, it is loaded and cached.

func (*State) LoadSpec

func (s *State) LoadSpec() (*specs.Spec, error)

LoadSpec loads the OCI spec associated with the container state