Agent-based remote execution allows you to deploy and run your tests on remote machines using a Ranorex Agent. You manage these agents and monitor test progress through the Remote pad within Ranorex Studio or via the command line.
The remote pad
The remote pad serves as the central control center for managing agents in your network.
You can open the remote pad in Ranorex Studio in two ways:
- Click the Remote pad symbol in the toolbar, or
- Navigate to View > Remote in the menu bar.
Add Agents to the remote pad
Before running tests remotely, you must add agents to the remote pad:
- In the remote pad, click Add Ranorex Agent.
- Install the Ranorex Agent on the target machine if you haven't done so already. For more information, see Ranorex Agents. The remote machine must be in the same network as the machine you are using the remote pad on.
- Click Manage Agents….
- Identify the agent in the Available Agents in your network list and click Add Agent, or enter the IP address or hostname manually.
-
Click Back to return to the control panel of the remote pad.
In the control panel of the remote pad, you can see the added Agent in its idle state, ready to be used for running tests.
Remote pad control panel
Use the control panel to deploy and run tests on Agents. To do so, you first need to open a solution with a test suite project.
The control panel consists of the following elements:
- Button to open the Manage Agents… screen.
- Allows you to select the test suite/test sequence and specify the run configuration you want to run.
If you select a test sequence, you can’t specify a run configuration. Instead, the individual test suites of the test sequence will execute in the run configuration that is active when you click the Run button next to an Agent. - All Agents you add to the remote pad.
- Information that displays about the agent when you hover over it..
Run a test via the remote pad
Once you add an agent, you can deploy and execute tests directly from the Remote pad control panel:
- Select the desired Test suite(s) or test sequence.
-
Select a Run config from the dropdown menu, if possible.
Note: Test sequences use the configurations active in the contained test suites at the time of clicking the Run button in the remote pad -
Click the Run button next to the target agent.
Ranorex Studio automatically builds the project and deploys it to the agent. A progress bar in the Remote pad shows the current status of the deployment and execution. You can click the Stop button at any time to abort the run.
- Ranorex Studio is creating an executable build of the test and deploying it to the Agent machine. The green status bar shows the progress.
- Test execution has started on the Agent machine. The status message shows which test container is currently being executed and the clock symbol on the Run button indicates a test in progress. You can abort the test with the Stop button at any time.
- Test execution has finished.
- The Agent returns to the idle state. Click the button with the page and the numbered symbol to display the run history for this Agent.
The numbered symbol indicates how many test runs were completed since the last viewing of the run history. The symbol’s color indicates the success status of the test run:
-
- Green = successful test run.
- Red = test run with at least one error.
If more than one test run is queued on the Agent, a blue number over the Run button shows which test in the queue is currently being executed:
Run history
The run history tracks every test executed on an agent, regardless of whether you started it from the remote pad or the command line. You can review it by clicking the View run history option.
- Filter categories for test runs. You can filter by success/error, test run initiator, and time.
- List of executed tests in chronological order.
- Clicking a run above displays details about it in this area.
- From left to right: Opens the report, downloads the report from the Agent machine to the local machine, and deletes the selected history entry.
Run a test via the command line
You can trigger agent-based execution from the command line interface, which is ideal for incorporating Agent-based test execution into your continuous integration process.
- Create an executable build of your project in Ranorex Studio.
- Open a command line interface in your source machine and navigate to the executable build’s output folder.
-
Execute the file using the agent argument:
[ProjectName].exe /agent:[agent-name]
If the agent is available, the application automatically zips the build, deploys it to the agent, and streams the execution progress back to the command line interface. If you spell the Agent name incorrectly or if the Agent can’t be reached over the network, the application displays a list of Agents available in the network.
-
- The application is creating the ZIP file out of the Output folder.
- The test run starts on the Agent machine.
- The application is downloading report files to the local machine. By default, it downloads files with the .rxzlog (default Ranorex Studio report) and .junit.xml (Ranorex Studio report in JUnit format) extensions.
- The test run is complete.
The test run also appears in the run history of the Agent in the remote pad.