Installing and starting the personal agent

When you want to run server test assets or server suite assets locally on your system and view the live test run, you can install and use the personal agent. To run tests locally, you must first download the DevOps Test Runtime agent, and then install and start the agent in Test Editor.

Before you begin

You must have ensured that you are a Team Space Owner, Project Owner, or Member with a Tester role to create or edit a test resource.

Procedure

  1. Log in to Test Hub on the system that you want to register as an agent.
    The Projects page of the initial team space is displayed.
  2. Click My projects > project_name to open the project that contains the test assets.
    The Overview page of the project is displayed.
  3. Click Author > Test Editor.
    The Test Editor page and the test navigator panel are displayed.
  4. Click the Personal Agent Inactive button located in the page title bar next to the branch selector.
    The Manage DevOps Test Runtime dialog opens and checks the status of your local installation.
  5. Perform one of the following steps depending on the installation status of the agent:
    If... Then...
    The agent is not installed, and the screen displays the following options:
    • Windows (64-bit .msi)
    • Mac OS (64-bit .zip)
    • Debian/Ubuntu (64-bit .deb)
    • RHEL/Fedora/OpenSUSE (64-bit .rpm)
    Perform the following steps to install the agent on Windows:
    1. Click Download to download the recording agent installer.

      The devops-test-runtime.msi file is downloaded.

    2. Double-click the .msi file to install the agent.

      The installation window with the progress bar is displayed.

    3. Click Proceed to accept the download of the proprietary certificate if prompted.
    4. Click Verify to confirm the agent installation.

      A browser notification might get displayed for you to confirm the opening of the agent. You must click Open Link.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Mac:
    1. Click Download to download the recording agent installer.

      The devops-test-runtime.zip file is downloaded.

    2. Extract the .zip file:

      unzip devops-test-runtime.zip

    3. Quarantine the installer:

      xattr -dr com.apple.quarantine ./*

    4. Run the installer:

      ./install.sh

    5. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Ubuntu:
    1. Click Download to download the recording agent installer.

      The devops-test-runtime_11.0.9_amd64.deb file is downloaded.

    2. Navigate to the directory where the installer is downloaded:

      cd <download-directory>

    3. Run the installer:

      sudo apt install ./devops-test-runtime_11.0.9_amd64.deb

    4. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Linux:
    1. Click Download to download the recording agent installer.

      The devops-test-runtime-11.0.9-1.x86_64.rpm file is downloaded.

    2. Navigate to the directory where the installer is downloaded:

      cd <download-directory>

    3. Run the following command:

      INGRESS_DOMAIN=<domain_name> dnf

      localinstall ./devops-test-runtime-11.0.9-1.x86_64.rpm

    4. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    The agent is installed, but not updated, and the screen displays the following options:
    • Windows (64-bit .msi)
    • Mac OS (64-bit .zip)
    • Debian/Ubuntu (64-bit .deb)
    • RHEL/Fedora/OpenSUSE (64-bit .rpm)
    Perform the following steps to update the agent on Windows:
    1. Click Upgrade.

      The installation screen with the progress bar is displayed. The latest DevOps Test Runtime is installed and configured.

    2. Click Proceed to accept the download of the proprietary certificate if prompted.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Mac:
    1. Click Download to download the recording agent installer.
    2. Uninstall the existing agent:

      rm -rf ~/Applications/devops-test-runtime.app

    3. Extract the downloaded .zip file:

      unzip devops-test-runtime.zip

    4. Quarantine the installer:

      xattr -dr com.apple.quarantine ./*

    5. Run the installer:

      ./install.sh

    6. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Ubuntu:
    1. Click Download to download the recording agent installer.
    2. Uninstall the existing agent:

      sudo apt remove devops-test-runtime

    3. Navigate to the directory where the installer is downloaded:

      cd <download-directory>

    4. Run the following command:

      sudo apt install ./devops-test-runtime_11.0.9_amd64.deb

    5. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    Perform the following steps to install the agent on Linux:
    1. Click Download to download the recording agent installer.
    2. Uninstall the existing agent:

      sudo yum remove devops-test-runtime

    3. Navigate to the directory where the installer is downloaded:

      cd <download-directory>

    4. Run the installer:

      sudo INGRESS_DOMAIN=<domain_name> dnf localinstall ./devops-test-runtime-11.0.9-1.x86_64.rpm

    5. Click Verify to confirm the agent installation.

      The Launch button is enabled. Go to step 6.

    The agent is installed.

    The Launch button is displayed. Go to step 6.

  6. Click Launch.
    The personal agent button changes to Personal Agent Active, and the tooltip displays the following message when hovered over:

    Personal Agent Ready - Click to stop. This message indicates that the agent is active.

Results

You have downloaded and installed a DevOps Test Runtime agent. The personal agent is listed and visible only to you when you navigate to Infrastructure > Agents and Intercepts, both in the initial team space and in the projects that you are associated with.

What to do next

You can run the Web UI tests or suites and view the results. See Running server test assets and Running server suite assets.