117 lines
3.5 KiB
Go
117 lines
3.5 KiB
Go
package testcontainers
|
|
|
|
const (
|
|
MountTypeBind MountType = iota
|
|
MountTypeVolume
|
|
MountTypeTmpfs
|
|
MountTypePipe
|
|
)
|
|
|
|
var (
|
|
_ ContainerMountSource = (*GenericBindMountSource)(nil)
|
|
_ ContainerMountSource = (*GenericVolumeMountSource)(nil)
|
|
_ ContainerMountSource = (*GenericTmpfsMountSource)(nil)
|
|
)
|
|
|
|
type (
|
|
// ContainerMounts represents a collection of mounts for a container
|
|
ContainerMounts []ContainerMount
|
|
MountType uint
|
|
)
|
|
|
|
// ContainerMountSource is the base for all mount sources
|
|
type ContainerMountSource interface {
|
|
// Source will be used as Source field in the final mount
|
|
// this might either be a volume name, a host path or might be empty e.g. for Tmpfs
|
|
Source() string
|
|
|
|
// Type determines the final mount type
|
|
// possible options are limited by the Docker API
|
|
Type() MountType
|
|
}
|
|
|
|
// GenericBindMountSource implements ContainerMountSource and represents a bind mount
|
|
// Optionally mount.BindOptions might be added for advanced scenarios
|
|
type GenericBindMountSource struct {
|
|
// HostPath is the path mounted into the container
|
|
// the same host path might be mounted to multiple locations within a single container
|
|
HostPath string
|
|
}
|
|
|
|
func (s GenericBindMountSource) Source() string {
|
|
return s.HostPath
|
|
}
|
|
|
|
func (GenericBindMountSource) Type() MountType {
|
|
return MountTypeBind
|
|
}
|
|
|
|
// GenericVolumeMountSource implements ContainerMountSource and represents a volume mount
|
|
type GenericVolumeMountSource struct {
|
|
// Name refers to the name of the volume to be mounted
|
|
// the same volume might be mounted to multiple locations within a single container
|
|
Name string
|
|
}
|
|
|
|
func (s GenericVolumeMountSource) Source() string {
|
|
return s.Name
|
|
}
|
|
|
|
func (GenericVolumeMountSource) Type() MountType {
|
|
return MountTypeVolume
|
|
}
|
|
|
|
// GenericTmpfsMountSource implements ContainerMountSource and represents a TmpFS mount
|
|
// Optionally mount.TmpfsOptions might be added for advanced scenarios
|
|
type GenericTmpfsMountSource struct {
|
|
}
|
|
|
|
func (s GenericTmpfsMountSource) Source() string {
|
|
return ""
|
|
}
|
|
|
|
func (GenericTmpfsMountSource) Type() MountType {
|
|
return MountTypeTmpfs
|
|
}
|
|
|
|
// ContainerMountTarget represents the target path within a container where the mount will be available
|
|
// Note that mount targets must be unique. It's not supported to mount different sources to the same target.
|
|
type ContainerMountTarget string
|
|
|
|
func (t ContainerMountTarget) Target() string {
|
|
return string(t)
|
|
}
|
|
|
|
// BindMount returns a new ContainerMount with a GenericBindMountSource as source
|
|
// This is a convenience method to cover typical use cases.
|
|
func BindMount(hostPath string, mountTarget ContainerMountTarget) ContainerMount {
|
|
return ContainerMount{
|
|
Source: GenericBindMountSource{HostPath: hostPath},
|
|
Target: mountTarget,
|
|
}
|
|
}
|
|
|
|
// VolumeMount returns a new ContainerMount with a GenericVolumeMountSource as source
|
|
// This is a convenience method to cover typical use cases.
|
|
func VolumeMount(volumeName string, mountTarget ContainerMountTarget) ContainerMount {
|
|
return ContainerMount{
|
|
Source: GenericVolumeMountSource{Name: volumeName},
|
|
Target: mountTarget,
|
|
}
|
|
}
|
|
|
|
// Mounts returns a ContainerMounts to support a more fluent API
|
|
func Mounts(mounts ...ContainerMount) ContainerMounts {
|
|
return mounts
|
|
}
|
|
|
|
// ContainerMount models a mount into a container
|
|
type ContainerMount struct {
|
|
// Source is typically either a GenericBindMountSource or a GenericVolumeMountSource
|
|
Source ContainerMountSource
|
|
// Target is the path where the mount should be mounted within the container
|
|
Target ContainerMountTarget
|
|
// ReadOnly determines if the mount should be read-only
|
|
ReadOnly bool
|
|
}
|