fake

Documentation

Index

• Constants
• type BindFunction
• type BindingValidationFunction
• type Module
  • func New() (*Module, error)
  • func (m *Module) GetCatalog() (service.Catalog, error)
  • func (m *Module) GetName() string
  • func (m *Module) GetStability() service.Stability
• type ProvisioningValidationFunction
• type ServiceManager
  • func (s *ServiceManager) Bind(instance service.Instance, bindingParameters service.BindingParameters, ...) (service.BindingDetails, service.SecureBindingDetails, error)
  • func (s *ServiceManager) GetCredentials(service.Instance, service.Binding) (service.Credentials, error)
  • func (s *ServiceManager) GetDeprovisioner(service.Plan) (service.Deprovisioner, error)
  • func (s *ServiceManager) GetProvisioner(service.Plan) (service.Provisioner, error)
  • func (s *ServiceManager) GetUpdater(service.Plan) (service.Updater, error)
  • func (s *ServiceManager) SplitBindingParameters(cbp service.CombinedBindingParameters) (service.BindingParameters, service.SecureBindingParameters, error)
  • func (s *ServiceManager) SplitProvisioningParameters(cpp service.CombinedProvisioningParameters) (service.ProvisioningParameters, service.SecureProvisioningParameters, error)
  • func (s *ServiceManager) Unbind(instance service.Instance, binding service.Binding) error
  • func (s *ServiceManager) ValidateBindingParameters(bindingParameters service.BindingParameters, ...) error
  • func (s *ServiceManager) ValidateProvisioningParameters(provisioningParameters service.ProvisioningParameters, ...) error
  • func (s *ServiceManager) ValidateUpdatingParameters(instance service.Instance) error
• type UnbindFunction
• type UpdatingValidationFunction

Constants

const (
	// ServiceID is the service ID of the fake service
	ServiceID = "cdd1fb7a-d1e9-49e0-b195-e0bab747798a"
	// StandardPlanID is the plan ID for the standard (and only) variant of the
	// fake service
	StandardPlanID = "bd15e6f3-4ff5-477c-bb57-26313a368e74"
)

Types

type BindFunction

type BindFunction func(
	service.Instance,
	service.BindingParameters,
) (service.BindingDetails, service.SecureBindingDetails, error)

BindFunction describes a function used to provide pluggable binding behavior to the fake implementation of the service.Module interface

type BindingValidationFunction

type BindingValidationFunction func(
	service.BindingParameters,
	service.SecureBindingParameters,
) error

BindingValidationFunction describes a function used to provide pluggable binding validation behavior to the fake implementation of the service.Module interface

type Module

type Module struct {
	ServiceManager *ServiceManager
}

Module is a fake implementation of the service.Module interface used to facilittate testing.

func New

func New() (*Module, error)

New returns a new instance of a type that fulfills the service.Module and provides an example of how such a module is implemented

func (*Module) GetCatalog

func (m *Module) GetCatalog() (service.Catalog, error)

GetCatalog returns a Catalog of service/plans offered by a module

func (*Module) GetName

func (m *Module) GetName() string

GetName returns this module's name

func (*Module) GetStability

func (m *Module) GetStability() service.Stability

GetStability returns this module's relative stability

type ProvisioningValidationFunction

type ProvisioningValidationFunction func(
	service.ProvisioningParameters,
	service.SecureProvisioningParameters,
) error

ProvisioningValidationFunction describes a function used to provide pluggable provisioning validation behavior to the fake implementation of the service.Module interface

type ServiceManager

type ServiceManager struct {
	ProvisioningValidationBehavior ProvisioningValidationFunction
	UpdatingValidationBehavior     UpdatingValidationFunction
	BindingValidationBehavior      BindingValidationFunction
	BindBehavior                   BindFunction
	UnbindBehavior                 UnbindFunction
}

ServiceManager is a fake implementation of the service.ServiceManager interface used to facilitate testing.

func (*ServiceManager) Bind

func (s *ServiceManager) Bind(
	instance service.Instance,
	bindingParameters service.BindingParameters,
	_ service.SecureBindingParameters,
) (service.BindingDetails, service.SecureBindingDetails, error)

Bind synchronously binds to a service

func (*ServiceManager) GetCredentials

func (s *ServiceManager) GetCredentials(
	service.Instance,
	service.Binding,
) (service.Credentials, error)

GetCredentials returns service-specific credentials populated from instance and binding details

func (*ServiceManager) GetDeprovisioner

func (s *ServiceManager) GetDeprovisioner(
	service.Plan,
) (service.Deprovisioner, error)

GetDeprovisioner returns a deprovisioner that defines the steps a module must execute asynchronously to deprovision a service

func (*ServiceManager) GetProvisioner

func (s *ServiceManager) GetProvisioner(
	service.Plan,
) (service.Provisioner, error)

GetProvisioner returns a provisioner that defines the steps a module must execute asynchronously to provision a service

func (*ServiceManager) GetUpdater

func (s *ServiceManager) GetUpdater(service.Plan) (service.Updater, error)

GetUpdater returns a updater that defines the steps a module must execute asynchronously to update a service

func (*ServiceManager) SplitBindingParameters

func (s *ServiceManager) SplitBindingParameters(
	cbp service.CombinedBindingParameters,
) (
	service.BindingParameters,
	service.SecureBindingParameters,
	error,
)

SplitBindingParameters splits a map of binding parameters into two separate maps, with one containing non-sensitive binding parameters and the other containing sensitive binding parameters.

func (*ServiceManager) SplitProvisioningParameters

func (s *ServiceManager) SplitProvisioningParameters(
	cpp service.CombinedProvisioningParameters,
) (
	service.ProvisioningParameters,
	service.SecureProvisioningParameters,
	error,
)

SplitProvisioningParameters splits a map of provisioning parameters into two separate maps, with one containing non-sensitive provisioning parameters and the other containing sensitive provisioning parameters.

func (*ServiceManager) Unbind

func (s *ServiceManager) Unbind(
	instance service.Instance,
	binding service.Binding,
) error

Unbind synchronously unbinds from a service

func (*ServiceManager) ValidateBindingParameters

func (s *ServiceManager) ValidateBindingParameters(
	bindingParameters service.BindingParameters,
	secureBindingParameters service.SecureBindingParameters,
) error

ValidateBindingParameters validates the provided bindingParameters and returns an error if there is any problem

func (*ServiceManager) ValidateProvisioningParameters

func (s *ServiceManager) ValidateProvisioningParameters(
	provisioningParameters service.ProvisioningParameters,
	secureProvisioningParameters service.SecureProvisioningParameters,
) error

ValidateProvisioningParameters validates the provided provisioningParameters and returns an error if there is any problem

func (*ServiceManager) ValidateUpdatingParameters

func (s *ServiceManager) ValidateUpdatingParameters(
	instance service.Instance,
) error

ValidateUpdatingParameters validates the provided updating parameters and returns an error if there is any problem

type UnbindFunction

type UnbindFunction func(
	service.Instance,
	service.Binding,
) error

UnbindFunction describes a function used to provide pluggable unbinding behavior to the fake implementation of the service.Module interface

type UpdatingValidationFunction

type UpdatingValidationFunction func(service.Instance) error

UpdatingValidationFunction describes a function used to provide pluggable updating validation behavior to the fake implementation of the service.Module interface