Skip to main content
Version: DAI 26.2

Environments

For information about how environments work in DAI, please read About Execution Environments and Agents before this page.

To start using an execution environment, you need to:

Add an Execution Environment​

Before you install and configure an agent to run your tests, you must add an execution environment. This process generates a unique access key (.ini file) that you’ll need to complete your agent setup.

To set up an execution environment, follow these steps:

  1. Log into Eggplant DAI with your browser. The Spaces page opens, with the Environments option available in the menu on the left.

    The DAI Spaces page showing the **Shared space** and the **Environments option in the menu on the left

    Display the DAI Spaces page to see the Environments option in the menu on the left

  2. Click Environments. The Execution environments page opens showing a list of existing execution environments and their status.

  3. Click + New environment. The New environment General tab opens.

    The **New environment General** tab, where you specify information about a DAI execution environment

    The New environment General tab, where you specify information about a DAI execution environment

  4. In the Environment name box, enter a unique name for the execution environment with no spaces.

    note

    The agents can run on the same machine as the Eggplant DAI server, or any local or hosted machine that can connect to the Eggplant DAI server via the network.

  5. (Optional) Add Environment tags by entering a name for the tag and pressing Enter. You can add any number of tags, which can be used for selecting an environment to use in a test.

  6. (Optional) Enter the full path to access the .CSV files for using with code snippets in the suite. For example, for a .CSV file located on your desktop, enter C:\Users\Eggy\Desktop\.

  7. Click Create environment. The .ini file automatically downloads to your system and the Execution environments Spaces tab opens, with the name of your new environment at the top of the page. All environments are available in the Shared space by default, but you need to select any private spaces you want to grant access to this environment on this tab.

    The **New environment Spaces** tab, where you select any private spaces you want to grant access to your new environment and the **Shared space** is selected by default

    The New environment Spaces tab, where you select any private spaces you want to grant access to your new environment and the Shared space is selected by default

  8. Select the spaces you want to have access to your new environment, and click Save.

  9. Continue to Install Eggplant Studio/Fusion Engine.

Install Eggplant Studio/Fusion Engine​

Install Eggplant Functional (EPF) on a machine that is network accessible to the DAI Server and the machine where you will run your agent. See Install Eggplant Functional for more information.

Install an Agent​

Agents are available as a Windows .exe files, Mac apps, and Linux binaries for CentOS/Red Hat and Ubuntu. See the Prerequisites page for information about supported operating system versions.

note

The agent installers are also available from the Eggplant Software Downloads page.

  1. On the Environments page, click Agent Tools.
    Separate installers are available for the DAI Design Agent and the DAI Run Agent. You can choose to download either or both. For each installer that you require carry out the following steps 2 to 4:
  2. From the Design/Run Agent Installer list, select the platform that you use.
  3. Select Download to save the installation file to your Downloads folder.
  4. Open your Downloads folder and use the following platform-specific instructions.

For Windows​

Double-click eggplantDAIDesignAgent.exe or eggplantDAIRunAgent.exe and follow the prompts to complete the installation.

For macOS​

  1. Double-click eggplantDAIDesignAgent.dmg or eggplantDAIRunAgent.dmg.
  2. Drag eggplantDAIDesignAgent.app or eggplantDAIRunAgent.app into your Applications folder.

For Linux​

note

The steps for extracting and running the agent are the same across different Linux platforms.

  1. Manually extract eggplantDAIDesignAgent-Linux.tar.gz or eggplantDAIRunAgent-Linux.tar.gz to your preferred directory, or use the following script:

    cd $HOME
    mkdir eggplant
    tar -xzf eggplantDAIDesignAgent-Linux-26.2.1-0.tar.gz -C "$HOME/eggplant"

  2. (Optional) To run eggplantDAIDesignAgent or eggplantDAIRunAgent directly from the command line, add export PATH="$PATH:$HOME/eggplant" to your .bashrc or .zshrc file, or use the following commands:

    cd $HOME/eggplant
    ./eggplantDAIDesignAgent

Launch Your DAI Design Agent​

You can launch the DAI Design Agent from the Start menu on Windows or from the Applications folder on a Mac.

For Windows​

Open eggplantDAIDesignAgent from the Start menu.

For macOS​

Launch the eggplantDAIDesignAgent from the Applications folder.

For Linux​

Launch your DAI Design Agent from the terminal.

  1. Open a command prompt.

  2. Find the directory where you extracted the .tar.gz file, e.g.:

    cd $HOME/eggplant

  3. Enter the following command to run the DAI Design Agent:

    ./eggplantDAIDesignAgent

Configure Your DAI Design Agent​

To log in and start using your DAI Design Agent, you must:

Add Your Agent Access Key​

  1. On the DAI Design Agent dialog box, select Add New and browse to the access key (.ini file) that you downloaded in Add an Execution Environment or Regenerate Access Key.
  2. Click Open. The Execution Environment box shows the name and URL of the execution environment that you created and the details are automatically added to an environment settings file on your computer.
  3. Click Login to authenticate with your Eggplant DAI environment. A new DAI Design Agent dialog box appears as soon as your access key is verified.
  4. Delete the access key from your computer.

Enter Your Connection Details​

  1. Update the default value in the Eggplant Functional drive executable box if the eggplant.bat is stored in a different place on your system.
  2. If necessary, update the default value in the Port box.
  3. Select the Extra debug messages checkbox to display more detailed messages in the Log output pane.
  4. In the Suites pane, click Choose to browse and select the folder on your system that contains your Eggplant Functional suites and SenseTalk code snippets. See Manage Suites to learn how to upload and download subfolders in this directory.
  5. Click Start to launch the DAI Design Agent. Both the DAI Design Agent and Eggplant Functional launch automatically.
note

Click Stop to close the DAI Design Agent or Logout to go back to the DAI Design Agent Login screen to connect to a different server.

Regenerate an Access Key​

If you need to regenerate your access key for security reasons, for example, follow the steps below:

Important

If you upgraded to DAI 26.2.1, you need to regenerate your access key so the URLs it contains use HTTPS.

  1. Log in to Eggplant DAI.

  2. Go to Spaces > View all spaces > Environments. The Environments page shows a list of the existing execution environments and their status.

  3. Click the actions menu of the execution environment that you're interested in and select Regenerate access key:

    Regenerate access key option on an Environment Action Menu

    Regenerate access key option on an Environment Action Menu

  4. When the dialog box appears, click Regenerate and then Download. Store the .ini file in a secure location.

  5. Follow the instructions in Add Your Agent Access Key to set up your agent with the new key.

Launch Your DAI Run Agent​

The DAI Run Agent is a lightweight command-line application (no user interface) used solely to run tests without needing the other features that the DAI Design Agent offers such as managing suites.

The DAI Run Agent configuration is set via its command-line arguments. More details in the DAI Run Agent page.

Last updated on