internal

Documentation

Index

• type Addon
• type AddonTransferableData

Types

type Addon

type Addon interface {
	// For non-global addons, this function is called on all ginkgo processes without
	// any arguments. For global addons, this function is called on ginkgo process #1
	// without any arguments, but the returned data is passed to the Setup function
	// on all other ginkgo processes.
	Setup(*config.Config, ...AddonTransferableData) (AddonTransferableData, error)

	// For non-global addons, this function is called on all ginkgo processes. For global
	// addons, this function is called only on ginkgo process #1.
	Provision() error

	// For non-global addons, this function is called on all ginkgo processes. For global
	// addons, this function is called only on ginkgo process #1.
	Deprovision() error

	SupportsGlobal() bool
}

Addon is an interface that defines a e2e addon.

type AddonTransferableData

type AddonTransferableData interface{}

TransferableData is data generated by a global addons' Setup function running on ginigo process #1 that should be copied to all other ginkgo processes. This is used to setup these processes with the same data as ginkgo process #1. The data has to be json serializable.

eg. The process #1 Setup function generates a private key and certificate and transfers it to all other ginkgo processes. Process #1 then starts a shared server that trusts the certificate. All other ginkgo processes can authenticate to this server using the private key and certificate that was transferred to them.