controller

Documentation

Overview

Package controller is a package meant for internal testing only. The interfaces may change or be removed at any time without warning.

Index

• type Option
  • func DisableAuthMethodCreation() Option
  • func DisableDatabaseCreation() Option
  • func DisableDatabaseDestruction() Option
  • func WithConfigFile(f string) Option
  • func WithConfigText(ct string) Option
  • func WithDatabaseUrl(url string) Option
  • func WithDefaultLoginName(ln string) Option
  • func WithDefaultOidcAuthMethodId(id string) Option
  • func WithDefaultPassword(pw string) Option
  • func WithDefaultPasswordAuthMethodId(id string) Option
  • func WithEnableTemplatedDatabase(enable bool) Option
  • func WithRecoveryKms(wrapper wrapping.Wrapper) Option
  • func WithRootKms(wrapper wrapping.Wrapper) Option
  • func WithWorkerAuthKms(wrapper wrapping.Wrapper) Option
• type TestController
  • func NewTestController(t *testing.T, opt ...Option) *TestController

Types

type Option

type Option func(*option) error

func DisableAuthMethodCreation

func DisableAuthMethodCreation() Option

DisableAuthMethodCreation skips creating a default auth method

func DisableDatabaseCreation

func DisableDatabaseCreation() Option

DisableDatabaseCreation skips creating a database in docker and allows one to be provided through a tcOptions.

func DisableDatabaseDestruction

func DisableDatabaseDestruction() Option

DisableDatabaseCreation skips creating a database in docker and allows one to be provided through a tcOptions.

func WithConfigFile

func WithConfigFile(f string) Option

WithConfigFile provides the given ConfigFile to the built TestController. This option cannot be used if WithConfigText is used.

func WithConfigText

func WithConfigText(ct string) Option

WithConfigText configures the TestController sets up the Controller using the provided config text. This option cannot be used if WithConfigFile is used.

func WithDatabaseUrl

func WithDatabaseUrl(url string) Option

func WithDefaultLoginName

func WithDefaultLoginName(ln string) Option

func WithDefaultOidcAuthMethodId

func WithDefaultOidcAuthMethodId(id string) Option

func WithDefaultPassword

func WithDefaultPassword(pw string) Option

func WithDefaultPasswordAuthMethodId

func WithDefaultPasswordAuthMethodId(id string) Option

func WithEnableTemplatedDatabase

func WithEnableTemplatedDatabase(enable bool) Option

WithEnableTemplatedDatabase enables usage of a local database test instance with a template. Generally outside tests will probably want to use the non-templated database, so this defaults to enabling instead of disabling.

func WithRecoveryKms

func WithRecoveryKms(wrapper wrapping.Wrapper) Option

func WithRootKms

func WithRootKms(wrapper wrapping.Wrapper) Option

func WithWorkerAuthKms

func WithWorkerAuthKms(wrapper wrapping.Wrapper) Option

type TestController

type TestController struct {
	*controller.TestController
}

func NewTestController

func NewTestController(t *testing.T, opt ...Option) *TestController

NewTestController blocks until a new TestController is created, returns the url for the TestController and a function that can be called to tear down the controller after it has been used for testing.