DeployVisualStudioTestAgent@2 - Visual Studio test agent deployment v2 task

Important

This task is deprecated and will be retired January 31, 2024. Use the Visual Studio Test task to run unit and functional tests.

Syntax

# Visual Studio test agent deployment v2
# DeployVisualStudioTestAgent@2 is deprecated. Use the Visual Studio Test task to run unit and functional tests.
- task: DeployVisualStudioTestAgent@2
  inputs:
  # Test Machines
    testMachines: # string. Required. Machines. 
    adminUserName: # string. Required. Admin login. 
    adminPassword: # string. Required. Admin password. 
    winRmProtocol: 'Http' # 'Http' | 'Https'. Required. Protocol. Default: Http.
    #testCertificate: true # boolean. Optional. Use when winRmProtocol = Https. Test Certificate. Default: true.
  # Agent Configuration
    machineUserName: # string. Required. Username. 
    machinePassword: # string. Required. Password. 
    #runAsProcess: false # boolean. Run UI tests. Default: false.
    #isDataCollectionOnly: false # boolean. Enable data collection only. Default: false.
  # Advanced
    #testPlatform: '14.0' # '15.0' | '14.0'. Test agent version. Default: 14.0.
    #agentLocation: # string. Test agent location. 
    #updateTestAgent: false # boolean. Update test agent. Default: false.

Inputs

testMachines - Machines
string. Required.

This input has three options:

• Provides a comma separated list of machine IP addresses or FQDNs along with ports. The default port is based on the selected protocol. For example, dbserver.fabrikam.com,dbserver_int.fabrikam.com:5986,192.168.12.34:5986.
• Provides the output variable of other tasks. For example, $(variableName).
• Provides a machine group name. If you are using HTTPS, the name/IP of the machine should match the CN on the certificate.

adminUserName - Admin login
string. Required.

Specifies the administrator login for the target machines.

adminPassword - Admin password
string. Required.

Specifies the administrator password for the target machines. This input can accept a variable defined in build/release definitions as $(passwordVariable). You may mark the variable type as secret to secure it.

winRmProtocol - Protocol
string. Required. Allowed values: Http, Https. Default value: Http.

Specifies the protocol to use for the WinRM connection with the machine(s). The default value is HTTPS.

testCertificate - Test Certificate
boolean. Optional. Use when winRmProtocol = Https. Default value: true.

Provides the option to skip the authenticity validation of the machine's certificate by a trusted certification authority. The parameter is required for the WinRM HTTPS protocol.

machineUserName - Username
string. Required.

Specifies the username with which test agent needs to run.

machinePassword - Password
string. Required.

Specifies the password for the username given above.

runAsProcess - Run UI tests
boolean. Default value: false.

Denotes if the test agent needs to run as an interactive process. This input is needed for Coded UI Tests.

isDataCollectionOnly - Enable data collection only
boolean. Default value: false.

Optional. Specifies if the test agent is used only for data collection and not for running tests. This can typically be found on the application under the test (AUT) machine group.

testPlatform - Test agent version
string. Allowed values: 15.0 (Visual Studio 2017), 14.0 (Visual Studio 2015). Default value: 14.0.

Specifies the version of Visual Studio test agent. Chooses an appropriate version to match the VS version using the test binaries that were built.

agentLocation - Test agent location
string.

Optional. Supplies the path to vstf_testagent.exe from the network or local location. If no path is provided, it will be automatically downloaded from the download center. Install the Test Agent 2015 Update 3.
Install Test Agent 2017.

updateTestAgent - Update test agent
boolean. Default value: false.

If the Test Agent is already deployed on a machine, this option checks to see if an update is available for that version.

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.

Remarks

What's new in this task version:

• Support for Visual Studio Test Agent 2017: You can now deploy and run tests using multiple versions of Visual Studio Test Agent. Versions 2015 and 2017 are supported.
• Machine groups created from the test hub are no longer supported. You can continue to use a list of machines or Azure resource groups.

Requirements

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