framework

README

Some source files were originally from: k8s.io/kubernetes@/v1.21.0

Documentation

Index

• func ExpectConsistOf(actual interface{}, extra interface{}, explain ...interface{})
• func ExpectEmpty(actual interface{}, explain ...interface{})
• func ExpectEqual(actual interface{}, extra interface{}, explain ...interface{})
• func ExpectError(err error, explain ...interface{})
• func ExpectHaveKey(actual interface{}, key interface{}, explain ...interface{})
• func ExpectNoError(err error, explain ...interface{})
• func ExpectNoErrorWithOffset(offset int, err error, explain ...interface{})
• func ExpectNotEqual(actual interface{}, extra interface{}, explain ...interface{})
• func Fail(msg string, callerSkip ...int)
• func Failf(format string, args ...interface{})
• func FailfWithOffset(offset int, format string, args ...interface{})
• func Logf(format string, args ...interface{})
• func NewTableReporter(filename string) ginkgo.Reporter
• func PrunedStack(skip int) string
• func RegisterAndHandleFlags()
• func RemoveCleanupAction(p CleanupActionHandle)
• func RunCleanupActions()
• func WaitForNamespacesDeleted(client client.Client, namespaces []string, timeout time.Duration) error
• type CleanupActionHandle
  • func AddCleanupAction(fn func()) CleanupActionHandle
• type Context
• type PreserveResourcesMode

Functions

func ExpectConsistOf

func ExpectConsistOf(actual interface{}, extra interface{}, explain ...interface{})

ExpectConsistOf expects actual contains precisely the extra elements. The ordering of the elements does not matter.

func ExpectEmpty

func ExpectEmpty(actual interface{}, explain ...interface{})

ExpectEmpty expects actual is empty

func ExpectEqual

func ExpectEqual(actual interface{}, extra interface{}, explain ...interface{})

ExpectEqual expects the specified two are the same, otherwise an exception raises

func ExpectError

func ExpectError(err error, explain ...interface{})

ExpectError expects an error happens, otherwise an exception raises

func ExpectHaveKey

func ExpectHaveKey(actual interface{}, key interface{}, explain ...interface{})

ExpectHaveKey expects the actual map has the key in the keyset

func ExpectNoError

func ExpectNoError(err error, explain ...interface{})

ExpectNoError checks if "err" is set, and if so, fails assertion while logging the error.

func ExpectNoErrorWithOffset

func ExpectNoErrorWithOffset(offset int, err error, explain ...interface{})

ExpectNoErrorWithOffset checks if "err" is set, and if so, fails assertion while logging the error at "offset" levels above its caller (for example, for call chain f -> g -> ExpectNoErrorWithOffset(1, ...) error would be logged for "f").

func ExpectNotEqual

func ExpectNotEqual(actual interface{}, extra interface{}, explain ...interface{})

ExpectNotEqual expects the specified two are not the same, otherwise an exception raises

func Fail

func Fail(msg string, callerSkip ...int)

Fail is a replacement for ginkgo.Fail which logs the problem as it occurs together with a stack trace and then calls ginkgowrapper.Fail.

func Failf

func Failf(format string, args ...interface{})

Failf logs the fail info, including a stack trace.

func FailfWithOffset

func FailfWithOffset(offset int, format string, args ...interface{})

FailfWithOffset calls "Fail" and logs the error with a stack trace that starts at "offset" levels above its caller (for example, for call chain f -> g -> FailfWithOffset(1, ...) error would be logged for "f").

func Logf

func Logf(format string, args ...interface{})

Logf logs the info.

func NewTableReporter

func NewTableReporter(filename string) ginkgo.Reporter

func PrunedStack

func PrunedStack(skip int) string

PrunedStack is a wrapper around debug.Stack() that removes information about the current goroutine and optionally skips some of the initial stack entries. With skip == 0, the returned stack will start with the caller of PruneStack. From the remaining entries it automatically filters out useless ones like entries coming from Ginkgo.

This is a modified copy of PruneStack in https://github.com/onsi/ginkgo/blob/f90f37d87fa6b1dd9625e2b1e83c23ffae3de228/internal/codelocation/code_location.go#L25: - simplified API and thus renamed (calls debug.Stack() instead of taking a parameter) - source code filtering updated to be specific to Kubernetes

func RegisterAndHandleFlags

func RegisterAndHandleFlags()

func RemoveCleanupAction

func RemoveCleanupAction(p CleanupActionHandle)

RemoveCleanupAction removes a function that was installed by AddCleanupAction.

func RunCleanupActions

func RunCleanupActions()

RunCleanupActions runs all functions installed by AddCleanupAction. It does not remove them (see RemoveCleanupAction) but it does run unlocked, so they may remove themselves.

func WaitForNamespacesDeleted

func WaitForNamespacesDeleted(client client.Client, namespaces []string, timeout time.Duration) error

Types

type CleanupActionHandle

type CleanupActionHandle *int

CleanupActionHandle is an integer pointer type for handling cleanup action

func AddCleanupAction

func AddCleanupAction(fn func()) CleanupActionHandle

AddCleanupAction installs a function that will be called in the event of the whole test being terminated. This allows arbitrary pieces of the overall test to hook into SynchronizedAfterSuite().

type Context

type Context struct {
	KubeConfigsDir    string
	FabdnsZone        string
	EdgeLabels        string
	GenReport         bool
	ReportFile        string
	RequestTimeout    time.Duration
	WaitTimeout       int64
	CurlTimeout       int64
	NetToolImage      string
	IPv6Enabled       bool
	PreserveResources string
	ShowExecError     bool
}

var TestContext Context

type PreserveResourcesMode

type PreserveResourcesMode string

const (
	PreserveResourcesAlways    PreserveResourcesMode = "always"
	PreserveResourcesNever     PreserveResourcesMode = "never"
	PreserveResourcesOnFailure PreserveResourcesMode = "fail"
)