SystemPropertiesConfiguration (serenity-core 1.1.29-rc.3 API)

java.lang.Object
- net.thucydides.core.webdriver.SystemPropertiesConfiguration

All Implemented Interfaces:

Configuration
```
public class SystemPropertiesConfiguration
extends java.lang.Object
implements Configuration
```
Centralized configuration of the test runner. You can configure the output directory, the browser to use, and the reports to generate. Most configuration elements can be set using system properties.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_ELEMENT_TIMEOUT_SECONDS` Default timeout when waiting for AJAX elements in pages, in milliseconds.
`static java.lang.Integer`	`DEFAULT_ESTIMATED_AVERAGE_STEP_COUNT`
`static java.lang.String`	`DEFAULT_WEBDRIVER_DRIVER` The default browser is Firefox.
`static java.lang.String`	`JUNIT_RETRY_TESTS`
`static java.lang.String`	`MAX_RETRIES`
`static java.lang.String`	`OUTPUT_DIRECTORY_PROPERTY` Use this property to define the output directory in which reports will be stored.
`static java.lang.String`	`PROJECT_BUILD_DIRECTORY` If in system properties will be defined project.build.directory or project.reporting.OutputDirectory then it will be used for output for serenity test reports.
`static java.lang.String`	`REFUSE_UNTRUSTED_CERTIFICATES` By default, when accepting untrusted SSL certificates, assume that these certificates will come from an untrusted issuer or will be self signed.

Constructor Summary

Constructors
Constructor and Description

SystemPropertiesConfiguration(EnvironmentVariables environmentVariables)

Constructors
Constructor and Description
`SystemPropertiesConfiguration(EnvironmentVariables environmentVariables)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`copy()`
`java.lang.String`	`getBaseUrl()` This is the URL where test cases start.
`int`	`getCurrentTestCount()` This is the URL where test cases start.
`SupportedWebDriver`	`getDriverType()` Get the currently-configured browser type.
`int`	`getElementTimeout()`
`EnvironmentVariables`	`getEnvironmentVariables()`
`double`	`getEstimatedAverageStepCount()`
`java.io.File`	`getOutputDirectory()` The output directory is where the test runner writes the XML and HTML reports to.
`int`	`getRestartFrequency()`
`com.google.common.base.Optional<TakeScreenshots>`	`getScreenshotLevel()` How often should screenshots be taken.
`int`	`getStepDelay()`
`boolean`	`getUseUniqueBrowser()` Use shouldUseAUniqueBrowser() instead
`java.io.File`	`loadOutputDirectoryFromSystemProperties()` Where should the reports go?
`int`	`maxRetries()`
`boolean`	`onlySaveFailingScreenshots()`
`void`	`reloadOutputDirectory()` If some property that can change output directory was changed this method should be called
`void`	`setDefaultBaseUrl(java.lang.String defaultBaseUrl)` Override the default base URL manually.
`void`	`setIfUndefined(java.lang.String property, java.lang.String value)`
`void`	`setOutputDirectory(java.io.File outputDirectory)`
`boolean`	`shouldUseAUniqueBrowser()`
`boolean`	`storeHtmlSourceCode()`
`boolean`	`takeVerboseScreenshots()` Take a screenshot for each action.
`Configuration`	`withEnvironmentVariables(EnvironmentVariables environmentVariables)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_WEBDRIVER_DRIVER
```
public static final java.lang.String DEFAULT_WEBDRIVER_DRIVER
```
    The default browser is Firefox.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ELEMENT_TIMEOUT_SECONDS
```
public static final int DEFAULT_ELEMENT_TIMEOUT_SECONDS
```
    Default timeout when waiting for AJAX elements in pages, in milliseconds.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ESTIMATED_AVERAGE_STEP_COUNT
```
public static final java.lang.Integer DEFAULT_ESTIMATED_AVERAGE_STEP_COUNT
```
  - OUTPUT_DIRECTORY_PROPERTY
```
public static final java.lang.String OUTPUT_DIRECTORY_PROPERTY
```
    Use this property to define the output directory in which reports will be stored.
  - PROJECT_BUILD_DIRECTORY
```
public static final java.lang.String PROJECT_BUILD_DIRECTORY
```
    If in system properties will be defined project.build.directory or project.reporting.OutputDirectory then it will be used for output for serenity test reports. By default maven NEVER push this properties to system environment, but they are available in maven pm. This property is used when maven/gradle build conta subprojects by serenity plugins
    
    See Also:
    
    Constant Field Values
  - REFUSE_UNTRUSTED_CERTIFICATES
```
public static final java.lang.String REFUSE_UNTRUSTED_CERTIFICATES
```
    By default, when accepting untrusted SSL certificates, assume that these certificates will come from an untrusted issuer or will be self signed. Due to limitation within Firefox, it is easy to find out if the certificate has expired or does not match the host it was served for, but hard to find out if the issuer of the certificate is untrusted. By default, it is assumed that the certificates were not be issued from a trusted CA. If you are receive an "untrusted site" prompt on Firefox when using a certificate that was issued by valid issuer, but has expired or is being served served for a different host (e.g. production certificate served in a testing environment) set this to false.
  - MAX_RETRIES
```
public static final java.lang.String MAX_RETRIES
```
    See Also:
    
    Constant Field Values
  - JUNIT_RETRY_TESTS
```
public static final java.lang.String JUNIT_RETRY_TESTS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SystemPropertiesConfiguration
```
@Inject
public SystemPropertiesConfiguration(EnvironmentVariables environmentVariables)
```
- Method Detail
  - copy
```
public Configuration copy()
```
    Specified by:
    
    copy in interface Configuration
  - withEnvironmentVariables
```
public Configuration withEnvironmentVariables(EnvironmentVariables environmentVariables)
```
    Specified by:
    
    withEnvironmentVariables in interface Configuration
  - getEnvironmentVariables
```
public EnvironmentVariables getEnvironmentVariables()
```
    Specified by:
    
    getEnvironmentVariables in interface Configuration
  - maxRetries
```
public int maxRetries()
```
    Specified by:
    
    maxRetries in interface Configuration
  - getDriverType
```
public SupportedWebDriver getDriverType()
```
    Get the currently-configured browser type.
    
    Specified by:
    
    getDriverType in interface Configuration
  - loadOutputDirectoryFromSystemProperties
```
public java.io.File loadOutputDirectoryFromSystemProperties()
```
    Where should the reports go?
  - reloadOutputDirectory
```
public void reloadOutputDirectory()
```
    If some property that can change output directory was changed this method should be called
  - getStepDelay
```
public int getStepDelay()
```
    Specified by:
    
    getStepDelay in interface Configuration
  - getElementTimeout
```
public int getElementTimeout()
```
    Specified by:
    
    getElementTimeout in interface Configuration
  - getUseUniqueBrowser
```
public boolean getUseUniqueBrowser()
```
    Description copied from interface: Configuration
    
    Use shouldUseAUniqueBrowser() instead
    
    Specified by:
    
    getUseUniqueBrowser in interface Configuration
  - shouldUseAUniqueBrowser
```
public boolean shouldUseAUniqueBrowser()
```
    Specified by:
    
    shouldUseAUniqueBrowser in interface Configuration
  - setOutputDirectory
```
public void setOutputDirectory(java.io.File outputDirectory)
```
    Specified by:
    
    setOutputDirectory in interface Configuration
  - getOutputDirectory
```
public java.io.File getOutputDirectory()
```
    The output directory is where the test runner writes the XML and HTML reports to. By default, it will be in 'target/site/serenity', but you can override this value either programmatically or by providing a value in the thucydides.output.dir system property.
    
    Specified by:
    
    getOutputDirectory in interface Configuration
  - getEstimatedAverageStepCount
```
public double getEstimatedAverageStepCount()
```
    Specified by:
    
    getEstimatedAverageStepCount in interface Configuration
  - onlySaveFailingScreenshots
```
public boolean onlySaveFailingScreenshots()
```
    Specified by:
    
    onlySaveFailingScreenshots in interface Configuration
  - takeVerboseScreenshots
```
public boolean takeVerboseScreenshots()
```
    Description copied from interface: Configuration
    
    Take a screenshot for each action.
    
    Specified by:
    
    takeVerboseScreenshots in interface Configuration
  - getScreenshotLevel
```
public com.google.common.base.Optional<TakeScreenshots> getScreenshotLevel()
```
    Description copied from interface: Configuration
    
    How often should screenshots be taken.
    
    Specified by:
    
    getScreenshotLevel in interface Configuration
  - storeHtmlSourceCode
```
public boolean storeHtmlSourceCode()
```
    Specified by:
    
    storeHtmlSourceCode in interface Configuration
  - setIfUndefined
```
public void setIfUndefined(java.lang.String property,
                           java.lang.String value)
```
    Specified by:
    
    setIfUndefined in interface Configuration
  - setDefaultBaseUrl
```
public void setDefaultBaseUrl(java.lang.String defaultBaseUrl)
```
    Override the default base URL manually. Normally only needed for testing.
    
    Specified by:
    
    setDefaultBaseUrl in interface Configuration
  - getRestartFrequency
```
public int getRestartFrequency()
```
    Specified by:
    
    getRestartFrequency in interface Configuration
  - getCurrentTestCount
```
public int getCurrentTestCount()
```
    Description copied from interface: Configuration
    
    This is the URL where test cases start. The default value can be overriden using the webdriver.baseurl property. It is also the base URL used to build relative paths.
    
    Specified by:
    
    getCurrentTestCount in interface Configuration
  - getBaseUrl
```
public java.lang.String getBaseUrl()
```
    This is the URL where test cases start. The default value can be overriden using the webdriver.baseurl property. It is also the base URL used to build relative paths.
    
    Specified by:
    
    getBaseUrl in interface Configuration

Class SystemPropertiesConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_WEBDRIVER_DRIVER

DEFAULT_ELEMENT_TIMEOUT_SECONDS

DEFAULT_ESTIMATED_AVERAGE_STEP_COUNT

OUTPUT_DIRECTORY_PROPERTY

PROJECT_BUILD_DIRECTORY

REFUSE_UNTRUSTED_CERTIFICATES

MAX_RETRIES

JUNIT_RETRY_TESTS

Constructor Detail

SystemPropertiesConfiguration

Method Detail

copy

withEnvironmentVariables

getEnvironmentVariables

maxRetries

getDriverType

loadOutputDirectoryFromSystemProperties

reloadOutputDirectory

getStepDelay

getElementTimeout

getUseUniqueBrowser

shouldUseAUniqueBrowser

setOutputDirectory

getOutputDirectory

getEstimatedAverageStepCount

onlySaveFailingScreenshots

takeVerboseScreenshots

getScreenshotLevel

storeHtmlSourceCode

setIfUndefined

setDefaultBaseUrl

getRestartFrequency

getCurrentTestCount

getBaseUrl