com.github.dockerunit.core.annotation

Annotation Type WithSvc

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
 @Repeatable(value=RepeatableWithSvc.class)
public @interface WithSvc

Connects your test to one of svc descriptors that you have defined. It basically tells Dockerunit which services you need in your test.

It can be used at class and method level. If used at class level, the referenced services will be started before JUnit executes your @BeforeClass method.

If used at method level, the referenced services will be started before JUnit executes your @Before method.

It can also be used at class and method level at the same time, if some services will be used by all the tests in your class, while other are specific for one method.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	svc The descriptor class that defines how to instantiate the svc

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	containerNamePrefix A prefix that will be used to give names to the containers instantiated to run your svc.
int	priority Value used to support dependencies between services.
int	replicas

Element Detail

svc

public abstract Class<?> svc

The descriptor class that defines how to instantiate the svc

Returns:

the descriptor type

containerNamePrefix

public abstract String containerNamePrefix

A prefix that will be used to give names to the containers instantiated to run your svc.

If not set, Docker random names will be used. If set and replicas has been set to 1, the actual value will be the container name. If set and replicas has been set to more than 1, containers will be named as value + "1", value + "2", ...

Returns:

the value to set as name prefix for containers instantiated for this svc.

Default:

""

replicas

public abstract int replicas

Returns:

the number of replicas that should be instantiated for this svc

Default:

1

priority

public abstract int priority

Value used to support dependencies between services. The higher the value, the earlier this svc will be instantiated. The lower the value, the later this svc will be instantiated.

Returns:

the priority for this svc

Default:

0