AppCenterTestRunUitestSettings Class

Summary

Settings for appcenter test run uitest. Starts a test run with Xamarin UI Tests..
Assembly
Cake.AppCenter.dll
Namespace
Cake.AppCenter
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.AppCenter/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["AppCenterTestRunUitestSettings"] class Type type-node

Syntax

public sealed class AppCenterTestRunUitestSettings : AutoToolSettings

Attributes

Type Description
NullableContextAttribute
NullableAttribute
CompilerGeneratedAttribute

Constructors

Properties

Name Value Summary
App string
-a|--app <arg> Specify app in the <ownerName>/<appName> format
AppPath string
--app-path <arg> Path to an application file
AssemblyDir string
--assembly-dir <arg> Obsolete. Please use --build-dir instead
Async Nullable<bool>
--async Exit the command when tests are uploaded, without waiting for test results
BuildDir string
--build-dir <arg> Path to the directory with the built test assemblies (usually <project>/bin/<configuration>)
Debug Nullable<bool>
--debug Display extra output for debugging
Devices string
--devices <arg> Device selection slug
DisableTelemetry Nullable<bool>
--disable-telemetry Disable telemetry for this command
DsymDir string
--dsym-dir <arg> Path to the directory with iOS symbol files. This option is deprecated and ignored
Env string
--env <arg> Environment when using API token
ExcludeCategory string[]
--exclude-category <arg> NUnit category to not run. (Can be used multiple times) (When include and/or fixture are combined with exclude, all tests with the included categories are run, except for those also marked with the excluded categories)
Fixture string[]
--fixture <arg> NUnit fixture / namespace to run. If used with include- / exclude-category the fixture filter is applied first (Can be used multiple times)
FixtureChunk Nullable<bool>
--fixture-chunk Run tests in parallel by fixture, ignore the use of include- / exclude-category
Help Nullable<bool>
-h|--help Display help for current command
Include string
--include <arg> Additional files and directories to include. The value must be either path relative to the input directory, or be in format "targetDir=sourceDir"
IncludeCategory string[]
--include-category <arg> NUnit category to run. (Can be used multiple times)
KeyAlias string
--key-alias <arg> Alias to the key in the keystore. Corresponds to the "-alias" argument in jarsigner
KeyPassword string
--key-password <arg> Password to the matching private key in the keystore. Corresponds to the "-keypass" argument in jarsigner
Language string
--language <arg> Override the language (iOS only) for the test run
Locale string
--locale <arg> The system locale for the test run. For example, en_US
MergeNunitXml string
--merge-nunit-xml <arg> Merge the xml files into the <arg> file. Requires --test-output-dir to specify the directory where the <arg> file will be. This parameter is ignored when used with the --async option because we have to wait for test results.
Output string
--output <arg> Output format: json
Quiet Nullable<bool>
--quiet Auto-confirm any prompts without waiting for input
SignInfo string
--sign-info <arg> Use Signing Info for signing the test server.
StorePassword string
--store-password <arg> Password to the keystore. Corresponds to the "-storepass" argument in jarsigner
StorePath string
--store-path <arg> Path to the keystore file
TestChunk Nullable<bool>
--test-chunk Run tests in parallel by method
TestOutputDir string
--test-output-dir <arg> Path to the directory for test results. This parameter won't work when you run using --async because we have to wait for test results. The results will be saved in the working directory if a relative path is specified
TestParameter string
-p|--test-parameter <arg> Additional test parameters. The value must be in format "key=value"
TestSeries string
--test-series <arg> Name of the test series
Timeout string
--timeout <arg> Maximum time (in seconds) to wait for test results
Token string
--token <arg> API token
UitestToolsDir string
--uitest-tools-dir <arg> Path to the directory containing the Xamarin UI Tests tools including test-cloud.exe
Version Nullable<bool>
-v|--version Display appcenter version
VstsIdVariable string
--vsts-id-variable <arg> Outputs the Test Run Id to the named VSTS variable

Extension Methods

Name Value Summary
Dump<AppCenterTestRunUitestSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AppCenterTestRunUitestSettings>(AppCenterTestRunUitestSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AppCenterTestRunUitestSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AppCenterTestRunUitestSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AppCenterTestRunUitestSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AppCenterTestRunUitestSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin