utils

Documentation

Index

• Variables
• func Containerized() bool
• func CreateTempDirInTempDir() (string, error)
• func ExitWithError(optionalExitCode ...int) *exitMatcher
• func IsCommandAvailable(command string) bool
• func IsKernelNewerThan(version string) (bool, error)
• func StringInSlice(s string, sl []string) bool
• func WaitContainerReady(p PodmanTestCommon, id string, expStr string, timeout int, step int) bool
• func WaitForContainer(p PodmanTestCommon) bool
• func WriteJsonFile(data []byte, filePath string) error
• type HostOS
  • func GetHostDistributionInfo() HostOS
• type PodmanSession
  • func StartSystemExec(command string, args []string) *PodmanSession
  • func SystemExec(command string, args []string) *PodmanSession
  • func (s *PodmanSession) ErrorGrepString(term string) (bool, []string)
  • func (s *PodmanSession) ErrorToString() string
  • func (s *PodmanSession) ErrorToStringArray() []string
  • func (s *PodmanSession) GrepString(term string) (bool, []string)
  • func (s *PodmanSession) IsJSONOutputValid() bool
  • func (s *PodmanSession) LineInOutputContains(term string) bool
  • func (s *PodmanSession) LineInOutputContainsTag(repo, tag string) bool
  • func (s *PodmanSession) LineInOutputStartsWith(term string) bool
  • func (s *PodmanSession) OutputToString() string
  • func (s *PodmanSession) OutputToStringArray() []string
  • func (s *PodmanSession) WaitWithDefaultTimeout()
• type PodmanTest
  • func (p *PodmanTest) GetContainerStatus() string
  • func (p *PodmanTest) MakeOptions(args []string, noEvents, noCache bool) []string
  • func (p *PodmanTest) NumberOfContainers() int
  • func (p *PodmanTest) NumberOfContainersRunning() int
  • func (p *PodmanTest) NumberOfPods() int
  • func (p *PodmanTest) PodmanAsUserBase(args []string, uid, gid uint32, cwd string, env []string, ...) *PodmanSession
  • func (p *PodmanTest) PodmanBase(args []string, noEvents, noCache bool) *PodmanSession
  • func (p *PodmanTest) WaitContainerReady(id string, expStr string, timeout int, step int) bool
  • func (p *PodmanTest) WaitForContainer() bool
• type PodmanTestCommon

Variables

var (
	OSReleasePath        = "/etc/os-release"
	ProcessOneCgroupPath = "/proc/1/cgroup"
)

Functions

func Containerized

func Containerized() bool

Containerized check the podman command run inside container

func CreateTempDirInTempDir

func CreateTempDirInTempDir() (string, error)

CreateTempDirinTempDir create a temp dir with prefix podman_test

func ExitWithError

func ExitWithError(optionalExitCode ...int) *exitMatcher

ExitWithError matches when assertion is > argument. Default 0 Modeled after the gomega Exit() matcher

func IsCommandAvailable

func IsCommandAvailable(command string) bool

IsCommandAvaible check if command exist

func IsKernelNewerThan

func IsKernelNewerThan(version string) (bool, error)

IsKernelNewerThan compares the current kernel version to one provided. If the kernel is equal to or greater, returns true

func StringInSlice

func StringInSlice(s string, sl []string) bool

StringInSlice determines if a string is in a string slice, returns bool

func WaitContainerReady

func WaitContainerReady(p PodmanTestCommon, id string, expStr string, timeout int, step int) bool

WaitForContainerReady is a wrapper function for accept inheritance PodmanTest struct.

func WaitForContainer

func WaitForContainer(p PodmanTestCommon) bool

WaitForContainer is a wrapper function for accept inheritance PodmanTest struct.

func WriteJsonFile

func WriteJsonFile(data []byte, filePath string) error

WriteJsonFile write json format data to a json file

Types

type HostOS

type HostOS struct {
	Distribution string
	Version      string
	Arch         string
}

HostOS is a simple struct for the test os

func GetHostDistributionInfo

func GetHostDistributionInfo() HostOS

GetHostDistributionInfo returns a struct with its distribution name and version

type PodmanSession

type PodmanSession struct {
	*Session
}

PodmanSession wraps the gexec.session so we can extend it

func StartSystemExec

func StartSystemExec(command string, args []string) *PodmanSession

StartSystemExec is used to start exec a system command

func SystemExec

func SystemExec(command string, args []string) *PodmanSession

SystemExec is used to exec a system command to check its exit code or output

func (*PodmanSession) ErrorGrepString

func (s *PodmanSession) ErrorGrepString(term string) (bool, []string)

ErrorGrepString takes session stderr output and behaves like grep. it returns a bool if successful and an array of strings on positive matches

func (*PodmanSession) ErrorToString

func (s *PodmanSession) ErrorToString() string

ErrorToString formats session stderr to string

func (*PodmanSession) ErrorToStringArray

func (s *PodmanSession) ErrorToStringArray() []string

ErrorToStringArray returns the stderr output as a []string where each array item is a line split by newline

func (*PodmanSession) GrepString

func (s *PodmanSession) GrepString(term string) (bool, []string)

GrepString takes session output and behaves like grep. it returns a bool if successful and an array of strings on positive matches

func (*PodmanSession) IsJSONOutputValid

func (s *PodmanSession) IsJSONOutputValid() bool

IsJSONOutputValid attempts to unmarshal the session buffer and if successful, returns true, else false

func (*PodmanSession) LineInOutputContains

func (s *PodmanSession) LineInOutputContains(term string) bool

LineInOutputContains returns true if a line in a session output contains the supplied string

func (*PodmanSession) LineInOutputContainsTag

func (s *PodmanSession) LineInOutputContainsTag(repo, tag string) bool

LineInOutputContainsTag returns true if a line in the session's output contains the repo-tag pair as returned by podman-images(1).

func (*PodmanSession) LineInOutputStartsWith

func (s *PodmanSession) LineInOutputStartsWith(term string) bool

LineInOutputStartsWith returns true if a line in a session output starts with the supplied string

func (*PodmanSession) OutputToString

func (s *PodmanSession) OutputToString() string

OutputToString formats session output to string

func (*PodmanSession) OutputToStringArray

func (s *PodmanSession) OutputToStringArray() []string

OutputToStringArray returns the output as a []string where each array item is a line split by newline

func (*PodmanSession) WaitWithDefaultTimeout

func (s *PodmanSession) WaitWithDefaultTimeout()

WaitWithDefaultTimeout waits for process finished with defaultWaitTimeout

type PodmanTest

type PodmanTest struct {
	PodmanMakeOptions  func(args []string, noEvents, noCache bool) []string
	PodmanBinary       string
	ArtifactPath       string
	TempDir            string
	RemoteTest         bool
	RemotePodmanBinary string
	RemoteSession      *os.Process
	RemoteSocket       string
	RemoteCommand      *exec.Cmd
	ImageCacheDir      string
	ImageCacheFS       string
}

PodmanTest struct for command line options

func (*PodmanTest) GetContainerStatus

func (p *PodmanTest) GetContainerStatus() string

GetContainerStatus returns the containers state. This function assumes only one container is active.

func (*PodmanTest) MakeOptions

func (p *PodmanTest) MakeOptions(args []string, noEvents, noCache bool) []string

MakeOptions assembles all podman options

func (*PodmanTest) NumberOfContainers

func (p *PodmanTest) NumberOfContainers() int

NumberOfContainers returns an int of how many containers are currently defined.

func (*PodmanTest) NumberOfContainersRunning

func (p *PodmanTest) NumberOfContainersRunning() int

NumberOfContainersRunning returns an int of how many containers are currently running.

func (*PodmanTest) NumberOfPods

func (p *PodmanTest) NumberOfPods() int

NumberOfPods returns an int of how many pods are currently defined.

func (*PodmanTest) PodmanAsUserBase

func (p *PodmanTest) PodmanAsUserBase(args []string, uid, gid uint32, cwd string, env []string, noEvents, noCache bool, extraFiles []*os.File) *PodmanSession

PodmanAsUserBase exec podman as user. uid and gid is set for credentials usage. env is used to record the env for debugging

func (*PodmanTest) PodmanBase

func (p *PodmanTest) PodmanBase(args []string, noEvents, noCache bool) *PodmanSession

PodmanBase exec podman with default env.

func (*PodmanTest) WaitContainerReady

func (p *PodmanTest) WaitContainerReady(id string, expStr string, timeout int, step int) bool

WaitContainerReady waits process or service inside container start, and ready to be used.

func (*PodmanTest) WaitForContainer

func (p *PodmanTest) WaitForContainer() bool

WaitForContainer waits on a started container

type PodmanTestCommon

type PodmanTestCommon interface {
	MakeOptions(args []string, noEvents, noCache bool) []string
	WaitForContainer() bool
	WaitContainerReady(id string, expStr string, timeout int, step int) bool
}

PodmanTestCommon contains common functions will be updated later in the inheritance structs