Module com.serenitybdd.serenitymodel

Package net.thucydides.model.environment

Class SystemEnvironmentVariables

java.lang.Object

net.thucydides.model.environment.SystemEnvironmentVariables

All Implemented Interfaces:

EnvironmentVariables

public class SystemEnvironmentVariables
extends Object
implements EnvironmentVariables

Return system environment variable values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemEnvironmentVariables.EnvironmentUpdater

Constructor Summary

Constructors

Constructor	Description
SystemEnvironmentVariables()
SystemEnvironmentVariables(Map<String,String> propertyValues, Map<String,String> systemValues)
SystemEnvironmentVariables(Properties systemProperties, Map<String,String> systemValues)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	asMap()
boolean	aValueIsDefinedFor(Enum<?> property)
boolean	aValueIsDefinedFor(String property)
void	clearProperty(String name)
EnvironmentVariables	copy()
static SystemEnvironmentVariables	createEnvironmentVariables()
static SystemEnvironmentVariables	createEnvironmentVariables(Path configurationFile)
static SystemEnvironmentVariables	createEnvironmentVariables(Path configurationFile, SystemEnvironmentVariables environmentVariables)
static SystemEnvironmentVariables.EnvironmentUpdater	currentEnvironment()
static EnvironmentVariables	currentEnvironmentVariables()	Get the current environment variables, including any values updated for the scope of this test.
com.typesafe.config.Config	getConfig(String prefix)
List<String>	getKeys()
Properties	getProperties()
Properties	getPropertiesWithPrefix(String prefix)
String	getProperty(Enum<?> property)
String	getProperty(Enum<?> property, String defaultValue)
String	getProperty(String name)
String	getProperty(String name, String defaultValue)
Boolean	getPropertyAsBoolean(Enum<?> property, boolean defaultValue)
Boolean	getPropertyAsBoolean(String name, boolean defaultValue)
Integer	getPropertyAsInteger(Enum<?> property, Integer defaultValue)
Integer	getPropertyAsInteger(String property, Integer defaultValue)
String	getValue(Enum<?> property)
String	getValue(Enum<?> property, String defaultValue)
String	getValue(String name)
String	getValue(String name, String defaultValue)
boolean	hasPath(String path)
String	injectSystemPropertiesInto(String value)
Optional<String>	optionalProperty(String name)	Returns an optional system property.
Map<String,String>	properties()
void	reset()
void	setConfig(com.typesafe.config.Config typesafeConfig)
void	setProperties(Map<String,String> properties)
void	setProperty(String name, String value)
Map<String,String>	simpleSystemPropertiesAsMap()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.thucydides.model.util.EnvironmentVariables

activeEnvironments

Constructor Details

SystemEnvironmentVariables

public SystemEnvironmentVariables()

SystemEnvironmentVariables

public SystemEnvironmentVariables(Map<String,String> propertyValues,
 Map<String,String> systemValues)

SystemEnvironmentVariables

public SystemEnvironmentVariables(Properties systemProperties,
 Map<String,String> systemValues)

Method Details

copy

public EnvironmentVariables copy()

Specified by:

copy in interface EnvironmentVariables

currentEnvironment

public static SystemEnvironmentVariables.EnvironmentUpdater currentEnvironment()

currentEnvironmentVariables

public static EnvironmentVariables currentEnvironmentVariables()

Get the current environment variables, including any values updated for the scope of this test. Test-local environment variables can be updated using the TestLocalEnvironmentVariables class.

setConfig

public void setConfig(com.typesafe.config.Config typesafeConfig)

Specified by:

setConfig in interface EnvironmentVariables

getValue

public String getValue(String name)

Specified by:

getValue in interface EnvironmentVariables

getValue

public String getValue(Enum<?> property)

Specified by:

getValue in interface EnvironmentVariables

getValue

public String getValue(String name,
 String defaultValue)

Specified by:

getValue in interface EnvironmentVariables

getValue

public String getValue(Enum<?> property,
 String defaultValue)

Specified by:

getValue in interface EnvironmentVariables

getKeys

public List<String> getKeys()

Specified by:

getKeys in interface EnvironmentVariables

getProperties

public Properties getProperties()

Specified by:

getProperties in interface EnvironmentVariables

getPropertiesWithPrefix

public Properties getPropertiesWithPrefix(String prefix)

Specified by:

getPropertiesWithPrefix in interface EnvironmentVariables

aValueIsDefinedFor

public boolean aValueIsDefinedFor(Enum<?> property)

Specified by:

aValueIsDefinedFor in interface EnvironmentVariables

aValueIsDefinedFor

public boolean aValueIsDefinedFor(String property)

Specified by:

aValueIsDefinedFor in interface EnvironmentVariables

hasPath

public boolean hasPath(String path)

Specified by:

hasPath in interface EnvironmentVariables

injectSystemPropertiesInto

public String injectSystemPropertiesInto(String value)

Specified by:

injectSystemPropertiesInto in interface EnvironmentVariables

getPropertyAsInteger

public Integer getPropertyAsInteger(String property,
 Integer defaultValue)

Specified by:

getPropertyAsInteger in interface EnvironmentVariables

getPropertyAsInteger

public Integer getPropertyAsInteger(Enum<?> property,
 Integer defaultValue)

Specified by:

getPropertyAsInteger in interface EnvironmentVariables

getPropertyAsBoolean

public Boolean getPropertyAsBoolean(String name,
 boolean defaultValue)

Specified by:

getPropertyAsBoolean in interface EnvironmentVariables

getPropertyAsBoolean

public Boolean getPropertyAsBoolean(Enum<?> property,
 boolean defaultValue)

Specified by:

getPropertyAsBoolean in interface EnvironmentVariables

getProperty

public String getProperty(String name)

Specified by:

getProperty in interface EnvironmentVariables

optionalProperty

public Optional<String> optionalProperty(String name)

Description copied from interface: EnvironmentVariables

Returns an optional system property. The property may be defined in the project's serenity.properties or serenity.conf file, or be provided as a a system property. This is designed particularly for user-provided properties, to make it easier to store test confiuration properties in a single file.

Sample usage: ``` EnvironmentVariables environmentVariables;

String environment = environmentVariables.optionalProperty("env").orElse("DEV") ```

Specified by:

optionalProperty in interface EnvironmentVariables

getProperty

public String getProperty(Enum<?> property)

Specified by:

getProperty in interface EnvironmentVariables

getProperty

public String getProperty(String name,
 String defaultValue)

Specified by:

getProperty in interface EnvironmentVariables

getProperty

public String getProperty(Enum<?> property,
 String defaultValue)

Specified by:

getProperty in interface EnvironmentVariables

setProperty

public void setProperty(String name,
 String value)

Specified by:

setProperty in interface EnvironmentVariables

setProperties

public void setProperties(Map<String,String> properties)

Specified by:

setProperties in interface EnvironmentVariables

clearProperty

public void clearProperty(String name)

Specified by:

clearProperty in interface EnvironmentVariables

asMap

public Map<String,String> asMap()

Specified by:

asMap in interface EnvironmentVariables

simpleSystemPropertiesAsMap

public Map<String,String> simpleSystemPropertiesAsMap()

Specified by:

simpleSystemPropertiesAsMap in interface EnvironmentVariables

reset

public void reset()

Specified by:

reset in interface EnvironmentVariables

createEnvironmentVariables

public static SystemEnvironmentVariables createEnvironmentVariables()

createEnvironmentVariables

public static SystemEnvironmentVariables createEnvironmentVariables(Path configurationFile)

createEnvironmentVariables

public static SystemEnvironmentVariables createEnvironmentVariables(Path configurationFile,
 SystemEnvironmentVariables environmentVariables)

getConfig

public com.typesafe.config.Config getConfig(String prefix)

Specified by:

getConfig in interface EnvironmentVariables

properties

public Map<String,String> properties()

Specified by:

properties in interface EnvironmentVariables