athodyd

README

Athodyd

Table-driven integration tests for Kubernetes controllers and CustomResourceDefinitions.

Documentation

Index

• type Config
• type Manager
  • func New(cfg *rest.Config, o ...Option) (*Manager, error)
  • func (m *Manager) Cleanup() error
  • func (m *Manager) GetClient() client.Client
  • func (m *Manager) Run()
• type OperationFn
  • func NewBuilder() OperationFn
  • func NewCleaner() OperationFn
• type Option
  • func WithBuilder(builder OperationFn) Option
  • func WithCRDDirectoryPaths(crds []string) Option
  • func WithCleaner(cleaner OperationFn) Option
  • func WithManagerOptions(m manager.Options) Option

Types

type Config

type Config struct {
	CRDDirectoryPaths []string
	Builder           OperationFn
	Cleaner           OperationFn
	ManagerOptions    manager.Options
}

Config is a set of configuration values for Athodyd setup.

type Manager

type Manager struct {
	manager.Manager
	// contains filtered or unexported fields
}

Manager wraps a controller-runtime manager with additional functionality.

func New

func New(cfg *rest.Config, o ...Option) (*Manager, error)

New creates a new Athodyd Manager.

func (*Manager) Cleanup

func (m *Manager) Cleanup() error

Cleanup runs the supplied cleanup or defaults to deleting all CRDs.

func (*Manager) GetClient

func (m *Manager) GetClient() client.Client

GetClient returns a Kubernetes rest client.

func (*Manager) Run

func (m *Manager) Run()

Run starts a controller-runtime manager with Athodyd's channel.

type OperationFn

type OperationFn func(*envtest.Environment, client.Client) error

OperationFn is a function that uses a Kubernetes client to perform and operation

func NewBuilder

func NewBuilder() OperationFn

NewBuilder returns a new no-op Builder

func NewCleaner

func NewCleaner() OperationFn

NewCleaner returns a new Cleaner that deletes all installed CRDs from the API server.

type Option

type Option func(*Config)

An Option configures an Athodyd Config.

func WithBuilder

func WithBuilder(builder OperationFn) Option

WithBuilder sets a custom builder function for an Athodyd Config.

func WithCRDDirectoryPaths

func WithCRDDirectoryPaths(crds []string) Option

WithCRDDirectoryPaths sets custom CRD locations for an Athodyd Config.

func WithCleaner

func WithCleaner(cleaner OperationFn) Option

WithCleaner sets a custom cleaner function for an Athodyd Config.

func WithManagerOptions

func WithManagerOptions(m manager.Options) Option

WithManagerOptions sets custom options for the manager configured by Athodyd Config.