com.levelaccess.continuum

Class ConfigProvider

java.lang.Object

com.levelaccess.continuum.ConfigProvider

public final class ConfigProvider
extends Object

This class encapsulates all Continuum configuration-related functionality defined in the user-editable src/main/resources/continuum.properties file.

Method Summary

Modifier and Type	Method and Description
static String	getAccessEngineType() Gets the value for the 'accessEngineType' key defined in continuum.properties, which is used to determine which version of Access Engine is included with this installation of Continuum and should be used.
static String	getAmpApiToken() Gets the value for the 'ampApiToken' key defined in continuum.properties, which is the AMP API token of the user to use to authenticate any requests to AMP that require authentication, e.g.
static String	getAmpInstanceUrl() Gets the value for the 'ampInstanceUrl' key defined in continuum.properties, which is the URL to the desired AMP instance from which to pull best practice data from.
static String	getAndroidAppPackage() Gets the value for the 'androidAppPackage' key defined in continuum.properties, which is the Java package name of the app to be tested, e.g.
static String	getAndroidVirtualDeviceName() Gets the value for the 'androidVirtualDeviceName' key defined in continuum.properties, which is the name of the virtual device to be tested.
static String	getConfigAsString(String key) Gets the value for a given key defined in continuum.properties.
static Set<Integer>	getDefaultStandardIds() Gets the set of IDs implied from the value of the 'getDefaultStandardIds' key defined in continuum.properties, which is a comma-delimited string of IDs of the accessibility standards to test for by default (invoke Continuum.getSupportedStandards() for a list of these).
static Boolean	getIncludePotentialAccessibilityConcerns() Gets the value for the 'includePotentialAccessibilityConcerns' key defined in continuum.properties, which is used to determine whether or not accessibility concerns that require manual review are returned in any of Continuum's test results.
static String	getiOSAutomationName() Gets the value for the 'iOSAutomationName' key defined in continuum.properties, which is the test automation driver to use.
static String	getiOSPlatformVersion() Gets the value for the 'iOSPlatformVersion' key defined in continuum.properties, which is the version of the iOS platform to be tested.
static String	getiOSWebBrowserName() Gets the value for the 'iOSWebBrowserName' key defined in continuum.properties, which is the mobile web browser to use for testing.
static String	getiOSXcodeOrgId() Gets the value for the 'iOSXcodeOrgId' key defined in continuum.properties, which is your team ID, i.e.
static String	getiOSXcodeSigningId() Gets the value for the 'iOSXcodeSigningId' key defined in continuum.properties.
static String	getMobileAppiumURL() Gets the value for the 'mobileAppiumURL' key defined in continuum.properties, which is the URL to a running Appium server.
static String	getMobileDeviceName() Gets the value for the 'mobileDeviceName' key defined in continuum.properties, which is the name of the mobile device or emulator to test with.
static String	getMobilePathToAppFile() Gets the value for the 'mobilePathToAppFile' key defined in continuum.properties, which is the absolute path to a compiled app file to be tested.
static String	getMobilePhysicalDeviceId() Gets the value for the 'mobilePhysicalDeviceId' key defined in continuum.properties, which is the ID of the physical device to tested with.
static String	getMobilePlatformName() Gets the value for the 'mobilePlatformName' key defined in continuum.properties, which is the name of the mobile platform to test with.
static Boolean	getMobileScanWebViews() Gets the value for the 'mobileScanWebViews' key defined in continuum.properties, which is used to determine whether or not Continuum should scan for accessibility concerns in the content of any visible web views.
static String	getProxyHost() Gets the value for the 'proxyHost' key defined in continuum.properties, which is the IP address or hostname of the desired proxy to route all network traffic from Continuum through.
static String	getProxyPassword() Gets the value for the 'proxyPassword' key defined in continuum.properties, which is the password for the desired proxy to route all network traffic from Continuum through.
static Integer	getProxyPort() Gets the value for the 'proxyPort' key defined in continuum.properties, which is the port of the desired proxy to route all network traffic from Continuum through.
static String	getProxyUsername() Gets the value for the 'proxyUsername' key defined in continuum.properties, which is the username for the desired proxy to route all network traffic from Continuum through.
static String	getSauceLabsAccessKey() Gets the value for the 'saucelabsAccessKey' key defined in continuum.properties, which is the Sauce Labs access key that should be used to connect to Sauce Labs.
static String	getSauceLabsChromeVersion() Gets the value for the 'saucelabsChromeVersion' key defined in continuum.properties, which is the version of Google Chrome that should be used when testing via Sauce Labs.
static String	getSauceLabsPlatform() Gets the value for the 'saucelabsPlatform' key defined in continuum.properties, which is the Sauce Labs-supported operating system that should be used when testing via Sauce Labs.
static String	getSauceLabsUsername() Gets the value for the 'saucelabsUsername' key defined in continuum.properties, which is the Sauce Labs username that should be used to connect to Sauce Labs.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAccessEngineType

public static String getAccessEngineType()

Gets the value for the 'accessEngineType' key defined in continuum.properties, which is used to determine which version of Access Engine is included with this installation of Continuum and should be used.

Returns:

String

getAmpApiToken

public static String getAmpApiToken()

Gets the value for the 'ampApiToken' key defined in continuum.properties, which is the AMP API token of the user to use to authenticate any requests to AMP that require authentication, e.g. creating/editing reports in AMP from Continuum as part of submitting test results from Continuum to AMP.

Returns:

String

getAmpInstanceUrl

public static String getAmpInstanceUrl()

Gets the value for the 'ampInstanceUrl' key defined in continuum.properties, which is the URL to the desired AMP instance from which to pull best practice data from.

Returns:

String

getAndroidAppPackage

public static String getAndroidAppPackage()

Gets the value for the 'androidAppPackage' key defined in continuum.properties, which is the Java package name of the app to be tested, e.g. 'com.example.app'. Only meant to be used when testing on Android.

Returns:

String

getAndroidVirtualDeviceName

public static String getAndroidVirtualDeviceName()

Gets the value for the 'androidVirtualDeviceName' key defined in continuum.properties, which is the name of the virtual device to be tested. Only meant to be used when testing on Android.

Returns:

String

getConfigAsString

public static String getConfigAsString(String key)

Gets the value for a given key defined in continuum.properties.

Parameters:

key - configuration key for which to fetch its value in continuum.properties

Returns:

String

getDefaultStandardIds

public static Set<Integer> getDefaultStandardIds()

Gets the set of IDs implied from the value of the 'getDefaultStandardIds' key defined in continuum.properties, which is a comma-delimited string of IDs of the accessibility standards to test for by default (invoke Continuum.getSupportedStandards() for a list of these). Set the value for the 'getDefaultStandardIds' key in continuum.properties to an empty string to not filter by any accessibility standards by default.

Returns:

String

getIncludePotentialAccessibilityConcerns

public static Boolean getIncludePotentialAccessibilityConcerns()

Gets the value for the 'includePotentialAccessibilityConcerns' key defined in continuum.properties, which is used to determine whether or not accessibility concerns that require manual review are returned in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern.getNeedsReview() return true. This setting can be toggled programmatically using Continuum.setIncludePotentialAccessibilityConcerns(boolean), overriding the value specified in continuum.properties.

Returns:

Boolean

getiOSAutomationName

public static String getiOSAutomationName()

Gets the value for the 'iOSAutomationName' key defined in continuum.properties, which is the test automation driver to use. Only meant to be used when testing on iOS.

Returns:

String

getiOSPlatformVersion

public static String getiOSPlatformVersion()

Gets the value for the 'iOSPlatformVersion' key defined in continuum.properties, which is the version of the iOS platform to be tested. Only meant to be used when testing on iOS.

Returns:

String

getiOSWebBrowserName

public static String getiOSWebBrowserName()

Gets the value for the 'iOSWebBrowserName' key defined in continuum.properties, which is the mobile web browser to use for testing. Only meant to be used when testing on iOS.

Returns:

String

getiOSXcodeOrgId

public static String getiOSXcodeOrgId()

Gets the value for the 'iOSXcodeOrgId' key defined in continuum.properties, which is your team ID, i.e. the unique 10-character string generated by Apple that is assigned to your team. Only applicable if you're testing an iOS app on a physical device. See Appium's documentation on real iOS device testing for more information.

Returns:

String

getiOSXcodeSigningId

public static String getiOSXcodeSigningId()

Gets the value for the 'iOSXcodeSigningId' key defined in continuum.properties. Only applicable if you're testing an iOS app on a physical device. See Appium's documentation on real iOS device testing for more information.

Returns:

String

getMobileAppiumURL

public static String getMobileAppiumURL()

Gets the value for the 'mobileAppiumURL' key defined in continuum.properties, which is the URL to a running Appium server. Only meant to be used when testing on a mobile platform like Android or iOS.

Returns:

String

getMobileDeviceName

public static String getMobileDeviceName()

Gets the value for the 'mobileDeviceName' key defined in continuum.properties, which is the name of the mobile device or emulator to test with. Only meant to be used when testing on a mobile platform like Android or iOS.

Returns:

String

getMobilePathToAppFile

public static String getMobilePathToAppFile()

Gets the value for the 'mobilePathToAppFile' key defined in continuum.properties, which is the absolute path to a compiled app file to be tested. For example, for Android apps, this should be the absolute path to an APK. Only meant to be used when testing on a mobile platform like Android or iOS.

Returns:

String

getMobilePhysicalDeviceId

public static String getMobilePhysicalDeviceId()

Gets the value for the 'mobilePhysicalDeviceId' key defined in continuum.properties, which is the ID of the physical device to tested with. Only meant to be used when testing on a mobile platform like Android or iOS using a physical device.

Returns:

String

getMobilePlatformName

public static String getMobilePlatformName()

Gets the value for the 'mobilePlatformName' key defined in continuum.properties, which is the name of the mobile platform to test with. Only meant to be used when testing on a mobile platform like Android or iOS.

Returns:

String

getMobileScanWebViews

public static Boolean getMobileScanWebViews()

Gets the value for the 'mobileScanWebViews' key defined in continuum.properties, which is used to determine whether or not Continuum should scan for accessibility concerns in the content of any visible web views. If enabled, any accessibility concerns that come from web views will have AccessibilityConcern.getTestContext() return Continuum.TestContext.WEB. This setting can be toggled programmatically using Continuum.setScanWebViews(boolean), overriding the value specified in continuum.properties.

Returns:

Boolean

getProxyHost

public static String getProxyHost()

Gets the value for the 'proxyHost' key defined in continuum.properties, which is the IP address or hostname of the desired proxy to route all network traffic from Continuum through. Leave blank if you don't want to use a proxy, otherwise this property is required.

Returns:

String

getProxyPassword

public static String getProxyPassword()

Gets the value for the 'proxyPassword' key defined in continuum.properties, which is the password for the desired proxy to route all network traffic from Continuum through. Leave blank if your proxy does not require a password, or if you don't want to use a proxy.

Returns:

String

getProxyPort

public static Integer getProxyPort()

Gets the value for the 'proxyPort' key defined in continuum.properties, which is the port of the desired proxy to route all network traffic from Continuum through. Leave blank if you don't want to use a proxy, otherwise this property is required.

Returns:

String

getProxyUsername

public static String getProxyUsername()

Gets the value for the 'proxyUsername' key defined in continuum.properties, which is the username for the desired proxy to route all network traffic from Continuum through. Leave blank if your proxy does not require a username, or if you don't want to use a proxy.

Returns:

String

getSauceLabsAccessKey

public static String getSauceLabsAccessKey()

Gets the value for the 'saucelabsAccessKey' key defined in continuum.properties, which is the Sauce Labs access key that should be used to connect to Sauce Labs. Only meant to be used when testing with Sauce Labs.

Returns:

String

getSauceLabsChromeVersion

public static String getSauceLabsChromeVersion()

Gets the value for the 'saucelabsChromeVersion' key defined in continuum.properties, which is the version of Google Chrome that should be used when testing via Sauce Labs. Only meant to be used when testing with Sauce Labs.

Returns:

String

getSauceLabsPlatform

public static String getSauceLabsPlatform()

Gets the value for the 'saucelabsPlatform' key defined in continuum.properties, which is the Sauce Labs-supported operating system that should be used when testing via Sauce Labs. Only meant to be used when testing with Sauce Labs.

Returns:

String

getSauceLabsUsername

public static String getSauceLabsUsername()

Gets the value for the 'saucelabsUsername' key defined in continuum.properties, which is the Sauce Labs username that should be used to connect to Sauce Labs. Only meant to be used when testing with Sauce Labs.

Returns:

String