GaleniumConfiguration (Galenium Core 5.0.0-SNAPSHOT API)

java.lang.Object
- io.wcm.qa.glnm.configuration.GaleniumConfiguration

```
public final class GaleniumConfiguration
extends Object
```
Central place to integrate test run and environment configuration from Maven et al.

Since:

1.0.0

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getActualImagesDirectory()` The root directory for storing sample images of current run.
`static String`	`getAuthorPass()` Password to use when logging into author.
`static String`	`getAuthorUser()` Username to use when logging into author.
`static String`	`getBaseUrl()` The base URL to use when running tests.
`static String`	`getChromeBinaryPath()` Path to Chrome binary which is passed to driver.
`static int`	`getDefaultWebdriverTimeout()` Default timeout for webdriver in seconds.
`static String`	`getExpectedImagesDirectory()` Path to root folder of expected image samples to verify against.
`static String`	`getGalenJsTestPath()` Path to root folder containing Galen JS tests.
`static String`	`getGalenSpecPath()` Path to root folder containing Galen specs.
`static String`	`getGridHost()` Selenium Grid hostname or address.
`static int`	`getGridPort()` Selenium Grid port number.
`static String`	`getHttpPass()` HTTP password to use in HTTP basic auth.
`static String`	`getHttpUser()` HTTP username to use in HTTP basic auth.
`static Integer`	`getMediaQueryHeight()` Height to use when instantiating devices using media queries.
`static Integer`	`getMediaQueryMaximalWidth()` Height to use when instantiating devices using media queries.
`static Integer`	`getMediaQueryMinimalWidth()` Height to use when instantiating devices using media queries.
`static String`	`getMediaQueryPropertiesPath()` Path to media query definitions.
`static int`	`getNumberOfBrowserInstantiationRetries()` Number of retries when instantiating browsers.
`static int`	`getNumberOfRetries()` Number of retries for failed tests.
`static String`	`getReportDirectory()` Report root folder.
`static String`	`getTestLogDirectory()` Test log root folder.
`static String`	`getTextComparisonOutputDirectory()` Directory to retrieve the text samples from.
`static boolean`	`isFixChromeImageComparison()` Headless Chrome Windows workaround flag.
`static boolean`	`isHeadless()` Headless browser flag.
`static boolean`	`isLazyWebDriverInitialization()` Lazy web driver intialization takes control away from WebDriverListener and lets the test itself decide when or whether to initialize a webdriver.
`static boolean`	`isOnlyReportGalenErrors()` Only report Galen errors and leave successful tests out of report.
`static boolean`	`isSamplingVerificationIgnore()` Ignore sampling verification errors and continue running test.
`static boolean`	`isSkipExtentReports()` Usually Galenium will log to ExtentReports, but it can be skipped.
`static boolean`	`isSparseReporting()` Sparse reporting is a different set of logging configuration.
`static boolean`	`isSuppressAutoAdjustBrowserSize()` Adjusting the browser size is important to ensure the correct viewport size, but it can lead to problems with certain browser/driver/OS combinations.
`static boolean`	`isTakeScreenshotOnSkippedTest()` Take screenshots for skipped tests.
`static boolean`	`isTakeScreenshotOnSuccessfulTest()` Take screenshots for successful tests.
`static boolean`	`isWebDriverAcceptTrustedSslCertificatesOnly()` Control whether to only accept secure SSL certificates Key:
`static boolean`	`isWebDriverAlwaysNew()` Control whether to attempt reuse of drivers.
`static boolean`	`isWebDriverRefuseSslCertificates()` Control whether to refuse SSL certificates Key:

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

- Method Detail
  - getActualImagesDirectory
```
public static String getActualImagesDirectory()
```
    The root directory for storing sample images of current run.
    - Key:
      galenium.sampling.image.directory.actual
    - Default:
      "./target/galenium-reports"
    Returns:
    
    path to root folder
    
    Since:
    
    3.0.0
  - getAuthorPass
```
public static String getAuthorPass()
```
    Password to use when logging into author.
    - Key:
      io.wcm.qa.aem.author.pass
    - Default:
      "admin"
    Returns:
    
    password to author instance
    
    Since:
    
    3.0.0
  - getAuthorUser
```
public static String getAuthorUser()
```
    Username to use when logging into author.
    - Key:
      io.wcm.qa.aem.author.user
    - Default:
      "admin"
    Returns:
    
    username for author instance
    
    Since:
    
    3.0.0
  - getBaseUrl
```
public static String getBaseUrl()
```
    The base URL to use when running tests. This is the URL called from the browsers when controlled by Selenium. You can add basic HTTP auth if needed for your SUTs.
    - Key:
      io.wcm.qa.baseUrl
    - Default:
      "http://localhost:4502"
    Returns:
    
    base URL with HTTP basic auth, if configured
    
    Since:
    
    3.0.0
  - getChromeBinaryPath
```
public static String getChromeBinaryPath()
```
    Path to Chrome binary which is passed to driver.
    - Key:
      galenium.webdriver.chrome.binary
    - Default:
      null
    Returns:
    
    path to chrome binary or null
    
    Since:
    
    3.0.0
  - getDefaultWebdriverTimeout
```
public static int getDefaultWebdriverTimeout()
```
    Default timeout for webdriver in seconds.
    - Key:
      galenium.webdriver.timeout
    - Default:
      10
    Returns:
    
    default timeout used by Galenium
    
    Since:
    
    3.0.0
  - getExpectedImagesDirectory
```
public static String getExpectedImagesDirectory()
```
    Path to root folder of expected image samples to verify against.
    - Key:
      galenium.sampling.image.directory.expected
    - Default:
      "./target/specs"
    Returns:
    
    path to root folder of expected image samples
    
    Since:
    
    3.0.0
  - getGalenJsTestPath
```
public static String getGalenJsTestPath()
```
    Path to root folder containing Galen JS tests.
    - Key:
      galenium.jsTestPath
    - Default:
      getGalenSpecPath()
    Returns:
    
    path to root folder of Galen JS tests
    
    Since:
    
    3.0.0
  - getGalenSpecPath
```
public static String getGalenSpecPath()
```
    Path to root folder containing Galen specs.
    - Key:
      galenium.specPath
    - Default:
      "./target/specs"
    Returns:
    
    path to root folder of Galen specs
    
    Since:
    
    3.0.0
  - getGridHost
```
public static String getGridHost()
```
    Selenium Grid hostname or address.
    - Key:
      selenium.host
    - Default:
      null
    Returns:
    
    Selenium Grid host
    
    Since:
    
    3.0.0
  - getGridPort
```
public static int getGridPort()
```
    Selenium Grid port number.
    - Key:
      selenium.port
    - Default:
      4444
    Returns:
    
    Selenium Grid port number
    
    Since:
    
    3.0.0
  - getHttpPass
```
public static String getHttpPass()
```
    HTTP password to use in HTTP basic auth.
    - Key:
      io.wcm.qa.http.pass
    - Default:
      null
    Returns:
    
    HTTP password
    
    Since:
    
    3.0.0
  - getHttpUser
```
public static String getHttpUser()
```
    HTTP username to use in HTTP basic auth.
    - Key:
      io.wcm.qa.http.user
    - Default:
      null
    Returns:
    
    HTTP username
    
    Since:
    
    3.0.0
  - getMediaQueryHeight
```
public static Integer getMediaQueryHeight()
```
    Height to use when instantiating devices using media queries.
    - Key:
      galenium.mediaquery.height
    - Default:
      800
    Returns:
    
    height for use with device creation
    
    Since:
    
    3.0.0
  - getMediaQueryMaximalWidth
```
public static Integer getMediaQueryMaximalWidth()
```
    Height to use when instantiating devices using media queries.
    - Key:
      galenium.mediaquery.width.max
    - Default:
      2000
    Returns:
    
    minimal width to use with media query instantiation
    
    Since:
    
    3.0.0
  - getMediaQueryMinimalWidth
```
public static Integer getMediaQueryMinimalWidth()
```
    Height to use when instantiating devices using media queries.
    - Key:
      galenium.mediaquery.width.min
    - Default:
      320
    Returns:
    
    minimal width to use with media query instantiation
    
    Since:
    
    3.0.0
  - getMediaQueryPropertiesPath
```
public static String getMediaQueryPropertiesPath()
```
    Path to media query definitions.
    - Key:
      galenium.mediaquery.properties
    - Default:
      ./target/test-classes/mediaqueries.properties
    Returns:
    
    path to Properties file containing media query definitions
    
    Since:
    
    3.0.0
  - getNumberOfBrowserInstantiationRetries
```
public static int getNumberOfBrowserInstantiationRetries()
```
    Number of retries when instantiating browsers. Use this to handle flaky browser initializations.
    - Key:
      galenium.webdriver.retryMax
    - Default:
      0
    Returns:
    
    HTTP username
    
    Since:
    
    3.0.0
  - getNumberOfRetries
```
public static int getNumberOfRetries()
```
    Number of retries for failed tests. Use this to handle flaky test results.
    - Key:
      galenium.retryMax
    - Default:
      2
    Returns:
    
    maximum number of retries
    
    Since:
    
    3.0.0
  - getReportDirectory
```
public static String getReportDirectory()
```
    Report root folder.
    - Key:
      galenium.report.rootPath
    - Default:
      "./target/galenium-reports"
    Returns:
    
    root folder for storing report artefacts
    
    Since:
    
    3.0.0
  - getTestLogDirectory
```
public static String getTestLogDirectory()
```
    Test log root folder.
    - Key:
      galenium.logging.testlogs
    - Default:
      "./target/testlogs"
    Returns:
    
    root folder for storing test logs
  - getTextComparisonOutputDirectory
```
public static String getTextComparisonOutputDirectory()
```
    Directory to retrieve the text samples from.
    - Key:
      galenium.sampling.text.directory.actual
    - Default:
      "./target/sampled"
    Returns:
    
    output directory for new baseline samples
    
    Since:
    
    3.0.0
  - isFixChromeImageComparison
```
public static boolean isFixChromeImageComparison()
```
    Headless Chrome Windows workaround flag.
    - Key:
      galenium.sampling.image.chromefix
    - Default:
      true
    Returns:
    
    whether to use workaround to fix Chrome's image comparison behavior
    
    Since:
    
    3.0.0
  - isHeadless
```
public static boolean isHeadless()
```
    Headless browser flag.
    - Key:
      galenium.headless
    - Default:
      false
    Returns:
    
    whether browser is running in headless mode
    
    Since:
    
    3.0.0
  - isLazyWebDriverInitialization
```
public static boolean isLazyWebDriverInitialization()
```
    Lazy web driver intialization takes control away from WebDriverListener and lets the test itself decide when or whether to initialize a webdriver.
    - Key:
      galenium.webdriver.lazy
    - Default:
      false
    Returns:
    
    whether to use lazy web driver initialization
    
    Since:
    
    3.0.0
  - isOnlyReportGalenErrors
```
public static boolean isOnlyReportGalenErrors()
```
    Only report Galen errors and leave successful tests out of report. This drastically reduces the size of reports in the target folder. Useful to save disk space on CI.
    - Key:
      galenium.report.galen.errorsOnly
    - Default:
      false
    Returns:
    
    whether to skip reporting of successful tests
    
    Since:
    
    3.0.0
  - isSamplingVerificationIgnore
```
public static boolean isSamplingVerificationIgnore()
```
    Ignore sampling verification errors and continue running test. This is useful when generating initial samples.
    - Key:
      galenium.sampling.verification.ignoreErrors
    - Default:
      false
    Returns:
    
    whether to ignore errors when validating samples
    
    Since:
    
    3.0.0
  - isSkipExtentReports
```
public static boolean isSkipExtentReports()
```
    Usually Galenium will log to ExtentReports, but it can be skipped.
    - Key:
      galenium.report.extent.skip
    - Default:
      false
    Returns:
    
    whether TestNG is used
    
    Since:
    
    3.0.0
  - isSparseReporting
```
public static boolean isSparseReporting()
```
    Sparse reporting is a different set of logging configuration. This allows to configure to different kinds of reporting for local development with more debugging needs and for CI which should give you a quick view of the important test steps and their results.
    - Key:
      galenium.report.sparse
    - Default:
      false
    Returns:
    
    whether to use sparse reporting on this run
    
    Since:
    
    3.0.0
  - isSuppressAutoAdjustBrowserSize
```
public static boolean isSuppressAutoAdjustBrowserSize()
```
    Adjusting the browser size is important to ensure the correct viewport size, but it can lead to problems with certain browser/driver/OS combinations.
    - Key:
      galenium.suppressAutoAdjustBrowserSize
    - Default:
      false
    Returns:
    
    whether to skip automatic adjusting of browser size
    
    Since:
    
    3.0.0
  - isTakeScreenshotOnSkippedTest
```
public static boolean isTakeScreenshotOnSkippedTest()
```
    Take screenshots for skipped tests.
    - Key:
      galenium.screenshotOnSkipped
    - Default:
      false
    Returns:
    
    whether to take and store screenshots of skipped tests for reporting
    
    Since:
    
    3.0.0
  - isTakeScreenshotOnSuccessfulTest
```
public static boolean isTakeScreenshotOnSuccessfulTest()
```
    Take screenshots for successful tests.
    - Key:
      galenium.screenshotOnSuccess
    - Default:
      false
    Returns:
    
    whether to take and store screenshots of successful tests for reporting
    
    Since:
    
    3.0.0
  - isWebDriverAcceptTrustedSslCertificatesOnly
```
public static boolean isWebDriverAcceptTrustedSslCertificatesOnly()
```
    Control whether to only accept secure SSL certificates
    - Key:
      galenium.webdriver.ssl.trusted
    - Default:
      false
    Returns:
    
    whether browser accepts secure SSL certificates only
    
    Since:
    
    3.0.0
  - isWebDriverAlwaysNew
```
public static boolean isWebDriverAlwaysNew()
```
    Control whether to attempt reuse of drivers.
    - Key:
      galenium.webdriver.alwaysNew
    - Default:
      false
    Returns:
    
    whether to always instantiate a new webdriver for each test
    
    Since:
    
    3.0.0
  - isWebDriverRefuseSslCertificates
```
public static boolean isWebDriverRefuseSslCertificates()
```
    Control whether to refuse SSL certificates
    - Key:
      galenium.webdriver.ssl.refuse
    - Default:
      false
    Returns:
    
    whether browser refuses SSL certificates
    
    Since:
    
    3.0.0

Class GaleniumConfiguration

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getActualImagesDirectory

getAuthorPass

getAuthorUser

getBaseUrl

getChromeBinaryPath

getDefaultWebdriverTimeout

getExpectedImagesDirectory

getGalenJsTestPath

getGalenSpecPath

getGridHost

getGridPort

getHttpPass

getHttpUser

getMediaQueryHeight

getMediaQueryMaximalWidth

getMediaQueryMinimalWidth

getMediaQueryPropertiesPath

getNumberOfBrowserInstantiationRetries

getNumberOfRetries

getReportDirectory

getTestLogDirectory

getTextComparisonOutputDirectory

isFixChromeImageComparison

isHeadless

isLazyWebDriverInitialization

isOnlyReportGalenErrors

isSamplingVerificationIgnore

isSkipExtentReports

isSparseReporting

isSuppressAutoAdjustBrowserSize

isTakeScreenshotOnSkippedTest

isTakeScreenshotOnSuccessfulTest

isWebDriverAcceptTrustedSslCertificatesOnly

isWebDriverAlwaysNew

isWebDriverRefuseSslCertificates