addon

Documentation

Index

• Variables
• func DeprovisionGlobals(cfg *config.Config) error
• func GlobalLogs() (map[string]string, error)
• func InitGlobals(cfg *config.Config)
• func ProvisionGlobals(cfg *config.Config) error
• func SetupGlobalsNonPrimary(cfg *config.Config, transferred []AddonTransferableData) error
• type Addon
• type AddonTransferableData
  • func SetupGlobalsPrimary(cfg *config.Config) ([]AddonTransferableData, error)

Variables

var (
	// Base is a base addon containing Kubernetes clients
	Base  = &base.Base{}
	Vault = &vault.Vault{}
)

Functions

func DeprovisionGlobals

func DeprovisionGlobals(cfg *config.Config) error

DeprovisionGlobals deprovisions all of the global addons. This should be called by the test suite in a SynchronizedAfterSuite to ensure all global addons are cleaned up after a run. This should be run only on ginkgo process #1.

func GlobalLogs

func GlobalLogs() (map[string]string, error)

func InitGlobals

func InitGlobals(cfg *config.Config)

InitGlobals actually allocates the addon values that are defined above. We do this here so that we can access the suites config structure during the definition of global addons.

func ProvisionGlobals

func ProvisionGlobals(cfg *config.Config) error

ProvisionGlobals calls Provision on all of the global addons. This should be called by the test suite in a SynchronizedBeforeSuite block after the Setup data has been transferred to all ginkgo processes, so that not all processes have to wait for the addons to be provisioned. Instead, the individual test has to check that the addon is provisioned (eg. by querying the API server for a resource that the addon creates or by checking that an HTTP endpoint is available) This function should be run only on ginkgo process #1.

func SetupGlobalsNonPrimary

func SetupGlobalsNonPrimary(cfg *config.Config, transferred []AddonTransferableData) error

SetupGlobalsNonPrimary setups all of the global addons. A non-primary ginkgo process is one that is not process #1 (process #2 and above). This function should be called by the test suite entrypoint in a SynchronizedBeforeSuite block on all ginkgo processes except #1. It has to be run after the primary process has run SetupGlobalsPrimary, so that the data returned by SetupGlobalsPrimary on process #1 can be passed into this function. This function calls Setup on all of the non-primary processes (processes #2 and above) and passes in the AddonTransferableData data returned by the primary process.

Types

type Addon

type Addon = internal.Addon

type AddonTransferableData

type AddonTransferableData = internal.AddonTransferableData

func SetupGlobalsPrimary

func SetupGlobalsPrimary(cfg *config.Config) ([]AddonTransferableData, error)

SetupGlobals setups all of the global addons. The primary ginkgo process is the process with index 1. This function should be called by the test suite entrypoint in a SynchronizedBeforeSuite block to ensure it is run only on ginkgo process #1. It has to be run before any other ginkgo processes are started, because the return value of this function has to be transferred to the other ginkgo processes.