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

Direct Known Subclasses:

StubRunnerRule.PortStubRunnerRule

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StubRunnerRule.PortStubRunnerRule Helper class with additional port, related methods once you pick a stub to download.

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.PortStubRunnerRule	downloadLatestStub(String groupId, String artifactId, String classifier)
StubRunnerRule.PortStubRunnerRule	downloadStub(String ivyNotation)
StubRunnerRule.PortStubRunnerRule	downloadStub(String groupId, String artifactId)
StubRunnerRule.PortStubRunnerRule	downloadStub(String groupId, String artifactId, String version)
StubRunnerRule.PortStubRunnerRule	downloadStub(String groupId, String artifactId, String version, String classifier)
StubRunnerRule	downloadStubs(List<String> ivyNotations)
StubRunnerRule	downloadStubs(String... ivyNotations)
StubRunnerRule	failOnNoStubs(boolean failOnNoStubs)
RunningStubs	findAllRunningStubs()
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()
Map<String,Collection<String>>	labels() Feature related to messaging.
StubRunnerRule	maxPort(int maxPort)
StubRunnerRule	messageVerifier(MessageVerifier messageVerifier) Pass the MessageVerifier that this rule should use.
StubRunnerRule	minPort(int minPort)
StubRunnerRule	options(StubRunnerOptions stubRunnerOptions) Override all options.
StubRunnerRule	repoRoot(String repoRoot)
StubRunnerRule	stubsMode(StubRunnerProperties.StubsMode stubsMode)
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)
StubRunnerRule	withDeleteStubsAfterTest(boolean deleteStubsAfterTest)
StubRunnerRule	withGenerateStubs(boolean generateStubs)
StubRunnerRule	withHttpServerStubConfigurer(Class<? extends HttpServerStubConfigurer> httpServerStubConfigurer)
StubRunnerRule	withMappingsOutputFolder(String mappingsOutputFolder)
StubRunnerRule	withProperties(Map<String,String> properties)
StubRunnerRule	withStubPerConsumer(boolean stubPerConsumer)

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.

Parameters:

messageVerifier - message verifier implementation

Returns:

the rule

options

public StubRunnerRule options(StubRunnerOptions stubRunnerOptions)

Override all options.

Parameters:

stubRunnerOptions - options of Stub Runner

Returns:

the rule

See Also:

StubRunnerOptions

minPort

public StubRunnerRule minPort(int minPort)

Parameters:

minPort - min value of port for WireMock server

Returns:

the rule

maxPort

public StubRunnerRule maxPort(int maxPort)

Parameters:

maxPort - max value of port for WireMock server

Returns:

the rule

repoRoot

public StubRunnerRule repoRoot(String repoRoot)

Parameters:

repoRoot - String URI of repository containing stubs

Returns:

the rule

stubsMode

public StubRunnerRule stubsMode(StubRunnerProperties.StubsMode stubsMode)

Parameters:

stubsMode - Stubs mode that should be used

Returns:

the rule

downloadStub

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

Parameters:

groupId - group id of the stub

artifactId - artifact id of the stub

version - version of the stub

classifier - classifier of the stub

Returns:

the rule with port

downloadLatestStub

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

Parameters:

groupId - group id of the stub

artifactId - artifact id of the stub

classifier - classifier of the stub

Returns:

the rule with port

downloadStub

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

Parameters:

groupId - group id of the stub

artifactId - artifact id of the stub

version - version of the stub

Returns:

the rule with port

downloadStub

public StubRunnerRule.PortStubRunnerRule downloadStub(String groupId,
                                                      String artifactId)

Parameters:

groupId - group id of the stub

artifactId - artifact id of the stub

Returns:

the rule with port

downloadStub

public StubRunnerRule.PortStubRunnerRule downloadStub(String ivyNotation)

Parameters:

ivyNotation - Ivy notation of a single stub to download.

Returns:

the rule with port

downloadStubs

public StubRunnerRule downloadStubs(String... ivyNotations)

Parameters:

ivyNotations - Stubs to download in Ivy notations.

Returns:

the rule

downloadStubs

public StubRunnerRule downloadStubs(List<String> ivyNotations)

Parameters:

ivyNotations - Stubs to download in Ivy notations.

Returns:

the rule

withStubPerConsumer

public StubRunnerRule withStubPerConsumer(boolean stubPerConsumer)

Parameters:

stubPerConsumer - Allows stub per consumer.

Returns:

the rule

withConsumerName

public StubRunnerRule withConsumerName(String consumerName)

Parameters:

consumerName - given consumer name

Returns:

the rule

withMappingsOutputFolder

public StubRunnerRule withMappingsOutputFolder(String mappingsOutputFolder)

Parameters:

mappingsOutputFolder - Allows setting the output folder for mappings

Returns:

the rule

withDeleteStubsAfterTest

public StubRunnerRule withDeleteStubsAfterTest(boolean deleteStubsAfterTest)

Parameters:

deleteStubsAfterTest - If set to false will NOT delete stubs from a temporary folder after running tests

Returns:

the rule

withGenerateStubs

public StubRunnerRule withGenerateStubs(boolean generateStubs)

Parameters:

generateStubs - If set to true will NOT load generated stubs but will generate stubs from contract definitions at runtime.

Returns:

the rule

failOnNoStubs

public StubRunnerRule failOnNoStubs(boolean failOnNoStubs)

Parameters:

failOnNoStubs - when enabled, this flag will tell stub runner to throw an exception when no stubs / contracts were found.

Returns:

the rule

withProperties

public StubRunnerRule withProperties(Map<String,String> properties)

Parameters:

properties - Map of properties that can be passed to custom StubDownloaderBuilder

Returns:

the rule

withHttpServerStubConfigurer

public StubRunnerRule withHttpServerStubConfigurer(Class<? extends HttpServerStubConfigurer> httpServerStubConfigurer)

Parameters:

httpServerStubConfigurer - Configuration for an HTTP server stub

Returns:

the rule

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

artifactId - - artifact id of the stub

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()

Specified by:

findAllRunningStubs in interface StubFinder

Returns:

all running stubs

getContracts

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

Specified by:

getContracts in interface StubFinder

Returns:

the list of Contracts

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

Parameters:

ivyNotation - ivy notation of a stub

labelName - name of the label to trigger

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

Parameters:

labelName - name of the label to trigger

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

Feature related to messaging.

Specified by:

labels in interface StubTrigger

Returns:

a mapping of ivy notation of a dependency to all the labels it has.