utils

Documentation

Index

• Constants
• Variables
• func BinaryInPath(bin string) error
• func DeleteFromResult(t testing.TB, pth string, r gjson.Result) gjson.Result
• func GetFirstMatchResult(t testing.TB, rs []gjson.Result, k, v string) gjson.Result
• func GetJSONPaths(result gjson.Result) []string
• func GetLoggerFromT() *logger.Logger
• func GetResultStrSlice(rs []gjson.Result) []string
• func GetTerminalJSONPaths(result gjson.Result) []string
• func GetWD(t testing.TB) string
• func LoadJSON(t testing.TB, path string) gjson.Result
• func MinSemver(gotSemver string, minSemver string) error
• func NewTestFileLogger(t *testing.T, pth string) (*logger.Logger, func(t *testing.T))
• func ParseJSONResult(t testing.TB, j string) gjson.Result
• func ParseKubectlJSONResult(t testing.TB, str string) gjson.Result
• func Poll(t testing.TB, condition func() (bool, error), numRetries int, ...)
• func PollE(t testing.TB, condition func() (bool, error), numRetries int, ...) error
• func RandStr(l int) string
• func RunStage(stageName string, stage func())
• func SetEnv(t testing.TB, key string, value string)
• func StringFromTextAndArgs(msgAndArgs ...interface{}) string
• func ValFromEnv(t testing.TB, k string) string
• func WithHTTPClient(c *http.Client) assertOption
• func WithHTTPRequestRetries(count int, interval time.Duration) assertOption
• func WriteTmpFile(data string) (string, error)
• func WriteTmpFileWithExtension(data string, extension string) (string, error)
• type AssertHTTP
  • func NewAssertHTTP(opts ...assertOption) *AssertHTTP
  • func (ah *AssertHTTP) AssertResponse(t testing.TB, r *http.Request, wantCode int, want ...string)
  • func (ah *AssertHTTP) AssertResponseWithRetry(t testing.TB, r *http.Request, wantCode int, want ...string)
  • func (ah *AssertHTTP) AssertSuccess(t testing.TB, r *http.Request)
  • func (ah *AssertHTTP) AssertSuccessWithRetry(t testing.TB, r *http.Request)
• type PollConditionError
  • func (e *PollConditionError) Error() string
  • func (e *PollConditionError) Unwrap() error
• type PollParameterError
  • func (e *PollParameterError) Error() string
• type PollRetryLimitExceededError
  • func (e *PollRetryLimitExceededError) Error() string
• type TestFileLogger
  • func (fl TestFileLogger) Close(t *testing.T)
  • func (fl TestFileLogger) Logf(t terraTesting.TestingT, format string, args ...interface{})

Constants

const RUN_STAGE_ENV_VAR = "RUN_STAGE"

Variables

var (
	KubectlTransientErrors = []string{
		"E022[23] .* the server is currently unable to handle the request",
	}
)

Kubectl transient errors

Functions

func BinaryInPath

func BinaryInPath(bin string) error

BinaryInPath checks if a given binary is in path.

func DeleteFromResult

func DeleteFromResult(t testing.TB, pth string, r gjson.Result) gjson.Result

DeleteFromResult deletes given path from result and returns the modified result

func GetFirstMatchResult

func GetFirstMatchResult(t testing.TB, rs []gjson.Result, k, v string) gjson.Result

GetFirstMatchResult returns the first matching result with a given k/v

func GetJSONPaths

func GetJSONPaths(result gjson.Result) []string

GetJSONPaths returns a []string of all possible JSON paths for a gjson.Result

func GetLoggerFromT

func GetLoggerFromT() *logger.Logger

GetLoggerFromT returns a logger based on test verbosity

func GetResultStrSlice

func GetResultStrSlice(rs []gjson.Result) []string

GetResultStrSlice parses results into a string slice

func GetTerminalJSONPaths

func GetTerminalJSONPaths(result gjson.Result) []string

GetTerminalJSONPaths returns a []string of all terminal JSON paths for a gjson.Result

func GetWD

func GetWD(t testing.TB) string

Get the environment Working Directory.

func LoadJSON

func LoadJSON(t testing.TB, path string) gjson.Result

LoadJSON reads and parses a json file into a gjson.Result. It fails test if not unable to parse.

func MinSemver

func MinSemver(gotSemver string, minSemver string) error

MinSemver validates gotSemver is not less than minSemver

func NewTestFileLogger

func NewTestFileLogger(t *testing.T, pth string) (*logger.Logger, func(t *testing.T))

NewTestFileLogger returns a TestFileLogger logger that can be used with the WithLogger option.

func ParseJSONResult

func ParseJSONResult(t testing.TB, j string) gjson.Result

ParseJSONResult converts a JSON string into gjson result

func ParseKubectlJSONResult

func ParseKubectlJSONResult(t testing.TB, str string) gjson.Result

Filter transient errors from kubectl output

func Poll

func Poll(t testing.TB, condition func() (bool, error), numRetries int, interval time.Duration)

Polls on a particular condition function while the returns true. It fails the test if the condition is not met within numRetries.

func PollE

func PollE(t testing.TB, condition func() (bool, error), numRetries int, interval time.Duration) error

Polls on a particular condition function while the returns true. Returns an error if the condition is not met within numRetries.

func RandStr

func RandStr(l int) string

RandStr generates rand lowercase strings of length l

func RunStage

func RunStage(stageName string, stage func())

RunStage runs stage if stageName matches RUN_STAGE env var or RUN_STAGE is unset. Similar to terratest RunStage but instead of skipping using env var, we match using envvar.

func SetEnv

func SetEnv(t testing.TB, key string, value string)

SetEnv set a environment variable.

func StringFromTextAndArgs

func StringFromTextAndArgs(msgAndArgs ...interface{}) string

StringFromTextAndArgs converts msg and args to formatted text

func ValFromEnv

func ValFromEnv(t testing.TB, k string) string

ValFromEnv returns value for a given env var. It fails test if not set.

func WithHTTPClient

func WithHTTPClient(c *http.Client) assertOption

WithHTTPClient specifies an HTTP client for the AssertHTTP use.

func WithHTTPRequestRetries

func WithHTTPRequestRetries(count int, interval time.Duration) assertOption

WithHTTPRequestRetries specifies a HTTP request retry policy.

func WriteTmpFile

func WriteTmpFile(data string) (string, error)

WriteTmpFile writes data to a temp file and returns the path.

func WriteTmpFileWithExtension

func WriteTmpFileWithExtension(data string, extension string) (string, error)

WriteTmpFileWithExtension writes data to a temp file with given extension and returns the path.

Types

type AssertHTTP

type AssertHTTP struct {
	// contains filtered or unexported fields
}

AssertHTTP provides a collection of HTTP asserts.

func NewAssertHTTP

func NewAssertHTTP(opts ...assertOption) *AssertHTTP

NewAssertHTTP creates a new AssertHTTP with option overrides.

func (*AssertHTTP) AssertResponse

func (ah *AssertHTTP) AssertResponse(t testing.TB, r *http.Request, wantCode int, want ...string)

AssertResponse runs httpResponse without retry.

func (*AssertHTTP) AssertResponseWithRetry

func (ah *AssertHTTP) AssertResponseWithRetry(t testing.TB, r *http.Request, wantCode int, want ...string)

AssertResponseWithRetry runs httpResponse and retries on errors outside client control.

func (*AssertHTTP) AssertSuccess

func (ah *AssertHTTP) AssertSuccess(t testing.TB, r *http.Request)

AssertSuccess runs httpRequest without retry.

func (*AssertHTTP) AssertSuccessWithRetry

func (ah *AssertHTTP) AssertSuccessWithRetry(t testing.TB, r *http.Request)

AssertSuccessWithRetry runs httpRequest and retries on errors outside client control.

type PollConditionError

type PollConditionError struct {
	// contains filtered or unexported fields
}

PollConditionError is an error returned on the final PollE attempt.

func (*PollConditionError) Error

func (e *PollConditionError) Error() string

func (*PollConditionError) Unwrap

func (e *PollConditionError) Unwrap() error

type PollParameterError

type PollParameterError struct {
	// contains filtered or unexported fields
}

PollParameterError is returend by PollE when input parameters are invalid.

func (*PollParameterError) Error

func (e *PollParameterError) Error() string

type PollRetryLimitExceededError

type PollRetryLimitExceededError struct {
	// contains filtered or unexported fields
}

PollRetryLimitExceededError is returned by PollE when retries exceed numRetries.

func (*PollRetryLimitExceededError) Error

func (e *PollRetryLimitExceededError) Error() string

type TestFileLogger

type TestFileLogger struct {
	// contains filtered or unexported fields
}

TestFileLogger is a logger that writes to disk instead of stdout. This is useful when you want to redirect verbose logs of long running tests to disk.

func (TestFileLogger) Close

func (fl TestFileLogger) Close(t *testing.T)

func (TestFileLogger) Logf

func (fl TestFileLogger) Logf(t terraTesting.TestingT, format string, args ...interface{})