A Java plugin for gauge to send the test execution summary to a defined audience

Why do we need an email client for Gauge?

Gauge is a light-weight, cross-platform, behavior driven test automation tool with the ability to author test cases in the business language. It is developed by thoughtworks.

If you like to learn more regarding Gauge, you can go-through this documentation.

In testing perspective, the test execution report is a vital document where the stakeholders can get an idea of the project health.

Gauge is proving a detailed test execution report with all the error messages and the screenshots incorporated to the failing steps.

But anyhow we should manually send the test execution report to the stakeholders by mentioning the number of scenarios executed, passed count, failed count and skipped count. Also in a regression cycle, we have to send those counts as module wise figures. Further we are embedding pie charts and bar charts to that report to represents the test execution data in a high readable manner.

Here I have given an automated solution for this issue.

How to use MaxSoft — GReporter?

Pre-requisites:

Gmail Configuration

1. Go to this link.
2. Turn on Less secure app access.

Step by step guide:

1. Clone this demo project.
2. Go to “env” folder of the demo project and copy “chart” and “email” folders into your gauge project’s “env” folder.
3. Copy “manifest.json” file of the demo project and replace it with your gauge project.
4. Add these repositories and dependencies to your “pom.xml”.

<repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
</repositories>

<dependencies>
        <dependency>
            <groupId>com.github.osandadeshan</groupId>
            <artifactId>maxsoft-greporter</artifactId>
            <version>1.1.0</version>
        </dependency>
        <dependency>
            <groupId>com.thoughtworks.gauge</groupId>
            <artifactId>gauge-java</artifactId>
            <version>0.7.15</version>
        </dependency>
</dependencies>

5. Add these properties to your “pom.xml” file.

    <properties>
        <src.dir>src/main/java</src.dir>
        <emailConfigEnv>dev</emailConfigEnv>
    </properties>

6. Add these build configurations to your “pom.xml” file.

<build>
   <plugins>
      <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>exec-maven-plugin</artifactId>
         <version>3.0.0</version>
         <executions>
            <execution>
               <goals>
                  <goal>java</goal>
               </goals>
            </execution>
         </executions>
         <configuration>
            <mainClass>com.maxsoft.greporter.email.EmailSender</mainClass>
         </configuration>
      </plugin>
      <plugin>
         <groupId>com.thoughtworks.gauge.maven</groupId>
         <artifactId>gauge-maven-plugin</artifactId>
         <version>1.4.3</version>
      </plugin>
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
         <version>3.2.0</version>
      </plugin>
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <version>2.22.2</version>
      </plugin>
      <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.8.1</version>
         <configuration>
            <source>8</source>
            <target>8</target>
         </configuration>
      </plugin>
   </plugins>
</build>

A complete pom.xml file can be found here.

7. Now you can change the email configurations and chart configurations as you need by changing the properties in property files of “chart” and “email” folders.

barchart.properties

piechart.properties

email.properties

8. Now you have completed all the configurations and ready to execute your tests and send the test execution report.

9. Run your specs in the “specs” folder by executing the below command on the command prompt.

mvn test-compile gauge:execute -DspecsDir="specs" -Denv="dev"

10. After the execution, execute the below command on the command prompt to send the test execution report to the stakeholders.

mvn clean -DemailConfigEnv=dev install exec:java

11. If you need to perform these two operations from a single click, you can use a batch file. Here is a sample batch file.

12. Here is a sample test execution report.

YouTube Tutorial: https://youtu.be/9uqKlFFIyt4

Happy Automation !!!

MaxSoft — GReporter was originally published in MaxSoft — GReporter on Medium, where people are continuing the conversation by highlighting and responding to this story.