API Tests

This page walks you through Drill4J integration for Java-based API tests. It will enable you to use such features as Per Test Coverage and Test Recommendations

Prerequisites

1. This page assumes you have Application Agent configured for application under test. For instructions see:

   • Getting Started
   • Application Agent reference

2. API tests launched with either Maven or Gradle

This instruction involves making changes to the Gradle/Maven project build file.

Install Drill4J Plugin

The Drill4J CI/CD integration plugin allows you to run API tests together with the Drill4J agent. Add following changes to your Gradle/Maven project with API tests build file to install the Drill4J plugin:

Gradle

plugins {
    id("com.epam.drill.integration.cicd") version "0.1.15"
}

Maven

<build>
    <plugins>
        <plugin>
            <groupId>com.epam.drill.integration</groupId>
            <artifactId>drill-maven-plugin</artifactId>
            <version>0.1.15</version>
            <configuration>
            </configuration>
        </plugin>
   </plugins>
</build>

Enable Agent

To enable the Drill4J agent set the plugin configuration:

Gradle

Add drill section into the bottom of the Gradle build file:

drill {
    // Set the Drill4J API URL
    // or set DRILL_API_URL env variable
    apiUrl = "http://localhost:8090/api"
    // Set the Drill4J API Key
    // or set DRILL_API_KEY env variable
    apiKey = "1_01cdf51ff20544ee..."
    // Set the Drill4J Group ID
    groupId = "my-group"
    agent {
        version = "0.9.20"
    }
    // Enable test tracing
    testTracing()
}

Maven

Add <configuration> and <executions> elements to Drill4J plugin in your Maven pom.xml file:

<plugin>
    <groupId>com.epam.drill.integration</groupId>
    <artifactId>drill-maven-plugin</artifactId>
    <version>0.1.15</version>
    <configuration>
        <!-- Set the Drill4J API URL -->
        <!-- or set DRILL_API_URL env variable -->
        <apiUrl>http://localhost:8090/api</apiUrl>
        <!-- Set the Drill4J API Key -->
        <!-- or set DRILL_API_KEY env variable -->
        <apiKey>1_01cdf51ff20544ee...</apiKey>
        <!-- Set the Drill4J Group ID -->
        <groupId>my-group</groupId>
        <agent>
            <version>0.9.20</version>
        </agent>
        <!-- Enable test tracing -->
        <testTracing>
            <enabled>true</enabled>
        </testTracing>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>enableAgent</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Run API Tests

1. Launch your tests with Gradle/Maven (e.g. gradle test, mvn test).

IMPORTANT! When running tests in your IDE, double-check that it's picking up the correct configuration file with the Drill4J test agent added (that will be build.gradle for Gradle, pom.xml for Maven)

2. To confirm the agent is working check tests log. There should be Drill4J ASCII logo followed by agent version:

   ```log

   Task :test is modified by Drill

   ____ ____ _ _ _ _ _

   | _"\U | _"\ u ___ |"| |"| | ||"| U |"| u

   /| | | |\| |_) |/ |_"_| U | | u U | | u | || |_ _ \| |/

   U| |_| |\| _ < | | \| |/__ \| |/__ |__ _| | |_| |_,-.

   |____/ u|_| \_\ U/| |\u |_____| |_____| /|_|\ \___/-(_/

   |||_ // \\_.-,_|___|_,-.// \\ // \\ u_|||_u _//

   (__)_) (__) (__)\_)-' '-(_/(_")("_)(_")("_) (__)__) (__)

   Autotest Agent (v0.23.1)

   ```

That’s it! Open the Metabase UI and confirm that the new test information is coming through. You should see the Test Launches on the Build Summary dashboard.