smartbear/readyapi-testengine repository overview

⁠Introduction

ReadyAPI TestEngine⁠ allows SmartBear users to run ReadyAPI functional API tests in an automated, server-based environment. It delivers the most value when used together with ReadyAPI⁠ and CI/CD pipelines.

⁠Important Notes

Versions '1.25.1' and later mitigate the log4j CVE-2021-44228 vulnerability.

⁠Before You Start

1. To run TestEngine, you need a valid license. Purchase a license from the SmartBear website⁠ or use an SLM access key for automatic activation.
2. Expose all ports used in the configuration and ensure your network allows traffic on those ports.
3. The default embedded database is H2. For production use, consider configuring an external PostgreSQL database.

⁠Application Setup

Default API address: http://localhost:8080

⁠docker-compose

version: "3.8"  
  
services:  
  testengine:  
    image: smartbear/readyapi-testengine:latest  
    container_name: testengine  
    ports:  
      - "8080:8080"  
      - "8443:8443"  
    environment:  
      - TESTENGINE_PASSWORD=admin_password  # password for admin user
      - TestEngineUser=john.smith  # username for a new user
      - TestEnginePassword=secret  # user password
      - TestEngineUserRole=Admin
      - SlmAccessKey=YOUR_ACCESS_KEY_HERE  
      - SlmServer=https://license-server.example.com  # optional  
    volumes:  
      - ./data:/data  # optional  
      - ./ext:/ext   # optional  
    restart: unless-stopped  

Start the service:

docker-compose up -d  

⁠Docker CLI

docker run -d \  
  --name testengine \  
  -v /opt/testengine/data:/data \  # optional  
  -v /opt/testengine/ext:/ext \  # optional 
  -p 8080:8080 \  
  -p 8443:8443 \  
  -e TESTENGINE_PASSWORD=your-admin-password \  #password for admin
  -e TestEngineUser=john.smith \  # username for a new user
  -e TestEnginePassword=secret \  #password for user
  -e TestEngineUserRole=Admin \  
  -e SlmAccessKey=YOUR_ACCESS_KEY_HERE \  
  --restart unless-stopped \  
  smartbear/readyapi-testengine:latest  

⁠Alternative Run Commands

docker run -d \  
  -v /opt/testengine/data:/data \  
  -p 8080:8080 \  
  -e TESTENGINE_PASSWORD=your-admin-password \  
  -e SlmAccessKey=<SLM access key> \  
  smartbear/readyapi-testengine:latest  

docker run -d \  
  -v /opt/testengine/data:/data \  
  -p 8080:8080 \  
  -e TESTENGINE_PASSWORD=your-admin-password \  
  -e SlmServer=<SLM license server address> \  
  -e SlmAccessKey=<SLM access key> \  
  smartbear/readyapi-testengine:latest  

docker run -d \  
  -v /opt/testengine/data:/data \  
  -p 8080:8080 \  
  -e TESTENGINE_PASSWORD=your-admin-password \  
  -e SlmAccessKey=<SLM access key> \  
  -e JVM_OPT_db_driver="<VARIABLE_SYNTAX>" \
  -e JVM_OPT_db_url="<VARIABLE_SYNTAX>" \
  -e JVM_OPT_db_user="<VARIABLE_SYNTAX>" \
  -e JVM_OPT_db_password="<VARIABLE_SYNTAX>" \
  smartbear/readyapi-testengine:latest  

docker run -d \  
  -v /opt/testengine/data:/data \  
  -p 8080:8080 \  
  -e TESTENGINE_PASSWORD=your-admin-password \  
  -e TestEngineSandbox=true \  
  -e SlmAccessKey=<SLM access key> \  
  smartbear/readyapi-testengine:latest  

⁠Setup Parameters

⁠Environment Variables

When running docker run (or the equivalent in Docker Cloud or similar platforms), you pass configuration values to the container using environment variables.

In Docker Cloud and similar platforms, you typically configure these variables in a table view. When running from the command line, define them as environment variables in the container configuration.

The following parameters are available:

* Required only for the initial run. If you reuse the same storage volume (/data) between runs, TestEngine retains its stored configuration and user data.

⁠Configuration File (readyapi-testengine.yaml)

The configuration file is persisted at /data/readyapi-testengine.yaml. It supports `` substitution. You can override individual properties at runtime using JVM_OPT_* variables with VARIABLE_SYNTAX like this: -Ddw.<path>=<value>.