org.springframework.cloud.contract.stubrunner.junit

Class StubRunnerRule

java.lang.Object

org.springframework.cloud.contract.stubrunner.junit.StubRunnerRule

All Implemented Interfaces:

org.junit.rules.TestRule, StubFinder, StubTrigger

public class StubRunnerRule
extends Object
implements org.junit.rules.TestRule, StubFinder

JUnit class rule that allows you to download the provided stubs.

Author:

Marcin Grzejszczak

Constructor Summary

Constructors

Constructor and Description
StubRunnerRule()

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
StubRunnerRule	downloadLatestStub(String groupId, String artifactId, String classifier) Group Id, artifact Id and classifier of a single stub to download in the latest version
StubRunnerRule	downloadStub(String ivyNotation) Ivy notation of a single stub to download.
StubRunnerRule	downloadStub(String groupId, String artifactId) Group Id, artifact Id of a single stub to download.
StubRunnerRule	downloadStub(String groupId, String artifactId, String version) Group Id, artifact Id and version of a single stub to download
StubRunnerRule	downloadStub(String groupId, String artifactId, String version, String classifier) Group Id, artifact Id, version and classifier of a single stub to download
StubRunnerRule	downloadStubs(List<String> ivyNotations) Stubs to download in Ivy notations
StubRunnerRule	downloadStubs(String... ivyNotations) Stubs to download in Ivy notations
RunningStubs	findAllRunningStubs() Returns all running stubs
URL	findStubUrl(String ivyNotation) For the given Ivy notation [groupId]:artifactId:[version]:[classifier] tries to find the matching URL of the running stub.
URL	findStubUrl(String groupId, String artifactId) For the given groupId and artifactId tries to find the matching URL of the running stub.
Map<StubConfiguration,Collection<org.springframework.cloud.contract.spec.Contract>>	getContracts() Returns the list of Contracts
Map<String,Collection<String>>	labels() Returns a mapping of ivy notation of a dependency to all the labels it has.
StubRunnerRule	maxPort(int maxPort) Max value of port for WireMock server
StubRunnerRule	messageVerifier(MessageVerifier messageVerifier) Pass the MessageVerifier that this rule should use.
StubRunnerRule	minPort(int minPort) Min value of port for WireMock server
StubRunnerRule	options(StubRunnerOptions stubRunnerOptions) Override all options
StubRunnerRule	repoRoot(String repoRoot) String URI of repository containing stubs
boolean	trigger() Triggers all possible events.
boolean	trigger(String labelName) Triggers an event by a given label.
boolean	trigger(String ivyNotation, String labelName) Triggers an event by a given label for a given groupid:artifactid notation.
StubRunnerRule	withConsumerName(String consumerName) Allows setting consumer name
StubRunnerRule	withPort(Integer port) Appends port to last added stub
StubRunnerRule	withStubPerConsumer(boolean stubPerConsumer) Allows stub per consumer
StubRunnerRule	workOffline(boolean workOffline) Should download stubs or use only the local repository

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StubRunnerRule

public StubRunnerRule()

Method Detail

apply

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

Specified by:

apply in interface org.junit.rules.TestRule

messageVerifier

public StubRunnerRule messageVerifier(MessageVerifier messageVerifier)

Pass the MessageVerifier that this rule should use. If you don't pass anything a ExceptionThrowingMessageVerifier will be used. That means that an exception will be thrown whenever you try to do sth messaging related.

options

public StubRunnerRule options(StubRunnerOptions stubRunnerOptions)

Override all options

See Also:

StubRunnerOptions

minPort

public StubRunnerRule minPort(int minPort)

Min value of port for WireMock server

maxPort

public StubRunnerRule maxPort(int maxPort)

Max value of port for WireMock server

repoRoot

public StubRunnerRule repoRoot(String repoRoot)

String URI of repository containing stubs

workOffline

public StubRunnerRule workOffline(boolean workOffline)

Should download stubs or use only the local repository

downloadStub

public StubRunnerRule downloadStub(String groupId,
                                   String artifactId,
                                   String version,
                                   String classifier)

Group Id, artifact Id, version and classifier of a single stub to download

downloadLatestStub

public StubRunnerRule downloadLatestStub(String groupId,
                                         String artifactId,
                                         String classifier)

Group Id, artifact Id and classifier of a single stub to download in the latest version

downloadStub

public StubRunnerRule downloadStub(String groupId,
                                   String artifactId,
                                   String version)

Group Id, artifact Id and version of a single stub to download

downloadStub

public StubRunnerRule downloadStub(String groupId,
                                   String artifactId)

Group Id, artifact Id of a single stub to download. Default classifier will be picked.

downloadStub

public StubRunnerRule downloadStub(String ivyNotation)

Ivy notation of a single stub to download.

downloadStubs

public StubRunnerRule downloadStubs(String... ivyNotations)

Stubs to download in Ivy notations

downloadStubs

public StubRunnerRule downloadStubs(List<String> ivyNotations)

Stubs to download in Ivy notations

withPort

public StubRunnerRule withPort(Integer port)

Appends port to last added stub

withStubPerConsumer

public StubRunnerRule withStubPerConsumer(boolean stubPerConsumer)

Allows stub per consumer

withConsumerName

public StubRunnerRule withConsumerName(String consumerName)

Allows setting consumer name

findStubUrl

public URL findStubUrl(String groupId,
                       String artifactId)

Description copied from interface: StubFinder

For the given groupId and artifactId tries to find the matching URL of the running stub.

Specified by:

findStubUrl in interface StubFinder

Parameters:

groupId - - might be null. In that case a search only via artifactId takes place

Returns:

URL of a running stub or throws exception if not found

findStubUrl

public URL findStubUrl(String ivyNotation)

Description copied from interface: StubFinder

For the given Ivy notation [groupId]:artifactId:[version]:[classifier] tries to find the matching URL of the running stub. You can also pass only artifactId.

Specified by:

findStubUrl in interface StubFinder

Parameters:

ivyNotation - - Ivy representation of the Maven artifact

Returns:

URL of a running stub or throws exception if not found

findAllRunningStubs

public RunningStubs findAllRunningStubs()

Description copied from interface: StubFinder

Returns all running stubs

Specified by:

findAllRunningStubs in interface StubFinder

getContracts

public Map<StubConfiguration,Collection<org.springframework.cloud.contract.spec.Contract>> getContracts()

Description copied from interface: StubFinder

Returns the list of Contracts

Specified by:

getContracts in interface StubFinder

trigger

public boolean trigger(String ivyNotation,
                       String labelName)

Description copied from interface: StubTrigger

Triggers an event by a given label for a given groupid:artifactid notation. You can use only artifactId too. Feature related to messaging.

Specified by:

trigger in interface StubTrigger

Returns:

true - if managed to run a trigger

trigger

public boolean trigger(String labelName)

Description copied from interface: StubTrigger

Triggers an event by a given label. Feature related to messaging.

Specified by:

trigger in interface StubTrigger

Returns:

true - if managed to run a trigger

trigger

public boolean trigger()

Description copied from interface: StubTrigger

Triggers all possible events. Feature related to messaging.

Specified by:

trigger in interface StubTrigger

Returns:

true - if managed to run a trigger

labels

public Map<String,Collection<String>> labels()

Description copied from interface: StubTrigger

Returns a mapping of ivy notation of a dependency to all the labels it has. Feature related to messaging.

Specified by:

labels in interface StubTrigger