au.com.dius.pact.consumer

Class PactProviderRule

au.com.dius.pact.consumer.PactProviderRule

public class PactProviderRule

A junit rule that wraps every test annotated with annotationclass PactVerification. Before each test, a mock server will be setup at given port/host that will provide mocked responses for the given provider. After each test, it will be teared down. If no host is given, it will default to localhost. If no port is given, it will default to a random port.

See Also:

annotationclass PactVerification

Constructor Detail

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        java.lang.String host,
                        java.lang.Integer port,
                        au.com.dius.pact.model.PactSpecVersion pactVersion,
                        java.lang.Object target)

Creates a mock provider by the given name

Parameters:

provider - Provider name to mock

host - Host to bind to. Defaults to localhost

port - Port to bind to. Defaults to a random port.

pactVersion - Pact specification version

target - Target test to apply this rule to.

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        java.lang.String host,
                        java.lang.Integer port,
                        boolean https,
                        au.com.dius.pact.model.PactSpecVersion pactVersion,
                        java.lang.Object target)

Creates a mock provider by the given name

Parameters:

provider - Provider name to mock

host - Host to bind to. Defaults to localhost

port - Port to bind to. Defaults to a random port.

https - Boolean flag to control starting HTTPS or HTTP mock server

pactVersion - Pact specification version

target - Target test to apply this rule to.

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        java.lang.String host,
                        java.lang.Integer port,
                        boolean https,
                        java.lang.String keystore,
                        java.lang.String password,
                        au.com.dius.pact.model.PactSpecVersion pactVersion,
                        java.lang.Object target)

Creates a mock provider by the given name

Parameters:

provider - Provider name to mock

host - Host to bind to. Defaults to localhost

port - Port to bind to. Defaults to a random port.

https - Boolean flag to control starting HTTPS or HTTP mock server

keystore - Path to keystore, example: /path/to/keystore.jks

password - Password for the keystore.

pactVersion - Pact specification version

target - Target test to apply this rule to.

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        java.lang.String host,
                        java.lang.Integer port,
                        java.lang.Object target)

Creates a mock provider by the given name

Parameters:

provider - Provider name to mock

host - Host to bind to. Defaults to localhost

port - Port to bind to. Defaults to a random port.

target - Target test to apply this rule to.

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        java.lang.Object target)

Creates a mock provider by the given name. Binds to localhost and a random port.

Parameters:

provider - Provider name to mock

target - Target test to apply this rule to.

PactProviderRule

public PactProviderRule(java.lang.String provider,
                        au.com.dius.pact.model.PactSpecVersion pactSpecVersion,
                        java.lang.Object target)

Creates a mock provider by the given name. Binds to localhost and a random port.

Parameters:

provider - Provider name to mock

target - Target test to apply this rule to.

Method Detail

getConfig

public au.com.dius.pact.model.MockProviderConfig getConfig()

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

getPacts

protected java.util.Map<java.lang.String,au.com.dius.pact.model.PactFragment> getPacts(java.lang.String fragment)

scan all methods for @Pact annotation and execute them, if not already initialized

Parameters:

fragment -