Description

The Step Docker plugin provides an integration with Docker and let you run containerized application with Step as well as executing test scenario (Keyword) against the containerized application.

Usage

Prepare your Step agent to be able to use Docker

Install Docker

Refer to the official Docker documentation in order to install Docker on the OS your Agent is running on.

Update the Agent configuration file

In order for the Step Controller to be able to target the Agent where Docker is running, the Agent configuration needs to be updated by adding the “$docker” selection criteria:

tokenGroups:
- capacity: 1
  tokenConf:
    attributes:
      $docker: true

If your Agent is running in a container itself, the attribute “docker.in.docker” also needs to be set:

tokenGroups:
- capacity: 1
  tokenConf:
    attributes:
      $docker: true
      docker.in.docker: true

Refer to Agent installation and to Keyword routing for more details about the Agent configuration.

Configure your Docker registry in Step

In order to use the Docker image defined in the next section of this documentation, you first need to define the Docker repository to use to pull your image.

To do so, navigate to the Admin views, select Docker registries, hit the add button and fill the informations about your registry:

Registry URL
Registry user
Registry password

Define your container settings using the Session Control

Now that you registry has been created, you can create your Step plan to define your test.

In order to start your containerized application on the Step Agent, you will have to use a Session control withing your plan and configure its “Docker” section accordingly:

Docker image: the Docker image to use to start the container
Container user: the user under which the application will run
Container command (optional) : can be used to override the default image CMD or ENTRYPOINT (useful for debugging)