Elastest Documentation

Try ElasTest

In this section we will see how to install and start ElasTest depending on the platform you are going to use:

ElasTest on Laptop
ElasTest on Linux VM
ElasTest on Server
ElasTest on Kubernetes

We'll also see how to manage your ElasTest installation.

ElasTest on laptop

ElasTest is based on Docker technology. To execute ElasTest you need Docker CE installed on your machine following the official instructions:

For Ubuntu.
For Mac.
For Docker for Windows or for Docker Toolbox for Windows.

Although ElasTest can be used on both Mac and Windows, it is recommended to use Linux since in these two OS docker runs on an internal VM.

For Linux

Once you have docker installed, execute the following command to start ElasTest:

docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start

Whatever platform you are using, you will see this output when ElasTest is ready:


  Pulling some necessary images...

  Preload images finished.

  Starting ElasTest Platform latest (mini Mode)...

  Creating volume "elastest_platform-services" with local driver
  Creating elastest_platform-services_1 ... done
  Creating elastest_edm-mysql_1         ... done
  Creating elastest_etm-filebeat_1      ... done
  Creating elastest_etm_1               ... done
  Creating elastest_etm-proxy_1         ... done

  ElasTest services are starting. This will likely take some time. The ElasTest URL will be shown when ready.


  ElasTest Platform is available at http://localhost:37000

  Press Ctrl+C to stop.

You can then open in your web browser the shown URL to access to ElasTest dashboard.

To stop ElasTest, press Ctrl+C in the shell used to start it. Now you can try any of the test projects available by default when you start ElasTest. You can start with Unit Tests project.

Options

You can add --testlink if you want to start the TestLink integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --testlink

The --jenkins option can be added if you want to start the Jenkins integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --jenkins

You can execute --help if you need more information about the options.


  docker run --rm -v /var/run/docker.sock:/var/run/docker.sock elastest/platform --help

Recommended system specifications

ElasTest needs some minimum system specifications in order to run smoothly:

Processor	1GHz or faster
RAM	16GB
SWAP	4GB (if RAM < 16GB)
Hard Disk	30GB

For Mac

Once you have docker installed, execute the following command to start ElasTest:

docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start

Whatever platform you are using, you will see this output when ElasTest is ready:


  Pulling some necessary images...

  Preload images finished.

  Starting ElasTest Platform latest (mini Mode)...

  Creating volume "elastest_platform-services" with local driver
  Creating elastest_platform-services_1 ... done
  Creating elastest_edm-mysql_1         ... done
  Creating elastest_etm-filebeat_1      ... done
  Creating elastest_etm_1               ... done
  Creating elastest_etm-proxy_1         ... done

  ElasTest services are starting. This will likely take some time. The ElasTest URL will be shown when ready.


  ElasTest Platform is available at http://localhost:37000

  Press Ctrl+C to stop.

You can then open in your web browser the shown URL to access to ElasTest dashboard.

To stop ElasTest, press Ctrl+C in the shell used to start it. Now you can try any of the test projects available by default when you start ElasTest. You can start with Unit Tests project.

Options

You can add --testlink if you want to start the TestLink integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --testlink

The --jenkins option can be added if you want to start the Jenkins integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --jenkins

You can execute --help if you need more information about the options.


  docker run --rm -v /var/run/docker.sock:/var/run/docker.sock elastest/platform --help

Recommended system specifications

ElasTest needs some minimum system specifications in order to run smoothly:

Processor	1GHz or faster
RAM	16GB
SWAP	4GB (if RAM < 16GB)
Hard Disk	30GB

For Windows

Once you have docker installed, execute the following command to start ElasTest:

IMPORTANT: for the following command, you need to create the "~/.elastest" folder manually before.

Docker for Windows

docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start

Docker Toolbox(_run it from your Docker Toolbox terminal_)


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --server-address=$(docker-machine ip)

Whatever platform you are using, you will see this output when ElasTest is ready:


  Pulling some necessary images...

  Preload images finished.

  Starting ElasTest Platform latest (mini Mode)...

  Creating volume "elastest_platform-services" with local driver
  Creating elastest_platform-services_1 ... done
  Creating elastest_edm-mysql_1         ... done
  Creating elastest_etm-filebeat_1      ... done
  Creating elastest_etm_1               ... done
  Creating elastest_etm-proxy_1         ... done

  ElasTest services are starting. This will likely take some time. The ElasTest URL will be shown when ready.


  ElasTest Platform is available at http://localhost:37000

  Press Ctrl+C to stop.

You can then open in your web browser the shown URL to access to ElasTest dashboard.

To stop ElasTest, press Ctrl+C in the shell used to start it. Now you can try any of the test projects available by default when you start ElasTest. You can start with Unit Tests project.

Options

You can add --testlink if you want to start the TestLink integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --testlink

The --jenkins option can be added if you want to start the Jenkins integrated in ElasTest and enable access to it. If you do not add this option, you can start it later manually from the ElasTest GUI.


  docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform start --jenkins

You can execute --help if you need more information about the options.


  docker run --rm -v /var/run/docker.sock:/var/run/docker.sock elastest/platform --help

Recommended system specifications

ElasTest needs some minimum system specifications in order to run smoothly:

Processor	1GHz or faster
RAM	16GB
SWAP	4GB (if RAM < 16GB)
Hard Disk	30GB

ElasTest on a Linux Virtual Machine

To run ElasTest on a Linux Virtual Machine and be able to access it from the host it is necessary to use the --server-address option with the IP of the VM that the host sees as value. Once you have started ElasTest you should be able to access the url http://VM-IP:37000 from your browser on the host.

ElasTest on a server

Linux server

To run ElasTest on a Linux server follow the steps detailed in the Linux Server section.

Amazon Web Services

ElasTest has been designed from the outset to offer an extremely simple deployment in Amazon Web Services. Check Amazon Web Services section to learn how to do it in a couple of minutes.

ElasTest on Kubernetes

You have all the information here.

ElasTest Installation Management

Updating ElasTest

To update ElasTest to the latest stable version available, just need to change start to update and add -it in the launching command:

docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock elastest/platform update

The update command will detect if you are currently running ElasTest with the same version you want to update to and, if so, warn you that if you continue that instance will be stoppped.

docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock elastest/platform update
Updating ElasTest Platform version ...
You are going to update the ElasTest version unspecified. Continue? [Y/n]
The version of ElasTest that you want to update is already running and it is  necessary to stop it. Continue? [Y/n]

If your answer is 'Y', then the following message will appear while ElasTest is being Updating.

Preparing the environment...

When all containers have been pulled you will see an output similiar to:

Update finished successfully.

In order to clean the ElasTest installation, the old images associated with the previous version will be removed from the system after the update process has finished.

Using a specific ElasTest version

To use a specific ElasTest version available, only need to set it as elastest/platform tag, that is, adding :version. For example, to use the 1.0.0 version you would have to execute the following command

docker run --rm -v ~/.elastest:/data -v /var/run/docker.sock:/var/run/docker.sock elastest/platform:1.0.0 start

ElasTest data

You can see the Elastest data information here