Neodymium properties

This chapter contains all information about the Neodymium properties.

Configuration via Properties Files

Neodymium combines a couple of frameworks that all have their own configuration needs which also effects test execution. Most of these properties can be defined/overwritten with environment variables. However since this is an awkward way of configuration we introduced the file: config/neodymium.properties The file contains a collection of properties that is used to configure some aspects of the used frameworks. It doesn’t cover all the possible configurations for all the frameworks we’ve integrated. Have a look at this file since it lists all supported properties as well as their default values and its purpose.

We use Owner a framework to write powerful and flexible properties in order to avoid writing all the boilerplate code. If you are in need of your own set of global properties we encourage you to give Owner a try.

Neodymium Properties

The following properties can be configured in the config/neodymium.properties file and can be accessed via Neodymium.configuration().[propertyGetterMethod]().

Those properties can be overwritten in the following way (The system environment overwrites everything):

• the standard way via config/neodymium.properties
• configure your development environment via config/dev-neodymium.properties (This file should not be committed)
• a temporary properties file to change the configuration for a single test case during runtime ( ConfigFactory.setProperty("neodymium.temporaryConfigFile", "file:PATH/[temporaryFile].properties"))
• System.getProperties() (passing configuration properties via the -D switch on command line)
• System.getenv() (set configuration properties via your system environment e.g. PATH)

decide to use the following text or the info box

The Order in which the properties are loaded is as follows:

1. System properties
2. temporary config file (e.g. config/temp-neodymium.properties)
3. config/dev-neodymium.properties
4. System environment variables
5. config/credentials.properties
6. config/neodymium.properties

If one property exists in multiple of those places. The value of the higher ranking file is taken. This makes it possible to define config/dev-neodymium.properties for local testing without changing the setup for CI/CD, which is quite useful.

The next sections contain all properties which can be configured in Neodymium.

**sort** properties! and maybe combine them under a fitting heading?

add missing descriptions

URL

Localization

Basic authentication

Selenide

Debugging

Neodymium context

Responsive design breakpoints. Determines at which page width a site is considered to be displayed on a small, medium, large oder extra large device.

JavaScriptUtils

Proxy

HTTP proxy settings. Specify host and port of the proxy server and whether it should be used at all. If the proxy requires user authentication, make sure to provide the credentials needed. You may also configure a comma separated list of hosts that can be used directly, thus bypassing the proxy. Note that the host definitions are interpreted as regular expressions so ensure proper use of escape characters. Beside the config/neodymium.properties file the proxy configuration can be also be configured within a config/proxy.properties file. In case you need a separate file for CI environments.

Local proxy

The following settings can be used to set up an embedded local proxy. The proxy can be used with a (self-signed) certificate to authenticate the proxy that acts as a man in the middle (MITM). This certificate can be provided by the user or generated on the fly.

Browser behavior

The browser behavior describes how the browser in general conducts during test. There are a couple of properties that you can use to alter that.

Test filtering

In some projects, it’s required to execute only the test, the class name, method name, and dataset id of which match the specific regex. To do so, you have to define neodymium.testNameFilter inside of config/neodymium.properties .

SelenideAddons

AllureAddons

TestData

Work in progress

Advanced screenshot

Accessibility / Lighthouse

The Lighthouse thresholdScore properties define minimal values the tests need to achieve to pass, otherwise they will fail. Each value rages from 0.0 - 1.0 representing 0% to 100%.

Report

Selenium log level

Popup blocker

We introduced a simple popup blocker to get rid of test affecting popups on a webpage. To use it just configure add a CSS selector which targets the close button of the popup.

Credentials properties

Since we support platforms like SauceLabs and BrowserStack there is a need to store credentials to access their service. In order to use these service you need to provide a URL as well as credentials to access. Both platforms use Selenium Grid protocol which is used to remote control a web browser in the cloud. You can also set up your own browser cloud with Selenium Grid.

Look at the credentials template. It’s designed for accessing only browser automation services which usually use a URL, username and a password respective access key. These credentials are necessary to access the services that allow you to use remote browser to execute your tests. SauceLabs usually doesn’t use a password. They use an access key which is different from your password and which can be accessed through their website. So keep that in mind if you want to use such services.

In the example below there is a Firefox configuration that references the SauceLabs account from credentials file. The connection is made by the key pattern of the credentials file. browserprofile.testEnvironment.saucelabs.* defines a test environment named saucelabs which can be referenced in the browser settings as a testEnvironment. That actually means that in order to create that particular web driver defined in browser.properties the information from credentials.properties will be taken into account.

Here are the example properties from the paragraph above.

First the config/credentials.properties:

## Sauce Labs Credentials
browserprofile.testEnvironment.saucelabs.url=https://ondemand.saucelabs.com:443/wd/hub
browserprofile.testEnvironment.saucelabs.username=MyAccount
browserprofile.testEnvironment.saucelabs.password=secret

Second the config/browser.properties:

browserprofile.FF_1024x768.name=Firefox
browserprofile.FF_1024x768.browser=firefox
browserprofile.FF_1024x768.browserResolution=1024x768
browserprofile.FF_1024x768.testEnvironment=saucelabs

Browser configuration

add browser config or link it to the chapter in multi-browser?