e2e

README

Backend end to end tests

This runs a series of tests against the Kubernetes API to verify that OLM is functioning properly.

Requirements

• Minikube > 0.25.0
• Helm > 2.7.0

How to use

Execute make e2e-local in the root of the repository, which will:

• optionally update test/e2e/assets/chart/zz_chart.go as needed
• build local executables used during testing
  • bin/e2e-local.test
  • bin/wait
  • bin/cpb
  • bin/catalog
  • bin/olm
  • bin/package-server
• build docker file e2e.Dockerfile which includes the local executables in a kind image archive test/e2e-local.image.tar
• execute ginkgo to run the pre-compiled test package bin/e2e-local.test with the kind image archive. This runs BDD tests defined in test/e2e
  • these tests are run in a kind cluster that is started fresh each time the test is executed

Examples:

• Run all BDD tests (this takes a long time)

  make e2e-local
  

• Run a specific BDD test using the TEST argument to make. Note that this argument uses regular expressions.

  make e2e-local TEST='API service resource not migrated if not adoptable'
  

• If you have previously created the bin/e2e-local.test executable and want a quick way to ensure that your TEST regex argument will work, you can bypass the make file and use -dryRun with -focus and see if the regex would trigger your specific test(s).

  GO111MODULE=on go run github.com/onsi/ginkgo/v2/ginkgo -dryRun -focus 'API service resource not migrated if not adoptable' bin/e2e-local.test
  

• It is also possible to specify the number of parallel test nodes (i.e. one or more instances of go test) to run using the NODES argument. Defaults to 1 if not specified

  make e2e-local NODES=2
  

Build infrastructure

Note that the make file target e2e-local is executed by the github workflow .github/workflows/e2e-tests.yml and uses two parallel go test processes.

Running on minikube

The e2e suite is also runnable on a minikube cluster. First spin up the minikube cluster manually with the desired provisioner, then run make run-local to deploy OLM onto the cluster. Tests can be run by invoking ginkgo and passing the required command line arguments to the test suite. For example to run a specific test:

GO111MODULE=on go run github.com/onsi/ginkgo/v2/ginkgo -focus "static provider" -v --progress ./test/e2e -- -namespace=operators -olmNamespace=olm -dummyImage=bitnami/nginx:latest

Documentation

Index

• Constants
• func Apply(obj controllerclient.Object, changeFunc interface{}) func() error
• func CSVHasPhase(goal operatorsv1alpha1.ClusterServiceVersionPhase) gtypes.GomegaMatcher
• func HaveMessage(goal string) gtypes.GomegaMatcher
• func HavePhase(goal operatorsv1alpha1.InstallPlanPhase) gtypes.GomegaMatcher
• func K8sSafeCurrentTestDescription() string
• func Local(client operatorclient.ClientInterface) (bool, error)
• func MaskNotFound(err error) error
• func SetupGeneratedTestNamespace(name string, targetNamespaces ...string) corev1.Namespace
• func SetupGeneratedTestNamespaceWithOperatorGroup(name string, og operatorsv1.OperatorGroup) corev1.Namespace
• func TearDown(namespace string)
• func TeardownNamespace(ns string)
• type FileBasedCatalogProvider
  • func NewFileBasedFiledBasedCatalogProvider(path string) (FileBasedCatalogProvider, error)
  • func NewRawFileBasedCatalogProvider(data string) (FileBasedCatalogProvider, error)
• type MagicCatalog
  • func NewMagicCatalog(kubeClient k8scontrollerclient.Client, namespace string, catalogName string, ...) *MagicCatalog
  • func NewMagicCatalogFromFile(kubeClient k8scontrollerclient.Client, namespace string, catalogName string, ...) (*MagicCatalog, error)
  • func (c *MagicCatalog) DeployCatalog(ctx context.Context) error
  • func (c *MagicCatalog) GetName() string
  • func (c *MagicCatalog) GetNamespace() string
  • func (c *MagicCatalog) UndeployCatalog(ctx context.Context) []error
  • func (c *MagicCatalog) UpdateCatalog(ctx context.Context, provider FileBasedCatalogProvider) error

Constants

const (
	BuilderServiceAccount = "builder"
)

Functions

func Apply

func Apply(obj controllerclient.Object, changeFunc interface{}) func() error

func CSVHasPhase

func CSVHasPhase(goal operatorsv1alpha1.ClusterServiceVersionPhase) gtypes.GomegaMatcher

func HaveMessage

func HaveMessage(goal string) gtypes.GomegaMatcher

func HavePhase

func HavePhase(goal operatorsv1alpha1.InstallPlanPhase) gtypes.GomegaMatcher

func K8sSafeCurrentTestDescription

func K8sSafeCurrentTestDescription() string

func Local

func Local(client operatorclient.ClientInterface) (bool, error)

Local determines whether test is running locally or in a container on openshift-CI. Queries for a clusterversion object specific to OpenShift.

func MaskNotFound

func MaskNotFound(err error) error

MaskNotFound "masks" an given error by returning nil when it refers to a "NotFound" API status response, otherwise returns the error unaltered.

func SetupGeneratedTestNamespace

func SetupGeneratedTestNamespace(name string, targetNamespaces ...string) corev1.Namespace

func SetupGeneratedTestNamespaceWithOperatorGroup

func SetupGeneratedTestNamespaceWithOperatorGroup(name string, og operatorsv1.OperatorGroup) corev1.Namespace

func TearDown

func TearDown(namespace string)

TearDown deletes all OLM resources in the corresponding namespace and at the cluster scope.

func TeardownNamespace

func TeardownNamespace(ns string)

Types

type FileBasedCatalogProvider

type FileBasedCatalogProvider interface {
	GetCatalog() string
}

func NewFileBasedFiledBasedCatalogProvider

func NewFileBasedFiledBasedCatalogProvider(path string) (FileBasedCatalogProvider, error)

func NewRawFileBasedCatalogProvider

func NewRawFileBasedCatalogProvider(data string) (FileBasedCatalogProvider, error)

type MagicCatalog

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

func NewMagicCatalog

func NewMagicCatalog(kubeClient k8scontrollerclient.Client, namespace string, catalogName string, provider FileBasedCatalogProvider) *MagicCatalog

NewMagicCatalog creates an object that can deploy an arbitrary file-based catalog given by the FileBasedCatalogProvider Keep in mind that there are limits to the configMaps. So, the catalogs need to be relatively simple

func NewMagicCatalogFromFile

func NewMagicCatalogFromFile(kubeClient k8scontrollerclient.Client, namespace string, catalogName string, fbcFilePath string) (*MagicCatalog, error)

func (*MagicCatalog) DeployCatalog

func (c *MagicCatalog) DeployCatalog(ctx context.Context) error

func (*MagicCatalog) GetName

func (c *MagicCatalog) GetName() string

func (*MagicCatalog) GetNamespace

func (c *MagicCatalog) GetNamespace() string

func (*MagicCatalog) UndeployCatalog

func (c *MagicCatalog) UndeployCatalog(ctx context.Context) []error

func (*MagicCatalog) UpdateCatalog

func (c *MagicCatalog) UpdateCatalog(ctx context.Context, provider FileBasedCatalogProvider) error