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.BeforeAllCallback, 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, 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	beforeAll(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
StubRunnerExtension.PortStubRunnerExtension	downloadLatestStub(String groupId, String artifactId, String classifier) Group Id, artifact Id and classifier of a single stub to download in the latest version
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String ivyNotation) Ivy notation of a single stub to download.
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId) Group Id, artifact Id of a single stub to download.
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId, String version) Group Id, artifact Id and version of a single stub to download
StubRunnerExtension.PortStubRunnerExtension	downloadStub(String groupId, String artifactId, String version, String classifier) Group Id, artifact Id, version and classifier of a single stub to download
StubRunnerExtension	downloadStubs(List<String> ivyNotations) Stubs to download in Ivy notations
StubRunnerExtension	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<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.
StubRunnerExtension	maxPort(int maxPort) Max value of port for WireMock server
StubRunnerExtension	messageVerifier(MessageVerifier messageVerifier) Pass the MessageVerifier that this rule should use.
StubRunnerExtension	minPort(int minPort) Min value of port for WireMock server
StubRunnerExtension	options(StubRunnerOptions stubRunnerOptions) Override all options
StubRunnerExtension	repoRoot(String repoRoot) String URI of repository containing stubs
StubRunnerExtension	stubsMode(StubRunnerProperties.StubsMode stubsMode) Stubs mode that should be used
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) Allows setting consumer name
StubRunnerExtension	withDeleteStubsAfterTest(boolean deleteStubsAfterTest) If set to false will NOT delete stubs from a temporary folder after running tests
StubRunnerExtension	withMappingsOutputFolder(String mappingsOutputFolder) Allows setting the output folder for mappings
StubRunnerExtension	withProperties(Map<String,String> properties) Map of properties that can be passed to custom StubDownloaderBuilder
StubRunnerExtension	withStubPerConsumer(boolean stubPerConsumer) Allows stub per consumer

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

beforeAll

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

Specified by:

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

afterAll

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

Specified by:

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

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

Returns:

URL of a running stub or throws exception if not found

Throws:

StubNotFoundException

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

findAllRunningStubs

public RunningStubs findAllRunningStubs()

Description copied from interface: StubFinder

Returns all running stubs

Specified by:

findAllRunningStubs in interface StubFinder

getContracts

public Map<StubConfiguration,Collection<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

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.

options

public StubRunnerExtension options(StubRunnerOptions stubRunnerOptions)

Override all options

See Also:

StubRunnerOptions

minPort

public StubRunnerExtension minPort(int minPort)

Min value of port for WireMock server

maxPort

public StubRunnerExtension maxPort(int maxPort)

Max value of port for WireMock server

repoRoot

public StubRunnerExtension repoRoot(String repoRoot)

String URI of repository containing stubs

stubsMode

public StubRunnerExtension stubsMode(StubRunnerProperties.StubsMode stubsMode)

Stubs mode that should be used

downloadStub

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

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

downloadLatestStub

public StubRunnerExtension.PortStubRunnerExtension 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 StubRunnerExtension.PortStubRunnerExtension downloadStub(String groupId,
                                                                String artifactId,
                                                                String version)

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

downloadStub

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

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

downloadStub

public StubRunnerExtension.PortStubRunnerExtension downloadStub(String ivyNotation)

Ivy notation of a single stub to download.

downloadStubs

public StubRunnerExtension downloadStubs(String... ivyNotations)

Stubs to download in Ivy notations

downloadStubs

public StubRunnerExtension downloadStubs(List<String> ivyNotations)

Stubs to download in Ivy notations

withStubPerConsumer

public StubRunnerExtension withStubPerConsumer(boolean stubPerConsumer)

Allows stub per consumer

withConsumerName

public StubRunnerExtension withConsumerName(String consumerName)

Allows setting consumer name

withMappingsOutputFolder

public StubRunnerExtension withMappingsOutputFolder(String mappingsOutputFolder)

Allows setting the output folder for mappings

withDeleteStubsAfterTest

public StubRunnerExtension withDeleteStubsAfterTest(boolean deleteStubsAfterTest)

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

withProperties

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

Map of properties that can be passed to custom StubDownloaderBuilder