Skip to content

Commit 25caeea

Browse files
authored
Merge pull request #2956 from gewarren/test-agents
Update test agent/controller config steps
2 parents 57de107 + d94ce6d commit 25caeea

7 files changed

+47
-69
lines changed

docs/test/assign-roles-to-a-test-controller-and-test-agent.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Assigning Roles to a Test Controller and Test Agent for Automated Testing in Visual Studio"
2+
title: "Assign Roles to a Test Controller and Test Agent for Automated Testing"
33
ms.date: 10/20/2016
44
ms.topic: conceptual
5-
helpviewer_keywords:
5+
helpviewer_keywords:
66
- "testing, walkthroughs, test controller and test agents"
77
- "test agent, walkthrough"
88
- "walkthroughs [Visual Studio ALM] testing"

docs/test/collect-diagnostic-information-using-test-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The following table provides an overview of the various ways that the diagnostic
4242
|**Code coverage:** You can create a test setting that includes code coverage information that is used to investigate how much of your code is covered by tests.|No|Yes (See Notes)|No|- You can use code coverage only when you run an automated test from Visual Studio or *mstest.exe*, and only from the machine that runs the test. Remote collection is not supported.<br />- Collecting code coverage data does not work if you also have the test setting configured to collect IntelliTrace information. **Note:** This diagnostic data adapter is only applicable to Visual Studio test settings. It is not used for test settings in Microsoft Test Manager. Additionally, this adapter is for compatibility with Visual Studio 2010 test projects. **Note:** For compatibility, the code coverage applies when automated tests are run from Microsoft Test Manager or on a remote Test agent from Visual Studio using the legacy MSTest runner.|
4343
|**Event log:** You can configure a test setting to include event log collecting, which is included in the test results.|Yes|Yes|Yes||
4444
|**IntelliTrace:** You can configure the diagnostic data adapter for *IntelliTrace* to collect specific diagnostic trace information to help isolate bugs that are difficult to reproduce. This creates an IntelliTrace file that contains this information. An IntelliTrace file has an extension of *.iTrace*. When a test fails, you can create a bug. The IntelliTrace file that is saved together with the test results is automatically linked to this bug. The data that is collected in the IntelliTrace file increases debugging productivity by reducing the time that is required to reproduce and diagnose an error in the code. From this IntelliTrace file the local session can be simulated on another computer. This reduces the risk of a bug being non-reproducible.|Yes|Yes|Yes|- If you enable the collection of IntelliTrace data, collection of code coverage data does not work.<br />- If you use IntelliTrace for a web client role, you must also select the ASP.NET Client Proxy for IntelliTrace and Test Impact diagnostic data adapter.<br />- Only the following versions of IIS are supported: IIS 7.0, IIS 7.5 and IIS 8.0.|
45-
|**Network emulation:** You can specify that you want to place an artificial network load on your test by using a test setting. Network emulation affects the communication to and from the machine by emulating a particular network connection speed, such as dial-up. |No|Yes (See Notes)|No|You can use the network emulation diagnostic data adapter for a client or server role. You do not have to use the adapter on both these roles that communicate with each other. **Note:** This diagnostic data adapter is only applicable to Visual Studio test settings. It is not used for test settings in Microsoft Test Manager. **Note:** Network emulation cannot be used to increase the network connection speed. **Warning:** If you include the network emulation diagnostic data adapter in the test settings and you intend to use it on your local machine, then you must also bind the network emulation driver to one of your machine’s network adapters. The network emulation driver is required for the network emulation diagnostic data adapter to function. The network emulation driver is installed and bound to your adapter in two ways: <ul><li>**Network emulation driver installed with Microsoft Visual Studio Test Agent:** The Microsoft Visual Studio Test Agent can be used on both remote machines and your local machine. When you install a Visual Studio Test Agent, the installation process includes a configuration step that binds the network emulation driver to your network card. For more information, see [Install and configure test agents](../test/lab-management/install-configure-test-agents.md).</li><li>**Network emulation driver installed with Microsoft Visual Studio Test Professional:** When you use network emulation for the first time, you are prompted to bind the network emulation driver to a network card.</li></ul> You can also install the network emulation driver from the command line on your local machine without installing the Visual Studio test agent by using the following command: **VSTestConfig NETWORKEMULATION /install** **Warning:** The Network Emulation adapter is ignored by load tests. Instead, load tests use the settings that are specified in the network mix of the load test scenario.|
45+
|**Network emulation:** You can specify that you want to place an artificial network load on your test by using a test setting. Network emulation affects the communication to and from the machine by emulating a particular network connection speed, such as dial-up. |No|Yes (See Notes)|No|You can use the network emulation diagnostic data adapter for a client or server role. You do not have to use the adapter on both these roles that communicate with each other. **Note:** This diagnostic data adapter is only applicable to Visual Studio test settings. It is not used for test settings in Microsoft Test Manager. **Note:** Network emulation cannot be used to increase the network connection speed. **Warning:** If you include the network emulation diagnostic data adapter in the test settings and you intend to use it on your local machine, then you must also bind the network emulation driver to one of your machine’s network adapters. The network emulation driver is required for the network emulation diagnostic data adapter to function. The network emulation driver is installed and bound to your adapter in two ways: <ul><li>**Network emulation driver installed with Microsoft Visual Studio Test Agent:** The Visual Studio Test Agent can be used on both remote machines and your local machine. When you install a Visual Studio Test Agent, the installation process includes a configuration step that binds the network emulation driver to your network card. For more information, see [Install and configure test agents](../test/lab-management/install-configure-test-agents.md).</li><li>**Network emulation driver installed with Microsoft Visual Studio Test Professional:** When you use network emulation for the first time, you are prompted to bind the network emulation driver to a network card.</li></ul> You can also install the network emulation driver from the command line on your local machine without installing the Visual Studio test agent by using the following command: **VSTestConfig NETWORKEMULATION /install** **Warning:** The Network Emulation adapter is ignored by load tests. Instead, load tests use the settings that are specified in the network mix of the load test scenario.|
4646
|**System information:** A test setting can be set up to include the system information about the machine on which the test is run.|Yes|Yes|Yes||
4747
|**Test impact:** You can collect information about which methods of your applications code were used when a test case was run. This can be used together with changes to the application code that was made by developers to determine which tests were affected by those development changes.|Yes|Yes|Yes|- If you are collecting test impact data for a web client role, you must also select the ASP.NET Client Proxy for IntelliTrace and Test Impact diagnostic data adapter.<br />- Only the following versions of IIS are supported: IIS 7.0, IIS 7.5 and IIS 8.0.|
4848
|**Video Recorder:** You can create a video recording of your desktop session when you run a test. The video can help other team members isolate application issues that are difficult to reproduce.|Yes|Yes (See Notes)|Yes|- If you enable the test agent software to run as a process instead of a service, you can create a video recording when you run automated tests.|

docs/test/how-to-select-a-load-test-results-repository.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ You are not limited to a local results store. Frequently, load tests are run on
2424

2525
Test results from your agents or your local computer can be saved to any SQL server on which you have created a load test results store. In either case, you must identify where you want to store your load test results by using the **Administer Test Controllers** window.
2626

27-
For more information about agents, see [Test controllers and test agents](configure-test-agents-and-controllers-for-load-tests.md).
28-
2927
## Identify a results store for load test data
3028

3129
1. In **Solution Explorer**, open your load test file.

docs/test/how-to-set-up-your-test-agent-to-run-tests-that-interact-with-the-desktop.md

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Configure a Visual Studio Test Agent to Run Tests that Interact with the Desktop"
3-
ms.date: 10/20/2016
2+
title: Configure a test agent
3+
ms.date: 09/18/2018
44
ms.topic: conceptual
55
helpviewer_keywords:
66
- "agents, configuring for interaction with desktop"
@@ -13,7 +13,7 @@ ms.technology: vs-ide-test
1313
---
1414
# How to: Set up your test agent to run tests that interact with the desktop
1515

16-
If you want to run automated tests that interact with the desktop, you must set up your agent to run as a process instead of a service. For example, if you want to run a coded UI test remotely using a test controller and test agent, or you want to run a test and capture a video recording when you run it, you must set up your agent to run as a process. When you assign agents to roles in your test settings using Visual Studio, or you assign agents to roles in your environment by using Microsoft Test Manager, you must change the set up for any agents assigned to roles that have to interact with the desktop.
16+
If you want to run automated tests that interact with the desktop, you must set up your agent to run as a process instead of a service. For example, if you want to run a coded UI test remotely using a test controller and test agent, or you want to run a test and capture a video recording when you run it, you must set up your agent to run as a process. When you assign agents to roles in your test settings using Visual Studio, or you assign agents to roles in your environment by using Microsoft Test Manager, you must change the setup for any agents assigned to roles that have to interact with the desktop.
1717

1818
> [!WARNING]
1919
> If you use Microsoft Test Manager to set up a lab environment, it installs the test agent. You can specify in the **Environment Creation Wizard** that you want to configure one of the roles to run coded UI tests.
@@ -26,59 +26,48 @@ If you are running coded UI tests that start a browser, the service account for
2626
> [!IMPORTANT]
2727
> If you are running a coded UI test that starts a browser as part of a build definition, the service account for the build service is used to start that browser. This service account must be the same as the user account that is the active user on this computer. If it is not the same user account, the browser will not start.
2828
29-
Use the following procedure to set up any agents that are assigned to a role that performs a task that needs to interact with the desktop.
29+
Use the following procedure to set up any agents that are assigned to a role that performs a task that needs to interact with the desktop.
3030

3131
## To set up an agent to run as a process
3232

33-
1. To configure the test agent you have installed to run as a process, go to **Start**, **All Programs**, **Microsoft Visual Studio**, **Microsoft Visual Studio Test Agent Configuration Tool**.
33+
1. To configure the test agent you have installed to run as a process, go to **Start** > **Test Agent Configuration Tool**.
3434

35-
The **Configure Test Agent** dialog box is displayed.
35+
The **Configure Test Agent** dialog box is displayed.
3636

37-
2. To view the page to select to run as a process, choose **Run Options**.
37+
![Configure Test Agent for Visual Studio](media/configure-test-agent.png)
3838

39-
The page that enables you to choose to run the agent as a process or a service is displayed.
39+
2. Select **Interactive Process**. The test agent will be started as a process instead of a service. Choose **Next**.
4040

41-
3. Select **Interactive Process**. The test agent will be started as a process instead of a service. Choose **Next**.
41+
3. Enter the user name and password for the user that will run the test agent process.
4242

43-
You can now enter the details for the user to use when you start the test agent as a process, and other options.
43+
> [!NOTE]
44+
> - The user who you add to start the process must also be added as a member of the TeamTestAgentService group on the computer for the test controller for this agent. If this user is the current user, when you add this user to the test controller computer you must log off or reboot.
45+
- Null passwords are not supported for user accounts.
46+
- If you want to use the IntelliTrace or the network emulation data and diagnostic adapter, the user account must be a member of the Administrators group. If the machine that is running the test agent is running an OS that has Least-Privileged User Account, you have to run it as an administrator also (elevated). If the agent user name is not in the agent service it will try to add it, which requires permissions on the test controller.
47+
- The user trying to use the test controller must be in the test controller's Users account or they won't be able to run the tests against the controller.
4448

45-
> [!NOTE]
46-
> The user who you add to start the process must also be added as a member of the TeamTestAgentService group on the computer for the test controller for this agent. If this user is the current user, when you add this user to the test controller computer, you must log off or reboot this computer.
49+
4. To make sure that a computer that has a test agent can run tests after rebooting, you can set up the computer to sign in automatically as the test agent user. Select **Log on automatically**. This will store the user name and password in an encrypted form in the registry.
4750

48-
4. Type the name in **User name**.
51+
> [!NOTE]
52+
> When you are connected to the lab environment using a remote desktop or guest-based connection, you might experience frequent, unexpected disconnects. One possible cause of the loss of the connection is that the machine is configured to automatically log onto the network.
4953
50-
5. Type the password in **Password**.
54+
7. To make sure that the screen saver is disabled because this might interfere with any automated tests that must interact with the desktop, select **Ensure screen saver is disabled**.
5155

52-
**Important user account information:**
56+
> [!WARNING]
57+
> There are security risks if you log on automatically or disable the screen saver. By enabling automatic log on, you enable other users to start this computer and to be able to use the account that automatically logs on. If you disable the screen saver, the computer might not prompt for a user to log on to unlock the computer. This enables anyone to access the computer if they have physical access to the computer. If you enable these features on a computer, you should make sure that these computers are physically secure. For example, these computers are located in a physically secure lab. If you clear **Ensure screen saver is disabled**, this does not enable your screen saver.
5358
54-
- Null passwords are not supported for user accounts.
59+
To change the agent back to run as a service, you can use this tool and select **Service**.
5560

56-
- If you want to use the IntelliTrace or the network emulation data and diagnostic adapter, the user account must be a member of the Administrators group. If the machine that is running the test agent is running an OS that has Least-Privileged User Account, you have to run it as an administrator also (elevated). If the agent user name is not in the agent service it will try to add it, which requires permissions on the test controller.
61+
8. To apply your changes, choose **Apply Settings**.
5762

58-
- The user trying to use the test controller must be in the test controller's Users account or the they will not be able to run the tests against the controller.
59-
60-
6. To make sure that a computer that has a test agent can run tests after rebooting, you can set up the computer to log on automatically as the test agent user. Select **Log on automatically**. This will store the user name and password in an encrypted form in the registry.
61-
62-
> [!NOTE]
63-
> When you are connected to the lab environment using a remote desktop or guest-based connection, you might experience frequent, unexpected disconnects. One possible cause of the loss of the connection is that the machine is configured to automatically log onto the network.
64-
65-
7. To make sure that the screen saver is disabled because this might interfere with any automated tests that must interact with the desktop, select **Ensure screen saver is disabled**.
66-
67-
> [!WARNING]
68-
> There are security risks if you log on automatically or disable the screen saver. By enabling automatic log on, you enable other users to start this computer and to be able to use the account that automatically logs on. If you disable the screen saver, the computer might not prompt for a user to log on to unlock the computer. This enables anyone to access the computer if they have physical access to the computer. If you enable these features on a computer, you should make sure that these computers are physically secure. For example, these computers are located in a physically secure lab. If you clear **Ensure screen saver is disabled**, this does not enable your screen saver.
69-
70-
To change the agent back to run as a service, you can use this tool and select **Service**.
71-
72-
8. To apply your changes, choose **Apply Settings**.
73-
74-
A **Configuration summary** dialog box is displayed that shows the status of each of the steps to configure your test agent.
63+
A **Configuration summary** dialog box is displayed that shows the status of each of the steps to configure your test agent.
7564

7665
9. To close the **Configuration summary** dialog box, choose **Close**. Then choose **Close** again to close the **Test Agent Configuration Tool**.
7766

78-
> [!NOTE]
79-
> There is a notification area icon that runs on the computer for a test agent that is running as a process. It shows the status of the test agent. You can start, stop or restart the agent if it is running as a process using this tool. To start the test agent as a process if it is not running, choose **Start**, **All Programs**, **Microsoft Visual Studio**, **Microsoft Visual Studio Test Agent**.
67+
> [!NOTE]
68+
> There is a notification area icon that runs on the computer for a test agent that is running as a process. It shows the status of the test agent. You can start, stop or restart the agent if it is running as a process using this tool. To start the test agent as a process if it is not running, choose **Start** > **Visual Studio** > **Microsoft Visual Studio Test Agent**.
8069
81-
If the test controller for this test agent is registered with Team Foundation Server, the status of a test agent that is running as an interactive process is displayed in the **Controllers** view in the **Lab Center** for Microsoft Test Manager. It is listed with a preceding asterisk symbol to denote that it is running as an interactive process. To restart this test agent you must use the tool that runs on the computer for the test agent and not the **Controllers** view.
70+
If the test controller for this test agent is registered with Team Foundation Server, the status of a test agent that is running as an interactive process is displayed in the **Controllers** view in the **Lab Center** for Microsoft Test Manager. It is listed with a preceding asterisk symbol to denote that it is running as an interactive process. To restart this test agent, you must use the tool that runs on the computer for the test agent and not the **Controllers** view.
8271

8372
## See also
8473

0 commit comments

Comments
 (0)