Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DeviceFarm.Types.ScheduleRunTest

Description

Synopsis

Documentation

data ScheduleRunTest Source #

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

See: newScheduleRunTest smart constructor.

Constructors

ScheduleRunTest'

Fields

testSpecArn :: Maybe Text
The ARN of the YAML-formatted test specification.
testPackageArn :: Maybe Text
The ARN of the uploaded test to be run.
parameters :: Maybe (HashMap Text Text)
The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.
For all tests:
- app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.
For Calabash tests:
- profile: A cucumber profile (for example, my_profile_name).
- tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).
For Appium tests (all types):
- appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.
  - latest runs the latest Appium version supported by Device Farm (1.9.1).
  - For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
  - This behavior is subject to change.
For fuzz tests (Android only):
- event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
- throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
- seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.
For Explorer tests:
- username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
- password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.
For Instrumentation:
- filter: A test filter string. Examples:
  - Running a single test case: com.android.abc.Test1
  - Running a single test: com.android.abc.Test1#smoke
  - Running multiple tests: com.android.abc.Test1,com.android.abc.Test2
For XCTest and XCTestUI:
- filter: A test filter string. Examples:
  - Running a single test class: LoginTests
  - Running a multiple test classes: LoginTests,SmokeTests
  - Running a single test: LoginTests/testValid
  - Running multiple tests: LoginTests/testValid,LoginTests/testInvalid
For UIAutomator:
- filter: A test filter string. Examples:
  - Running a single test case: com.android.abc.Test1
  - Running a single test: com.android.abc.Test1#smoke
  - Running multiple tests: com.android.abc.Test1,com.android.abc.Test2
filter' :: Maybe Text
The test's filter.
type' :: TestType
The test's type.
Must be one of the following values:
- BUILTIN_FUZZ
- BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
- APPIUM_JAVA_JUNIT
- APPIUM_JAVA_TESTNG
- APPIUM_PYTHON
- APPIUM_NODE
- APPIUM_RUBY
- APPIUM_WEB_JAVA_JUNIT
- APPIUM_WEB_JAVA_TESTNG
- APPIUM_WEB_PYTHON
- APPIUM_WEB_NODE
- APPIUM_WEB_RUBY
- CALABASH
- INSTRUMENTATION
- UIAUTOMATION
- UIAUTOMATOR
- XCTEST
- XCTEST_UI

Instances

Instances details

Eq ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods (==) :: ScheduleRunTest -> ScheduleRunTest -> Bool # (/=) :: ScheduleRunTest -> ScheduleRunTest -> Bool #
Read ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods readsPrec :: Int -> ReadS ScheduleRunTest # readList :: ReadS [ScheduleRunTest] # readPrec :: ReadPrec ScheduleRunTest # readListPrec :: ReadPrec [ScheduleRunTest] #
Show ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods showsPrec :: Int -> ScheduleRunTest -> ShowS # show :: ScheduleRunTest -> String # showList :: [ScheduleRunTest] -> ShowS #
Generic ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Associated Types type Rep ScheduleRunTest :: Type -> Type # Methods from :: ScheduleRunTest -> Rep ScheduleRunTest x # to :: Rep ScheduleRunTest x -> ScheduleRunTest #
NFData ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods rnf :: ScheduleRunTest -> () #
Hashable ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods hashWithSalt :: Int -> ScheduleRunTest -> Int # hash :: ScheduleRunTest -> Int #
ToJSON ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest Methods toJSON :: ScheduleRunTest -> Value # toEncoding :: ScheduleRunTest -> Encoding # toJSONList :: [ScheduleRunTest] -> Value # toEncodingList :: [ScheduleRunTest] -> Encoding #
type Rep ScheduleRunTest Source #
Instance details Defined in Amazonka.DeviceFarm.Types.ScheduleRunTest type Rep ScheduleRunTest = D1 ('MetaData "ScheduleRunTest" "Amazonka.DeviceFarm.Types.ScheduleRunTest" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "ScheduleRunTest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "testSpecArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "testPackageArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TestType)))))

newScheduleRunTest Source #

Arguments

:: TestType	`$sel:type':ScheduleRunTest'`
-> ScheduleRunTest

Create a value of ScheduleRunTest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:testSpecArn:ScheduleRunTest', scheduleRunTest_testSpecArn - The ARN of the YAML-formatted test specification.

$sel:testPackageArn:ScheduleRunTest', scheduleRunTest_testPackageArn - The ARN of the uploaded test to be run.

$sel:parameters:ScheduleRunTest', scheduleRunTest_parameters - The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

For Calabash tests:

profile: A cucumber profile (for example, my_profile_name).
tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).

For Appium tests (all types):

appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.
- latest runs the latest Appium version supported by Device Farm (1.9.1).
- For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
- This behavior is subject to change.

For fuzz tests (Android only):

event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.

For Instrumentation:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:

filter: A test filter string. Examples:
- Running a single test class: LoginTests
- Running a multiple test classes: LoginTests,SmokeTests
- Running a single test: LoginTests/testValid
- Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

$sel:filter':ScheduleRunTest', scheduleRunTest_filter - The test's filter.

$sel:type':ScheduleRunTest', scheduleRunTest_type - The test's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT
APPIUM_JAVA_TESTNG
APPIUM_PYTHON
APPIUM_NODE
APPIUM_RUBY
APPIUM_WEB_JAVA_JUNIT
APPIUM_WEB_JAVA_TESTNG
APPIUM_WEB_PYTHON
APPIUM_WEB_NODE
APPIUM_WEB_RUBY
CALABASH
INSTRUMENTATION
UIAUTOMATION
UIAUTOMATOR
XCTEST
XCTEST_UI

scheduleRunTest_testSpecArn :: Lens' ScheduleRunTest (Maybe Text) Source #

The ARN of the YAML-formatted test specification.

scheduleRunTest_testPackageArn :: Lens' ScheduleRunTest (Maybe Text) Source #

The ARN of the uploaded test to be run.

scheduleRunTest_parameters :: Lens' ScheduleRunTest (Maybe (HashMap Text Text)) Source #

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to false to disable it.

For Calabash tests:

profile: A cucumber profile (for example, my_profile_name).
tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke or @smoke,~@wip).

For Appium tests (all types):

appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.
- latest runs the latest Appium version supported by Device Farm (1.9.1).
- For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
- This behavior is subject to change.

For fuzz tests (Android only):

event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.

For Instrumentation:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

For XCTest and XCTestUI:

filter: A test filter string. Examples:
- Running a single test class: LoginTests
- Running a multiple test classes: LoginTests,SmokeTests
- Running a single test: LoginTests/testValid
- Running multiple tests: LoginTests/testValid,LoginTests/testInvalid

For UIAutomator:

filter: A test filter string. Examples:
- Running a single test case: com.android.abc.Test1
- Running a single test: com.android.abc.Test1#smoke
- Running multiple tests: com.android.abc.Test1,com.android.abc.Test2

scheduleRunTest_filter :: Lens' ScheduleRunTest (Maybe Text) Source #

The test's filter.

scheduleRunTest_type :: Lens' ScheduleRunTest TestType Source #

The test's type.

Must be one of the following values:

BUILTIN_FUZZ
BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.
APPIUM_JAVA_JUNIT
APPIUM_JAVA_TESTNG
APPIUM_PYTHON
APPIUM_NODE
APPIUM_RUBY
APPIUM_WEB_JAVA_JUNIT
APPIUM_WEB_JAVA_TESTNG
APPIUM_WEB_PYTHON
APPIUM_WEB_NODE
APPIUM_WEB_RUBY
CALABASH
INSTRUMENTATION
UIAUTOMATION
UIAUTOMATOR
XCTEST
XCTEST_UI