org.springframework.cloud.contract.stubrunner.junit

Class StubRunnerExtension

java.lang.Object

org.springframework.cloud.contract.stubrunner.junit.StubRunnerExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension, StubFinder, StubTrigger

Direct Known Subclasses:

StubRunnerExtension.PortStubRunnerExtension

public class StubRunnerExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback, StubFinder

JUnit 5 extension that allows to download and run stubs.

Since:

2.1.0

Author:

Olga Maciaszek-Sharma

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
StubRunnerExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
StubRunnerExtension.PortStubRunnerExtension	downloadLatestStub(String groupId, String artifactId, String classifier)
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String ivyNotation)
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId)
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId, String version)
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId, String version, String classifier)
StubRunnerExtension	downloadStubs(List<String> ivyNotations)
StubRunnerExtension	downloadStubs(String... ivyNotations)
StubRunnerExtension	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.
StubRunnerExtension	maxPort(int maxPort)
StubRunnerExtension	messageVerifier(MessageVerifier messageVerifier) Pass the MessageVerifier that this rule should use.
StubRunnerExtension	minPort(int minPort)
StubRunnerExtension	options(StubRunnerOptions stubRunnerOptions) Override all options.
StubRunnerExtension	repoRoot(String repoRoot)
StubRunnerExtension	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.
StubRunnerExtension	withConsumerName(String consumerName)
StubRunnerExtension	withDeleteStubsAfterTest(boolean deleteStubsAfterTest)
StubRunnerExtension	withGenerateStubs(boolean generateStubs)
StubRunnerExtension	withHttpServerStubConfigurer(Class<? extends HttpServerStubConfigurer> httpServerStubConfigurer)
StubRunnerExtension	withMappingsOutputFolder(String mappingsOutputFolder)
StubRunnerExtension	withProperties(Map<String,String> properties)
StubRunnerExtension	withStubPerConsumer(boolean stubPerConsumer)

Methods inherited from class java.lang.Object

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

Constructor Detail

StubRunnerExtension

public StubRunnerExtension()

Method Detail

afterAll

public void afterAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

afterAll in interface org.junit.jupiter.api.extension.AfterAllCallback

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
               throws Exception

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

Throws:

Exception

beforeAll

public void beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Specified by:

beforeAll in interface org.junit.jupiter.api.extension.BeforeAllCallback

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

findStubUrl

public URL findStubUrl(String groupId,
                       String artifactId)
                throws StubNotFoundException

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

Throws:

StubNotFoundException - in case of not finding a stub

findStubUrl

public URL findStubUrl(String ivyNotation)
                throws StubNotFoundException

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

Throws:

StubNotFoundException - in case of not finding a stub

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.

messageVerifier

public StubRunnerExtension 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 stub runner extension

options

public StubRunnerExtension options(StubRunnerOptions stubRunnerOptions)

Override all options.

Parameters:

stubRunnerOptions - options of Stub Runner

Returns:

the stub runner extension

See Also:

StubRunnerOptions

minPort

public StubRunnerExtension minPort(int minPort)

Parameters:

minPort - min value of port for WireMock server

Returns:

the stub runner extension

maxPort

public StubRunnerExtension maxPort(int maxPort)

Parameters:

maxPort - max value of port for WireMock server

Returns:

the stub runner extension

repoRoot

public StubRunnerExtension repoRoot(String repoRoot)

Parameters:

repoRoot - String URI of repository containing stubs

Returns:

the stub runner extension

stubsMode

public StubRunnerExtension stubsMode(StubRunnerProperties.StubsMode stubsMode)

Parameters:

stubsMode - Stubs mode that should be used

Returns:

the stub runner extension

downloadStub

public StubRunnerExtension.PortStubRunnerExtension 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 stub runner extension with ports

downloadLatestStub

public StubRunnerExtension.PortStubRunnerExtension 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 stub runner extension with ports

downloadStub

public StubRunnerExtension.PortStubRunnerExtension 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 stub runner extension with ports

downloadStub

public StubRunnerExtension.PortStubRunnerExtension downloadStub(String groupId,
                                                                String artifactId)

Parameters:

groupId - group id of the stub

artifactId - artifact id of the stub

Returns:

the stub runner extension with ports

downloadStub

public StubRunnerExtension.PortStubRunnerExtension downloadStub(String ivyNotation)

Parameters:

ivyNotation - Ivy notation of a single stub to download.

Returns:

the stub runner extension with ports

downloadStubs

public StubRunnerExtension downloadStubs(String... ivyNotations)

Parameters:

ivyNotations - Stubs to download in Ivy notations.

Returns:

the stub runner extension

downloadStubs

public StubRunnerExtension downloadStubs(List<String> ivyNotations)

Parameters:

ivyNotations - Stubs to download in Ivy notations.

Returns:

the stub runner extension

withStubPerConsumer

public StubRunnerExtension withStubPerConsumer(boolean stubPerConsumer)

Parameters:

stubPerConsumer - Allows stub per consumer.

Returns:

the stub runner extension

withConsumerName

public StubRunnerExtension withConsumerName(String consumerName)

Parameters:

consumerName - given consumer name

Returns:

the stub runner extension

withMappingsOutputFolder

public StubRunnerExtension withMappingsOutputFolder(String mappingsOutputFolder)

Parameters:

mappingsOutputFolder - Allows setting the output folder for mappings

Returns:

the stub runner extension

withDeleteStubsAfterTest

public StubRunnerExtension withDeleteStubsAfterTest(boolean deleteStubsAfterTest)

Parameters:

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

Returns:

the stub runner extension

withGenerateStubs

public StubRunnerExtension 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 StubRunnerExtension 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 StubRunnerExtension withProperties(Map<String,String> properties)

Parameters:

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

Returns:

the stub runner extension

withHttpServerStubConfigurer

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

Parameters:

httpServerStubConfigurer - Configuration for an HTTP server stub

Returns:

the stub runner extension