- All Implemented Interfaces:
Serializable,Comparable<ThucydidesSystemProperty>,java.lang.constant.Constable
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
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSet to true to activate the AcceptInsecureCertificates options for Chrome and Firefox.List of capabilities that should be provided in addition to supported by w3c or Appium.The device name used for Appium tests(Experimental) Specifies a list of devices to be used for parallel testing.Set to true to enable processing of desired capabilities, created from the provided 'appium:' properties.Unique device identifier of the connected physical device used for appium testsBrowserstack uses this property for desktop browsers, like firefox, chrome and IE.Browserstack uses this one for android and iphone.Specify a name for a logical group of tests on BrowserStackGenerates screenshots at various steps in tests on BrowserStackBrowserStack mobile device name on which tests should be runSet the screen orientation of BrowserStack mobile deviceSpecify the Internet Explorer webdriver version on BrowserStackEnable the popup blocker in Internet Explorer on BrowserStackDisable flash on Internet Explorer on BrowserStackFor Testing against internal/local servers on BrowserStackSpecify a name for a logical group of builds on BrowserStackSets resolution of VM on BrowserStackSpecify an identifier for the test run on BrowserStackBrowserStack Hub URL if running the tests on BrowserStack CloudPath to the Chrome binary, if it is not on the system path.Set this to true to activate the "w3c" experimental option for chrome.Path to a Chrome-driver specific extensions fileArguments to be passed to the Chrome driver, separated by commas.Provide a text that distinguishes tests run in a particular environment or context from the same test run in a different environment or context.Property used to define the current target version for manual tests defined in Cucumber scenarios with the @manual and @@last-version-tested annotations.If set, this will define the list of tag types to be excluded from the dashboard screensIf set, this will define the list of tag types to appear on the dashboard screensSet this to true if you want Serenity to report nested step structures for subsequent steps after a step failure.Delete the history directory before a new set of results is recordedA shortcut for 'webdriver.driver'.Used to specify either chrome options or firefox preferences, depending on which driver is being used.Use this property to pass options to Edge driver using the 'ms:edgeOptions' capability option.If set to true (the default), allow markdown formatting in test outcome titles and descriptions.What encoding to use for reading Cucumber feature files?What (human) language are the Cucumber feature files written in?An alternative to gecko.firefox.optionsThe character to be used to separate firefox preference key-value pairs when using the "firefox.preferences" property.Preferences to be passed to the Firefox driver, separated by semi-colons (commas often appear in the preference values.Use this property to pass options to Marionette using the 'moz:firefoxOptions' capability option.Activate headless mode for chrome, firefox or edgeLegacy form of "serenity.report.exclude.tags"If set to true, don't format embedded tables in JBehave or Gherkin steps.If provided, each test in a test run will have these tags added.If defined, the JIRA password required to connect to JIRA.If defined, the JIRA project id will be prepended to issue numbers.If the base JIRA URL is defined, Thucydides will build the issue tracker url using the standard JIRA form.If defined, the JIRA username required to connect to JIRA.What charset to use for JSON processing.Format the JSON test outcomes nicely.Wait for an element to be visible and fail if the element is not visible.Should Serenity Manage your appium servers for youHow many days before a manually configured test result expires and goes back to pending.Set this property to true if you don't want Serenity to try to instrument tasks for you.What test result (success,ignored, or pending) should be shown for manual annotated tests in the reports?If set to true, Asciidoc formatting will be supported in the narrative texts.What format should test results be generated in.Allows you to override the default serenity.properties location for properties file.Record failures to a file specified by property rerun.failures.file or rerun.xml in current directoryDon't accept sites using untrusted certificates.Replay failures from a file specified by property rerun.failures.file or rerun.xml in current directoryWhere to find images used in the reports (defaults to src/test/resources/assets)What charset to use for report generation.If set, this will define the list of tag types which will be not formatted with title case in HTML report.The maximum number of entries to appear on report scoreboards (default 5)A subtitle to appear in the Serenity HTML reports.The title to appear in the tag type table in the email reportsWhat tag types should be listed in the report summaryFine-tune the number of threads Serenity uses for report generation.Location of the directory where the failure files are recorded.Instruct the SafariDriver to delete all existing session data when starting a new session (true by default)SauceLabs access key - if provided, Thucydides can generate links to the SauceLabs reports that don't require a login.SauceLabs datacenter used for interaction with SauceLabs API and adding link to Serenity report Examples: US: us-west-1 Europe: eu-central-1Override the default implicit timeout value for the Saucelabs driver.Saucelabs records screenshots as well as videos by default.Saucelabs URL, including username and api keySauceLabs user id - if provided with the access key, Thucydides can generate links to the SauceLabs reports that don't require a login.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.Enable applets in Firefox.Activate the Firebugs plugin for firefox.If set to true, automatically add a contextual tag to each test with the name of the browser the test was run on.Include context tags with a test if one is provided.If set to true, automatically add a contextual tag to each test with the name of the operating system the test was run on.Use this property if you need to completely override the location of requirements for the Annotated Provider.A deprecated property that is synonymous with thucydides.batch.sizeIf batch testing is being used, this is the number of the batch being run on this machine.If batch testing is being used, this is the size of the batches being executed.Batch strategy to use for parallel batches.Set the browser o full screen mode before tests are executedRedimension the browser to enable larger screenshots.Set to true to get WebDriver to maximise the Browser window before the tests are executed.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)Redimension the browser to enable larger screenshots.If set to false, render report names in a readable form as opposed to a hash format.If set, Serenity will scale down the screenshots taken during execution to the size of the carousel in the screenshot page.Comma-separated list of exception classes that should produce a compromised test in the reports.Default name of report with configurations.Write the console banner using ascii-art ("ascii", default value) or in smaller text ("normal")Use ASCII color codes when outputing the console logs.Write the console headings using ascii-art ("ascii", default value) or in normal text ("normal")Add extra columns to the CSV output, obtained from tag values.Where Serenity stores local data.When multiple actors are used with the Screenplay pattern, a separate browser is configured for each actor.Normally, REST calls are disabled when a failure occurs.Set to true to write the chronological number of each test as it is executed to the consoleA set of user-defined capabilities to be used to configure the WebDriver driver.Possible values are:none, eager or normalPossible values are: accept, dismiss, accept and notify, dismiss and notify, ignoreRun through the steps without actually executing them.Enable WebDriver calls in @After methods, even after a step has failed (true by default).Comma-separated list of exception classes that should produce an error in the reports.The estimated number of steps in a pending scenario.The estimated number of tests in a typical story.Deprecated.Extension packages.The root package or packages used to look for Serenity extension classes, as a comma-separated list.Comma-separated list of exception classes that should produce a failure in the reports.Override the directory name for the directory containing feature files.Timeout (in seconds) for retrying file I/O.Default name of folder, with reports about test flow and aggregation report generationIf batch testing is being used in a multithreaded environment, this is the number of forks that will be created.If batch testing is being used in a multithreaded environment, this is the executing fork number.Deprecated.Generate a CSV report for each test result (false by default)Base directory in which history files are stored.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.The home directory for Thucydides output and data files - by default, $USER_HOME/.thucydidesIf set to true, the name of the actor will appear in "should" statements for Screenplay tests.Base URL for the issue tracking system to be referred to in the reports.The JIRA workflow is defined in this file.If set to true, JIRA Workflow is active.Enable JQuery integration.If set to true, a copy of the original screenshot will be kept when screenshots are scaled for the reports.A comma-separated list of tag types for which human-readable report names will be generated.Normally, Serenity uses SmartElementLocatorFactory, an extension of the AjaxElementLocatorFactory when instantiating page objects.Four levels are supported: NONE, QUIET, NORMAL and VERBOSE - NONE: Disable Serenity logging - QUIET: Only report compromised tests, errors and failuresDetermine what the lowest level requirement (test cases, feature files, story files, should be called.Keep the Serenity session data between tests.When creating steps that contain references to other steps serenity does a recursion check to prevent cyclic references.Activate native events in Firefox.Where should reports be generated (use the system property 'serenity.outputDirectory').Comma-separated list of exception classes that should produce a pending test in the reports.A unique identifier for the project under test, used to record test statistics.What name should appear on the reportsSpecifies the URL to be used for proxy auto-configuration.Specifies whether to autodetect proxy settings.Specify which proxy to use for FTP connections.HTTP Proxy URL configuration Specify which proxy to use for HTTP connections.HTTP Proxy port configuration Use 'thucydides.proxy.http_port'Sets proxy bypass (noproxy) addresses The proxy bypass (noproxy) addresses separated by commasHTTP Proxy password configurationGets the SOCKS proxy's password.Specifies which proxy to use for SOCKS.Specifies a username for the SOCKS proxy.Specifies which version of SOCKS to use (4 or 5).Specify which proxy to use for SSL connections.SSL Proxy port configuration - serenity.proxy.sslProxyPortExplicitly sets the proxy type, useful for forcing direct connection on Linux.HTTP Proxy username configurationPublic URL where the Thucydides reports will be displayed.What tag names identify the release types (e.g.Use patterns as well as colors for the graphs and charts.Encoding for reports outputA comma-separated list of tags which should not be included the reports.Set to true to only display requirements that contain test outcomes.Indicates a directory from which the resources for the HTML reports should be copied.Show statistics for manual tests in the test reports.Report on releasesAlternative to report.tagtypesIf set to true (the default value), Serenity will report on test duration in the test results.Link to the generated Serenity report to embed in the emailable summary report.Should Thucydides display detailed information in the test result tables.When deriving requirement types from a path, exclude any values from this comma-separated list.The hierarchy of requirement types.The maximum number of features allowed in the requirements cache.Use this property if you need to completely override the location of requirements for the File System Provider.If set, resize screenshots to this size to save space.Indicate when a browser should be restarted during a test run.Restart the browser every so often during data-driven tests.Specify the screenshot tool to be used to take screenshots.Deprecated.If set to true, the full description of the parent story or feature is displayed at the top of an individual test report.Comma-separated list of exception classes that should produce a skipped test in the reports.Pause (in ms) between each test step.Configure whether to store the HTML source with screenshots.Same as serenity.features.directory but for src/test/storiesWhat file name should be used for the email summary report (defaults to serenity-summary.html)What name should appear on the email summary reportIf set to true, add a tag for test failures, based on the error type and messageFine-grained control over when screenshots are to be taken.The base directory in which requirements are kept.The root package for the tests in a given project.if specified, should point to a folder that contains one or more Serenity CSV output filesDeprecated.This property is no longer supported: use the W3C properties instead.By default, Thucydides will read requirements from the directory structure that contains the stories.If set to true, WebElementFacade events and other step actions will be logged to the console.Should we assume that collections of webdriver elements are already on the page, or if we should wait for them to be available.Disable Webdriver integration.Show the full test results in the emailable reportsIf set to true, historical flags will be displayed in test lists.Display the pie charts on the dashboard by default.If set, this will display the related tag statistics on the home page.Stack traces are by default decluttered for readability.By default, new @Steps libraries are made as new instances, unless declared `shared`, in which case they are cached by type.If provided, only classes and/or methods with tags in this list will be executed.Use this property to specify the maximum number of times to rerun the failing tests.Use this property to specify the maximum number of times to rerun the failing tests for cucumber tests.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Display the context in the test title.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.This property is still supported, but thucydides.take.screenshots provides more fine-grained control.Deprecated.Sets a number of common chrome options useful for automated testing.If the Gecko Driver is on the system path, it will be used (with Marionnette) by default.If set to true (the default value), a story tag will be extracted from the test case or feature file containing the test.If the automatic webdriver download should happen.The default starting URL for the application, and base URL for relative paths.Used to identify the current driver using the W3C capabililitesOld property for chrome.binaryPath to the Chrome driver, if it is not on the system path.A semi-colon list of (partial) error messages.If we can't create the webdriver for some reason (for example, all parallel tests are in use), we wait for a short delay and try again a number of times.If we can't create the webdriver for some reason (for example, all parallel tests are in use), we wait for a short delay and try again a number of times.The WebDriver driver - firefox, chrome, iexplorer, safari.Path to the Edge driver, if it is not on the system path.Full path to the Firefox profile to be used with Firefox.Path to the Gecko driver binaryPath to the Internet Explorer driver, if it is not on the system path.The minimum time to wait between screenshots.If using a provided driver, what type is it.The driver to be used for remote driversThe URL to be used for remote drivers (including a selenium grid hub)If set to true, PageObject find methods will retry after a short pause when a stale element exception occurs.Synonym for webdriver.wait.for.timeoutDeprecated.Use the timeouts section in the webdriver.capabilities block in serenity.conf, For example: webdriver { capabilities { timeouts { script = 30000 pageLoad = 300000 implicit = 0 } } }Try to create a Chrome driver using a driver service poolUse this property to set how long webdriver should wait x second for an alert to be present before throwing an exception.How long webdriver waits by default when you use a fluent waiting method, in milliseconds. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionbooleanFrom(EnvironmentVariables environmentVariables) booleanFrom(EnvironmentVariables environmentVariables, Boolean defaultValue) from(EnvironmentVariables environmentVariables) from(EnvironmentVariables environmentVariables, String defaultValue) intintegerFrom(EnvironmentVariables environmentVariables) intintegerFrom(EnvironmentVariables environmentVariables, int defaultValue) booleanisDefinedIn(EnvironmentVariables environmentVariables) longlongFrom(EnvironmentVariables environmentVariables, long defaultValue) optionalFrom(EnvironmentVariables environmentVariables) toString()static ThucydidesSystemPropertyReturns 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.
-
Enum Constant Details
-
WEBDRIVER_DRIVER
The WebDriver driver - firefox, chrome, iexplorer, safari. -
DRIVER
A shortcut for 'webdriver.driver'. -
WEBDRIVER_CAPABILITIES_BROWSERNAME
Used to identify the current driver using the W3C capabililites -
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) -
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_RETRY_ON_STALE_ELEMENT_EXCEPTION
If set to true, PageObject find methods will retry after a short pause when a stale element exception occurs. -
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.Use serenity.project.key instead -
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.Use serenity.home instead -
SERENITY_HOME
The home directory for Thucydides output and data files - by default, $USER_HOME/.thucydides -
THUCYDIDES_REPORT_RESOURCES
Deprecated.Use serenity.report.resources -
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 contain 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. -
SERENITY_REPORT_EXCLUDE_TAGS
A comma-separated list of tags which should not be included the reports. This can be helpful for technical tags which are not relevant to documentation, and can reduce the size and time taken to produce the reports. -
HIDDEN_TAGS
Legacy form of "serenity.report.exclude.tags" -
THUCYDIDES_REPORT_SHOW_RELEASES
Deprecated. -
SERENITY_REPORT_SHOW_RELEASES
Report on releases -
SERENITY_REPORT_ACCESSIBILITY
Use patterns as well as colors for the graphs and charts. -
SERENITY_REPORT_DURATIONS
-
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_REPORT_HIDE_EMPTY_REQUIREMENTS
Set to true to only display requirements that contain test outcomes. Useful when running a test suite with a filter. -
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.This property is no longer supported: use the W3C properties 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. -
THUCYDIDES_PROXY_TYPE
Deprecated. -
THUCYDIDES_PROXY_USER
Deprecated. -
THUCYDIDES_PROXY_PASSWORD
Deprecated. -
SERENITY_PROXY_HTTP
HTTP Proxy URL configuration Specify which proxy to use for HTTP connections. Expected format is hostname:1234 -
SERENITY_PROXY_HTTP_PORT
HTTP Proxy port configuration Use 'thucydides.proxy.http_port' -
SERENITY_PROXY_USER
HTTP Proxy username configuration -
SERENITY_PROXY_PASSWORD
HTTP Proxy password configuration -
SERENITY_PROXY_SSL_PORT
SSL Proxy port configuration - serenity.proxy.sslProxyPort -
SERENITY_PROXY_SSL
Specify which proxy to use for SSL connections. Expected format is hostname.com:1234 -
SERENITY_PROXY_FTP
Specify which proxy to use for FTP connections. -
SERENITY_PROXY_AUTODETECT
Specifies whether to autodetect proxy settings. Set to true to use proxy auto detection, false to leave proxy settings unspecified -
SERENITY_PROXY_NOPROXY
Sets proxy bypass (noproxy) addresses The proxy bypass (noproxy) addresses separated by commas -
SERENITY_PROXY_TYPE
Explicitly sets the proxy type, useful for forcing direct connection on Linux. Takes a value of org.openqa.selenium.Proxy.ProxyType: DIRECT, MANUAL, PAC, RESERVED_1, AUTODETECT, SYSTEM, UNSPECIFIED -
SERENITY_PROXY_AUTOCONFIG
Specifies the URL to be used for proxy auto-configuration. Expected format is http://hostname.com:1234/pacfile. This is required if getProxyType() is set to Proxy.ProxyType.PAC, ignored otherwise. -
SERENITY_PROXY_SOCKS_PROXY
Specifies which proxy to use for SOCKS. Expected format is hostname.com:1234 -
SERENITY_PROXY_SOCKS_USERNAME
Specifies a username for the SOCKS proxy. Supported by SOCKS v5 and above. -
SERENITY_PROXY_SOCKS_PASSWORD
Gets the SOCKS proxy's password. Supported by SOCKS v5 and above. -
SERENITY_PROXY_SOCKS_VERSION
Specifies which version of SOCKS to use (4 or 5). -
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
Deprecated.Use the timeouts section in the webdriver.capabilities block in serenity.conf, For example: webdriver { capabilities { timeouts { script = 30000 pageLoad = 300000 implicit = 0 } } }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. Set to false by default in Serenity 3.x -
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.model.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, Serenity 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 requirements hierarchy associated with a test. Technical note: If you are using the File System Requirements provider, Serenity 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)
-
SERENITY_STORE_HTML
Configure whether to store the HTML source with screenshots. Possible values are: - ALWAYS - store HTML source code for every screenshot - FAILURES - store HTML source code for failing tests - NEVER - don't store HTML source code Set to FAILURES by default. -
THUCYDIDES_KEEP_UNSCALED_SCREENSHOTS
Deprecated. -
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" -
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 (false 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. -
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_REPORT_TEST_DURATIONS
If set to true (the default value), Serenity will report on test duration in the test results. This provides richer reports but takes more space, so you can turn it off if you prefer to save 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 invalid input: '&' stitch method - VERTICAL_SCROLL:vertical scroll page screenshot using scroll invalid input: '&' stitch method - HORIZONTAL_SCROLL: horizontal scroll page screenshot using scroll invalid input: '&' 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. -
SERENITY_ADD_CONTEXT_TAG
Include context tags 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 Serenity session data between tests. Normally, the session data is cleared between tests, but it can sometimes be useful to preserve this data. When using @BeforeAll methods in JUnit or Cucumber, you need to set this variable to true to use values set in these methods. -
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, firefox or edge -
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_CAPABILITIESwill 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 -
SERENITY_REPORT_TAGTYPES
Alternative to report.tagtypes -
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_DELAY
If we can't create the webdriver for some reason (for example, all parallel tests are in use), we wait for a short delay and try again a number of times. This is the time we wait between retries. The default is 5 seconds. -
WEBDRIVER_CREATION_RETRY_COUNT
If we can't create the webdriver for some reason (for example, all parallel tests are in use), we wait for a short delay and try again a number of times. This is the maximum number of times we try to create the webdriver. The default is 6. -
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 -
SERENITY_REQUIREMENTS_CACHE_HEAP_SIZE
The maximum number of features allowed in the requirements cache. -
SERENITY_ADD_OS_TAG
If set to true, automatically add a contextual tag to each test with the name of the operating system the test was run on. False by default. -
SERENITY_ADD_BROWSER_TAG
If set to true, automatically add a contextual tag to each test with the name of the browser the test was run on. False by default. -
WEBDRIVER_WAIT_FOR_ALERT_TIMEOUT
Use this property to set how long webdriver should wait x second for an alert to be present before throwing an exception.
-
-
Field Details
-
DEFAULT_HEIGHT
public static final int DEFAULT_HEIGHT- See Also:
-
DEFAULT_WIDTH
public static final int DEFAULT_WIDTH- See Also:
-
DEFAULT_HISTORY_DIRECTORY
- See Also:
-
-
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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getPropertyName
-
getLegacyPropertyName
-
toString
- Overrides:
toStringin classEnum<ThucydidesSystemProperty>
-
optionalFrom
-
from
-
preferredName
-
legacyNames
-
from
-
integerFrom
-
integerFrom
-
longFrom
-
booleanFrom
-
booleanFrom
-
isDefinedIn
-