e2e

Documentation

Overview

Package e2e is created because:

During test setup, SetupLocalRegistry is called, and container tests need to be run before VM tests so that the local registry won't be removed by VM tests, and container tests can use the images stored in it.

However, by default Ginkgo does not guarantee the order in which specs run [1], and Ginkgo doc says that "You should only ever call RunSpecs once" [2], which means that we need two binaries that run VM tests and container tests respectively.

We could add ginkgo.Ordered to the top level Ginkgo container, but that will make every single spec to run in the order they are defined: "Any container nodes nested within a container node will automatically be considered Ordered and there is no way to mark a node within an Ordered container as "not Ordered"" [1], and we don't want that because it can hide implicit dependencies among tests, while each test should be independent unless specially designed.

As a result, we split the tests into `e2e/vm` and `e2e/container` packages and extract the common logic into this package.

[1] https://onsi.github.io/ginkgo/#ordered-containers. [2] https://onsi.github.io/ginkgo/#mental-model-go-modules-packages-and-tests

Index

• Constants
• Variables
• func CreateOption() (*option.Option, error)

Constants

const InstalledTestSubject = "finch"

InstalledTestSubject is the test subject when Finch is installed.

Variables

var (
	// Installed indicates whether the tests are run against installed application.
	Installed = flag.Bool("installed", false, "the flag to show whether the tests are run against installed application")
	// Registry indicates which container registry to pull from.
	Registry = flag.String("registry", "", "used when pulling from registry to test credential helper")
)

Functions

func CreateOption

func CreateOption() (*option.Option, error)

CreateOption creates an option for running e2e tests.