com.github.dockerunit.core.annotation

Annotation Type Volume

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Repeatable(value=RepeatableVolume.class)
public @interface Volume

Equivalent of -v in docker run. Allows mapping of host files or directories inside the instantiated containers.

It can be easily leveraged to mount test config during tests execution.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	container
String	host

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Volume.AccessMode	accessMode
boolean	useClasspath If set to true, it tells Dockerunit to treat the host path as a path that is relative to the test classpath.

Element Detail

host

public abstract String host

Returns:

the host path of the volume.

container

public abstract String container

Returns:

the absolute path where the host volume should be mounted inside the container.

useClasspath

public abstract boolean useClasspath

If set to true, it tells Dockerunit to treat the host path as a path that is relative to the test classpath. If the base test path for resources is src/test/resources, then a host value of config/config.json will be translated into an absolute path that points to /path/to/src/test/resources/config/config.json.

If set to false, the value of host will be treated as an absolute path.

Returns:

whether the value of host should be treated as relative to the test classpath.

Default:

false

accessMode

public abstract Volume.AccessMode accessMode

Returns:

the access mode to the volume (read write or read only).

Default:

com.github.dockerunit.core.annotation.Volume.AccessMode.RW