fake

package
v0.9.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2018 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
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"
)

Variables

This section is empty.

Functions

This section is empty.

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 BindingDetails 

type BindingDetails struct {
}

BindingDetails represents details collected and modified over the course of a fake service instance's binding and unbinding processes. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type BindingParameters 

type BindingParameters struct {
	SomeParameter string `json:"someParameter"`
}

BindingParameters represents non-sensitive parameters specific to binding to a service instance using the fake service module. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

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 Credentials 

type Credentials struct {
}

Credentials generally represent credentials AND/OR ANY OTHER DETAILS (e.g. URLs, port numbers, etc.) that will be conveyed back to the client upon successful completion of a bind. In the specific case of the fake service module, which doesn't do much of anything (other than generate a messageID and write some logs), there are no important details to convey back to the client. The messageID is included just to provide an example of HOW details such as these can be conveyed to the client. Note that, ordinarily, service module-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type InstanceDetails 

type InstanceDetails struct {
	ResourceGroupName string `json:"resourceGroup"`
}

InstanceDetails represents details collected and modified over the course of a fake service instance's provisioning and deprovisioning processes. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

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 ProvisioningParameters 

type ProvisioningParameters struct {
	SomeParameter string `json:"someParameter"`
}

ProvisioningParameters represents non-sensitive parameters specific to provisioning a service using the fake service module. Note that, ordinarily, service module-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

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 SecureBindingDetails 

type SecureBindingDetails struct {
}

SecureBindingDetails represents secure details collected and modified over the course of a fake service instance's binding and unbinding processes. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type SecureBindingParameters 

type SecureBindingParameters struct {
}

SecureBindingParameters represents sensitive parameters specific to binding to a service instance using the fake service module. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type SecureInstanceDetails 

type SecureInstanceDetails struct{}

SecureInstanceDetails represents sensitive details collected and modified over the course of a fake service instance's provisioning and deprovisioning processes. Note that, ordinarily, service-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type SecureProvisioningParameters 

type SecureProvisioningParameters struct{}

SecureProvisioningParameters represents sensitive parameters specific to provisioning a service using the fake service module. Note that, ordinarily, service module-specific types such as this do not need to be exported. An exception is made here because the fake service module is used to facilitate testing of the broker framework itself.

type ServiceManager added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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) GetEmptyBindingDetails added in v0.12.0 

func (s *ServiceManager) GetEmptyBindingDetails() service.BindingDetails

GetEmptyBindingDetails returns an empty instance of non-sensitive service-specific binding details

func (*ServiceManager) GetEmptyBindingParameters 

func (s *ServiceManager) GetEmptyBindingParameters() service.BindingParameters

GetEmptyBindingParameters returns an empty instance of non-sensitive service-specific binding parameters

func (*ServiceManager) GetEmptyInstanceDetails added in v0.12.0 

func (
	s *ServiceManager,
) GetEmptyInstanceDetails() service.InstanceDetails

GetEmptyInstanceDetails returns an empty instance of non-sensitive service-specific instance details

func (*ServiceManager) GetEmptyProvisioningParameters 

func (
	s *ServiceManager,
) GetEmptyProvisioningParameters() service.ProvisioningParameters

GetEmptyProvisioningParameters returns an empty instance of non-sensitive service-specific provisioningParameters

func (*ServiceManager) GetEmptySecureBindingDetails 

func (
	s *ServiceManager,
) GetEmptySecureBindingDetails() service.SecureBindingDetails

GetEmptySecureBindingDetails returns an empty instance of secure (sensitive) service-specific bindingDetails

func (*ServiceManager) GetEmptySecureBindingParameters 

func (
	s *ServiceManager,
) GetEmptySecureBindingParameters() service.SecureBindingParameters

GetEmptySecureBindingParameters returns an empty instance of sensitive service-specific binding parameters

func (*ServiceManager) GetEmptySecureInstanceDetails 

func (
	s *ServiceManager,
) GetEmptySecureInstanceDetails() service.SecureInstanceDetails

GetEmptySecureInstanceDetails returns an empty instance of sensitive service-specific instance details

func (*ServiceManager) GetEmptySecureProvisioningParameters 

func (
	s *ServiceManager,
) GetEmptySecureProvisioningParameters() service.SecureProvisioningParameters

GetEmptySecureProvisioningParameters returns an empty instance of sensitive service-specific provisioningParameters

func (*ServiceManager) GetProvisioner added in v0.10.0 

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 added in v0.10.0 

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) Unbind added in v0.10.0 

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

Unbind synchronously unbinds from a service

func (*ServiceManager) ValidateBindingParameters added in v0.10.0 

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 added in v0.10.0 

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 added in v0.10.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.