Package net.thucydides.core
Enum ThucydidesSystemProperty
java.lang.Object
java.lang.Enum<ThucydidesSystemProperty>
net.thucydides.core.ThucydidesSystemProperty
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ThucydidesSystemProperty>
,java.lang.constant.Constable
public enum ThucydidesSystemProperty extends java.lang.Enum<ThucydidesSystemProperty>
Properties that can be passed to a web driver test to customize its behaviour.
The properties can be passed as system properties or placed in the 'thucydides.properties' file using a lower-case,
period-separated format. For example, WEBDRIVER_DRIVER is passed as -Dwebdriver.driver=firefox
- Author:
- johnsmart
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCEPT_INSECURE_CERTIFICATES
Set to true to activate the AcceptInsecureCertificates options for Chrome and Firefox.APPIUM_ADDITIONAL_CAPABILITIES
List of capabilities that should be provided in addition to supported by w3c or Appium.APPIUM_DEVICE_NAME
The device name used for Appium testsAPPIUM_DEVICE_NAMES
(Experimental) Specifies a list of devices to be used for parallel testing.APPIUM_HUB
APPIUM_PLATFORMNAME
APPIUM_PROCESS_DESIRED_CAPABILITIES
Set to true to enable processing of desired capabilities, created from the provided 'appium:' properties.APPIUM_UDID
Unique device identifier of the connected physical device used for appium testsBROWSERSTACK_BROWSER
Browserstack uses this property for desktop browsers, like firefox, chrome and IE.BROWSERSTACK_BROWSER_VERSION
BROWSERSTACK_BROWSERNAME
Browserstack uses this one for android and iphone.BROWSERSTACK_BUILD
Specify a name for a logical group of tests on BrowserStackBROWSERSTACK_DEBUG
Generates screenshots at various steps in tests on BrowserStackBROWSERSTACK_DEVICE
BrowserStack mobile device name on which tests should be runBROWSERSTACK_DEVICE_ORIENTATION
Set the screen orientation of BrowserStack mobile deviceBROWSERSTACK_IE_DRIVER
Specify the Internet Explorer webdriver version on BrowserStackBROWSERSTACK_IE_ENABLE_POPUPS
Enable the popup blocker in Internet Explorer on BrowserStackBROWSERSTACK_IE_NO_FLASH
Disable flash on Internet Explorer on BrowserStackBROWSERSTACK_KEY
BROWSERSTACK_LOCAL
For Testing against internal/local servers on BrowserStackBROWSERSTACK_OS
BROWSERSTACK_OS_VERSION
BROWSERSTACK_PROJECT
Specify a name for a logical group of builds on BrowserStackBROWSERSTACK_RESOLUTION
Sets resolution of VM on BrowserStackBROWSERSTACK_SELENIUM_VERSION
BROWSERSTACK_SESSION_NAME
Specify an identifier for the test run on BrowserStackBROWSERSTACK_URL
BrowserStack Hub URL if running the tests on BrowserStack CloudBROWSERSTACK_USER
CHROME_BINARY
Path to the Chrome binary, if it is not on the system path.CHROME_DEFAULT_OPTIONS_W3C
Set this to true to activate the "w3c" experimental option for chrome.CHROME_EXTENSION
Path to a Chrome-driver specific extensions fileCHROME_SWITCHES
Arguments to be passed to the Chrome driver, separated by commas.CONTEXT
Provide a text that distinguishes tests run in a particular environment or context from the same test run in a different environment or context.CUCUMBER_PRETTY_FORMAT_TABLES
CURRENT_TARGET_VERSION
Property used to define the current target version for manual tests defined in Cucumber scenarios with the @manual and @@last-version-tested annotations.DASHBOARD_EXCLUDED_TAG_LIST
If set, this will define the list of tag types to be excluded from the dashboard screensDASHBOARD_TAG_LIST
If set, this will define the list of tag types to appear on the dashboard screensDEEP_STEP_EXECUTION_AFTER_FAILURES
Set this to true if you want Serenity to report nested step structures for subsequent steps after a step failure.DELETE_HISTORY_DIRECTORY
Delete the history directory before a new set of results is recordedDRIVER
A shortcut for 'webdriver.driver'.DRIVER_OPTIONS
Used to specify either chrome options or firefox preferences, depending on which driver is being used.EDGE_OPTIONS
Use this property to pass options to Edge driver using the 'ms:edgeOptions' capability option.ENABLE_MARKDOWN
If set to true (the default), allow markdown formatting in test outcome titles and descriptions.ENVIRONMENT
FEATURE_FILE_ENCODING
What encoding to use for reading Cucumber feature files? Defaults to system default encodingFEATURE_FILE_LANGUAGE
What (human) language are the Cucumber feature files written in? Defaults to "en"FIREFOX_LOG_LEVEL
FIREFOX_OPTIONS
An alternative to gecko.firefox.optionsFIREFOX_PREFERENCE_SEPARATOR
The character to be used to separate firefox preference key-value pairs when using the "firefox.preferences" property.FIREFOX_PREFERENCES
Preferences to be passed to the Firefox driver, separated by semi-colons (commas often appear in the preference values.GECKO_FIREFOX_OPTIONS
Use this property to pass options to Marionette using the 'moz:firefoxOptions' capability option.HEADLESS_MODE
Activate headless mode for chrome or firefoxIE_OPTIONS_ENABLE_NATIVE_EVENTS
IE_OPTIONS_IGNORE_ZOOM_LEVEL
IE_OPTIONS_REQUIRE_WINDOW_FOCUS
IGNORE_EMBEDDED_TABLES
If set to true, don't format embedded tables in JBehave or Gherkin steps.INJECTED_TAGS
If provided, each test in a test run will have these tags added.IO_BLOCKING_COEFFICIENT
JIRA_PASSWORD
If defined, the JIRA password required to connect to JIRA.JIRA_PROJECT
If defined, the JIRA project id will be prepended to issue numbers.JIRA_URL
If the base JIRA URL is defined, Thucydides will build the issue tracker url using the standard JIRA form.JIRA_USERNAME
If defined, the JIRA username required to connect to JIRA.JSON_CHARSET
What charset to use for JSON processing.JSON_PRETTY_PRINTING
Format the JSON test outcomes nicely.LEGACY_WAIT_FOR_TEXT
Wait for an element to be visible and fail if the element is not visible.MANAGE_APPIUM_SERVERS
Should Serenity Manage your appium servers for youMANUAL_RESULT_EXPIRY_LIMIT
How many days before a manually configured test result expires and goes back to pending.MANUAL_TASK_INSTRUMENTATION
Set this property to true if you don't want Serenity to try to instrument tasks for you.MANUAL_TEST_REPORT_RESULT
What test result (success,ignored, or pending) should be shown for manual annotated tests in the reports?MAX_FREQUENT_FAILURES
NARRATIVE_FORMAT
If set to true, Asciidoc formatting will be supported in the narrative texts.OUTPUT_FORMATS
What format should test results be generated in.PHANTOMJS_BINARY_PATH
Path to PhantomJS executablePHANTOMJS_SSL_PROTOCOL
Path to PhantomJS SSL supportPHANTOMJS_WEBDRIVER_PORT
What port to run PhantomJS on (used in conjunction with webdriver.remote.url to register with a Selenium hub, e.g.PROPERTIES
Allows you to override the default serenity.properties location for properties file.RECORD_FAILURES
Record failures to a file specified by property rerun.failures.file or rerun.xml in current directoryREFUSE_UNTRUSTED_CERTIFICATES
Don't accept sites using untrusted certificates.REMOTE_PLATFORM
REPLAY_FAILURES
Replay failures from a file specified by property rerun.failures.file or rerun.xml in current directoryREPORT_ASSETS_DIRECTORY
Where to find images used in the reports (defaults to src/test/resources/assets)REPORT_CHARSET
What charset to use for report generation.REPORT_KEEP_ALIVE_TIME
REPORT_MAX_THREADS
REPORT_ON_TAGS
Display only test results and requirements containing any of the specified tagsREPORT_RAW_TAG_LIST
If set, this will define the list of tag types which will be not formatted with title case in HTML report.REPORT_SCOREBOARD_SIZE
The maximum number of entries to appear on report scoreboards (default 5)REPORT_SUBTITLE
A subtitle to appear in the Serenity HTML reports.REPORT_TAGTYPE_TITLE
The title to appear in the tag type table in the email reportsREPORT_TAGTYPES
What tag types should be listed in the report summaryREPORT_THREADS
Fine-tune the number of threads Serenity uses for report generation.REPORT_TIMEOUT_THREADDUMPS
RERUN_FAILURES_DIRECTORY
Location of the directory where the failure files are recorded.SAFARI_USE_CLEAN_SESSION
Instruct the SafariDriver to delete all existing session data when starting a new session (true by default)SAUCELABS_ACCESS_KEY
SauceLabs access key - if provided, Thucydides can generate links to the SauceLabs reports that don't require a login.SAUCELABS_BROWSER_VERSION
SAUCELABS_BROWSERNAME
SAUCELABS_DATACENTER
SauceLabs datacenter used for interaction with SauceLabs API and adding link to Serenity report Examples: US: us-west-1 Europe: eu-central-1SAUCELABS_IMPLICIT_TIMEOUT
Override the default implicit timeout value for the Saucelabs driver.SAUCELABS_RECORD_SCREENSHOTS
Saucelabs records screenshots as well as videos by default.SAUCELABS_TARGET_PLATFORM
SAUCELABS_TEST_NAME
SAUCELABS_URL
Saucelabs URL, including username and api keySAUCELABS_USER_ID
SauceLabs user id - if provided with the access key, Thucydides can generate links to the SauceLabs reports that don't require a login.SCREENPLAY_PRONOUNS
Words that will be recognised as pronouns by Serenity Screenplay in Cucumber and used to refer to the actor in the spotlight, rather than as an actor name.SECURITY_ENABLE_JAVA
Enable applets in Firefox.SERENITY_ACTIVATE_FIREBUGS
Activate the Firebugs plugin for firefox.SERENITY_ACTIVATE_HIGHLIGHTING
SERENITY_ANNOTATED_REQUIREMENTS_DIR
Use this property if you need to completely override the location of requirements for the Annotated Provider.SERENITY_BATCH_COUNT
A deprecated property that is synonymous with thucydides.batch.sizeSERENITY_BATCH_NUMBER
If batch testing is being used, this is the number of the batch being run on this machine.SERENITY_BATCH_SIZE
If batch testing is being used, this is the size of the batches being executed.SERENITY_BATCH_STRATEGY
Batch strategy to use for parallel batches.SERENITY_BROWSER_FULL_SCREEN
Set the browser o full screen mode before tests are executedSERENITY_BROWSER_HEIGHT
Redimension the browser to enable larger screenshots.SERENITY_BROWSER_MAXIMIZED
Set to true to get WebDriver to maximise the Browser window before the tests are executed.SERENITY_BROWSER_RESIZING
Set to false if you don't want Serenity to resize the browser page at the start of a test (Can be useful for custom Appium drivers)SERENITY_BROWSER_WIDTH
Redimension the browser to enable larger screenshots.SERENITY_COMPRESS_FILENAMES
If set to false, render report names in a readable form as opposed to a hash format.SERENITY_COMPRESS_SCREENSHOTS
If set, Serenity will scale down the screenshots taken during execution to the size of the carousel in the screenshot page.SERENITY_COMPROMISED_ON
Comma-separated list of exception classes that should produce a compromised test in the reports.SERENITY_CONFIGURATION_REPORT
Default name of report with configurations.SERENITY_CONSOLE_BANNER
Write the console banner using ascii-art ("ascii", default value) or in smaller text ("normal")SERENITY_CONSOLE_COLORS
Use ASCII color codes when outputing the console logs.SERENITY_CONSOLE_HEADINGS
Write the console headings using ascii-art ("ascii", default value) or in normal text ("normal")SERENITY_CSV_EXTRA_COLUMNS
Add extra columns to the CSV output, obtained from tag values.SERENITY_DATA_DIR
Where Serenity stores local data.SERENITY_DIFFERENT_BROWSER_FOR_EACH_ACTOR
When multiple actors are used with the Screenplay pattern, a separate browser is configured for each actor.SERENITY_DISABLE_REST_CALLS_AFTER_FAILURES
Normally, REST calls are disabled when a failure occurs.SERENITY_DISPLAY_TEST_NUMBERS
Set to true to write the chronological number of each test as it is executed to the consoleSERENITY_DRIVER_CAPABILITIES
A set of user-defined capabilities to be used to configure the WebDriver driver.SERENITY_DRIVER_PAGE_LOAD_STRATEGY
Possible values are:none, eager or normalSERENITY_DRIVER_UNEXPECTED_ALERT_BEHAVIOUR
Possible values are: accept, dismiss, accept and notify, dismiss and notify, ignoreSERENITY_DRY_RUN
Run through the steps without actually executing them.SERENITY_ENABLE_WEBDRIVER_IN_FIXTURE_METHODS
Enable WebDriver calls in @After methods, even after a step has failed (true by default).SERENITY_ERROR_ON
Comma-separated list of exception classes that should produce an error in the reports.SERENITY_ESTIMATED_AVERAGE_STEP_COUNT
The estimated number of steps in a pending scenario.SERENITY_ESTIMATED_TESTS_PER_REQUIREMENT
The estimated number of tests in a typical story.SERENITY_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPE
Deprecated.SERENITY_EXT_PACKAGES
Extension packages.SERENITY_EXTENSION_PACKAGES
The root package or packages used to look for Serenity extension classes, as a comma-separated list.SERENITY_FAIL_ON
Comma-separated list of exception classes that should produce a failure in the reports.SERENITY_FEATURES_DIRECTORY
Override the directory name for the directory containing feature files.SERENITY_FILE_IO_RETRY_TIMEOUT
Timeout (in seconds) for retrying file I/O.SERENITY_FLOW_REPORTS_DIR
Default name of folder, with reports about test flow and aggregation report generationSERENITY_FORK_COUNT
If batch testing is being used in a multithreaded environment, this is the number of forks that will be created.SERENITY_FORK_NUMBER
If batch testing is being used in a multithreaded environment, this is the executing fork number.SERENITY_FULL_PAGE_SCREENSHOT_STRATEGY
Deprecated.SERENITY_GENERATE_CSV_REPORTS
Generate a CSV report for each test result (true by default)SERENITY_HISTORY
Base directory in which history files are stored.SERENITY_HISTORY_DIRECTORY
Serenity will look in this directory for the previous build results, to use as a basis for the historical flags shown in the test results.SERENITY_HOME
The home directory for Thucydides output and data files - by default, $USER_HOME/.thucydidesSERENITY_INCLUDE_ACTOR_NAME_IN_CONSEQUENCES
If set to true, the name of the actor will appear in "should" statements for Screenplay tests.SERENITY_ISSUE_TRACKER_URL
Base URL for the issue tracking system to be referred to in the reports.SERENITY_JIRA_WORKFLOW
The JIRA workflow is defined in this file.SERENITY_JIRA_WORKFLOW_ACTIVE
If set to true, JIRA Workflow is active.SERENITY_JQUERY_INTEGRATION
Enable JQuery integration.SERENITY_KEEP_UNSCALED_SCREENSHOTS
If set to true, a copy of the original screenshot will be kept when screenshots are scaled for the reports.SERENITY_LINKED_TAGS
A comma-separated list of tag types for which human-readable report names will be generated.SERENITY_LOCATOR_FACTORY
Normally, Serenity uses SmartElementLocatorFactory, an extension of the AjaxElementLocatorFactory when instantiating page objects.SERENITY_LOGGING
Four levels are supported: NONE, QUIET, NORMAL and VERBOSE - NONE: Disable Serenity logging - QUIET: Only report compromised tests, errors and failures.SERENITY_LOWEST_REQUIREMENT_TYPE
Determine what the lowest level requirement (test cases, feature files, story files, should be called.SERENITY_MAINTAIN_SESSION
Keep the Thucydides session data between tests.SERENITY_MAXIMUM_STEP_NESTING_DEPTH
When creating steps that contain references to other steps serenity does a recursion check to prevent cyclic references.SERENITY_NATIVE_EVENTS
Activate native events in Firefox.SERENITY_OUTPUT_DIRECTORY
Where should reports be generated (use the system property 'serenity.outputDirectory').SERENITY_PENDING_ON
Comma-separated list of exception classes that should produce a pending test in the reports.SERENITY_PROJECT_KEY
A unique identifier for the project under test, used to record test statistics.SERENITY_PROJECT_NAME
What name should appear on the reportsSERENITY_PROXY_AUTOCONFIG
SERENITY_PROXY_AUTODETECT
SERENITY_PROXY_FTP
SERENITY_PROXY_HTTP
HTTP Proxy URL configurationSERENITY_PROXY_HTTP_PORT
HTTP Proxy port configuration for Firefox and PhantomJS Use 'thucydides.proxy.http_port'SERENITY_PROXY_NOPROXY
SERENITY_PROXY_PASSWORD
HTTP Proxy password configuration for Firefox and PhantomJSSERENITY_PROXY_SOCKS_PASSWORD
SERENITY_PROXY_SOCKS_PROXY
SERENITY_PROXY_SOCKS_USERNAME
SERENITY_PROXY_SOCKS_VERSION
SERENITY_PROXY_SSL
SSL Proxy port configuration for Firefox and PhantomJS - serenity.proxy.sslProxySERENITY_PROXY_SSL_PORT
SSL Proxy port configuration for Firefox and PhantomJS - serenity.proxy.sslProxyPortSERENITY_PROXY_TYPE
HTTP Proxy type configuration for Firefox and PhantomJSSERENITY_PROXY_USER
HTTP Proxy username configuration for Firefox and PhantomJSSERENITY_PUBLIC_URL
Public URL where the Thucydides reports will be displayed.SERENITY_RELEASE_TYPES
What tag names identify the release types (e.g.SERENITY_REPORT_ENCODING
Encoding for reports outputSERENITY_REPORT_RESOURCES
Indicates a directory from which the resources for the HTML reports should be copied.SERENITY_REPORT_SHOW_HISTORY
SERENITY_REPORT_SHOW_MANUAL_TESTS
Show statistics for manual tests in the test reports.SERENITY_REPORT_SHOW_PROGRESS
SERENITY_REPORT_SHOW_RELEASES
Report on releasesSERENITY_REPORT_SHOW_TAG_MENUS
SERENITY_REPORT_TAG_MENUS
SERENITY_REPORT_URL
Link to the generated Serenity report to embed in the emailable summary report.SERENITY_REPORTS_SHOW_STEP_DETAILS
Should Thucydides display detailed information in the test result tables.SERENITY_REQUIREMENT_EXCLUSIONS
When deriving requirement types from a path, exclude any values from this comma-separated list.SERENITY_REQUIREMENT_TYPES
The hierarchy of requirement types.SERENITY_REQUIREMENTS_DIR
Use this property if you need to completely override the location of requirements for the File System Provider.SERENITY_RESIZED_IMAGE_WIDTH
If set, resize screenshots to this size to save space.SERENITY_RESTART_BROWSER_FOR_EACH
Indicate when a browser should be restarted during a test run.SERENITY_RESTART_BROWSER_FREQUENCY
Restart the browser every so often during data-driven tests.SERENITY_SCREENSHOOTER
Specify the screenshot tool to be used to take screenshots.SERENITY_SCREENSHOT_STRATEGY
Deprecated.SERENITY_SHOW_STORY_DETAILS_IN_TESTS
If set to true, the full description of the parent story or feature is displayed at the top of an individual test report.SERENITY_SKIPPED_ON
Comma-separated list of exception classes that should produce a skipped test in the reports.SERENITY_STEP_DELAY
Pause (in ms) between each test step.SERENITY_STORIES_DIRECTORY
Same as serenity.features.directory but for src/test/storiesSERENITY_SUMMARY_REPORT_FILENAME
What file name should be used for the email summary report (defaults to serenity-summary.html)SERENITY_SUMMARY_REPORT_TITLE
What name should appear on the email summary reportSERENITY_TAG_FAILURES
If set to true, add a tag for test failures, based on the error type and messageSERENITY_TAKE_SCREENSHOTS
Fine-grained control over when screenshots are to be taken.SERENITY_TEST_REQUIREMENTS_BASEDIR
The base directory in which requirements are kept.SERENITY_TEST_ROOT
The root package for the tests in a given project.SERENITY_TEST_STATISTICS_DIR
if specified, should point to a folder that contains one or more Serenity CSV output filesSERENITY_TIMEOUT
Deprecated.Use WEBDRIVER_TIMEOUTS_IMPLICITLYWAIT instead.SERENITY_USE_REQUIREMENTS_DIRECTORIES
By default, Thucydides will read requirements from the directory structure that contains the stories.SERENITY_VERBOSE_STEPS
If set to true, WebElementFacade events and other step actions will be logged to the console.SERENITY_WEBDRIVER_COLLECTION_LOADING_STRATEGY
Should we assume that collections of webdriver elements are already on the page, or if we should wait for them to be available.SERENITY_WEBDRIVER_INTEGRATION
Disable Webdriver integration.SHOW_FULL_TEST_RESULTS
Show the full test results in the emailable reportsSHOW_HISTORY_FLAGS
If set to true, historical flags will be displayed in test lists.SHOW_PIE_CHARTS
Display the pie charts on the dashboard by default.SHOW_RELATED_TAGS
If set, this will display the related tag statistics on the home page.SIMPLIFIED_STACK_TRACES
Stack traces are by default decluttered for readability.STEP_CREATION_STRATEGY
By default, new @Steps libraries are made as new instances, unless declared `shared`, in which case they are cached by type.TAGS
If provided, only classes and/or methods with tags in this list will be executed.TEST_RETRY_COUNT
Use this property to specify the maximum number of times to rerun the failing tests.TEST_RETRY_COUNT_CUCUMBER
Use this property to specify the maximum number of times to rerun the failing tests for cucumber tests.THUCYDIDES_ACTIVATE_FIREBUGS
Deprecated.THUCYDIDES_ACTIVATE_HIGHLIGHTING
Deprecated.THUCYDIDES_ADD_CONTEXT_TAG
Include a context tag with a test if one is provided.THUCYDIDES_ANNOTATED_REQUIREMENTS_DIR
Deprecated.THUCYDIDES_BATCH_COUNT
Deprecated.THUCYDIDES_BATCH_NUMBER
Deprecated.THUCYDIDES_BATCH_SIZE
Deprecated.THUCYDIDES_BATCH_STRATEGY
Deprecated.THUCYDIDES_BROWSER_HEIGHT
Deprecated.THUCYDIDES_BROWSER_MAXIMIZED
Deprecated.THUCYDIDES_BROWSER_WIDTH
Deprecated.THUCYDIDES_CONFIGURATION_REPORT
Deprecated.THUCYDIDES_CONSOLE_COLORS
Deprecated.THUCYDIDES_CONSOLE_HEADINGS
Deprecated.THUCYDIDES_CSV_EXTRA_COLUMNS
Deprecated.THUCYDIDES_DATA_DIR
Deprecated.THUCYDIDES_DIFFERENT_BROWSER_FOR_EACH_ACTOR
Deprecated.THUCYDIDES_DISPLAY_CONTEXT
Display the context in the test title.THUCYDIDES_DRIVER_CAPABILITIES
Deprecated.THUCYDIDES_DRY_RUN
Deprecated.THUCYDIDES_ESTIMATED_AVERAGE_STEP_COUNT
Deprecated.THUCYDIDES_ESTIMATED_TESTS_PER_REQUIREMENT
Deprecated.THUCYDIDES_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPE
Deprecated.THUCYDIDES_EXT_PACKAGES
Deprecated.THUCYDIDES_FILE_IO_RETRY_TIMEOUT
Deprecated.THUCYDIDES_FLOW_REPORTS_DIR
Deprecated.THUCYDIDES_HISTORY
Deprecated.THUCYDIDES_HOME
Deprecated.THUCYDIDES_ISSUE_TRACKER_URL
Deprecated.THUCYDIDES_JQUERY_INTEGRATION
Deprecated.THUCYDIDES_KEEP_UNSCALED_SCREENSHOTS
Deprecated.THUCYDIDES_LOCATOR_FACTORY
Deprecated.THUCYDIDES_LOGGING
Deprecated.THUCYDIDES_LOWEST_REQUIREMENT_TYPE
Deprecated.THUCYDIDES_MAINTAIN_SESSION
Deprecated.THUCYDIDES_NATIVE_EVENTS
Deprecated.THUCYDIDES_ONLY_SAVE_FAILING_SCREENSHOTS
Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.THUCYDIDES_OUTPUT_DIRECTORY
Deprecated.THUCYDIDES_PROJECT_KEY
Deprecated.THUCYDIDES_PROJECT_NAME
Deprecated.THUCYDIDES_PROXY_HTTP
Deprecated.THUCYDIDES_PROXY_HTTP_PORT
Deprecated.THUCYDIDES_PROXY_PASSWORD
Deprecated.THUCYDIDES_PROXY_TYPE
Deprecated.THUCYDIDES_PROXY_USER
Deprecated.THUCYDIDES_PUBLIC_URL
Deprecated.THUCYDIDES_RELEASE_TYPES
Deprecated.THUCYDIDES_REPORT_ENCODING
Deprecated.THUCYDIDES_REPORT_RESOURCES
Deprecated.THUCYDIDES_REPORT_SHOW_HISTORY
Deprecated.THUCYDIDES_REPORT_SHOW_MANUAL_TESTS
Deprecated.THUCYDIDES_REPORT_SHOW_PROGRESS
Deprecated.THUCYDIDES_REPORT_SHOW_RELEASES
Deprecated.THUCYDIDES_REPORT_SHOW_TAG_MENUS
Deprecated.THUCYDIDES_REPORT_TAG_MENUS
Deprecated.THUCYDIDES_REPORTS_SHOW_STEP_DETAILS
Deprecated.THUCYDIDES_REQUIREMENT_EXCLUSIONS
Deprecated.THUCYDIDES_REQUIREMENT_TYPES
Deprecated.THUCYDIDES_REQUIREMENTS_DIR
Deprecated.THUCYDIDES_RESIZED_IMAGE_WIDTH
Deprecated.THUCYDIDES_RESTART_BROWSER_FOR_EACH
Deprecated.THUCYDIDES_RESTART_BROWSER_FREQUENCY
Deprecated.THUCYDIDES_STEP_DELAY
Deprecated.THUCYDIDES_TAKE_SCREENSHOTS
Deprecated.THUCYDIDES_TEST_REQUIREMENTS_BASEDIR
Deprecated.THUCYDIDES_TEST_ROOT
Deprecated.THUCYDIDES_TIMEOUT
Deprecated.THUCYDIDES_USE_REQUIREMENTS_DIRECTORIES
Deprecated.THUCYDIDES_USE_UNIQUE_BROWSER
Deprecated.THUCYDIDES_VERBOSE_SCREENSHOTS
Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.THUCYDIDES_VERBOSE_STEPS
Deprecated.USE_CHROME_AUTOMATION_OPTIONS
Sets a number of common chrome options useful for automated testing.USE_GECKO_DRIVER
If the Gecko Driver is on the system path, it will be used (with Marionnette) by default.USE_TEST_CASE_FOR_STORY_TAG
If set to true (the default value), a story tag will be extracted from the test case or feature file containing the test.VERBOSE_REPORTING
WEBDRIVER_AUTODOWNLOAD
If the automatic webdriver download should happen.WEBDRIVER_BASE_URL
The default starting URL for the application, and base URL for relative paths.WEBDRIVER_CHROME_BINARY
Old property for chrome.binaryWEBDRIVER_CHROME_DRIVER
Path to the Chrome driver, if it is not on the system path.WEBDRIVER_CREATION_RETRY_CAUSES
A semi-colon list of (partial) error messages.WEBDRIVER_CREATION_RETRY_MAX_TIME
WEBDRIVER_DRIVER
The WebDriver driver - firefox, chrome, iexplorer, htmlunit, safari.WEBDRIVER_EDGE_DRIVER
Path to the Edge driver, if it is not on the system path.WEBDRIVER_FIREFOX_PROFILE
Full path to the Firefox profile to be used with Firefox.WEBDRIVER_GECKO_DRIVER
Path to the Gecko driver binaryWEBDRIVER_IE_DRIVER
Path to the Internet Explorer driver, if it is not on the system path.WEBDRIVER_MIN_SCREENSHOT_INTERVAL
The minimum time to wait between screenshots.WEBDRIVER_PROVIDED_TYPE
If using a provided driver, what type is it.WEBDRIVER_REMOTE_BROWSER_VERSION
WEBDRIVER_REMOTE_DRIVER
The driver to be used for remote driversWEBDRIVER_REMOTE_OS
WEBDRIVER_REMOTE_URL
The URL to be used for remote drivers (including a selenium grid hub)WEBDRIVER_TIMEOUTS_FLUENTWAIT
Synonym for webdriver.wait.for.timeoutWEBDRIVER_TIMEOUTS_IMPLICITLYWAIT
How long webdriver waits for elements to appear by default, in milliseconds.WEBDRIVER_USE_DRIVER_SERVICE_POOL
Try to create a Chrome driver using a driver service poolWEBDRIVER_WAIT_FOR_TIMEOUT
How long webdriver waits by default when you use a fluent waiting method, in milliseconds. -
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_HEIGHT
static java.lang.String
DEFAULT_HISTORY_DIRECTORY
static int
DEFAULT_WIDTH
-
Method Summary
Modifier and Type Method Description java.lang.Boolean
booleanFrom(EnvironmentVariables environmentVariables)
java.lang.Boolean
booleanFrom(EnvironmentVariables environmentVariables, java.lang.Boolean defaultValue)
java.lang.String
from(EnvironmentVariables environmentVariables)
java.lang.String
from(EnvironmentVariables environmentVariables, java.lang.String defaultValue)
java.lang.String
getLegacyPropertyName()
java.lang.String
getPropertyName()
int
integerFrom(EnvironmentVariables environmentVariables)
int
integerFrom(EnvironmentVariables environmentVariables, int defaultValue)
boolean
isDefinedIn(EnvironmentVariables environmentVariables)
java.util.List<java.lang.String>
legacyNames()
java.util.Optional<java.lang.String>
optionalFrom(EnvironmentVariables environmentVariables)
java.lang.String
preferredName()
java.lang.String
toString()
static ThucydidesSystemProperty
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static ThucydidesSystemProperty[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
-
Enum Constant Details
-
WEBDRIVER_DRIVER
The WebDriver driver - firefox, chrome, iexplorer, htmlunit, safari. -
DRIVER
A shortcut for 'webdriver.driver'. -
WEBDRIVER_PROVIDED_TYPE
If using a provided driver, what type is it. The implementation class needs to be defined in the webdriver.provided.{type} system property. -
WEBDRIVER_BASE_URL
The default starting URL for the application, and base URL for relative paths. -
WEBDRIVER_REMOTE_URL
The URL to be used for remote drivers (including a selenium grid hub) -
PHANTOMJS_WEBDRIVER_PORT
What port to run PhantomJS on (used in conjunction with webdriver.remote.url to register with a Selenium hub, e.g. -Dphantomjs.webdriver=5555 -Dwebdriver.remote.url=http://localhost:4444 -
USE_CHROME_AUTOMATION_OPTIONS
Sets a number of common chrome options useful for automated testing. In particular, this includes: --enable-automation --test-type Set to false by default -
WEBDRIVER_AUTODOWNLOAD
If the automatic webdriver download should happen. -
WEBDRIVER_REMOTE_DRIVER
The driver to be used for remote drivers -
WEBDRIVER_REMOTE_BROWSER_VERSION
-
WEBDRIVER_REMOTE_OS
-
WEBDRIVER_MIN_SCREENSHOT_INTERVAL
The minimum time to wait between screenshots. Trying to take screenshots too often can slow down the tests. -
WEBDRIVER_IE_DRIVER
Path to the Internet Explorer driver, if it is not on the system path. -
WEBDRIVER_EDGE_DRIVER
Path to the Edge driver, if it is not on the system path. -
WEBDRIVER_CHROME_DRIVER
Path to the Chrome driver, if it is not on the system path. -
WEBDRIVER_CHROME_BINARY
Old property for chrome.binary -
CHROME_BINARY
Path to the Chrome binary, if it is not on the system path. -
THUCYDIDES_PROJECT_KEY
Deprecated. -
SERENITY_PROJECT_KEY
A unique identifier for the project under test, used to record test statistics. -
THUCYDIDES_PROJECT_NAME
Deprecated. -
SERENITY_PROJECT_NAME
What name should appear on the reports -
SERENITY_SUMMARY_REPORT_TITLE
What name should appear on the email summary report -
SERENITY_SUMMARY_REPORT_FILENAME
What file name should be used for the email summary report (defaults to serenity-summary.html) -
REPORT_SUBTITLE
A subtitle to appear in the Serenity HTML reports. This can be useful to describe a qualified or filtered report. -
REPORT_TIMEOUT_THREADDUMPS
-
SERENITY_REPORT_URL
Link to the generated Serenity report to embed in the emailable summary report. -
THUCYDIDES_HOME
Deprecated. -
SERENITY_HOME
The home directory for Thucydides output and data files - by default, $USER_HOME/.thucydides -
THUCYDIDES_REPORT_RESOURCES
Deprecated. -
SERENITY_REPORT_RESOURCES
Indicates a directory from which the resources for the HTML reports should be copied. This directory currently needs to be provided in a JAR file. -
THUCYDIDES_REPORT_ENCODING
Deprecated.Encoding for reports output -
SERENITY_REPORT_ENCODING
Encoding for reports output -
REMOTE_PLATFORM
-
THUCYDIDES_OUTPUT_DIRECTORY
Deprecated. -
SERENITY_OUTPUT_DIRECTORY
Where should reports be generated (use the system property 'serenity.outputDirectory'). -
THUCYDIDES_CONFIGURATION_REPORT
Deprecated.Default name of report with configurations. It will contains some values that was used during generation of reports -
SERENITY_CONFIGURATION_REPORT
Default name of report with configurations. It will contains some values that was used during generation of reports -
THUCYDIDES_FLOW_REPORTS_DIR
Deprecated. -
SERENITY_FLOW_REPORTS_DIR
Default name of folder, with reports about test flow and aggregation report generation -
THUCYDIDES_ONLY_SAVE_FAILING_SCREENSHOTS
Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.Should Thucydides only store screenshots for failing steps? This can save disk space and speed up the tests somewhat. Useful for data-driven testing. -
THUCYDIDES_DRIVER_CAPABILITIES
Deprecated. -
SERENITY_DRIVER_CAPABILITIES
A set of user-defined capabilities to be used to configure the WebDriver driver. Capabilities should be passed in as a space or semi-colon-separated list of key:value pairs, e.g. "build:build-1234; max-duration:300; single-window:true; tags:[tag1,tag2,tag3]" -
THUCYDIDES_VERBOSE_SCREENSHOTS
Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.Should Thucydides take screenshots for every clicked button and every selected link? By default, a screenshot will be stored at the start and end of each step. If this option is set to true, Thucydides will record screenshots for any action performed on a WebElementFacade, i.e. any time you use an expression like element(...).click(), findBy(...).click() and so on. This will be overridden if the THUCYDIDES_ONLY_SAVE_FAILING_SCREENSHOTS option is set to true. -
THUCYDIDES_VERBOSE_STEPS
Deprecated. -
SERENITY_VERBOSE_STEPS
If set to true, WebElementFacade events and other step actions will be logged to the console. -
VERBOSE_REPORTING
-
SCREENPLAY_PRONOUNS
Words that will be recognised as pronouns by Serenity Screenplay in Cucumber and used to refer to the actor in the spotlight, rather than as an actor name. Defaults to "he" and "she" -
THUCYDIDES_TAKE_SCREENSHOTS
Deprecated. -
SERENITY_TAKE_SCREENSHOTS
Fine-grained control over when screenshots are to be taken. This property accepts the following values:- FOR_EACH_ACTION
- BEFORE_AND_AFTER_EACH_STEP
- AFTER_EACH_STEP
- FOR_FAILURES
-
THUCYDIDES_REPORTS_SHOW_STEP_DETAILS
Deprecated. -
SERENITY_REPORTS_SHOW_STEP_DETAILS
Should Thucydides display detailed information in the test result tables. If this is set to true, test result tables will display a breakdown of the steps by result. This is false by default. -
THUCYDIDES_REPORT_SHOW_MANUAL_TESTS
Deprecated. -
SERENITY_REPORT_SHOW_MANUAL_TESTS
Show statistics for manual tests in the test reports. -
THUCYDIDES_REPORT_SHOW_RELEASES
Deprecated. -
SERENITY_REPORT_SHOW_RELEASES
Report on releases -
THUCYDIDES_REPORT_SHOW_PROGRESS
Deprecated. -
SERENITY_REPORT_SHOW_PROGRESS
-
THUCYDIDES_REPORT_SHOW_HISTORY
Deprecated. -
SERENITY_REPORT_SHOW_HISTORY
-
THUCYDIDES_REPORT_SHOW_TAG_MENUS
Deprecated. -
SERENITY_REPORT_SHOW_TAG_MENUS
-
THUCYDIDES_REPORT_TAG_MENUS
Deprecated. -
SERENITY_REPORT_TAG_MENUS
-
THUCYDIDES_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPE
@Deprecated public static final ThucydidesSystemProperty THUCYDIDES_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPEDeprecated. -
SERENITY_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPE
@Deprecated public static final ThucydidesSystemProperty SERENITY_EXCLUDE_UNRELATED_REQUIREMENTS_OF_TYPEDeprecated. -
THUCYDIDES_RESTART_BROWSER_FREQUENCY
Deprecated. -
SERENITY_RESTART_BROWSER_FREQUENCY
Restart the browser every so often during data-driven tests. -
THUCYDIDES_RESTART_BROWSER_FOR_EACH
Deprecated. -
SERENITY_RESTART_BROWSER_FOR_EACH
Indicate when a browser should be restarted during a test run. Can be one of: example, scenario, story, feature, never -
THUCYDIDES_DIFFERENT_BROWSER_FOR_EACH_ACTOR
@Deprecated public static final ThucydidesSystemProperty THUCYDIDES_DIFFERENT_BROWSER_FOR_EACH_ACTORDeprecated. -
SERENITY_DIFFERENT_BROWSER_FOR_EACH_ACTOR
When multiple actors are used with the Screenplay pattern, a separate browser is configured for each actor. Set this property to false if you want actors use a common browser. This can be useful if actors are used to illustrate the intent of a test, but no tests use more than one actor simultaneously -
THUCYDIDES_STEP_DELAY
Deprecated. -
SERENITY_STEP_DELAY
Pause (in ms) between each test step. -
THUCYDIDES_TIMEOUT
Deprecated. -
SERENITY_TIMEOUT
Deprecated.Use WEBDRIVER_TIMEOUTS_IMPLICITLYWAIT instead.How long should the driver wait for elements not immediately visible, in seconds. -
REFUSE_UNTRUSTED_CERTIFICATES
Don't accept sites using untrusted certificates. By default, Thucydides accepts untrusted certificates - use this to change this behaviour. -
THUCYDIDES_USE_UNIQUE_BROWSER
Deprecated.Use the same browser for all tests (the "Highlander" rule) Deprecated: Use THUCYDIDES_RESTART_BROWSER_FOR_EACH instead. -
THUCYDIDES_ESTIMATED_AVERAGE_STEP_COUNT
Deprecated. -
SERENITY_ESTIMATED_AVERAGE_STEP_COUNT
The estimated number of steps in a pending scenario. This is used for stories where no scenarios have been defined. -
THUCYDIDES_ESTIMATED_TESTS_PER_REQUIREMENT
Deprecated. -
SERENITY_ESTIMATED_TESTS_PER_REQUIREMENT
The estimated number of tests in a typical story. Used to estimate functional coverage in the requirements reports. -
THUCYDIDES_ISSUE_TRACKER_URL
Deprecated. -
SERENITY_ISSUE_TRACKER_URL
Base URL for the issue tracking system to be referred to in the reports. If defined, any issues quoted in the form #1234 will be linked to the relevant issue in the issue tracking system. Works with JIRA, Trac etc. -
THUCYDIDES_NATIVE_EVENTS
Deprecated. -
SERENITY_NATIVE_EVENTS
Activate native events in Firefox. This is true by default, but can cause issues with some versions of linux. -
JIRA_URL
If the base JIRA URL is defined, Thucydides will build the issue tracker url using the standard JIRA form. -
JIRA_PROJECT
If defined, the JIRA project id will be prepended to issue numbers. -
JIRA_USERNAME
If defined, the JIRA username required to connect to JIRA. -
JIRA_PASSWORD
If defined, the JIRA password required to connect to JIRA. -
SERENITY_JIRA_WORKFLOW
The JIRA workflow is defined in this file. -
SERENITY_JIRA_WORKFLOW_ACTIVE
If set to true, JIRA Workflow is active. -
THUCYDIDES_HISTORY
Deprecated. -
SERENITY_HISTORY
Base directory in which history files are stored. -
THUCYDIDES_BROWSER_HEIGHT
Deprecated. -
SERENITY_BROWSER_HEIGHT
Redimension the browser to enable larger screenshots. -
THUCYDIDES_BROWSER_WIDTH
Deprecated. -
SERENITY_BROWSER_WIDTH
Redimension the browser to enable larger screenshots. -
THUCYDIDES_BROWSER_MAXIMIZED
Deprecated. -
SERENITY_BROWSER_MAXIMIZED
Set to true to get WebDriver to maximise the Browser window before the tests are executed. -
SERENITY_BROWSER_FULL_SCREEN
Set the browser o full screen mode before tests are executed -
THUCYDIDES_RESIZED_IMAGE_WIDTH
Deprecated. -
SERENITY_BROWSER_RESIZING
Set to false if you don't want Serenity to resize the browser page at the start of a test (Can be useful for custom Appium drivers) -
SERENITY_RESIZED_IMAGE_WIDTH
If set, resize screenshots to this size to save space. -
THUCYDIDES_PUBLIC_URL
Deprecated. -
SERENITY_PUBLIC_URL
Public URL where the Thucydides reports will be displayed. This is mainly for use by plugins. -
THUCYDIDES_ACTIVATE_FIREBUGS
Deprecated. -
SERENITY_ACTIVATE_FIREBUGS
Activate the Firebugs plugin for firefox. Useful for debugging, but not very when running the tests on a build server. It is not activated by default. -
SECURITY_ENABLE_JAVA
Enable applets in Firefox. Use the system property 'security.enable_java'. Applets slow down webdriver, so are disabled by default. -
THUCYDIDES_ACTIVATE_HIGHLIGHTING
Deprecated. -
SERENITY_ACTIVATE_HIGHLIGHTING
-
THUCYDIDES_BATCH_STRATEGY
Deprecated. -
SERENITY_BATCH_STRATEGY
Batch strategy to use for parallel batches. Allowed values - DIVIDE_EQUALLY (default) and DIVIDE_BY_TEST_COUNT -
THUCYDIDES_BATCH_COUNT
Deprecated. -
SERENITY_BATCH_COUNT
A deprecated property that is synonymous with thucydides.batch.size -
THUCYDIDES_BATCH_SIZE
Deprecated. -
SERENITY_BATCH_SIZE
If batch testing is being used, this is the size of the batches being executed. -
THUCYDIDES_BATCH_NUMBER
Deprecated. -
SERENITY_BATCH_NUMBER
If batch testing is being used, this is the number of the batch being run on this machine. -
THUCYDIDES_PROXY_HTTP
Deprecated. -
THUCYDIDES_PROXY_HTTP_PORT
Deprecated. -
SERENITY_PROXY_HTTP_PORT
HTTP Proxy port configuration for Firefox and PhantomJS Use 'thucydides.proxy.http_port' -
THUCYDIDES_PROXY_TYPE
Deprecated. -
SERENITY_PROXY_TYPE
HTTP Proxy type configuration for Firefox and PhantomJS -
THUCYDIDES_PROXY_USER
Deprecated. -
SERENITY_PROXY_HTTP
HTTP Proxy URL configuration -
SERENITY_PROXY_USER
HTTP Proxy username configuration for Firefox and PhantomJS -
THUCYDIDES_PROXY_PASSWORD
Deprecated. -
SERENITY_PROXY_PASSWORD
HTTP Proxy password configuration for Firefox and PhantomJS -
SERENITY_PROXY_SSL_PORT
SSL Proxy port configuration for Firefox and PhantomJS - serenity.proxy.sslProxyPort -
SERENITY_PROXY_SSL
SSL Proxy port configuration for Firefox and PhantomJS - serenity.proxy.sslProxy -
SERENITY_PROXY_FTP
-
SERENITY_PROXY_NOPROXY
-
SERENITY_PROXY_AUTOCONFIG
-
SERENITY_PROXY_AUTODETECT
-
SERENITY_PROXY_SOCKS_PROXY
-
SERENITY_PROXY_SOCKS_USERNAME
-
SERENITY_PROXY_SOCKS_PASSWORD
-
SERENITY_PROXY_SOCKS_VERSION
-
SERENITY_DRIVER_PAGE_LOAD_STRATEGY
Possible values are:none, eager or normal -
SERENITY_DRIVER_UNEXPECTED_ALERT_BEHAVIOUR
Possible values are: accept, dismiss, accept and notify, dismiss and notify, ignore -
WEBDRIVER_TIMEOUTS_IMPLICITLYWAIT
How long webdriver waits for elements to appear by default, in milliseconds. -
WEBDRIVER_TIMEOUTS_FLUENTWAIT
Synonym for webdriver.wait.for.timeout -
WEBDRIVER_WAIT_FOR_TIMEOUT
How long webdriver waits by default when you use a fluent waiting method, in milliseconds. -
THUCYDIDES_EXT_PACKAGES
Deprecated. -
SERENITY_EXT_PACKAGES
Extension packages. This is a list of packages that will be scanned for custom TagProvider implementations. To add a custom tag provider, just implement the TagProvider interface and specify the root package for this provider in this parameter. -
CHROME_SWITCHES
Arguments to be passed to the Chrome driver, separated by commas. -
CHROME_EXTENSION
Path to a Chrome-driver specific extensions file -
CHROME_DEFAULT_OPTIONS_W3C
Set this to true to activate the "w3c" experimental option for chrome. This needs to be set to true for Saucelabs and false for Browserstack -
FIREFOX_PREFERENCES
Preferences to be passed to the Firefox driver, separated by semi-colons (commas often appear in the preference values. -
DRIVER_OPTIONS
Used to specify either chrome options or firefox preferences, depending on which driver is being used. -
WEBDRIVER_USE_DRIVER_SERVICE_POOL
Try to create a Chrome driver using a driver service pool -
WEBDRIVER_FIREFOX_PROFILE
Full path to the Firefox profile to be used with Firefox. You can include Java system properties ${user.dir}, ${user.home} and the Windows environment variables %APPDIR% and %USERPROFILE (assuming these are correctly set in the environment) -
THUCYDIDES_JQUERY_INTEGRATION
Deprecated. -
SERENITY_JQUERY_INTEGRATION
Enable JQuery integration. If set to true, JQuery will be injected into any page that does not already have it. This option is activated by default, deactivating can speed up the page loading. -
SAUCELABS_BROWSERNAME
-
SAUCELABS_TARGET_PLATFORM
-
SAUCELABS_BROWSER_VERSION
-
SAUCELABS_TEST_NAME
-
SAUCELABS_DATACENTER
SauceLabs datacenter used for interaction with SauceLabs API and adding link to Serenity report Examples: US: us-west-1 Europe: eu-central-1 -
SAUCELABS_URL
Saucelabs URL, including username and api key -
SAUCELABS_ACCESS_KEY
SauceLabs access key - if provided, Thucydides can generate links to the SauceLabs reports that don't require a login. -
SAUCELABS_USER_ID
SauceLabs user id - if provided with the access key, Thucydides can generate links to the SauceLabs reports that don't require a login. -
SAUCELABS_IMPLICIT_TIMEOUT
Override the default implicit timeout value for the Saucelabs driver. -
SAUCELABS_RECORD_SCREENSHOTS
Saucelabs records screenshots as well as videos by default. Since Thucydides also records screenshots, this feature is disabled by default. It can be reactivated using this system property. -
BROWSERSTACK_URL
BrowserStack Hub URL if running the tests on BrowserStack Cloud -
BROWSERSTACK_USER
-
BROWSERSTACK_KEY
-
BROWSERSTACK_OS
-
BROWSERSTACK_OS_VERSION
-
BROWSERSTACK_BROWSER
Browserstack uses this property for desktop browsers, like firefox, chrome and IE. -
BROWSERSTACK_BROWSERNAME
Browserstack uses this one for android and iphone. -
BROWSERSTACK_BROWSER_VERSION
-
BROWSERSTACK_DEVICE
BrowserStack mobile device name on which tests should be run -
BROWSERSTACK_DEVICE_ORIENTATION
Set the screen orientation of BrowserStack mobile device -
BROWSERSTACK_PROJECT
Specify a name for a logical group of builds on BrowserStack -
BROWSERSTACK_BUILD
Specify a name for a logical group of tests on BrowserStack -
BROWSERSTACK_SESSION_NAME
Specify an identifier for the test run on BrowserStack -
BROWSERSTACK_LOCAL
For Testing against internal/local servers on BrowserStack -
BROWSERSTACK_DEBUG
Generates screenshots at various steps in tests on BrowserStack -
BROWSERSTACK_RESOLUTION
Sets resolution of VM on BrowserStack -
BROWSERSTACK_SELENIUM_VERSION
-
BROWSERSTACK_IE_NO_FLASH
Disable flash on Internet Explorer on BrowserStack -
BROWSERSTACK_IE_DRIVER
Specify the Internet Explorer webdriver version on BrowserStack -
BROWSERSTACK_IE_ENABLE_POPUPS
Enable the popup blocker in Internet Explorer on BrowserStack -
THUCYDIDES_FILE_IO_RETRY_TIMEOUT
Deprecated. -
SERENITY_FILE_IO_RETRY_TIMEOUT
Timeout (in seconds) for retrying file I/O. Used in net.thucydides.core.resources.FileResources.copyResourceTo(). Sometimes, file I/O fails on Windows machine due to the way Windows handles memory-mapped files (http://stackoverflow.com/questions/3602783/file-access-synchronized-on-java-object). This property, if set, will retry copying the resource till timeout. A default value is used if the property is not set. -
THUCYDIDES_LOGGING
Deprecated. -
SERENITY_LOGGING
Four levels are supported: NONE, QUIET, NORMAL and VERBOSE - NONE: Disable Serenity logging - QUIET: Only report compromised tests, errors and failures. - NORMAL: Log the start and end of each test, and the result of each test. - VERBOSE: Log the start and end of each test, and the result of each test, and each test step. -
THUCYDIDES_TEST_ROOT
Deprecated. -
SERENITY_TEST_ROOT
The root package for the tests in a given project. If provided, Thucydides will log information about the total number of tests to be executed, and keep a tally of the executed tests. It will also use this as the root package when determining the capabilities associated with a test. If you are using the File System Requirements provider, Thucydides will expect this directory structure to exist at the top of the requirements tree. If you want to exclude packages in a requirements definition and start at a lower level in the hierarchy, use the thucydides.requirement.exclusions property. This is also used by the PackageAnnotationBasedTagProvider to know where to look for annotated requirements. -
CURRENT_TARGET_VERSION
Property used to define the current target version for manual tests defined in Cucumber scenarios with the @manual and @@last-version-tested annotations. -
THUCYDIDES_REQUIREMENTS_DIR
Deprecated. -
SERENITY_REQUIREMENTS_DIR
Use this property if you need to completely override the location of requirements for the File System Provider. -
SERENITY_TEST_STATISTICS_DIR
if specified, should point to a folder that contains one or more Serenity CSV output files -
THUCYDIDES_USE_REQUIREMENTS_DIRECTORIES
Deprecated. -
SERENITY_FEATURES_DIRECTORY
Override the directory name for the directory containing feature files. This is designed to work for both simple and multi-module projects. Give the name of the directory inside src/test/resources (e.g. you would put serenity.features.directory = myFeatures for src/test/resources/myFeatures -
SERENITY_SHOW_STORY_DETAILS_IN_TESTS
If set to true, the full description of the parent story or feature is displayed at the top of an individual test report. Set to false by default/ -
SERENITY_STORIES_DIRECTORY
Same as serenity.features.directory but for src/test/stories -
SERENITY_DISABLE_REST_CALLS_AFTER_FAILURES
Normally, REST calls are disabled when a failure occurs. Set this to false to never disable REST calls -
SERENITY_USE_REQUIREMENTS_DIRECTORIES
By default, Thucydides will read requirements from the directory structure that contains the stories. When other tag and requirements plugins are used, such as the JIRA plugin, this can cause conflicting tags. Set this property to false to deactivate this feature (it is true by default). -
THUCYDIDES_ANNOTATED_REQUIREMENTS_DIR
Deprecated. -
SERENITY_ANNOTATED_REQUIREMENTS_DIR
Use this property if you need to completely override the location of requirements for the Annotated Provider. This is recommended if you use File System and Annotated provider simultaneously. The default value is stories. -
THUCYDIDES_LOWEST_REQUIREMENT_TYPE
Deprecated. -
SERENITY_LOWEST_REQUIREMENT_TYPE
Determine what the lowest level requirement (test cases, feature files, story files, should be called. 'Story' is used by default. 'feature' is a popular alternative. -
THUCYDIDES_REQUIREMENT_TYPES
Deprecated. -
SERENITY_REQUIREMENT_TYPES
The hierarchy of requirement types. This is the list of requirement types to be used when reading requirements from the file system and when organizing the reports. It is a comma-separated list of tags.The default value is: capability, feature -
THUCYDIDES_REQUIREMENT_EXCLUSIONS
Deprecated. -
SERENITY_REQUIREMENT_EXCLUSIONS
When deriving requirement types from a path, exclude any values from this comma-separated list. -
THUCYDIDES_RELEASE_TYPES
Deprecated. -
SERENITY_RELEASE_TYPES
What tag names identify the release types (e.g. Release, Iteration, Sprint). A comma-separated list. By default, "Release, Iteration" -
THUCYDIDES_LOCATOR_FACTORY
Deprecated. -
SERENITY_LOCATOR_FACTORY
Normally, Serenity uses SmartElementLocatorFactory, an extension of the AjaxElementLocatorFactory when instantiating page objects. This is to ensure that web elements are available and usable before they are used. For alternative behaviour, you can set this value to DisplayedElementLocatorFactory, AjaxElementLocatorFactory or DefaultElementLocatorFactory. -
THUCYDIDES_DATA_DIR
Deprecated. -
SERENITY_DATA_DIR
Where Serenity stores local data. -
PROPERTIES
Allows you to override the default serenity.properties location for properties file. -
THUCYDIDES_TEST_REQUIREMENTS_BASEDIR
Deprecated. -
SERENITY_TEST_REQUIREMENTS_BASEDIR
The base directory in which requirements are kept. It is assumed that this directory contains sub folders src/test/resources. If this property is set, the requirements are read from src/test/resources under this folder instead of the classpath or working directory. If you need to set an independent requirements directory that does not follow the src/test/resources convention, use thucydides.requirements.dir insteadThis property is used to support situations where your working directory is different from the requirements base dir (for example when building a multi-module project from parent pom with requirements stored inside a sub-module : See Jira #Thucydides-100)
-
THUCYDIDES_KEEP_UNSCALED_SCREENSHOTS
Deprecated.Set to true if you want the HTML source code to be recorded as well as the screenshots. This is not currently used in the reports. -
SERENITY_KEEP_UNSCALED_SCREENSHOTS
If set to true, a copy of the original screenshot will be kept when screenshots are scaled for the reports. False by default to conserve disk space. -
TAGS
If provided, only classes and/or methods with tags in this list will be executed. The parameter expects a tag or comma-separated list of tags in the shortened form. This only works for JUnit tests. For Cucumber, use the -Dcucumber.options parameter For example, -Dtags="iteration:I1" or -Dtags="color:red,flavor:strawberry" -
REPORT_ON_TAGS
Display only test results and requirements containing any of the specified tags -
INJECTED_TAGS
If provided, each test in a test run will have these tags added. -
THUCYDIDES_CSV_EXTRA_COLUMNS
Deprecated. -
SHOW_HISTORY_FLAGS
If set to true, historical flags will be displayed in test lists. This must be set in conjunction with the serenity.historyDirectory property -
SERENITY_HISTORY_DIRECTORY
Serenity will look in this directory for the previous build results, to use as a basis for the historical flags shown in the test results. By default, the 'history' folder in the working directory will be used. -
DELETE_HISTORY_DIRECTORY
Delete the history directory before a new set of results is recorded -
SERENITY_GENERATE_CSV_REPORTS
Generate a CSV report for each test result (true by default) -
SERENITY_CSV_EXTRA_COLUMNS
Add extra columns to the CSV output, obtained from tag values. -
THUCYDIDES_CONSOLE_HEADINGS
Deprecated. -
SERENITY_CONSOLE_BANNER
Write the console banner using ascii-art ("ascii", default value) or in smaller text ("normal") -
SERENITY_CONSOLE_HEADINGS
Write the console headings using ascii-art ("ascii", default value) or in normal text ("normal") -
THUCYDIDES_CONSOLE_COLORS
Deprecated. -
SERENITY_CONSOLE_COLORS
Use ASCII color codes when outputing the console logs. -
SERENITY_DISPLAY_TEST_NUMBERS
Set to true to write the chronological number of each test as it is executed to the console -
NARRATIVE_FORMAT
If set to true, Asciidoc formatting will be supported in the narrative texts. -
OUTPUT_FORMATS
What format should test results be generated in. By default, this is "json, html". -
ENABLE_MARKDOWN
If set to true (the default), allow markdown formatting in test outcome titles and descriptions. This is a comma-separated lists of values from the following: story, narrative, step By default, Markdown is enabled for story titles and narrative texts, but not for steps. -
PHANTOMJS_BINARY_PATH
Path to PhantomJS executable -
WEBDRIVER_GECKO_DRIVER
Path to the Gecko driver binary -
IGNORE_EMBEDDED_TABLES
If set to true, don't format embedded tables in JBehave or Gherkin steps. False by default. -
SHOW_RELATED_TAGS
If set, this will display the related tag statistics on the home page. If you are using external requirements, you may not want to display these tags on the dashboard. -
USE_TEST_CASE_FOR_STORY_TAG
If set to true (the default value), a story tag will be extracted from the test case or feature file containing the test. -
SHOW_PIE_CHARTS
Display the pie charts on the dashboard by default. If this is set to false, the pie charts will be initially hidden on the dashboard. -
DASHBOARD_TAG_LIST
If set, this will define the list of tag types to appear on the dashboard screens -
SERENITY_COMPRESS_FILENAMES
If set to false, render report names in a readable form as opposed to a hash format. Note: this can cause problems on operating systems that limit path lengths such as Windows. -
SERENITY_COMPRESS_SCREENSHOTS
If set, Serenity will scale down the screenshots taken during execution to the size of the carousel in the screenshot page. This results in a loss of quality but a gain in disk space. -
SERENITY_SCREENSHOOTER
Specify the screenshot tool to be used to take screenshots. By default it will be WebDriver. Other values include:- shutterbug (for Shutterbug 0.9.5 - add the serenity-shutterbug dependency to your project)
- shutterbug1 (for Shutterbug 1.x - add the serenity-shutterbug1x dependency to your project)
-
SERENITY_FULL_PAGE_SCREENSHOT_STRATEGY
Deprecated.If set, Serenity will use full page screenshot strategy. -
SERENITY_SCREENSHOT_STRATEGY
Deprecated.Define the Shutterbug screen capture strategy: - VIEWPORT: capture visible part of the viewport only - FULL: full page screenshot using devtools - FULL_SCROLL: full page screenshot using scroll & stitch method - VERTICAL_SCROLL:vertical scroll page screenshot using scroll & stitch method - HORIZONTAL_SCROLL: horizontal scroll page screenshot using scroll & stitch method -
DASHBOARD_EXCLUDED_TAG_LIST
If set, this will define the list of tag types to be excluded from the dashboard screens -
REPORT_RAW_TAG_LIST
If set, this will define the list of tag types which will be not formatted with title case in HTML report. This option allows to preserve underscores or camel case in tag name. -
JSON_PRETTY_PRINTING
Format the JSON test outcomes nicely. "true" or "false", turned off by default. -
JSON_CHARSET
What charset to use for JSON processing. Defaults to UTF-8 -
REPORT_CHARSET
What charset to use for report generation. Defaults to UTF-8 -
SIMPLIFIED_STACK_TRACES
Stack traces are by default decluttered for readability. For example, calls to instrumented code or internal test libraries is removed. This behaviour can be deactivated by setting this property to false. -
THUCYDIDES_DRY_RUN
Deprecated. -
SERENITY_DRY_RUN
Run through the steps without actually executing them. -
FEATURE_FILE_LANGUAGE
What (human) language are the Cucumber feature files written in? Defaults to "en" -
THUCYDIDES_DISPLAY_CONTEXT
Display the context in the test title. Set to false by default. If the context is a browser type (chrome, ie, firefox, safari, opera), the browser icon will be displayed If the context is an OS (linux, mac, windows, android, iphone), an icon will be displayed Otherwise, the context name will be displayed at the start of the test title. -
THUCYDIDES_ADD_CONTEXT_TAG
Include a context tag with a test if one is provided. Set to 'true' by default -
FEATURE_FILE_ENCODING
What encoding to use for reading Cucumber feature files? Defaults to system default encoding -
REPORT_THREADS
Fine-tune the number of threads Serenity uses for report generation. -
REPORT_MAX_THREADS
-
REPORT_KEEP_ALIVE_TIME
-
DEEP_STEP_EXECUTION_AFTER_FAILURES
Set this to true if you want Serenity to report nested step structures for subsequent steps after a step failure. -
MANUAL_TEST_REPORT_RESULT
What test result (success,ignored, or pending) should be shown for manual annotated tests in the reports? -
THUCYDIDES_MAINTAIN_SESSION
Deprecated. -
SERENITY_MAINTAIN_SESSION
Keep the Thucydides session data between tests. Normally, the session data is cleared between tests. -
PHANTOMJS_SSL_PROTOCOL
Path to PhantomJS SSL support -
SERENITY_COMPROMISED_ON
Comma-separated list of exception classes that should produce a compromised test in the reports. -
SERENITY_SKIPPED_ON
Comma-separated list of exception classes that should produce a skipped test in the reports. -
SERENITY_ERROR_ON
Comma-separated list of exception classes that should produce an error in the reports. -
SERENITY_FAIL_ON
Comma-separated list of exception classes that should produce a failure in the reports. -
SERENITY_FORK_COUNT
If batch testing is being used in a multithreaded environment, this is the number of forks that will be created. -
SERENITY_FORK_NUMBER
If batch testing is being used in a multithreaded environment, this is the executing fork number. -
SERENITY_PENDING_ON
Comma-separated list of exception classes that should produce a pending test in the reports. -
SERENITY_TAG_FAILURES
If set to true, add a tag for test failures, based on the error type and message -
SERENITY_LINKED_TAGS
A comma-separated list of tag types for which human-readable report names will be generated. -
SERENITY_WEBDRIVER_COLLECTION_LOADING_STRATEGY
Should we assume that collections of webdriver elements are already on the page, or if we should wait for them to be available. This property takes two values: Optimistic or Pessimistic. Optimistic means that the elements are assumed to be on the screen, and will be loaded as-is immediately. This is the normal WebDriver behavior. For applications with lots of ASynchronous activity, it is often better to wait until the elements are visible before using them. The Pessimistic mode waits for at least one element to be visible before proceeding. For legacy reasons, the default strategy is Pessimistic. -
USE_GECKO_DRIVER
If the Gecko Driver is on the system path, it will be used (with Marionnette) by default. If you want to use the old-style Firefox driver, but have gecko on the system path, then set this property to false. -
GECKO_FIREFOX_OPTIONS
Use this property to pass options to Marionette using the 'moz:firefoxOptions' capability option. -
FIREFOX_OPTIONS
An alternative to gecko.firefox.options -
TEST_RETRY_COUNT
Use this property to specify the maximum number of times to rerun the failing tests. -
TEST_RETRY_COUNT_CUCUMBER
Use this property to specify the maximum number of times to rerun the failing tests for cucumber tests. -
RECORD_FAILURES
Record failures to a file specified by property rerun.failures.file or rerun.xml in current directory -
REPLAY_FAILURES
Replay failures from a file specified by property rerun.failures.file or rerun.xml in current directory -
RERUN_FAILURES_DIRECTORY
Location of the directory where the failure files are recorded. -
CONTEXT
Provide a text that distinguishes tests run in a particular environment or context from the same test run in a different environment or context. -
APPIUM_HUB
-
STEP_CREATION_STRATEGY
By default, new @Steps libraries are made as new instances, unless declared `shared`, in which case they are cached by type. Use this property to make Serenity use the older strategy, which was to default to 'shared' and only create new instances for step libraries with the uniqueInstance attribute. Possible values are: default (the default value), and legacy. -
SAFARI_USE_CLEAN_SESSION
Instruct the SafariDriver to delete all existing session data when starting a new session (true by default) -
HEADLESS_MODE
Activate headless mode for chrome or firefox -
REPORT_ASSETS_DIRECTORY
Where to find images used in the reports (defaults to src/test/resources/assets) -
FIREFOX_LOG_LEVEL
-
APPIUM_UDID
Unique device identifier of the connected physical device used for appium tests -
APPIUM_DEVICE_NAME
The device name used for Appium tests -
APPIUM_PLATFORMNAME
-
APPIUM_DEVICE_NAMES
(Experimental) Specifies a list of devices to be used for parallel testing. Will only be used if manage.appium.servers is set to true -
MANAGE_APPIUM_SERVERS
Should Serenity Manage your appium servers for you -
APPIUM_ADDITIONAL_CAPABILITIES
List of capabilities that should be provided in addition to supported by w3c or Appium. Properties, that match w3c pattern or listed in Appium's interfaces, will be included as is and 'appium:' prefix will be added to each name provided in this property -
APPIUM_PROCESS_DESIRED_CAPABILITIES
Set to true to enable processing of desired capabilities, created from the provided 'appium:' properties. If processing is enabled, only capabilities supported by w3c, Appium or mentioned inAPPIUM_ADDITIONAL_CAPABILITIES
will be included into desired capabilities. If processing is disabled, all of the properties that have 'appium:' prefix will be included into desired capabilities. Disabled by default -
ACCEPT_INSECURE_CERTIFICATES
Set to true to activate the AcceptInsecureCertificates options for Chrome and Firefox. -
FIREFOX_PREFERENCE_SEPARATOR
The character to be used to separate firefox preference key-value pairs when using the "firefox.preferences" property. By default this is a semicolon, but sometimes semicolon appears in the preference values. -
SERENITY_WEBDRIVER_INTEGRATION
Disable Webdriver integration. Turn this off to avoid Serenity loading WebDriver classes unnecessarily. -
SERENITY_MAXIMUM_STEP_NESTING_DEPTH
When creating steps that contain references to other steps serenity does a recursion check to prevent cyclic references. This property determines how many levels deep the step classes can be nested before it triggers a recursion exception. By default it is set to 32, but can be increased if you start getting RecursiveOrCyclicStepLibraryReferenceException due to step nesting rather than actual infinite recursion. -
REPORT_SCOREBOARD_SIZE
The maximum number of entries to appear on report scoreboards (default 5) -
SHOW_FULL_TEST_RESULTS
Show the full test results in the emailable reports -
REPORT_TAGTYPES
What tag types should be listed in the report summary -
MAX_FREQUENT_FAILURES
-
CUCUMBER_PRETTY_FORMAT_TABLES
-
IO_BLOCKING_COEFFICIENT
-
MANUAL_RESULT_EXPIRY_LIMIT
How many days before a manually configured test result expires and goes back to pending. -
MANUAL_TASK_INSTRUMENTATION
Set this property to true if you don't want Serenity to try to instrument tasks for you. -
SERENITY_EXTENSION_PACKAGES
The root package or packages used to look for Serenity extension classes, as a comma-separated list. -
WEBDRIVER_CREATION_RETRY_CAUSES
A semi-colon list of (partial) error messages. If WebDriver creation fails for a reason mentioned in this list, Serenity will retry driver creation every thirty seconds for at most WEBDRIVER_CREATION_RETRY_MAX_TIME times (the default is 30) The default recognises BrowserStack timeouts ("All parallel tests are currently in use") -
WEBDRIVER_CREATION_RETRY_MAX_TIME
-
SERENITY_INCLUDE_ACTOR_NAME_IN_CONSEQUENCES
If set to true, the name of the actor will appear in "should" statements for Screenplay tests. -
LEGACY_WAIT_FOR_TEXT
Wait for an element to be visible and fail if the element is not visible. By default, this behaviour is deactivated as of version 2.0.49, and the behaviour of getText() replicates the standard Selenium behavior of returning an empty string if an element is not visible. -
ENVIRONMENT
-
SERENITY_ENABLE_WEBDRIVER_IN_FIXTURE_METHODS
Enable WebDriver calls in @After methods, even after a step has failed (true by default). -
EDGE_OPTIONS
Use this property to pass options to Edge driver using the 'ms:edgeOptions' capability option. For example: """{"args": ["headless", "start-maximized", "disable-gpu"]}""" -
IE_OPTIONS_ENABLE_NATIVE_EVENTS
-
IE_OPTIONS_IGNORE_ZOOM_LEVEL
-
IE_OPTIONS_REQUIRE_WINDOW_FOCUS
-
REPORT_TAGTYPE_TITLE
The title to appear in the tag type table in the email reports
-
-
Field Details
-
DEFAULT_HEIGHT
public static final int DEFAULT_HEIGHT- See Also:
- Constant Field Values
-
DEFAULT_WIDTH
public static final int DEFAULT_WIDTH- See Also:
- Constant Field Values
-
DEFAULT_HISTORY_DIRECTORY
public static final java.lang.String DEFAULT_HISTORY_DIRECTORY- See Also:
- Constant Field Values
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getPropertyName
public java.lang.String getPropertyName() -
getLegacyPropertyName
public java.lang.String getLegacyPropertyName() -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Enum<ThucydidesSystemProperty>
-
optionalFrom
public java.util.Optional<java.lang.String> optionalFrom(EnvironmentVariables environmentVariables) -
from
-
preferredName
public java.lang.String preferredName() -
legacyNames
public java.util.List<java.lang.String> legacyNames() -
from
public java.lang.String from(EnvironmentVariables environmentVariables, java.lang.String defaultValue) -
integerFrom
-
integerFrom
-
booleanFrom
-
booleanFrom
public java.lang.Boolean booleanFrom(EnvironmentVariables environmentVariables, java.lang.Boolean defaultValue) -
isDefinedIn
-