io.specto.hoverfly.junit.core

Class Hoverfly

java.lang.Object

io.specto.hoverfly.junit.core.Hoverfly

All Implemented Interfaces:

java.lang.AutoCloseable

public class Hoverfly
extends java.lang.Object
implements java.lang.AutoCloseable

A wrapper class for the Hoverfly binary. Manage the lifecycle of the processes, and then manage Hoverfly itself by using it's API endpoints.

Constructor Summary

Constructors

Constructor and Description
Hoverfly(HoverflyConfig hoverflyConfigBuilder, HoverflyMode hoverflyMode) Instantiates Hoverfly
Hoverfly(HoverflyMode hoverflyMode) Instantiates Hoverfly

Method Summary

Modifier and Type	Method and Description
void	assertThatNoDiffIsReported(boolean shouldResetDiff)
void	close() Stops the running Hoverfly process and clean up resources
void	exportSimulation(java.nio.file.Path path) Exports a simulation and stores it on the filesystem at the given path
HoverflyConfiguration	getHoverflyConfig() Gets the validated HoverflyConfig object used by the current Hoverfly instance
HoverflyInfoView	getHoverflyInfo() Gets configuration information from the running instance of Hoverfly.
HoverflyMode	getMode() Gets the currently activated Hoverfly mode
Simulation	getSimulation() Gets the simulation currently used by the running Hoverfly instance
SslConfigurer	getSslConfigurer()
java.util.Map<java.lang.String,java.lang.String>	getState() Get all state from Hoverfly
void	importSimulation(SimulationSource simulationSource) Deprecated.
boolean	isHealthy()
void	reset() Delete existing simulations and journals
void	resetDiffs() Deletes all diffs from Hoverfly
void	resetJournal() Delete journal logs
void	resetMode(HoverflyMode mode) Reset mode with the initial mode arguments.
void	resetState() Deletes all state from Hoverfly
void	setDestination(java.lang.String destination) Sets a new destination for the running instance of Hoverfly, overwriting the existing destination setting.
void	setMode(HoverflyMode mode) Changes the mode of the running instance of 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)
void	start() Adds Hoverfly SSL certificate to the trust store Sets the proxy system properties to route through Hoverfly Starts Hoverfly
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

Constructor Detail

Hoverfly

public Hoverfly(HoverflyConfig hoverflyConfigBuilder,
                HoverflyMode hoverflyMode)

Instantiates Hoverfly

Parameters:

hoverflyConfigBuilder - the config

hoverflyMode - the mode

Hoverfly

public Hoverfly(HoverflyMode hoverflyMode)

Instantiates Hoverfly

Parameters:

hoverflyMode - the mode

Method Detail

start

public void start()

1. Adds Hoverfly SSL certificate to the trust store
2. Sets the proxy system properties to route through Hoverfly
3. Starts Hoverfly

close

public void close()

Stops the running Hoverfly process and clean up resources

Specified by:

close in interface java.lang.AutoCloseable

importSimulation

@Deprecated
public void importSimulation(SimulationSource simulationSource)

Deprecated.

Imports a simulation into Hoverfly from a SimulationSource

Parameters:

simulationSource - the simulation to import

simulate

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

reset

public void reset()

Delete existing simulations and journals

resetJournal

public void resetJournal()

Delete journal logs

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 state to set

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

Deletes all diffs from Hoverfly

exportSimulation

public void exportSimulation(java.nio.file.Path path)

Exports a simulation and stores it on the filesystem at the given path

Parameters:

path - the path on the filesystem to where the simulation should be stored

getSimulation

public Simulation getSimulation()

Gets the simulation currently used by the running Hoverfly instance

Returns:

the simulation

getHoverflyInfo

public HoverflyInfoView getHoverflyInfo()

Gets configuration information from the running instance of Hoverfly.

Returns:

the hoverfly info object

setDestination

public void setDestination(java.lang.String destination)

Sets a new destination for the running instance of Hoverfly, overwriting the existing destination setting.

Parameters:

destination - the destination setting to override

setMode

public void setMode(HoverflyMode mode)

Changes the mode of the running instance of Hoverfly.

Parameters:

mode - hoverfly mode to change

resetMode

public void resetMode(HoverflyMode mode)

Reset mode with the initial mode arguments.

Parameters:

mode - Hoverfly mode to reset

getHoverflyConfig

public HoverflyConfiguration getHoverflyConfig()

Gets the validated HoverflyConfig object used by the current Hoverfly instance

Returns:

the current Hoverfly configurations

getMode

public HoverflyMode getMode()

Gets the currently activated Hoverfly mode

Returns:

hoverfly mode

isHealthy

public boolean isHealthy()

getSslConfigurer

public SslConfigurer getSslConfigurer()

verify

public void verify(RequestMatcherBuilder requestMatcher,
                   VerificationCriteria criteria)

assertThatNoDiffIsReported

public void assertThatNoDiffIsReported(boolean shouldResetDiff)

verify

public void verify(RequestMatcherBuilder requestMatcher)

verifyZeroRequestTo

public void verifyZeroRequestTo(StubServiceBuilder requestedServiceBuilder)

verifyAll

public void verifyAll()