com.github.platan.varnishexec.spring

Annotation Type VarnishTest

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface VarnishTest

Test class annotation that is used to start varnish for tests.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
VarnishTest.HostAndPort	address Set a port to 0 to trigger listening on a random port.
VarnishTest.HostAndPort	backend Set a port to 0 to use a local application port (local.server.port) as a backend port.
java.lang.String	configFile Path to a VCL configuration file.
VarnishTest.HostAndPort	managementAddress
java.lang.String	name
boolean	randomName Use a random name as a varnish instance.
java.lang.String	storage
java.lang.String	varnishdCommand

Element Detail

address

public abstract VarnishTest.HostAndPort address

Set a port to 0 to trigger listening on a random port.

You can use @Value("${local.varnish.port}") to inject port value into field in test class.

Default is localhost:10080.

Default:

@com.github.platan.varnishexec.spring.VarnishTest.HostAndPort(host="localhost", port=10080)

backend

public abstract VarnishTest.HostAndPort backend

Set a port to 0 to use a local application port (local.server.port) as a backend port.

Only one of "backend" or "config file" can be specified.

Default:

@com.github.platan.varnishexec.spring.VarnishTest.HostAndPort(host="", port=-1)

configFile

public abstract java.lang.String configFile

Path to a VCL configuration file. If this file contains @local.port@ string, a copy of VCL configuration file will be made and @local.port@ value will be replaced by an application port (local.server.port) in this copy.

Only one of "backend" or "config file" can be specified.

Default:

""

managementAddress

public abstract VarnishTest.HostAndPort managementAddress

Default:

@com.github.platan.varnishexec.spring.VarnishTest.HostAndPort(host="", port=-1)

storage

public abstract java.lang.String storage

Default:

""

name

public abstract java.lang.String name

Default:

""

randomName

public abstract boolean randomName

Use a random name as a varnish instance. Random name starts with value of the default temp dir (java.io.tmpdir).

Default:

false

varnishdCommand

public abstract java.lang.String varnishdCommand

Default:

""