io.specto.hoverfly.junit.rule

Class HoverflyRule

java.lang.Object

org.junit.rules.ExternalResource

io.specto.hoverfly.junit.rule.HoverflyRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class HoverflyRule
extends org.junit.rules.ExternalResource

The HoverflyRule auto-spins up a Hoverfly process, and tears it down at the end of your tests. It also configures the JVM proxy to use Hoverfly, so so long as your client respects these proxy settings you shouldn't have to configure it.

Example Usage

 public class SomeTest {
       @ClassRule
      public static HoverflyRule hoverflyRule = HoverflyRule.inSimulationMode(classpath("test-service.json"))

       @Test
      public void test() { //All requests will be proxied through Hoverfly
          // Given
           final RequestEntity<Void> bookFlightRequest = RequestEntity.delete(new URI("http://www.other-anotherService.com/api/bookings/1")).build();

          // When
           final ResponseEntity<Void> bookFlightResponse = restTemplate.exchange(bookFlightRequest, Void.class);

          // Then
          assertThat(bookFlightResponse.getStatusCode()).isEqualTo(HttpStatus.NO_CONTENT);
      }
 }
 

You can provide data from a Hoverfly JSON simulation, or alternatively you can use a DSL - HoverflyDsl

It is also possible to capture data:

     @ClassRule
     public static HoverflyRule hoverflyRule = HoverflyRule.inCaptureMode("recorded-simulation.json");
 

The recorded data will be saved in your src/test/resources/hoverfly directory

It's recommended to always use the ClassRule annotation, so you can share the same instance of Hoverfly through all your tests. This avoids the overhead of starting Hoverfly multiple times, and also helps ensure all your system properties are set before executing any other code. If you want to change the data, you can do so in Before method by calling simulate(io.specto.hoverfly.junit.core.SimulationSource, io.specto.hoverfly.junit.core.SimulationSource...), but this will not be thread safe.

See Also:

SimulationSource, HoverflyDsl

Method Summary

Modifier and Type	Method and Description
protected void	after() Stops the managed instance of Hoverfly
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description) Log warning if HoverflyRule is annotated with Rule
void	assertThatNoDiffIsReported() Asserts that there was no diff between any of the expected responses set by simulations and the actual responses returned from the real service.
void	assertThatNoDiffIsReported(boolean shouldResetDiff) Asserts that there was no diff between any of the expected responses set by simulations and the actual responses returned from the real service.
protected void	before() Starts an instance of Hoverfly
void	capture(java.lang.String outputFilename) Stores what's currently been captured in the currently assigned file, reset simulations and journal logs, then starts capture again ready to store in the new file once complete.
void	capture(java.lang.String outputDir, java.lang.String outputFilename) Stores what's currently been captured in the currently assigned file, reset simulations and journal logs, then starts capture again ready to store in the new file once complete.
java.lang.String	getAuthHeaderName() Deprecated.
java.lang.String	getAuthHeaderValue() Deprecated.
HoverflyMode	getHoverflyMode() Gets started Hoverfly mode
int	getProxyPort() Gets the proxy port this has run on, which could be useful when running Hoverfly on a random port.
SslConfigurer	getSslConfigurer()
java.util.Map<java.lang.String,java.lang.String>	getState() Get all state from Hoverfly
static HoverflyRule	inCaptureMode()
static HoverflyRule	inCaptureMode(HoverflyConfig hoverflyConfig)
static HoverflyRule	inCaptureMode(java.lang.String outputFilename) Instantiates a rule which runs Hoverfly in capture mode
static HoverflyRule	inCaptureMode(java.lang.String outputFilename, HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in capture mode
static HoverflyRule	inCaptureMode(java.lang.String outputDir, java.lang.String outputFilename) Instantiates a rule which runs Hoverfly in capture mode
static HoverflyRule	inCaptureMode(java.lang.String outputDir, java.lang.String outputFilename, HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in capture mode
static HoverflyRule	inCaptureOrSimulationMode(java.lang.String recordFile) Instantiates a rule which runs Hoverfly in capture mode if recorded file is not present, or in simulation mode if record file is present
static HoverflyRule	inCaptureOrSimulationMode(java.lang.String recordFile, HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in capture mode if recorded file is not present, or in simulation mode if record file is present
static HoverflyRule	inDiffMode() Instantiates a rule which runs Hoverfly in diff mode with no data
static HoverflyRule	inDiffMode(HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in diff mode with no data
static HoverflyRule	inDiffMode(SimulationSource simulationSource) Instantiates a rule which runs Hoverfly in diff mode
static HoverflyRule	inDiffMode(SimulationSource simulationSource, HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in diff mode
static HoverflyRule	inSimulationMode() Instantiates a rule which runs Hoverfly in simulate mode with no data
static HoverflyRule	inSimulationMode(HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in simulate mode with no data
static HoverflyRule	inSimulationMode(SimulationSource simulationSource) Instantiates a rule which runs Hoverfly in simulate mode
static HoverflyRule	inSimulationMode(SimulationSource simulationSource, HoverflyConfig hoverflyConfig)
static HoverflyRule	inSpyMode() Instantiates a rule which runs Hoverfly in spy mode with no data
static HoverflyRule	inSpyMode(HoverflyConfig hoverflyConfig) Instantiates a rule which runs Hoverfly in spy mode with no data
static HoverflyRule	inSpyMode(SimulationSource simulationSource) Instantiates a rule which runs Hoverfly in spy mode
static HoverflyRule	inSpyMode(SimulationSource simulationSource, HoverflyConfig hoverflyConfig)
HoverflyRule	printSimulationData() Print the simulation data to console for debugging purpose.
void	resetDiffs()
void	resetJournal()
void	resetState() Deletes all state from Hoverfly
void	setState(java.util.Map<java.lang.String,java.lang.String> state) Deletes all state from Hoverfly and then sets the state.
void	simulate(SimulationSource simulationSource, SimulationSource... sources) Changes the Simulation used by Hoverfly It also reset the journal to ensure verification can be done on the new simulation source.
void	updateState(java.util.Map<java.lang.String,java.lang.String> state) Updates state in Hoverfly.
void	verify(RequestMatcherBuilder requestMatcher)
void	verify(RequestMatcherBuilder requestMatcher, VerificationCriteria criteria)
void	verifyAll()
void	verifyZeroRequestTo(StubServiceBuilder requestedServiceBuilder)

Methods inherited from class java.lang.Object

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

Method Detail

inCaptureOrSimulationMode

public static HoverflyRule inCaptureOrSimulationMode(java.lang.String recordFile)

Instantiates a rule which runs Hoverfly in capture mode if recorded file is not present, or in simulation mode if record file is present

Parameters:

recordFile - the path where captured or simulated traffic is taken. Relative to src/test/resources/hoverfly

Returns:

the rule

inCaptureOrSimulationMode

public static HoverflyRule inCaptureOrSimulationMode(java.lang.String recordFile,
                                                     HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in capture mode if recorded file is not present, or in simulation mode if record file is present

Parameters:

recordFile - the path where captured or simulated traffic is taken. Relative to src/test/resources/hoverfly

hoverflyConfig - the config

Returns:

the rule

inCaptureMode

public static HoverflyRule inCaptureMode()

inCaptureMode

public static HoverflyRule inCaptureMode(HoverflyConfig hoverflyConfig)

inCaptureMode

public static HoverflyRule inCaptureMode(java.lang.String outputFilename)

Instantiates a rule which runs Hoverfly in capture mode

Parameters:

outputFilename - the output simulation file name relative to src/test/resources/hoverfly

Returns:

the rule

inCaptureMode

public static HoverflyRule inCaptureMode(java.lang.String outputFilename,
                                         HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in capture mode

Parameters:

outputFilename - the output simulation file name relative to src/test/resources/hoverfly

hoverflyConfig - the config

Returns:

the rule

inCaptureMode

public static HoverflyRule inCaptureMode(java.lang.String outputDir,
                                         java.lang.String outputFilename)

Instantiates a rule which runs Hoverfly in capture mode

Parameters:

outputDir - the directory path relative to your project root for exporting the simulation file

outputFilename - the output simulation file name

Returns:

the rule

inCaptureMode

public static HoverflyRule inCaptureMode(java.lang.String outputDir,
                                         java.lang.String outputFilename,
                                         HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in capture mode

Parameters:

outputDir - the directory path relative to your project root for exporting the simulation file

outputFilename - the output simulation file name

hoverflyConfig - the config

Returns:

the rule

inSimulationMode

public static HoverflyRule inSimulationMode()

Instantiates a rule which runs Hoverfly in simulate mode with no data

Returns:

the rule

inSimulationMode

public static HoverflyRule inSimulationMode(HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in simulate mode with no data

Parameters:

hoverflyConfig - the config

Returns:

the rule

inSimulationMode

public static HoverflyRule inSimulationMode(SimulationSource simulationSource)

Instantiates a rule which runs Hoverfly in simulate mode

Parameters:

simulationSource - the simulation to import

Returns:

the rule

inSimulationMode

public static HoverflyRule inSimulationMode(SimulationSource simulationSource,
                                            HoverflyConfig hoverflyConfig)

inSpyMode

public static HoverflyRule inSpyMode()

Instantiates a rule which runs Hoverfly in spy mode with no data

Returns:

the rule

inSpyMode

public static HoverflyRule inSpyMode(HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in spy mode with no data

Parameters:

hoverflyConfig - the config

Returns:

the rule

inSpyMode

public static HoverflyRule inSpyMode(SimulationSource simulationSource)

Instantiates a rule which runs Hoverfly in spy mode

Parameters:

simulationSource - the simulation to import

Returns:

the rule

inSpyMode

public static HoverflyRule inSpyMode(SimulationSource simulationSource,
                                     HoverflyConfig hoverflyConfig)

inDiffMode

public static HoverflyRule inDiffMode()

Instantiates a rule which runs Hoverfly in diff mode with no data

Returns:

the rule

inDiffMode

public static HoverflyRule inDiffMode(HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in diff mode with no data

Parameters:

hoverflyConfig - the config

Returns:

the rule

inDiffMode

public static HoverflyRule inDiffMode(SimulationSource simulationSource)

Instantiates a rule which runs Hoverfly in diff mode

Parameters:

simulationSource - the simulation to import the responses will be compared to

Returns:

the rule

inDiffMode

public static HoverflyRule inDiffMode(SimulationSource simulationSource,
                                      HoverflyConfig hoverflyConfig)

Instantiates a rule which runs Hoverfly in diff mode

Parameters:

simulationSource - the simulation to import the responses will be compared to

hoverflyConfig - the config

Returns:

the rule

apply

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

Log warning if HoverflyRule is annotated with Rule

Specified by:

apply in interface org.junit.rules.TestRule

Overrides:

apply in class org.junit.rules.ExternalResource

before

protected void before()

Starts an instance of Hoverfly

Overrides:

before in class org.junit.rules.ExternalResource

after

protected void after()

Stops the managed instance of Hoverfly

Overrides:

after in class org.junit.rules.ExternalResource

getProxyPort

public int getProxyPort()

Gets the proxy port this has run on, which could be useful when running Hoverfly on a random port.

Returns:

the proxy port

getSslConfigurer

public SslConfigurer getSslConfigurer()

getHoverflyMode

public HoverflyMode getHoverflyMode()

Gets started Hoverfly mode

Returns:

the mode.

simulate

public void simulate(SimulationSource simulationSource,
                     SimulationSource... sources)

Changes the Simulation used by Hoverfly It also reset the journal to ensure verification can be done on the new simulation source.

Parameters:

simulationSource - the simulation

capture

public void capture(java.lang.String outputFilename)

Stores what's currently been captured in the currently assigned file, reset simulations and journal logs, then starts capture again ready to store in the new file once complete.

Parameters:

outputFilename - the output simulation file name relative to src/test/resources/hoverfly

capture

public void capture(java.lang.String outputDir,
                    java.lang.String outputFilename)

Stores what's currently been captured in the currently assigned file, reset simulations and journal logs, then starts capture again ready to store in the new file once complete.

Parameters:

outputDir - the directory path relative to your project root for exporting the simulation file

outputFilename - the output simulation file name relative to src/test/resources/hoverfly

getAuthHeaderName

@Deprecated
public java.lang.String getAuthHeaderName()

Deprecated.

Get custom Hoverfly header name used by Http client to authenticate with secured Hoverfly proxy

Returns:

the custom Hoverfly authorization header name

getAuthHeaderValue

@Deprecated
public java.lang.String getAuthHeaderValue()

Deprecated.

Get Bearer token used by Http client to authenticate with secured Hoverfly proxy

Returns:

a custom Hoverfly authorization header value

printSimulationData

public HoverflyRule printSimulationData()

Print the simulation data to console for debugging purpose. This can be set when you are building the HoverflyRule

Returns:

this HoverflyRule

verify

public void verify(RequestMatcherBuilder requestMatcher)

verify

public void verify(RequestMatcherBuilder requestMatcher,
                   VerificationCriteria criteria)

verifyZeroRequestTo

public void verifyZeroRequestTo(StubServiceBuilder requestedServiceBuilder)

verifyAll

public void verifyAll()

resetJournal

public void resetJournal()

resetState

public void resetState()

Deletes all state from Hoverfly

getState

public java.util.Map<java.lang.String,java.lang.String> getState()

Get all state from Hoverfly

Returns:

the state

setState

public void setState(java.util.Map<java.lang.String,java.lang.String> state)

Deletes all state from Hoverfly and then sets the state.

Parameters:

state - the new state

updateState

public void updateState(java.util.Map<java.lang.String,java.lang.String> state)

Updates state in Hoverfly.

Parameters:

state - the state to update with

resetDiffs

public void resetDiffs()

assertThatNoDiffIsReported

public void assertThatNoDiffIsReported()

Asserts that there was no diff between any of the expected responses set by simulations and the actual responses returned from the real service. When the assertion is done then all available diffs are removed from Hoverfly.

assertThatNoDiffIsReported

public void assertThatNoDiffIsReported(boolean shouldResetDiff)

Asserts that there was no diff between any of the expected responses set by simulations and the actual responses returned from the real service. The parameter shouldResetDiff says if all available diffs should be removed when the assertion is done.

Parameters:

shouldResetDiff - if all available diffs should be removed when the assertion is done.