common

Documentation

Index

• Constants
• func CleanOutput(stdOutput string) string
• func GetCurrentServiceRevision(t *testing.T, serviceName string) string
• func GetFuncBinaryPath() string
• func GetKnativeServiceRevisionAndUrl(t *testing.T, serviceName string) (revision string, url string)
• func GetOsEnvOrDefault(env string, dflt string) string
• func GetRegistry() string
• func GetRuntime() string
• func IsUseKnFunc() bool
• func RetrieveKnativeServiceResource(t *testing.T, serviceName string) *unstructured.Unstructured
• func WaitForFunctionReady(t *testing.T, functionName string) (revisionName string, functionUrl string)
• func WaitForNewRevisionReady(t *testing.T, previousRevision string, functionName string) (newRevision string)
• type GitProvider
  • func GetGitServer(T *testing.T) GitProvider
• type GitRemoteRepo
• type GitTestServerKnativeProvider
  • func (g *GitTestServerKnativeProvider) CreateRepository(repoName string) *GitRemoteRepo
  • func (g *GitTestServerKnativeProvider) DeleteRepository(repoName string)
  • func (g *GitTestServerKnativeProvider) Init(T *testing.T)
• type TestExecCmd
  • func NewKnFuncShellCli(t *testing.T) *TestExecCmd
  • func NewShellCmd(t *testing.T, fromDirectory string) *TestExecCmd
  • func (f *TestExecCmd) Exec(args ...string) TestExecCmdResult
  • func (f *TestExecCmd) FromDir(dir string) *TestExecCmd
  • func (f *TestExecCmd) Run(oneArgs string) TestExecCmdResult
  • func (f *TestExecCmd) WithEnv(envKey string, envValue string) *TestExecCmd
• type TestExecCmdResult
• type TestInteractiveCmd
  • func NewTestShellInteractiveCmd(t *testing.T) *TestInteractiveCmd
  • func (f *TestInteractiveCmd) PrepareRun(funcCommand ...string) func(args ...string) TestExecCmdResult

Constants

const (
	DefaultRegistry = "localhost:50000/user"
)

Intended to provide setup configuration for E2E tests

Functions

func CleanOutput

func CleanOutput(stdOutput string) string

CleanOutput Some commands, such as deploy command, spans spinner chars and cursor shifts at output which are captured and merged regular output messages. This functions is meant to remove these chars in order to facilitate tests assertions and data extraction from output

func GetCurrentServiceRevision

func GetCurrentServiceRevision(t *testing.T, serviceName string) string

GetCurrentServiceRevision retrieves current revision name for the deployed function

func GetFuncBinaryPath

func GetFuncBinaryPath() string

GetFuncBinaryPath should return the Path of 'func' binary under test

func GetKnativeServiceRevisionAndUrl

func GetKnativeServiceRevisionAndUrl(t *testing.T, serviceName string) (revision string, url string)

func GetOsEnvOrDefault

func GetOsEnvOrDefault(env string, dflt string) string

func GetRegistry

func GetRegistry() string

GetRegistry returns registry

func GetRuntime

func GetRuntime() string

GetRuntime returns the runtime that should be tested.

func IsUseKnFunc

func IsUseKnFunc() bool

IsUseKnFunc indicates that tests should be run against "kn func" instead of "func" binary

func RetrieveKnativeServiceResource

func RetrieveKnativeServiceResource(t *testing.T, serviceName string) *unstructured.Unstructured

RetrieveKnativeServiceResource wraps the logic to query knative serving resources in current namespace

func WaitForFunctionReady

func WaitForFunctionReady(t *testing.T, functionName string) (revisionName string, functionUrl string)

func WaitForNewRevisionReady

func WaitForNewRevisionReady(t *testing.T, previousRevision string, functionName string) (newRevision string)

NewRevisionCheck waits for a new revision to report as ready

Types

type GitProvider

type GitProvider interface {
	Init(T *testing.T)
	CreateRepository(repoName string) *GitRemoteRepo
	DeleteRepository(repoName string)
}

var DefaultGitServer GitProvider

func GetGitServer

func GetGitServer(T *testing.T) GitProvider

type GitRemoteRepo

type GitRemoteRepo struct {
	RepoName         string
	ExternalCloneURL string
	ClusterCloneURL  string
}

type GitTestServerKnativeProvider

type GitTestServerKnativeProvider struct {
	PodName    string
	ServiceUrl string
	Kubectl    *TestExecCmd
	// contains filtered or unexported fields
}

func (*GitTestServerKnativeProvider) CreateRepository

func (g *GitTestServerKnativeProvider) CreateRepository(repoName string) *GitRemoteRepo

func (*GitTestServerKnativeProvider) DeleteRepository

func (g *GitTestServerKnativeProvider) DeleteRepository(repoName string)

func (*GitTestServerKnativeProvider) Init

func (g *GitTestServerKnativeProvider) Init(T *testing.T)

type TestExecCmd

type TestExecCmd struct {

	// binary to invoke
	// Example: "func", "kn", "kubectl", "/usr/bin/sh"
	Binary string

	// Binary args to append before actual args. Examples:
	//  when 'kn' binary binaryArgs should be ["func"]
	BinaryArgs []string

	// Run commands from Dir
	SourceDir string

	// Indicates shell should dump command line args during execution
	ShouldDumpCmdLine bool

	// Indicates shell should dump
	ShouldDumpOnSuccess bool

	// Fail Test on Error
	ShouldFailOnError bool

	// Environment variable to be used with the command
	Env []string

	// Optional function to be used to dump stdout command results
	DumpLogger func(out string)

	// Access to Running or Latest command
	ExecCmd *exec.Cmd

	// Function to be executed while the command is running. This function is executed only once
	OnWaitCallback func(stdout *bytes.Buffer)

	// Function to be executed after the command is completed (before error and cmd stdout logic is executed)
	OnFinishCallback func(result *TestExecCmdResult)

	T *testing.T
}

func NewKnFuncShellCli

func NewKnFuncShellCli(t *testing.T) *TestExecCmd

func NewShellCmd

func NewShellCmd(t *testing.T, fromDirectory string) *TestExecCmd

func (*TestExecCmd) Exec

func (f *TestExecCmd) Exec(args ...string) TestExecCmdResult

Exec invokes go exec library and runs a shell command combining the binary args with args from method signature

func (*TestExecCmd) FromDir

func (f *TestExecCmd) FromDir(dir string) *TestExecCmd

func (*TestExecCmd) Run

func (f *TestExecCmd) Run(oneArgs string) TestExecCmdResult

func (*TestExecCmd) WithEnv

func (f *TestExecCmd) WithEnv(envKey string, envValue string) *TestExecCmd

type TestExecCmdResult

type TestExecCmdResult struct {
	Out   string
	Error error
}

TestExecCmdResult stored command result

type TestInteractiveCmd

type TestInteractiveCmd struct {
	TestCmd *TestExecCmd
	T       *testing.T

	// Sleep interval before first command input
	StartSleepInterval time.Duration

	// Sleep interval between each subcommand
	CommandSleepInterval time.Duration

	// Sleep interval after last command completion.
	// Required time to give to process to complete before EOF
	CompletionSleepInterval time.Duration

	// Timeout before kill the cmd in case of some failure
	CompletionTimeout time.Duration
}

func NewTestShellInteractiveCmd

func NewTestShellInteractiveCmd(t *testing.T) *TestInteractiveCmd

func (*TestInteractiveCmd) PrepareRun

func (f *TestInteractiveCmd) PrepareRun(funcCommand ...string) func(args ...string) TestExecCmdResult

PrepareRun creates a go function used to start kn func (binary) that requires user interaction such as `func config command`