Automation Test Queue (ATQ): Director

Automation Test Queue is a server-side binary which exposes a HTTP API and communicates with the Docker subsystem.

It's designed to work alongside a Docker Swarm cluster creating a short-lived distributed services on demand in the cluster with their own virtual network.

This ease the testing stage in CI/CD scenarios, allowing to run tests in a public/private/hybrid cloud without taking care of the infrastructure. The only configuration needed is an already working Docker Swarm and desired Docker Images.

It's developed in Golang and cross-compiled, so it's compatible natively with al OSes (Linux, OSX and Windows) and works with both container types: Windows & Linux with minimum host resource consumption.

How It Works?

ATQ-Director is installed in the Docker Swarm Host and listen for requests in a specified HTTP port.

When a new task is received, ATQ-Director deploys a new Service containing Discovery functions in all the Manager nodes in Global mode and exposes in the hosts the port 9090.

Then the Worker Service is deployed within the same network with DNSRR mode in order to make Discovery works.

ATQ waits until all containers are up & running and all their VIPs are accesible inside the created network using the first deployed Discovery Service and then, removes the Discovery service as it won't be needed anymore.

Master service is deployed in the same network context in mode replicated with only 1 instance.

The test stage begins as you deserve!

Versioning

ATQ will not broke your code upgrading the Release version cause all major changes to the API will be developed in a brand new version endpoint.

The initial version starts with v1 tag: https:\\host:port\v1\.... And the following versions will be https:\\host:port\v2...

Configuration

You can specify which images are available to use with ATQ for security reasons with a YAML configuration file with the following structure:

port: 8080
glusterPath: ...
images:
  - imageName: mtenrero/jmeter
    args:
      - name: MODE
        required: true
      - name: TEST_NAME
        required: false
      - name: REMOTES
        required: false

All images specified in this file will be pulled from the registries to make them available instantly when requested, so starting time may be increased in the first launch.

GlusterPath

GlusterPath represents the path on the filsystem which is shared between Docker Swarm nodes in order to ATQ middlewara data be available from all nodes.

It has been tested with GlusterFS and Samba.

Images

Images contain a list with the enabled images available to use with ATQ-Director

Available fields:

• imageName: Docker Image identifier (Docker Hub / Private Registry)
• Args: Available arguments

API

In order to maintain an up-to-date API documentation, please, check the Swagger API generated docs available inside the swagger folder in this repository

How to use this repository

I've used dep for vendor handling. So make sure tu do a dep ensure before start to code.

Goa Design

HTTP API were designed at the beggining of the project. Goa Design Framework was used to define the API, it has its own DSL and its available in the http/design package.

After a design modification it's neccesary to run the script ./regenerateGoa.ps1 or ./regenerateGoa.sh (depending OS) in order to regenerate all files taking care of the vendoring directory, which causes issues with goagen

If needed, check goa documentation: https://goa.design

Testing & Good practices

All commits should improve the test coverage and any commit that couldn't pass the tests will not be merged in the master branch.

Master branch is stable. All improvements or fixes should be done in the golang-dev branch or inside a specific branch.

Any feature should be well documented and tested.

Godocs compatible code must be used.