reg-compose-header

Selenium WebDriver – How To Run Multiple Test Suites Using Docker Compose – Part 2

Overview:

The modern cloud infrastructure, continuous integration & deployment processes etc have completely changed the way how applications are deployed in production nowadays. In order to release new features faster in Production, you need to reduce time we take in the each phase of the SDLC. As an automation lead/architect, It could be your responsibility to have a proper infrastructure to speed up the automated test execution! When it comes to infrastructure automation, Docker plays a major role there!

Testautomationguru already has few docker and selenium related articles which talks about setting up the dockerized selenium grid & running a docker container with a test.

  1. Setting up Dockerized Selenium grid.
  2. Running Automated Tests Inside A Docker Container – Part 1

Before continuing this article, I would request you to read the above 2 first! I am explaining few things here assuming that you have already read them.

This article is going to explain how to combine above 2 articles – ie running all regression testcases with multiple test suites & selenium grid with a single docker-compose file.

Test Suites:

We have thousands of automated tests for my application. I categorize / group them, based on the application business functionality / module and create multiple test suites. So that any change in specific module can trigger corresponding test suites.

Lets assume – in our sample application for this article, we have 3 modules.

  1. Registration Module
  2. Search Module
  3. Order Module

Lets also assume that, each module has hundreds of automated test cases already.  In order to get my automated results as early as possible, We need  to have multiple hosts + Selenium Grid set up as shown here to run the entire regression test suites!!

 

reg-suite-set-up

 

Setting up all the above machines with all the dependencies is a nightmare!

Lets see how we could set up the above entire infrastructure in a single compose file and execute the tests!!

Sample Project:

For the demo, I have created a simple project as shown here. This sample project is available in Github.

reg-suite-proj-set-up-1

Page Objects:

  • Above project has 2 page objects
    • SearchPage – acts as a page object for the search module (this is actually a page object for google search).
    • OrderPage  – acts as a page object for order module (this is actually a page object for  demoqa site).

Test Classes:

  • BaseTest – a base test which contains the logic for driver instantiation.
  • SearchTest – extends BaseTest – contains the test for the Search Module.
  • OrderTest – extends BaseTest – contains the test for the Order Module.

Test Suites:

In real life, we will have multiple tests for a single module. In our sample project, we have only one test. We collect all the tests for a module and create a test suite file as shown here.

  • order-module.xml – a testNG suite file which invokes order module tests.
<suite name="order-module" parallel="none" allow-return-values="true" >
  <test name="order-test">
    <classes>
      <class name="com.testautomationguru.container.test.OrderTest"/>
    </classes>
  </test>
</suite>
  • search-module.xml – a testNG suite file which invokes search module tests.
<suite name="search-module" parallel="none" allow-return-values="true" >
  <test name="search-test">
    <classes>
      <class name="com.testautomationguru.container.test.SearchTest"/>
    </classes>
  </test>
</suite>

Test Requirement:

In order to do the complete regression testing for the application, Lets assume that we need to invoke the tests for both modules as given below.

  • order module testing on chrome
  • search module testing on firefox

Dockerfile:

I create the below Dockerfile which creates an image which contains all the dependencies to the run the test including the testNG suite files. [I have already explained this here – Please read the article if you have not already]

FROM openjdk:8-jre-slim

# Add the jar with all the dependencies
ADD  target/container-test.jar /usr/share/tag/container-test.jar

# Add the suite xmls
ADD order-module.xml /usr/share/tag/order-module.xml
ADD search-module.xml /usr/share/tag/search-module.xml

# Command line to execute the test
# Expects below ennvironment variables
# BROWSER = chrome / firefox
# MODULE  = order-module / search-module
# SELENIUM_HUB = selenium hub hostname / ipaddress

ENTRYPOINT /usr/bin/java -cp /usr/share/tag/container-test.jar -DseleniumHubHost=$SELENIUM_HUB -Dbrowser=$BROWSER org.testng.TestNG /usr/share/tag/$MODULE

So basically idea here is to create a single image which accepts browser, module as parameters – then create a container which tests specific module.

Creating An Image:

Executing below command compiles, packages the jar with all the dependencies and builds the docker image based on the above Dockerfile.

mvn clean package

 

reg-suite-build-1

Docker Compose File:

Testautomationguru has already explained setting up the whole selenium grid infrastructure using docker-compose in this article – Setting up Dockerized Selenium grid.

version: "3"
services:
  selenium-hub:
    image: selenium/hub
    container_name: selenium-hub
    ports:
      - "4444:4444"
  chrome:
    image: selenium/node-chrome
    depends_on:
      - selenium-hub
    environment:
      - HUB_PORT_4444_TCP_ADDR=selenium-hub
      - HUB_PORT_4444_TCP_PORT=4444
  firefox:
    image: selenium/node-firefox
    depends_on:
      - selenium-hub
    environment:
      - HUB_PORT_4444_TCP_ADDR=selenium-hub
      - HUB_PORT_4444_TCP_PORT=4444

We were able to successfully create a Selenium Grid using above docker compose file.  Now we are going to add the image we created to create containers to test specific module.

search-module:
    image: vinsdocker/containertest:demo
    container_name: search-module
    depends_on:
      - chrome
      - firefox
    environment:
      - MODULE=search-module.xml
      - BROWSER=firefox
      - SELENIUM_HUB=selenium-hub
order-module:
    image: vinsdocker/containertest:demo
    container_name: order-module
    depends_on:
      - chrome
      - firefox
    environment:
      - MODULE=order-module.xml
      - BROWSER=chrome
      - SELENIUM_HUB=selenium-hub
  • depends_on – lets the docker know that the service should be created once the all the dependent containers have been created.

container-test-doc-03

Test Suites Execution:

Once the docker compose file is ready, the rest is very simple!!

  • A single command creates the entire infrastructure and executes the test.
sudo docker-compose up -d
Creating selenium-hub
Creating sel_firefox_1
Creating sel_chrome_1
Creating order-module
Creating search-module
  • Execute the below command to see the status
sudo docker-compose ps
    Name                   Command               State           Ports
-------------------------------------------------------------------------------
order-module    /bin/sh -c /usr/bin/java - ...   Up
search-module   /bin/sh -c /usr/bin/java - ...   Up
sel_chrome_1    /opt/bin/entry_point.sh          Up
sel_firefox_1   /opt/bin/entry_point.sh          Up
selenium-hub    /opt/bin/entry_point.sh          Up      0.0.0.0:4444->4444/tcp
  • Once the test execution is done, you would see Exit 0  (in case of any test failures, you would see Exit 1)
sudo docker-compose ps
    Name                   Command               State           Ports
-------------------------------------------------------------------------------
order-module    /bin/sh -c /usr/bin/java - ...   Exit 0
search-module   /bin/sh -c /usr/bin/java - ...   Exit 0
sel_chrome_1    /opt/bin/entry_point.sh          Up
sel_firefox_1   /opt/bin/entry_point.sh          Up
selenium-hub    /opt/bin/entry_point.sh          Up      0.0.0.0:4444->4444/tcp
  • If you are curious to see the test log of order-module and search-module only, then go for below command.
sudo docker-compose up | grep -e 'order-module' -e 'search-module'

reg-suite-log

  • To bring everything down, of course with a single command!
sudo docker-compose down
Removing search-module ... done
Removing order-module ... done
Removing sel_firefox_1 ... done
Removing sel_chrome_1 ... done
Removing selenium-hub ... done

Now the very complex selenium grid + hosts to run the java tests became very simple which you could define it in a text file. A single command creates the infrastructure in a second on a single host (you can also do that in multiple hosts) and disposes once everything is complete!

container-test-doc-04

 

GitHub:

This sample project is available here.

Summary:

Docker compose made our life very easier! With a single command,  we create Virtual Machines (containers are light weight VMs) with required browsers, tests and executes the test. Again with another command, we bring the entire infrastructure down!!

No more environment specific issues like ‘the test is not working in the machine’   🙂

By implementing docker in your project, you become 100% awesome as Barney!!

barney-awesomeness-thums-up

 

Happy Testing & Subscribe 🙂

 

Share This:

Categories: Articles, CI / CD / DevOps, Docker, Framework, Selenium, Selenium Grid

6 comments

  • Rahul

    Hi Vinoth,

    First of all thank you very much for the article. It is very helpful.
    I was trying to run your github code with small modifications to it. I was able to successfully run mvn test and also successfully get image, The problem appeared when I tried running the image created.
    I am constantly getting configuration failures.

    If you find sometime, please see my repo at –
    https://rahul-upadhyay@bitbucket.org/rahul-upadhyay/docker-maven-testng.git

    All my changes are placed in the files. This is basically your copy with some modifications.
    Need your help.

    • vIns

      TestNG expects all the dependencies to be in a separate folder – instead of one single jar. I modified my pom file in the github project. Please update yours and try.

  • Musaffir

    Hi Vinoth,
    Really useful article… Thanks for writing these…
    May I know where you are passing the chrome driver executable file here …? how the chrome instance configured with the hub will be invoked as it must definitely need to have the executable file ….
    also will you be able to visually see the browser automation when the tests are happening in the container..

    Thanks & Warm Regards
    Musaffir

  • Musaffir

    Now I understand you don’t have to pass the chrome driver executable… just would like to know how we can view the automtaed tests …

  • Musaffir

    Thanks Vinoth…
    One more question here…

    When you do mvn clean package….mvn is executing your tests already and it creates the test jar for you…. and later when mvn runs the docker plugin it utilizes the test jar and making an image… the image can be run on any machine where docker is installed…
    So for the first time , is your tests is not done on docker…?
    or is it also done on docker… in that case the tests will be happening two times as mvn already executed the tests in its test phase… pls clarrify….

Leave a Reply to vIns Cancel reply

Your email address will not be published. Required fields are marked *