match

Documentation

Overview

Package match provides various helper functions for matching actual output to expected output.

Index

• func EqualString(t *testing.T, expectedString string) func(t *testing.T, output string)
• func MatchAllEntries[T any](t *testing.T, outputMode OutputMode, output string, normalize func(*T), ...)
• func MatchEntries[T any](t *testing.T, outputMode OutputMode, output string, normalize func(*T), ...)
• func MatchRegexp(t *testing.T, expectedRegexp string) func(t *testing.T, output string)
• func MatchUnmarshalledEntries[T any](t *testing.T, entries []*T, expectedEntries ...*T)
• type OutputMode

Functions

func EqualString

func EqualString(t *testing.T, expectedString string) func(t *testing.T, output string)

EqualString verifies that the output string matches the expectedString. This function can be directly used as ValidateOutput function.

func MatchAllEntries

func MatchAllEntries[T any](t *testing.T, outputMode OutputMode, output string, normalize func(*T), expectedEntry *T)

MatchAllEntries verifies that expectedEntry is matched by all entries in the output. The output is parsed according to outputMode.

func MatchEntries

func MatchEntries[T any](t *testing.T, outputMode OutputMode, output string, normalize func(*T), expectedEntries ...*T)

MatchEntries verifies that all the entries in expectedEntries are matched by at least one entry in the output. The output is parsed according to outputMode.

func MatchRegexp

func MatchRegexp(t *testing.T, expectedRegexp string) func(t *testing.T, output string)

MatchRegexp verifies that the output string matches the expected regular expression. This function can be directly used as ValidateOutput function.

func MatchUnmarshalledEntries

func MatchUnmarshalledEntries[T any](t *testing.T, entries []*T, expectedEntries ...*T)

MatchUnmarshalledEntries verifies that all the entries in expectedEntries are matched by at least one entry in entries. MatchUnmarshalledEntries([]int{1, 2, 3}, 2, 3) will pass MatchUnmarshalledEntries([]int{1, 2, 3}, 2, 4) will fail

Types

type OutputMode

type OutputMode int

OutputMode represents how the output string should be parsed.

const (
	InvalidMode OutputMode = iota

	// JSONSingleObjectMode represents the mode in which the output is single
	// JSON object.
	//
	// Example: One object in one line:
	// {"key": "value1", "key2": "value4"}
	//
	// Example: Object spread across multiple lines:
	//{
	//	"key": "value1",
	//	"key2": "value4"
	//}
	//
	// Currently not known gadget produces this output.
	JSONSingleObjectMode

	// JSONMultiObjectMode represents the mode in which the output is one or multiple
	// JSON objects.
	//
	// Example: One object per line:
	// {"key": "value1", "key2": "value4"}
	// {"key": "value2", "key2": "value5"}
	// {"key": "value3", "key2": "value6"}
	//
	// Example: Object spread across multiple lines:
	//{
	//	"key": "value1",
	//	"key2": "value4"
	//}
	//{
	//	"key": "value2",
	//	"key2": "value5"
	//}
	//{
	//	"key": "value3",
	//	"key2": "value6"
	//}
	//
	// This output is produced by gadgets like trace_open, trace_exec, etc.
	JSONMultiObjectMode

	// JSONSingleArrayMode represents the mode in which the output a single JSON
	// array.
	//
	// Example: Single array in one line:
	// [{"key": "value1"}, {"key": "value2"}, {"key": "value3"}]
	//
	// Example: Single array in multiple lines:
	// [
	// 	{
	// 		"key": "value1"
	// 	},
	// 	{
	// 		"key": "value2"
	// 	},
	// 	{
	// 		"key": "value3"
	// 	}
	// ]
	//
	// This output is produced by gadgets like snapshot_process, snapshot_socket, etc.
	JSONSingleArrayMode

	// JSONMultiArrayMode represents the mode in which the output is one or multiple
	// JSON arrays.
	//
	// Example: Multiple arrays, one per line:
	// [{"key": "value1"}, {"key": "value2"}, {"key": "value3"}]
	// [{"key": "value4"}, {"key": "value5"}, {"key": "value4"}]
	//
	// Example: Multiple arrays, in multiple lines:
	// [
	// 	{
	// 		"key": "value1"
	// 	},
	// 	{
	// 		"key": "value2"
	// 	},
	// 	{
	// 		"key": "value3"
	// 	}
	// ]
	// [
	// 	{
	// 		"key": "value4"
	// 	},
	// 	{
	// 		"key": "value5"
	// 	},
	// 	{
	// 		"key": "value4"
	// 	}
	// ]
	//
	// This output is produced by gadgets like top_file, top_tcp, etc.
	JSONMultiArrayMode
)