testenv

Documentation

Overview

Package testenv contains common helpers for tests

Index

• Constants
• func AddRandomSuffix(name string, s rand.Source) string
• func ApplyTemplate(k kubectl.Command, asset string, data interface{}) error
• func AssetPath(p ...string) string
• func CreateCluster(k kubectl.Command, namespace, name string, labels map[string]string, ...) error
• func CreateClusterGroup(k kubectl.Command, namespace, name string, matchLabels map[string]string, ...) error
• func CreateGitRepo(k kubectl.Command, namespace string, name string, branch string, shard string, ...) error
• func ExamplePath(p ...string) string
• func NewNamespaceName(name string, s rand.Source) string
• func RandomFilename(filename string, r *rand.Rand) string
• func Root() string
• func SetRoot(dir string)
• func Template(output string, tmplPath string, data any) error
• type Env
  • func New() *Env
• type GitRepoData

Constants

const Timeout = 5 * time.Minute

Functions

func AddRandomSuffix

func AddRandomSuffix(name string, s rand.Source) string

AddRandomSuffix adds a random suffix to a given name.

func ApplyTemplate

func ApplyTemplate(k kubectl.Command, asset string, data interface{}) error

ApplyTemplate templates a file and applies it to the cluster.

func AssetPath

func AssetPath(p ...string) string

AssetPath returns the path to an asset

func CreateCluster

func CreateCluster(
	k kubectl.Command,
	namespace,
	name string,
	labels map[string]string,
	spec map[string]string,
) error

func CreateClusterGroup

func CreateClusterGroup(
	k kubectl.Command,
	namespace,
	name string,
	matchLabels map[string]string,
	labels map[string]string,
) error

CreateClusterGroup uses the template to create a clustergroup resource.

func CreateGitRepo

func CreateGitRepo(
	k kubectl.Command,
	namespace string,
	name string,
	branch string,
	shard string,
	paths ...string,
) error

CreateGitRepo uses the template to create a gitrepo resource. The namespace is the TargetNamespace for the workloads.

func ExamplePath

func ExamplePath(p ...string) string

ExamplePath returns the path to the fleet examples

func NewNamespaceName

func NewNamespaceName(name string, s rand.Source) string

NewNamespaceName returns a name for a namespace that is unique to the test run. e.g. as a targetNamespace for workloads

func RandomFilename

func RandomFilename(filename string, r *rand.Rand) string

RandomName returns a slightly random name, so temporary assets don't conflict

func Root

func Root() string

Root returns the relative path to the repositories root

func SetRoot

func SetRoot(dir string)

SetRoot set the root path for the other relative paths, e.g. AssetPath. Usually set to point to the repositories root.

func Template

func Template(output string, tmplPath string, data any) error

Template loads a gotemplate from a file and writes templated output to another file, preferably in a temp dir

Types

type Env

type Env struct {
	Kubectl kubectl.Command
	// Upstream context for cluster containing the fleet controller and local agent
	Upstream string
	// Downstream context for fleet-agent cluster
	Downstream string
	// Namespace which contains the cluster resource for most E2E tests
	// (cluster registration namespace)
	Namespace string
	// Namespace which contains downstream clusters, besides the local
	// cluster, for some multi-cluster E2E tests
	ClusterRegistrationNamespace string
}

func New

func New() *Env

type GitRepoData

type GitRepoData struct {
	Name            string
	Branch          string
	Paths           []string
	TargetNamespace string
	Shard           string
}

GitRepoData can be used with the gitrepo-template.yaml asset when no custom GitRepo properties are required. All fields except Shard are required.