Neodymium Context

The Neodymium context is a thread-local helper class, accessible via Neodymium, that provides essential methods and properties for your test execution.

Every test method runs in its own thread with a unique context. This context contains:

• All test data.
• The currently used WebDriver instance.
• Localization data.
• An instance of the NeodymiumConfiguration class.

This structure allows you to access and modify settings and test data strictly within a single test without affecting other concurrent tests.

Accessing Contextual Data

Data

To access your test data, use:

Neodymium.getData().get("<dataKey>"); // get the map entry directly
Neodymium.getData().asString("<dataKey>"); // get the map entry parsed as String (available for multiple types)

See the test data chapter for more information and convenience methods related to test data.

Localization

The Neodymium class offers access to the Localization feature:

Neodymium.localizedText("<LocalizationKey>");

Configuration

You can access the instantiated version of the NeodymiumConfiguration class to retrieve any configuration setting:

Neodymium.configuration().<settingFunctionName>()

WebDriver and Browser Management

WebDriver Access

You can retrieve different types of WebDriver instances as needed:

Browser Information

To take special actions based on the running browser or profile:

• Browser Profile Name: Retrieve the name of the used browser profile:

  Neodymium.getBrowserProfileName()
  

• Browser Type/Name: Retrieve the browser name (type) for interactions specific to that browser:

  Neodymium.getBrowserName()
  

• Local Proxy: If an embedded local proxy is used, its instance can be retrieved for additional scenarios:

  Neodymium.getLocalProxy()
  

Execution State

The current state and objects belonging to the execution can be retrieved using:

Neodymium.getWebDriverStateContainer()

The retrieved WebDriverStateContainer includes the current WebDriver, the embedded local BrowserUpProxy (if used), and a counter indicating how often the current execution setup has been utilized.

Site and Locale

Site Check

The Neodymium.isSite(String... sites) function allows you to check if the current configured site matches one or more provided site identifiers:

    // check against one site identifier 
    if(Neodymium.isSite("UK"))
    {
        // ...
    }

    // check against multiple site identifiers
    if(Neodymium.isSite("US","DE","JP"))
    {
        // ...
    }

Locale Check

Similarly, the Neodymium.isLocale(String... locales) method checks the current configured locale against a list of target locales:

    // check against one locale
    if(Neodymium.isLocale("en_US"))
    {
        // ...
    }

    // check against multiple locales
    if(Neodymium.isLocale("en_US","de_DE","jp_JP"))
    {
        // ...
    }

Web Site Dimensions

Convenience functions are provided to determine the current device category based on the browser viewport width. This is useful for adapting locators or interactions for sites optimized for different devices.

NOTE: The following values are defaults and can be configured in the config/neodymium.properties file.

Additionally, you can directly access the current dimensions of the browser elements:

Miscellaneous

Version

The Neodymium version can be retrieved using:

Neodymium.getNeodymiumVersion()

Fixed Random Support

Neodymium provides access to the current Random instance, which is useful for maintaining a fixed random setup for repeating runs from CI executions:

Neodymium.getRandom()