Documentation ¶
Overview ¶
Package builders helps you create struct for your unit test while keeping them expressive.
Index ¶
- func Autolock() func(*swarm.Swarm)
- func Config(builders ...func(config *swarm.Config)) *swarm.Config
- func ConfigCreatedAt(t time.Time) func(*swarm.Config)
- func ConfigData(data []byte) func(*swarm.Config)
- func ConfigID(ID string) func(config *swarm.Config)
- func ConfigLabels(labels map[string]string) func(config *swarm.Config)
- func ConfigName(name string) func(config *swarm.Config)
- func ConfigUpdatedAt(t time.Time) func(*swarm.Config)
- func ConfigVersion(v swarm.Version) func(*swarm.Config)
- func Container(name string, builders ...func(container *types.Container)) *types.Container
- func EngineVersion(version string) func(*swarm.Node)
- func GlobalService() func(*swarm.Service)
- func Hostname(hostname string) func(*swarm.Node)
- func IP(ip string) func(*types.Port)
- func Leader() func(*swarm.ManagerStatus)
- func Manager(managerStatusBuilders ...func(*swarm.ManagerStatus)) func(*swarm.Node)
- func ManagerStatus(managerStatusBuilders ...func(*swarm.ManagerStatus)) *swarm.ManagerStatus
- func NetworkResource(builders ...func(resource *types.NetworkResource)) *types.NetworkResource
- func NetworkResourceDriver(name string) func(networkResource *types.NetworkResource)
- func NetworkResourceID(id string) func(networkResource *types.NetworkResource)
- func NetworkResourceName(name string) func(networkResource *types.NetworkResource)
- func NetworkResourceScope(scope string) func(networkResource *types.NetworkResource)
- func Node(builders ...func(*swarm.Node)) *swarm.Node
- func NodeID(id string) func(*swarm.Node)
- func NodeLabels(labels map[string]string) func(*swarm.Node)
- func NodeName(name string) func(*swarm.Node)
- func PortStatus(portConfigs []swarm.PortConfig) func(*swarm.TaskStatus)
- func ReplicatedService(replicas uint64) func(*swarm.Service)
- func Secret(builders ...func(secret *swarm.Secret)) *swarm.Secret
- func SecretCreatedAt(t time.Time) func(*swarm.Secret)
- func SecretDriver(driver string) func(secret *swarm.Secret)
- func SecretID(ID string) func(secret *swarm.Secret)
- func SecretLabels(labels map[string]string) func(secret *swarm.Secret)
- func SecretName(name string) func(secret *swarm.Secret)
- func SecretUpdatedAt(t time.Time) func(*swarm.Secret)
- func SecretVersion(v swarm.Version) func(*swarm.Secret)
- func Service(builders ...func(*swarm.Service)) *swarm.Service
- func ServiceID(ID string) func(*swarm.Service)
- func ServiceImage(image string) func(*swarm.Service)
- func ServiceLabels(labels map[string]string) func(*swarm.Service)
- func ServiceName(name string) func(*swarm.Service)
- func ServicePort(port swarm.PortConfig) func(*swarm.Service)
- func ServiceStatus(desired, running uint64) func(*swarm.Service)
- func StatusErr(err string) func(*swarm.TaskStatus)
- func Swarm(swarmBuilders ...func(*swarm.Swarm)) *swarm.Swarm
- func TCP(p *types.Port)
- func Task(taskBuilders ...func(*swarm.Task)) *swarm.Task
- func TaskDesiredState(state swarm.TaskState) func(*swarm.Task)
- func TaskID(id string) func(*swarm.Task)
- func TaskImage(image string) func(*swarm.TaskSpec)
- func TaskName(name string) func(*swarm.Task)
- func TaskNodeID(id string) func(*swarm.Task)
- func TaskServiceID(id string) func(*swarm.Task)
- func TaskSlot(slot int) func(*swarm.Task)
- func TaskSpec(specBuilders ...func(*swarm.TaskSpec)) *swarm.TaskSpec
- func TaskState(state swarm.TaskState) func(*swarm.TaskStatus)
- func TaskStatus(statusBuilders ...func(*swarm.TaskStatus)) *swarm.TaskStatus
- func Timestamp(t time.Time) func(*swarm.TaskStatus)
- func UDP(p *types.Port)
- func Volume(builders ...func(volume *volume.Volume)) *volume.Volume
- func VolumeDriver(name string) func(volume *volume.Volume)
- func VolumeLabels(labels map[string]string) func(volume *volume.Volume)
- func VolumeName(name string) func(volume *volume.Volume)
- func WithLabel(key, value string) func(*types.Container)
- func WithName(name string) func(*types.Container)
- func WithPort(privateport, publicport uint16, builders ...func(*types.Port)) func(*types.Container)
- func WithSize(size int64) func(*types.Container)
- func WithStatus(statusBuilders ...func(*swarm.TaskStatus)) func(*swarm.Task)
- func WithTaskSpec(specBuilders ...func(*swarm.TaskSpec)) func(*swarm.Task)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Config ¶
Config creates a config with default values. Any number of config builder functions can be passed to augment it.
func ConfigCreatedAt ¶
ConfigCreatedAt sets the creation time for the config
func ConfigData ¶
ConfigData sets the config payload.
func ConfigLabels ¶
ConfigLabels sets the config's labels
func ConfigName ¶
ConfigName sets the config's name
func ConfigUpdatedAt ¶
ConfigUpdatedAt sets the update time for the config
func ConfigVersion ¶
ConfigVersion sets the version for the config
func Container ¶
Container creates a container with default values. Any number of container function builder can be passed to augment it.
func EngineVersion ¶
EngineVersion sets the node's engine version
func GlobalService ¶
GlobalService sets the service to use "global" mode
func Manager ¶
func Manager(managerStatusBuilders ...func(*swarm.ManagerStatus)) func(*swarm.Node)
Manager set the current node as a manager
func ManagerStatus ¶
func ManagerStatus(managerStatusBuilders ...func(*swarm.ManagerStatus)) *swarm.ManagerStatus
ManagerStatus create a ManageStatus with default values.
func NetworkResource ¶
func NetworkResource(builders ...func(resource *types.NetworkResource)) *types.NetworkResource
NetworkResource creates a network resource with default values. Any number of networkResource function builder can be pass to modify the existing value. feel free to add another builder func if you need to override another value
func NetworkResourceDriver ¶
func NetworkResourceDriver(name string) func(networkResource *types.NetworkResource)
NetworkResourceDriver sets the driver of the resource network
func NetworkResourceID ¶
func NetworkResourceID(id string) func(networkResource *types.NetworkResource)
NetworkResourceID sets the ID of the resource network
func NetworkResourceName ¶
func NetworkResourceName(name string) func(networkResource *types.NetworkResource)
NetworkResourceName sets the name of the resource network
func NetworkResourceScope ¶
func NetworkResourceScope(scope string) func(networkResource *types.NetworkResource)
NetworkResourceScope sets the Scope of the resource network
func Node ¶
Node creates a node with default values. Any number of node function builder can be pass to augment it.
n1 := Node() // Returns a default node n2 := Node(NodeID("foo"), NodeHostname("bar"), Leader())
func NodeLabels ¶
NodeLabels sets the node labels
func PortStatus ¶
func PortStatus(portConfigs []swarm.PortConfig) func(*swarm.TaskStatus)
PortStatus sets the tasks port config status FIXME(vdemeester) should be a sub builder 👼
func ReplicatedService ¶
ReplicatedService sets the service to use "replicated" mode with the specified number of replicas
func Secret ¶
Secret creates a secret with default values. Any number of secret builder functions can be passed to augment it.
func SecretCreatedAt ¶
SecretCreatedAt sets the creation time for the secret
func SecretDriver ¶
SecretDriver sets the secret's driver name
func SecretLabels ¶
SecretLabels sets the secret's labels
func SecretName ¶
SecretName sets the secret's name
func SecretUpdatedAt ¶
SecretUpdatedAt sets the update time for the secret
func SecretVersion ¶
SecretVersion sets the version for the secret
func Service ¶
Service creates a service with default values. Any number of service builder functions can be passed to augment it.
func ServiceImage ¶
ServiceImage sets the service's image
func ServiceLabels ¶
ServiceLabels sets the service's labels
func ServiceName ¶
ServiceName sets the service name
func ServicePort ¶
func ServicePort(port swarm.PortConfig) func(*swarm.Service)
ServicePort sets the service's port
func ServiceStatus ¶
ServiceStatus sets the services' ServiceStatus (API v1.41 and above)
func StatusErr ¶
func StatusErr(err string) func(*swarm.TaskStatus)
StatusErr sets the tasks status error
func Swarm ¶
Swarm creates a swarm with default values. Any number of swarm function builder can be pass to augment it.
func Task ¶
Task creates a task with default values . Any number of task function builder can be pass to augment it.
func TaskDesiredState ¶
TaskDesiredState sets the task's desired state
func TaskServiceID ¶
TaskServiceID sets the task service's ID
func TaskSpec ¶
TaskSpec creates a task spec with default values . Any number of taskSpec function builder can be pass to augment it.
func TaskState ¶
func TaskState(state swarm.TaskState) func(*swarm.TaskStatus)
TaskState sets the task's current state
func TaskStatus ¶
func TaskStatus(statusBuilders ...func(*swarm.TaskStatus)) *swarm.TaskStatus
TaskStatus creates a task status with default values . Any number of taskStatus function builder can be pass to augment it.
func Timestamp ¶
func Timestamp(t time.Time) func(*swarm.TaskStatus)
Timestamp sets the task status timestamp
func Volume ¶
Volume creates a volume with default values. Any number of volume function builder can be passed to augment it.
func VolumeDriver ¶
VolumeDriver sets the volume driver
func VolumeLabels ¶
VolumeLabels sets the volume labels
func VolumeName ¶
VolumeName sets the volume labels
func WithStatus ¶
func WithStatus(statusBuilders ...func(*swarm.TaskStatus)) func(*swarm.Task)
WithStatus sets the task status
Types ¶
This section is empty.