Run tests in Docker containers

Docker is a software container platform. It is designed to make it easier to create, deploy, and run applications by using containers. Containers include everything required to make software run. They do not bundle a full operating system (like VMs do), only libraries and settings, which make them efficient, lightweight, self-contained systems.

Note: This topic is aimed at people familiar with Docker. If you are new to Docker and would like to learn more, we recommend that you visit the Docker website.

LeanFT and Docker

LeanFT provides Docker images enabling you to run your tests in Docker containers.

Docker is supported for all Web and mobile technologies, as well as for running tests in StormRunner Functional.

Using Docker containers has major benefits for developers, DevOps, and the enterprise:

  • Zero installation. Run LeanFT tests without having LeanFT installed on your machine.
  • Background execution. Run your tests in the background and continue to work without distraction.
  • Execution box. Use a single command to run the Docker image, the test, and close the container when the test is done.

Back to top

LeanFT Docker images

There are three LeanFT docker images:

  • functionaltesting/leanft. The basic LeanFT image, which contains the engine and the capabilities to run LeanFT tests.
  • functionaltesting/leanft-chrome. The basic LeanFT image with a Chrome browser.
  • functionaltesting/leanft-firefox. The basic LeanFT image with a Firefox browser.

You can use the basic functionaltesting/leanft image that we supply and create a customized image that runs a different browser version. For instructions refer to the Docker Hub website.

Tip: To find out which versions of Chrome or Firefox browsers are included with the image, add the following to the end of the docker command (described in Run the Docker image):

Chrome: google-chrome --version

Firefox: firefox --version

Back to top

Standalone mode vs. execution box mode

You can run LeanFT tests in two modes: standalone or as an execution box.

Standalone

This mode is like running tests remotely.

In this mode, you start the LeanFT container which launches the LeanFT engine. The engine then waits for commands. You run the test separately, on your machine. You may need to update the LeanFT engine address (IP or host name) in the test in order to connect to the Docker image. When you run the test, the commands are executed within the Docker container. You need to stop the container when you are done.

For details on running tests remotely, see Run tests remotely.

Execution box

This mode is like running the LeanFT engine and the test on the same machine.

In this mode, you run the LeanFT container, which launches the test within the container and closes the container when the test completes.

Back to top

License usage

LeanFT Docker integration is supported only for concurrent LeanFT licenses. For more details on license types, see LeanFT licensing.

When you run the LeanFT image, you need to indicate which license server to use. You can do that in one of two ways:

  • Using --add-host=license-server:<enter your license address>
  • Using the LFT_LIC_SERVER environment variable. For more details, see License.

Back to top

Download the LeanFT image to your registry

Before you begin you must first have Docker installed on your machine.

Download one of the following images to your machine using the pull command from a command line:

  • functionaltesting/leanft
  • functionaltesting/leanft-chrome
  • functionaltesting/leanft-firefox

For example:

docker pull functionaltesting/leanft

Back to top

Run the Docker image

  1. Decide in which mode you want to run the Docker image standalone mode or execution box. For details, see Standalone mode vs. execution box mode.
  2. To run the Docker image in standalone mode:

    Run the following from a command line:

    docker run -it -p 5095:5095 -p 5900:5900 --add-host=license-server:xx.xx.xx.xx <leanft container>

    Note: The report is generated from the location as the test is run.

    Use environment variables as required. For details, see Run the LeanFT image with environment variables.

  1. To run the Docker image as an execution box:

    This mode is supported for both Java and JavaScript.

    Java

    Run the following from a command line:

    docker run -it -p 5900:5900 --add-host=license-server:xx.xx.xx.xx -e RUN_MODE=junit -e RUN_CMD="com.company.LeanFtTest" -v <full path on the host’s machine to java jars>:/tests -w /tests leanft-chrome

    JavaScript

    docker run -it -p 5900:5900 --add-host=license-server:xx.xx.xx.xx -v <full path on the host’s machine to javascript mocha project>:/tests -w /tests <leanft container>

    Use environment variables as required. For details, see Run the LeanFT image with environment variables.

  2. After you container is up and running, run your LeanFT tests from your local machine as you always do. The browser will be launched inside the container and your script commands will be executed there.

Back to top

Run the LeanFT image with environment variables

Run the LeanFT image with various environment variables to control how the container runs.

Prefix each variable that you run with -e. For example: 

docker run -it -p 5900:5900 --add-host=license-server:xx.xx.xx.xx -e RUN_MODE=junit -e RUN_CMD="com.company.LeanFtTest" -v <full path on the host’s machine to java jars>:/tests -w /tests functionaltesting/leanft-chrome

The following table includes the environment variables, their description, and possible values.

Run commands

RUN_MODE Determines how to run the container.

junit: runs a junit test using RUN_CMD s/sa/standalone: runs the container in standalone mode.

c/custom: runs the command in RUN_CMD. Use along with RUN_CMD when you want to run a custom command.

RUN_CMD Runs a command.

The command to run.

Use this option when you want to run a custom command.

VERBOSE Determines whether to print debug information. true
LFT_SAPUI5_ADDIN Indicates loading the SAPUI addin. true
NOVNC

Indicates disabling the VNC session.

The default is false.

true
USER_UID If you run docker on Linux , we recommend that you pass your user ID in order to manage the test results files. Your user ID
USER_GID (Optional) If you run docker on Linux , pass your group ID to provide group permissions. Your group ID

License

LFT_LIC_SERVER

The license server IP address or host name.

Can be used instead of --add-host=license-server:xx.xx.xx.xx

The license server IP address or host name.
LFT_LIC_ID The license ID that you want to use. The default is 20524. license number
LFT_LIC_ID_VERSION

The license ID version.

The default is 1.

version number

Mobile Center

You must use all three environment variables.

LFT_HPEMC_ADDRESS Use this variable along with LFT_HPEMC_USER and LFT_HPEMC_PASS to run Mobile Center in the container. The Mobile Center IP address or host name.
LFT_HPEMC_USER The Mobile Center user name used for logging on. The Mobile Center user name.
LFT_HPEMC_PASS The Mobile Center password used for logging on.

An encrypted password using the docker container machine encryption. For example:

docker run -it leanft /opt/leanft/Tools/password-encoder -me <password>
LFT_HPEMC_USE_PROXY Indicates whether Mobile Center runs behind a proxy. True or False
LFT_PROXY_ADDRESS The proxy IP address or host name.  

StormRunner Functional

LFT_SRF_ADDRESS The StormRunner Functional IP address or host name.  
LFT_SRF_CLIENT_ID Credentials for logging into StormRunner Functional. The client ID you generated to connect to StormRunner Functional.
LFT_SRF_CLIENT_SECRET The secret you generated to connect to StormRunner Functional.

An encrypted password using the docker container machine encryption. For example:

docker run -it leanft /opt/leanft/Tools/password-encoder -me <password>
LFT_SRF_USE_PROXY Indicates whether StormRunner Functional runs behind a proxy. True or False.
LFT_PROXY_ADDRESS The proxy IP address or host name.  

Proxy

Use these variables if you are running behind a proxy server.

http_proxy Your organization's http proxy. Host name or IP address and port
https_proxy Your organization's https proxy. Host name or IP address and port
no_proxy Any address that does not require a proxy, such as you local host. Host name or IP address and port

Back to top

See also: