com.github.junit5docker

Annotation Type Docker

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @ExtendWith(value=com.github.junit5docker.DockerExtension.class)
public @interface Docker

This annotation is the junit-docker entry point.

Adding this annotation to a test's class will start a docker container before running the tests and will be stop at the end of the tests. This is done once per class.

Since:

1.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	image
Port[]	ports

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Environment[]	environments
boolean	newForEachCase
WaitFor	waitFor

Element Detail

image

public abstract String image

Returns:

the image's name to start.

ports

public abstract Port[] ports

Returns:

the port mapping to send to docker. This is required since at least one port must be visible for the container to be useful.

See Also:

Port

environments

public abstract Environment[] environments

Returns:

the optional environment variables to pass to the docker container.

See Also:

Environment

Default:

{}

waitFor

public abstract WaitFor waitFor

Returns:

the optional log to wait for before running the tests.

See Also:

WaitFor

Default:

@com.github.junit5docker.WaitFor("")

newForEachCase

public abstract boolean newForEachCase

Returns:

true if the container should be recreated for each test case. False if it should be created only once for the test class.

Default:

true