Environments

In ReadyAPI, an environment is a set of parameters that match certain configuration for your tests. An environment includes API endpoints, authentication profiles for REST, SOAP, and GraphQL services, database connection settings, custom project properties, and parameters of connection to JMS servers.

By switching an environment, you can quickly change properties of your test without the necessity of changing them manually.

1. To open the Endpoints & Environments editor, select Configure Environments from a drop-down list on the ReadyAPI toolbar:

   

   Click the image to enlarge it.

2. In the editor, click to add an environment:

   

   Click the image to enlarge it.

3. Specify a name for the new environment and click OK.

   

   In ReadyAPI 1.9 or earlier, using services or interfaces with identical names can cause issues. Please update to ReadyAPI 3.56 to make sure your services have unique identifiers.

4. Populate the environment with the needed endpoints, properties, JDBC connections, and JMS servers.

   Tip:	You can copy or move custom properties to other environments. Besides that, you can copy the entire environment to another project.

To configure environments, select Configure Environments from a drop-down list on the toolbar:

Click the image to enlarge it.

Change API endpoints, project properties, JDBC connections, and JMS servers for different environments by using the corresponding tabs:

Toolbar

Use the buttons on the Endpoints & Environments editor toolbar to add, remove, modify environments, or copy them to another project.

Icon	Option	Description
	Add	Adds a new environment.
	Remove	Deletes the selected environment.
	Rename	Renames the selected environment.
	Clone	Creates a copy of the selected environment.
	Sort	Sorts environments alphabetically.
	Move Up Move Down	Moves the selected environment up or down in the list. The order of environments will also be changed in the Environments drop-down. Tip: You can also drag an environment to change its position in the list.
	Copy environment	Copies the selected environment to another project. To learn more, see below.

To switch between environments, use one of the following commands:

• Use the drop-down list on the control bar:

  

  Click the image to enlarge it.

• Double-click an environment in the Endpoints & Environments editor.

• Right-click an environment in the Endpoints & Environments editor, and select Set Active.

• Use the <project name>.setActiveEnvironment(<environment name>) code line in the setup or teardown script, or in the Groovy script test step:

  Groovy

  Groovy

  // Replace the project and environment names with those you need
  
  def proj = testRunner.testCase.project.workspace.getProjectByName("Sample Project")
  
  proj.setActiveEnvironment("Test Environment")

Set environments in command line runners

ReadyAPI copies environment values (API endpoints and the needed authorization profiles, custom project properties, JDBC connections, and JMS servers). To copy environments to another project:

1. Select the needed environments. Hold Ctrl or Shift to select several environments.

2. Click .

3. Select the project to which you want to copy environments.

To learn what ReadyAPI will do if the target project contains an element with the same name, see the following table:

• Functional test runner

• Performance test runner

• Security test runner