Class Settings

Settings of the WebEngine provides global testing parameters and behavior. settings can be loaded from external files, or provided via command line using WebRunner.

Inheritance
System.Object
Settings
Namespace: AxaFrance.WebEngine
Assembly: AxaFrance.WebEngine.dll
Syntax
[Serializable]
public class Settings

Properties

| Improve this Doc View Source

AllowAnyCertificate

Allow any HTTPS Certificate when creating Selenium Grid connection.

Declaration
public bool AllowAnyCertificate { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

AppId

[MobileApp Only] The applicationId to be used (System under test) It can be:

  1. A Package Name, application already installed and will be started.
  2. A local package fullpath, application will be on the device.
Declaration
public string AppId { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

AppPackageName

[MobileApp Only] Optional. The application package name used to test Mobile Applications, for example: fr.AxaFrance.customermgmt

Declaration
public string AppPackageName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Browser

Determine the browser which the test will run.

Declaration
public BrowserType Browser { get; set; }
Property Value
Type Description
BrowserType
| Improve this Doc View Source

BrowserOptions

Get a list of browser options according to current selected browser Browser loaded from appsettings.json

Declaration
public IEnumerable<string> BrowserOptions { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>
| Improve this Doc View Source

BrowserVersion

BrowserVersion to be used for Web Tests,

Declaration
public string BrowserVersion { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Capabilities

Additional capabilities for the selenium grid (if running in distance)

Declaration
public Dictionary<string, object> Capabilities { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>
| Improve this Doc View Source

DataSourceName

The filename of the data source.

Declaration
public string DataSourceName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Device

[Mobile Only] Device name, Mandatary when running tests on Mobile Devices. This parameter will be passed as appium:device for device selection

Declaration
public string Device { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

GridForDesktop

[Grid Only] Run Desktop based Selenium test in the Grid (default value is false, that is always run desktop tests locally) When value is true, the framework will create Selenium Grid connection provided by GridServerUrl

Declaration
public bool GridForDesktop { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

GridServerUrl

[Mobile Only] [Grid Only] Remote Selenium Grid Hub to connect. If platform is Android and IOS, this value is mandatary (default value = http://localhost:4723/wd/hub) for running tests on local Appium Server.

Declaration
public string GridServerUrl { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Instance

Get the active instance of Settings. Settings will be initialized by WebEngine Runner, if you are using another test framework settings should be initialized during Test Setup.

Declaration
public static Settings Instance { get; }
Property Value
Type Description
Settings
| Improve this Doc View Source

LogDir

The directory where the test framework will write the logs. WebEngine will generate a consolated report for the whole execution and may generate detailed report for teach test case.

Declaration
public string LogDir { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LogFileName

The filename of the generated WebEngine XML report. not available before the log has been generated.

Declaration
public string LogFileName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ManualMode

Indicates whether the test execution should done via manuel mode. When manuel mode is active, the execution will be paused before Test Case cleanup. User can do some manual manipuilation on system under test.

Declaration
public bool ManualMode { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OsVersion

[Grid Only] Version of the OS, Optional when running tests on Mobile Devices. It refers to iOS or Android version during the device selection.

Declaration
public string OsVersion { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PackageUploadUrl

When testing Mobile Application, This url is used to upload app packages such as APK or IPA. The upload method is implemented according to cloud provider based on this url.

Declaration
public string PackageUploadUrl { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Password

[Grid Only] Password or AccessKey used to connect to remote Selenium Grid or compatible cloud based mobile testing platforms

Declaration
public string Password { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Platform

[Grid Only] [Mobile Only] The platform for mobile testing. Mandatary for Mobile testing: Possible values Android / iOS

Declaration
public Platform Platform { get; set; }
Property Value
Type Description
Platform
| Improve this Doc View Source

ReportSettings

Settings about report generating, including additional formats and locations.

Declaration
public ReportSettings ReportSettings { get; set; }
Property Value
Type Description
ReportSettings
| Improve this Doc View Source

Separator

The CSV Seperator used during the data process. default value is semicolon (;)

Declaration
public string Separator { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ShowReportAfterTest

If webrunner should try to show test report after test execution.

Declaration
public bool ShowReportAfterTest { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SynchronzationTimeout

Default synchronization timeout during the test. This timeout is used on Browser Synchronziation, Find Test Objects.

Declaration
public int SynchronzationTimeout { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UseAppiumForWebMobile

Use Appium driver for Web Mobile Testing. This parameter can be set to true if you are running Web Mobile testing on local Appium Instance or a Selenium Grid based on Appium instances. True: Use Appium Driver (AndroidDriver or IOsDriver), False : Use RemoteWebDriver.

Declaration
public bool UseAppiumForWebMobile { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

UseJavaScriptClick

Active JavaScript Click. Mainly used for SafariDriver and Mobile Chrome based driver because native click may not work.

Declaration
public bool UseJavaScriptClick { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Username

[Grid Only] Username used to connect to remote Selenium Grid testing platforms (local Selenium Grid or cloud provider such as BrowserStack)

Declaration
public string Username { get; set; }
Property Value
Type Description
System.String