test

Documentation

Index

• Constants
• Variables
• func AContext() gomock.Matcher
• func AssertContentToFile(t *testing.T, gotContent, wantFile string)
• func AssertFilesEquals(t *testing.T, gotPath, wantPath string)
• func Bundle() *releasev1.Bundles
• func Bundles(tb testing.TB) *releasev1alpha1.Bundles
• func CACertContent() string
• func CAPICluster(opts ...CAPIClusterOpt) *clusterv1.Cluster
• func EksdRelease() *eksdv1.Release
• func EksdReleaseFromTestData(t *testing.T) *eksdv1alpha1.Release
• func FakeNow() time.Time
• func MatchFile(file string) gomock.Matcher
• func Namespace(name string) *corev1.Namespace
• func NewClusterSpec(opts ...ClusterSpecOpt) *cluster.Spec
• func NewClusterSpecForCluster(tb testing.TB, c *v1alpha1.Cluster) *cluster.Spec
• func NewClusterSpecForConfig(tb testing.TB, config *cluster.Config) *cluster.Spec
• func NewFakeKubeClient(objs ...client.Object) kubernetes.Client
• func NewFakeKubeClientAlwaysError(objs ...client.Object) kubernetes.Client
• func NewFakeNow() time.Time
• func NewFileReader() *files.Reader
• func NewFullClusterSpec(t *testing.T, clusterConfigFile string) *cluster.Spec
• func NewHTTPSServerForFile(t *testing.T, filePath string) *httptest.Server
• func NewHTTPServerForFile(t *testing.T, filePath string) *httptest.Server
• func NewKubeClient(client client.Client) kubernetes.Client
• func NewNullLogger() logr.Logger
• func NewWriter(t *testing.T) (dir string, writer filewriter.FileWriter)
• func OfType(t string) gomock.Matcher
• func RandString(n int) string
• func ReadFile(t *testing.T, file string) string
• func ReadFileAsBytes(t *testing.T, file string) []byte
• func RegistryMirrorConfigFilesInsecureSkipVerify() []bootstrapv1.File
• func RegistryMirrorConfigFilesInsecureSkipVerifyAndCACert() []bootstrapv1.File
• func RegistryMirrorInsecureSkipVerifyEnabled() *anywherev1.RegistryMirrorConfiguration
• func RegistryMirrorInsecureSkipVerifyEnabledAndCACert() *anywherev1.RegistryMirrorConfiguration
• func RegistryMirrorPreKubeadmCommands() []string
• func RegistryMirrorSudoPreKubeadmCommands() []string
• func RemoveFileIfExists(t *testing.T, filename string)
• func SanitizePath(s string) string
• func SetTag(image *releasev1alpha1.Image, tag string)
• func UseEnvTest(t *testing.T) *rest.Config
• func WithFakeFile(t *testing.T) (f *os.File)
• func WithFakeFileContents(t *testing.T, r io.Reader) (f *os.File)
• type CAPIClusterOpt
• type ClusterSpecOpt
• type Reader

Constants

const KubeVipTemplate = `` /* 1091-byte string literal not displayed */

KubeVipTemplate is the default kube-vip pod template for internal testing.

Variables

var UpdateGoldenFiles = flag.Bool("update", false, "update golden files")

Functions

func AContext

func AContext() gomock.Matcher

AContext returns a gomock matchers that evaluates if the receive value can fullfills the context.Context interface.

func AssertContentToFile

func AssertContentToFile(t *testing.T, gotContent, wantFile string)

func AssertFilesEquals

func AssertFilesEquals(t *testing.T, gotPath, wantPath string)

func Bundle

func Bundle() *releasev1.Bundles

Bundle returns a test bundle struct for unit testing.

func Bundles

func Bundles(tb testing.TB) *releasev1alpha1.Bundles

Bundles returs a test Bundles. All the paths to referenced manifests are valid and can be read.

func CACertContent

func CACertContent() string

CACertContent returns a test string representing a cacert contents.

func CAPICluster

func CAPICluster(opts ...CAPIClusterOpt) *clusterv1.Cluster

CAPICluster returns a capi cluster which can be configured by passing in opts arguments.

func EksdRelease

func EksdRelease() *eksdv1.Release

EksdRelease returns a test release struct for unit testing.

func EksdReleaseFromTestData

func EksdReleaseFromTestData(t *testing.T) *eksdv1alpha1.Release

EksdReleaseFromTestData returns a test release struct for unit testing from a testdata file. See EksdRelease() for a static struct to test with.

func FakeNow

func FakeNow() time.Time

func MatchFile

func MatchFile(file string) gomock.Matcher

MatchFile returns a gomock matcher that compares []byte input to the content of the given file.

func Namespace

func Namespace(name string) *corev1.Namespace

Namespace returns a test namespace struct for unit testing.

func NewClusterSpec

func NewClusterSpec(opts ...ClusterSpecOpt) *cluster.Spec

func NewClusterSpecForCluster

func NewClusterSpecForCluster(tb testing.TB, c *v1alpha1.Cluster) *cluster.Spec

NewClusterSpecForCluster builds a compliant cluster.Spec from a Cluster using a test Bundles and EKS-D Release.

func NewClusterSpecForConfig

func NewClusterSpecForConfig(tb testing.TB, config *cluster.Config) *cluster.Spec

NewClusterSpecForConfig builds a compliant cluster.Spec from a cluster.Config using a test Bundles and EKS-D Release.

func NewFakeKubeClient

func NewFakeKubeClient(objs ...client.Object) kubernetes.Client

NewFakeKubeClient returns a kubernetes.Client that uses a fake client.Client under the hood.

func NewFakeKubeClientAlwaysError

func NewFakeKubeClientAlwaysError(objs ...client.Object) kubernetes.Client

NewFakeKubeClientAlwaysError returns a kubernetes.Client that will always fail in any operation This is achieved by injecting an empty Scheme, which will make the underlying client.Client incapable of determining the resource type for a particular client.Object.

func NewFakeNow

func NewFakeNow() time.Time

NewFakeNow sets a dummy value for time.Now in unit tests. This is particularly useful when testing upgrade operations.

func NewFileReader

func NewFileReader() *files.Reader

NewFileReader builds a file reader with a proper user-agent. Unit tests should never make network call to the internet, but just in case we set the user-agent to be able to pin-point them here.

func NewFullClusterSpec

func NewFullClusterSpec(t *testing.T, clusterConfigFile string) *cluster.Spec

func NewHTTPSServerForFile

func NewHTTPSServerForFile(t *testing.T, filePath string) *httptest.Server

NewHTTPSServerForFile creates an HTTPS server that always serves the content of the given file.

func NewHTTPServerForFile

func NewHTTPServerForFile(t *testing.T, filePath string) *httptest.Server

func NewKubeClient

func NewKubeClient(client client.Client) kubernetes.Client

NewKubeClient builds a new kubernetes.Client by using client.Client.

func NewNullLogger

func NewNullLogger() logr.Logger

func NewWriter

func NewWriter(t *testing.T) (dir string, writer filewriter.FileWriter)

func OfType

func OfType(t string) gomock.Matcher

func RandString

func RandString(n int) string

func ReadFile

func ReadFile(t *testing.T, file string) string

func ReadFileAsBytes

func ReadFileAsBytes(t *testing.T, file string) []byte

func RegistryMirrorConfigFilesInsecureSkipVerify

func RegistryMirrorConfigFilesInsecureSkipVerify() []bootstrapv1.File

RegistryMirrorConfigFilesInsecureSkipVerify returns cluster-api bootstrap files that configure containerd to use a registry mirror with the insecure_skip_verify flag enabled.

func RegistryMirrorConfigFilesInsecureSkipVerifyAndCACert

func RegistryMirrorConfigFilesInsecureSkipVerifyAndCACert() []bootstrapv1.File

RegistryMirrorConfigFilesInsecureSkipVerifyAndCACert returns cluster-api bootstrap files that configure containerd to use a registry mirror with a cacert file and insecure_skip_verify flag enabled.

func RegistryMirrorInsecureSkipVerifyEnabled

func RegistryMirrorInsecureSkipVerifyEnabled() *anywherev1.RegistryMirrorConfiguration

RegistryMirrorInsecureSkipVerifyEnabled returns a test RegistryMirrorConfiguration with InsecureSkipVerify enabled.

func RegistryMirrorInsecureSkipVerifyEnabledAndCACert

func RegistryMirrorInsecureSkipVerifyEnabledAndCACert() *anywherev1.RegistryMirrorConfiguration

RegistryMirrorInsecureSkipVerifyEnabledAndCACert returns a test RegistryMirrorConfiguration with a CACert specified and InsecureSkipVerify enabled.

func RegistryMirrorPreKubeadmCommands

func RegistryMirrorPreKubeadmCommands() []string

RegistryMirrorPreKubeadmCommands returns a list of commands to writes a config_append.toml file to configure the registry mirror and restart containerd.

func RegistryMirrorSudoPreKubeadmCommands

func RegistryMirrorSudoPreKubeadmCommands() []string

RegistryMirrorSudoPreKubeadmCommands returns a list of commands that writes a config_append.toml file to configure the registry mirror and restart containerd with sudo permissions.

func RemoveFileIfExists

func RemoveFileIfExists(t *testing.T, filename string)

RemoveFileIfExists is a helper for ValidateFilename tests.

func SanitizePath

func SanitizePath(s string) string

SanitizePath sanitizes s so its usable as a path name. For safety, it assumes all characters that are not A-Z, a-z, 0-9, _ or - are illegal and replaces them with _.

func SetTag

func SetTag(image *releasev1alpha1.Image, tag string)

func UseEnvTest

func UseEnvTest(t *testing.T) *rest.Config

UseEnvTest sets up the controller-runtime EnvTest framework.

The test will be skipped if EnvTest framework isn't detected.

EnvTest provides fake k8s control plane components for testing purposes. The process of bringing up and tearing down the EnvTest framework involves running a few binaries, and is not integrated into a vanilla "go test" run, but rather can be run via the unit-test target in Makefile. See https://book.kubebuilder.io/reference/envtest.html for details.

TODO: What could be done to integrate EnvTest with go test, so that "go test" would work?

func WithFakeFile

func WithFakeFile(t *testing.T) (f *os.File)

WithFakeFile returns a throwaway file in a test-specific directory.

The file is automatically closed and removed when the test ends.

func WithFakeFileContents

func WithFakeFileContents(t *testing.T, r io.Reader) (f *os.File)

WithFakeFileContents returns a throwaway file containing some data.

The file is automatically closed and removed when the test ends.

Types

type CAPIClusterOpt

type CAPIClusterOpt func(*clusterv1.Cluster)

CAPIClusterOpt represents an function where a capi cluster is passed as an argument.

type ClusterSpecOpt

type ClusterSpecOpt func(*cluster.Spec)

type Reader

type Reader interface {
	ReadFile(url string) ([]byte, error)
}

Reader is a commonly used interface in multiple packages We are replicating here just to create a single mock we can use in multiple test packages.