io.specto.hoverfly.junit5

Class HoverflyExtension

java.lang.Object

io.specto.hoverfly.junit5.HoverflyExtension

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, org.junit.jupiter.api.extension.ParameterResolver

public class HoverflyExtension
extends java.lang.Object
implements org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterAllCallback, org.junit.jupiter.api.extension.BeforeAllCallback, org.junit.jupiter.api.extension.ParameterResolver

HoverflyExtension starts Hoverfly proxy server before all test methods are executed and stops it after all. It also reset Hoverfly state between each test and restore global configurations. By default Hoverfly is started in simulate mode and configured with default configuration parameters. The user is responsible of calling Hoverfly.exportSimulation(Path) or Hoverfly.simulate(SimulationSource, SimulationSource...)} It implements ParameterResolver which gives you the flexibility to inject the current Hoverfly instance into JUnit 5 annotated method, and make use of the Hoverfly API directly. HoverflyCore annotation can be used along with HoverflyExtension to set the mode and customize the configurations.

See Also:

for more configuration options {@link HoverflySimulate} annotation can be used to instruct Hoverfly to load simulation from a file located at Hoverfly default path (src/test/resources/hoverfly) and file called with fully qualified name of test class, replacing dots (.) and dollar signs ($) to underlines (_)., for more configuration options {@link HoverflyCapture} annotation can be used to config Hoverfly to capture and export simulation to a file located at Hoverfly default path (src/test/resources/hoverfly) and file called with fully qualified name of test class, replacing dots (.) and dollar signs ($) to underlines (_)., for more configuration options {@link HoverflyDiff} annotation can be used along with HoverflyExtension to set the mode to diff and customize the configurations., for more configuration options*

Constructor Summary

Constructors

Constructor and Description
HoverflyExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeAll(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
protected java.lang.String	getPath(org.junit.jupiter.api.extension.ExtensionContext context, HoverflySimulate.Source source) Returns the path to the simulation source.
java.lang.Object	resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)
boolean	supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext, org.junit.jupiter.api.extension.ExtensionContext extensionContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

HoverflyExtension

public HoverflyExtension()

Method Detail

beforeEach

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

Specified by:

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

beforeAll

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

Specified by:

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

getPath

protected java.lang.String getPath(org.junit.jupiter.api.extension.ExtensionContext context,
                                   HoverflySimulate.Source source)

Returns the path to the simulation source.

Parameters:

context - the current extension context; never null

source - the simulation source annotation; never null

Returns:

the path to the simulation source

afterAll

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

Specified by:

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

supportsParameter

public boolean supportsParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                 org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                          throws org.junit.jupiter.api.extension.ParameterResolutionException

Specified by:

supportsParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

resolveParameter

public java.lang.Object resolveParameter(org.junit.jupiter.api.extension.ParameterContext parameterContext,
                                         org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                                  throws org.junit.jupiter.api.extension.ParameterResolutionException

Specified by:

resolveParameter in interface org.junit.jupiter.api.extension.ParameterResolver

Throws:

org.junit.jupiter.api.extension.ParameterResolutionException

afterEach

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

Specified by:

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