XamarinTestCloud@1 - Xamarin Test Cloud v1 task

XamarinTestCloud@1 is deprecated. Originally, this task was used in a build or release pipeline to test mobile apps with Xamarin Test Cloud using Xamarin.UITest.

Note

This task is deprecated and will be retired January 31, 2024.

You can now sign up with App Center and use the AppCenterDistribute@3 task instead.

XamarinTestCloud@1 is deprecated. Originally, this task was used in a build or release pipeline to test mobile apps with Xamarin Test Cloud using Xamarin.UITest.

Note

You can now sign up with App Center and use the AppCenterDistrivbute#3 task instead.

Syntax

# Xamarin Test Cloud v1
# [Deprecated] Test mobile apps with Xamarin Test Cloud using Xamarin.UITest. Instead, use the 'App Center test' task.
- task: XamarinTestCloud@1
  inputs:
    appFile: # string. Alias: app. Required. App file. 
    #dsymFile: # string. Alias: dsym. dSYM file (iOS only). 
    teamApiKey: # string. Required. Team API key. 
    email: # string. Alias: user. Required. User email. 
    devices: # string. Required. Devices. 
    series: 'master' # string. Required. Series. Default: master.
    testAssemblyDirectory: # string. Alias: testDir. Required. Test assembly directory. 
  # Advanced
    parallelizationOption: 'none' # 'none' | '--fixture-chunk' | '--test-chunk'. Alias: parallelization. Required. Parallelization. Default: none.
    localeOption: 'en_US' # 'da_DK' | 'nl_NL' | 'en_GB' | 'en_US' | 'fr_FR' | 'de_DE' | 'ja_JP' | 'ru_RU' | 'es_MX' | 'es_ES' | 'user'. Alias: locale. Required. System language. Default: en_US.
    #userDefinedLocale: # string. Optional. Use when locale = user. Other locale. 
    testCloudFile: '**/packages/**/tools/test-cloud.exe' # string. Alias: testCloudLocation. Required. test-cloud.exe location. Default: **/packages/**/tools/test-cloud.exe.
    #optionalArgs: # string. Optional arguments. 
    #publishNUnitResults: true # boolean. Publish results to Azure Pipelines. Default: true.
# Xamarin Test Cloud v1
# [Depreciated] Testing mobile apps with Xamarin Test Cloud using Xamarin.UITest - recommended task is now AppCenterTest.
- task: XamarinTestCloud@1
  inputs:
    appFile: # string. Alias: app. Required. App file. 
    #dsymFile: # string. Alias: dsym. dSYM file (iOS only). 
    teamApiKey: # string. Required. Team API key. 
    email: # string. Alias: user. Required. User email. 
    devices: # string. Required. Devices. 
    series: 'master' # string. Required. Series. Default: master.
    testAssemblyDirectory: # string. Alias: testDir. Required. Test assembly directory. 
  # Advanced
    parallelizationOption: 'none' # 'none' | '--fixture-chunk' | '--test-chunk'. Alias: parallelization. Required. Parallelization. Default: none.
    localeOption: 'en_US' # 'da_DK' | 'nl_NL' | 'en_GB' | 'en_US' | 'fr_FR' | 'de_DE' | 'ja_JP' | 'ru_RU' | 'es_MX' | 'es_ES' | 'user'. Alias: locale. Required. System language. Default: en_US.
    #userDefinedLocale: # string. Optional. Use when locale = user. Other locale. 
    testCloudFile: '**/packages/**/tools/test-cloud.exe' # string. Alias: testCloudLocation. Required. test-cloud.exe location. Default: **/packages/**/tools/test-cloud.exe.
    #optionalArgs: # string. Optional arguments. 
    #publishNUnitResults: true # boolean. Publish results to Azure Pipelines/TFS. Default: true.

Inputs

appFile - App file
Input alias: app. string. Required.

Specifies the relative path from repo root of the app(s) to test. Wildcards can be used. For example, **/*.apk for all APK files in all subfolders. Learn more about file matching patterns.


dsymFile - dSYM file (iOS only)
Input alias: dsym. string.

Provides a path relative to the .ipa file. To make crash logs easier to read, you can upload a dSYM file that is associated with your app. This field only applies to iOS apps. Wildcards can be used. For example: *.dSYM. Learn more about file matching patterns.


teamApiKey - Team API key
string. Required.

Specifies your Xamarin Test Cloud Team API key, which can be found under Teams & Apps. Use a secret variable to avoid exposing this value.


email - User email
Input alias: user. string. Required.

Specifies the email address of your Xamarin Test Cloud account.


devices - Devices
string. Required.

Specifies the devices string generated by Xamarin Test Cloud. The string can be found as the value of the --devices command line argument of a Test Cloud test run.


series - Series
string. Required. Default value: master.

Specifies the series name for organizing test runs (e.g. master, production, beta).


testAssemblyDirectory - Test assembly directory
Input alias: testDir. string. Required.

Specifies the relative path to the folder containing the test assemblies, such as: SolutionName/TestsProjectName/bin/Release.


parallelizationOption - Parallelization
Input alias: parallelization. string. Required. Allowed values: none, --fixture-chunk (By test fixture), --test-chunk (By test method). Default value: none.

Specifies tests to run simultaneously.


localeOption - System language
Input alias: locale. string. Required. Allowed values: da_DK (Danish (Denmark)), nl_NL (Dutch (Netherlands)), en_GB (English (United Kingdom)), en_US (English (United States)), fr_FR (French (France)), de_DE (German (Germany)), ja_JP (Japanese (Japan)), ru_RU (Russian (Russia)), es_MX (Spanish (Mexico)), es_ES (Spanish (Spain)), user (Other). Default value: en_US.

Specifies your language. If your language isn't displayed, select Other and enter its locale below, such as en_US.


userDefinedLocale - Other locale
string. Optional. Use when locale = user.

Enters any two-letter ISO-639 language code along with any two-letter ISO 3166 country code in the format [language]_[country], such as en_US.


testCloudFile - test-cloud.exe location
Input alias: testCloudLocation. string. Required. Default value: **/packages/**/tools/test-cloud.exe.

Specifies the path to test-cloud.exe. Wildcards can be used, and when they are, the first occurrence of test-cloud.exe is used. Learn more about file matching patterns.


optionalArgs - Optional arguments
string.

Specifies the additional arguments passed to test-cloud.exe.


publishNUnitResults - Publish results to Azure Pipelines
boolean. Default value: true.

Specifies the --nunit-xml option to be passed to test-cloud.exeso that results from the NUnit xml file are be published to Azure Pipelines.


publishNUnitResults - Publish results to Azure Pipelines/TFS
boolean. Default value: true.

Specifies the --nunit-xml option to be passed to test-cloud.exeso that results from the NUnit xml file are be published to TFS or Azure Pipelines.


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 1.83.0 or greater
Task category Test