testutils

Documentation

Index

• Variables
• func CaptureLog(tb testing.TB, l *logrus.Logger)
• func CopyFile(toPath, fromPath string, perm os.FileMode) error
• func CopyFileToTmp(fname string) (string, error)
• func DoneWithExportFile(t testing.TB) error
• func GetExportFilename(t testing.TB) (string, error)
• func GetSpecFromTemplate(tmplname string, data interface{}) (string, error)
• func GetTgRuntimeConf() (*confmap.TetragonConfValue, error)
• func KeepExportFile(t testing.TB) error
• func MockPipedFile(t *testing.T, filename string)
• func ReadTgRuntimeConf(mapDir string) (*confmap.TetragonConfValue, error)
• func RedirectStdoutExecuteCmd(t *testing.T, cmd *cobra.Command) []byte
• func RepoRootPath(fname string) string
• type CmdBufferedPipes
  • func NewCmdBufferedPipes(cmd *exec.Cmd) (*CmdBufferedPipes, error)
  • func (cbp *CmdBufferedPipes) Close()
  • func (cbp *CmdBufferedPipes) ParseAndLogCmdOutput(t *testing.T, parseOut LineParser, parseErr LineParser) *sync.WaitGroup
• type CmdPipes
  • func NewCmdPipes(cmd *exec.Cmd) (*CmdPipes, error)
  • func (cp *CmdPipes) Close()
• type ExportFile
  • func CreateExportFile(tb testing.TB) (*ExportFile, error)
  • func (f *ExportFile) Close() error
• type LineParser
• type LogCapturer
  • func (tl LogCapturer) Write(p []byte) (n int, err error)
• type LseekPipeCmd
  • func NewLseekPipe(t *testing.T, ctx context.Context) *LseekPipeCmd
  • func (lp *LseekPipeCmd) Close() error
  • func (lp *LseekPipeCmd) Lseek(fd int, offset int64, whence int) string
  • func (lp *LseekPipeCmd) Pid() int
• type ThreadTesterInfo
  • func (tti *ThreadTesterInfo) AssertPidsTids(t *testing.T)
  • func (tti *ThreadTesterInfo) ParseLine(l string) error

Variables

var (
	ParentStartsRe = regexp.MustCompile(`parent:\t\t\(pid:(\d+), tid:(\d+), ppid:(\d+)\)\tstarts`)
	Child1Re       = regexp.MustCompile(`Child 1:\t\(pid:(\d+), tid:(\d+), ppid:(\d+)\)\t`)
	Thread1Re      = regexp.MustCompile(`Thread 1:\t\(pid:(\d+), tid:(\d+), ppid:(\d+)\)\t`)
)

Functions

func CaptureLog

func CaptureLog(tb testing.TB, l *logrus.Logger)

CaptureLog redirects logrus output to testing.Log

func CopyFile

func CopyFile(toPath, fromPath string, perm os.FileMode) error

func CopyFileToTmp

func CopyFileToTmp(fname string) (string, error)

func DoneWithExportFile

func DoneWithExportFile(t testing.TB) error

DoneWithExportFile: marks the export file to be deleted It is the tester's responsibility to call this function

func GetExportFilename

func GetExportFilename(t testing.TB) (string, error)

GetExportFilename return export filename for test

func GetSpecFromTemplate

func GetSpecFromTemplate(
	tmplname string,
	data interface{},
) (string, error)

GetSpecFromTemplate creates a file bsed on the given template

func GetTgRuntimeConf

func GetTgRuntimeConf() (*confmap.TetragonConfValue, error)

func KeepExportFile

func KeepExportFile(t testing.TB) error

KeepExportFile: marks the export file to be kept

func MockPipedFile

func MockPipedFile(t *testing.T, filename string)

MockPipedFile mocks the file being piped into stdin, similarly as what you can do with `cat file | cmd`. It restores the original os.Stdin in t.Cleanup. It's using a goroutine to copy the file content to the writer of the pipe.

func ReadTgRuntimeConf

func ReadTgRuntimeConf(mapDir string) (*confmap.TetragonConfValue, error)

func RedirectStdoutExecuteCmd

func RedirectStdoutExecuteCmd(t *testing.T, cmd *cobra.Command) []byte

RedirectStdoutExecuteCmd redirects stdout, executes the command and returns the result of the command.

func RepoRootPath

func RepoRootPath(fname string) string

RepoRootPath retrieves the repository root path (useful to find scripts and other files)

Types

type CmdBufferedPipes

type CmdBufferedPipes struct {
	P                  *CmdPipes
	StdoutRd, StderrRd *bufio.Reader
}

CmdBufferedPipes wraps stdout and stderr in a bufio.Reader

func NewCmdBufferedPipes

func NewCmdBufferedPipes(cmd *exec.Cmd) (*CmdBufferedPipes, error)

func (*CmdBufferedPipes) Close

func (cbp *CmdBufferedPipes) Close()

func (*CmdBufferedPipes) ParseAndLogCmdOutput

func (cbp *CmdBufferedPipes) ParseAndLogCmdOutput(
	t *testing.T,
	parseOut LineParser,
	parseErr LineParser,
) *sync.WaitGroup

ParseAndLogCmdOutput will log command output using t.Log, and also call the lineparser functions for each line. This will happen in two goroutines. It returns a waitgroup for them finishing.

type CmdPipes

type CmdPipes struct {
	Stdout, Stderr io.ReadCloser
	Stdin          io.WriteCloser
}

CmdPipes maintains pipes for stdout, stderr, and stdin

func NewCmdPipes

func NewCmdPipes(cmd *exec.Cmd) (*CmdPipes, error)

NewCmdPipes returns a new CmdPipes

func (*CmdPipes) Close

func (cp *CmdPipes) Close()

Close closes all the pipes

type ExportFile

type ExportFile struct {
	*os.File
	// contains filtered or unexported fields
}

func CreateExportFile

func CreateExportFile(tb testing.TB) (*ExportFile, error)

CreateExportFile creates an export file for a test. It returns an ExportFile that has a .Close() method, that will be called by the observer loop. This function is responsible to delete the file. For a file to be deleted, the tester should call DoneWithExportFile() if the test was successful.

func (*ExportFile) Close

func (f *ExportFile) Close() error

Close() is called by the observer loop when it exits, and is responsible for deleting the file.

type LineParser

type LineParser = func(line string) error

type LogCapturer

type LogCapturer struct {
	TB  testing.TB
	Log *logrus.Logger
}

func (LogCapturer) Write

func (tl LogCapturer) Write(p []byte) (n int, err error)

type LseekPipeCmd

type LseekPipeCmd struct {
	Cmd   *exec.Cmd
	Pipes *CmdBufferedPipes
}

func NewLseekPipe

func NewLseekPipe(t *testing.T, ctx context.Context) *LseekPipeCmd

starts a new lseek-pipe command

func (*LseekPipeCmd) Close

func (lp *LseekPipeCmd) Close() error

func (*LseekPipeCmd) Lseek

func (lp *LseekPipeCmd) Lseek(fd int, offset int64, whence int) string

func (*LseekPipeCmd) Pid

func (lp *LseekPipeCmd) Pid() int

type ThreadTesterInfo

type ThreadTesterInfo struct {
	ParentPid, ParentTid                     uint32
	Child1Pid, Child1Tid, ParentChild1Pid    uint32
	Thread1Pid, Thread1Tid, ParentThread1Pid uint32
}

func (*ThreadTesterInfo) AssertPidsTids

func (tti *ThreadTesterInfo) AssertPidsTids(t *testing.T)

func (*ThreadTesterInfo) ParseLine

func (tti *ThreadTesterInfo) ParseLine(l string) error