io.specto.hoverfly.junit.core.config

Class LocalHoverflyConfig

java.lang.Object

io.specto.hoverfly.junit.core.HoverflyConfig

io.specto.hoverfly.junit.core.config.LocalHoverflyConfig

public class LocalHoverflyConfig
extends HoverflyConfig

Config builder interface for settings specific to Hoverfly managed internally

Field Summary

Fields inherited from class io.specto.hoverfly.junit.core.HoverflyConfig

adminPort, captureHeaders, destination, incrementalCapture, proxyCaCert, proxyLocalHost, proxyPort, simulationPreprocessor, statefulCapture, webServer

Constructor Summary

Constructors

Constructor and Description
LocalHoverflyConfig()

Method Summary

Modifier and Type	Method and Description
LocalHoverflyConfig	addCommands(java.lang.String... commands) Set additional commands for starting Hoverfly.
HoverflyConfig	binaryLocation(java.lang.String binaryLocation) Overrides the default path for Hoverfly binary and working directory.
HoverflyConfiguration	build() Validate and build HoverflyConfiguration
LocalHoverflyConfig	clientAuthCaCertPath(java.lang.String clientCaCertPath) Set client CA certificate for mutual TLS authentication
LocalHoverflyConfig	disableTlsVerification() Configure Hoverfly to skip TLS verification.
LocalHoverflyConfig	enableClientAuth(java.lang.String clientCertPath, java.lang.String clientKeyPath, java.lang.String... destinations) Set client certificate and key for mutual TLS authentication with target server
LocalHoverflyConfig	localMiddleware(java.lang.String binary, java.lang.String path) Sets the middleware for Hoverfly
LocalHoverflyConfig	logger(java.lang.String loggerName) Set the name of the logger to use when logging the output of the Hoverfly binary.
LocalHoverflyConfig	logLevel(LogLevel logLevel) Set the log level of Hoverfly.
LocalHoverflyConfig	logToStdOut() Change the Hoverfly binary to output directly to System.out.
LocalHoverflyConfig	overrideDefaultCaCert(java.lang.String certPath, java.lang.String keyPath) Sets the certificate and key files to override the default Hoverfly's CA cert
LocalHoverflyConfig	plainHttpTunneling() Invoke to enable plain http tunneling By default it is false
LocalHoverflyConfig	sslCertificatePath(java.lang.String sslCertificatePath) Deprecated.
LocalHoverflyConfig	sslKeyPath(java.lang.String sslKeyPath) Deprecated.
LocalHoverflyConfig	upstreamProxy(java.net.InetSocketAddress proxyAddress) Set upstream proxy for hoverfly to connect to target host
LocalHoverflyConfig	upstreamProxy(java.lang.String upstreamProxy)

Methods inherited from class io.specto.hoverfly.junit.core.HoverflyConfig

adminPort, asWebServer, captureAllHeaders, captureHeaders, configs, destination, enableIncrementalCapture, enableStatefulCapture, localConfigs, proxyCaCert, proxyLocalHost, proxyLocalHost, proxyPort, remote, remoteConfigs, simulationPreprocessor

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalHoverflyConfig

public LocalHoverflyConfig()

Method Detail

sslCertificatePath

@Deprecated
public LocalHoverflyConfig sslCertificatePath(java.lang.String sslCertificatePath)

Deprecated.

Sets the certificate file to override the default Hoverfly's CA cert The file can be in any PEM encoded certificate, in .crt or .pem extensions

Parameters:

sslCertificatePath - certificate file in classpath

Returns:

the LocalHoverflyConfig for further customizations

sslKeyPath

@Deprecated
public LocalHoverflyConfig sslKeyPath(java.lang.String sslKeyPath)

Deprecated.

Sets the key file for Hoverfly's CA cert The file can be in any PEM encoded key, in .key or .pem extensions

Parameters:

sslKeyPath - key file in classpath

Returns:

the LocalHoverflyConfig for further customizations

overrideDefaultCaCert

public LocalHoverflyConfig overrideDefaultCaCert(java.lang.String certPath,
                                                 java.lang.String keyPath)

Sets the certificate and key files to override the default Hoverfly's CA cert

Parameters:

certPath - certificate file in classpath. Must be a PEM encoded certificate, with .crt or .pem extensions

keyPath - key file in classpath. Must be any PEM encoded key, with .key or .pem extensions

Returns:

the LocalHoverflyConfig for further customizations

localMiddleware

public LocalHoverflyConfig localMiddleware(java.lang.String binary,
                                           java.lang.String path)

Sets the middleware for Hoverfly

Parameters:

binary - absolute or relative path of binary

path - middleware script file in classpath

Returns:

the LocalHoverflyConfig for further customizations

disableTlsVerification

public LocalHoverflyConfig disableTlsVerification()

Configure Hoverfly to skip TLS verification. This option allows Hoverfly to perform “insecure” SSL connections to target server that uses invalid certificate (eg. self-signed certificate)

Returns:

the LocalHoverflyConfig for further customizations

plainHttpTunneling

public LocalHoverflyConfig plainHttpTunneling()

Invoke to enable plain http tunneling By default it is false

Returns:

a config

upstreamProxy

public LocalHoverflyConfig upstreamProxy(java.net.InetSocketAddress proxyAddress)

Set upstream proxy for hoverfly to connect to target host

Parameters:

proxyAddress - socket address of the upstream proxy, eg. 127.0.0.1:8500

Returns:

the LocalHoverflyConfig for further customizations

upstreamProxy

public LocalHoverflyConfig upstreamProxy(java.lang.String upstreamProxy)

logger

public LocalHoverflyConfig logger(java.lang.String loggerName)

Set the name of the logger to use when logging the output of the Hoverfly binary.

Parameters:

loggerName - Name of the logger to use when logging the output of the Hoverfly binary.

Returns:

the LocalHoverflyConfig for further customizations

logToStdOut

public LocalHoverflyConfig logToStdOut()

Change the Hoverfly binary to output directly to System.out.

Returns:

the LocalHoverflyConfig for further customizations

logLevel

public LocalHoverflyConfig logLevel(LogLevel logLevel)

Set the log level of Hoverfly. The default level is INFO.

Parameters:

logLevel - LogLevel to set

Returns:

the LocalHoverflyConfig for further customizations

addCommands

public LocalHoverflyConfig addCommands(java.lang.String... commands)

Set additional commands for starting Hoverfly.

Parameters:

commands - More Hoverfly command flags.

Returns:

the LocalHoverflyConfig for further customizations

binaryLocation

public HoverflyConfig binaryLocation(java.lang.String binaryLocation)

Overrides the default path for Hoverfly binary and working directory.

Parameters:

binaryLocation - absolute path for the Hoverfly working directory

Returns:

the LocalHoverflyConfig for further customizations

enableClientAuth

public LocalHoverflyConfig enableClientAuth(java.lang.String clientCertPath,
                                            java.lang.String clientKeyPath,
                                            java.lang.String... destinations)

Set client certificate and key for mutual TLS authentication with target server

Parameters:

clientCertPath - certificate file in classpath. Must be a PEM encoded certificate, with .crt or .pem extensions

clientKeyPath - key file in classpath. Must be unencrypted and PEM encoded key, with .key or .pem extensions

destinations - the destination filter to what target urls to enable mutual TLS authentication. Enable for all remote hosts if not provided.

Returns:

the LocalHoverflyConfig for further customizations

clientAuthCaCertPath

public LocalHoverflyConfig clientAuthCaCertPath(java.lang.String clientCaCertPath)

Set client CA certificate for mutual TLS authentication

Parameters:

clientCaCertPath - CA certificate file in classpath. Must be any PEM encoded certificate, with .crt or .pem extensions

Returns:

the LocalHoverflyConfig for further customizations

build

public HoverflyConfiguration build()

Description copied from class: HoverflyConfig

Validate and build HoverflyConfiguration

Specified by:

build in class HoverflyConfig

Returns:

a validated hoverfly configuration object