JUnit 5 test reporting

The Tesults Java API Library and JUnit5 extension are available from the JCenter and Maven Central repositories.

Gradle

If you are using Gradle add this dependency snippet to your build.gradle file:

dependencies {
  implementation 'com.tesults.junit5:tesults-junit5:1.2.0'
}

Also ensure you have the JCenter or Maven Central repository referenced in your build.gradle file.

Maven

If you are using Maven add this dependency snippet to your pom.xml file:

<dependency>
  <groupId>com.tesults.junit5</groupId>
  <artifactId>tesults-junit5</artifactId>
  <version>1.2.0</version>
</dependency>

JUnit5 Extensions Enable

JUnit5 extensions auto-detection is disabled by default. To enable automatic extension detection set the junit.jupiter.extensions.autodetection.enabled configuration parameter to true. This can be supplied as a JVM system property.

Gradle example:

test {
  useJUnitPlatform()
  systemProperty 'junit.jupiter.extensions.autodetection.enabled','true'
}

Maven example: Use the Maven Surefire plugin.

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>2.22.0</version>
      <configuration>
        <properties>
          <configurationParameters>
            junit.jupiter.extensions.autodetection.enabled = true
          </configurationParameters>
        </properties>
        <systemPropertyVariables>
          <tesultsTarget>token</tesultsTarget>
        </systemPropertyVariables>
      </configuration>
    </plugin>
  </plugins>
</build>

tesultsTargetRequired

Required to upload to Tesults, if this arg is not provided junit5-tesults does not attempt upload, effectively disabling it. Get your target token from the configuration menu in the Tesults web interface.

Inline method

-DtesultsTarget=eyJ0eXAiOiJ...

In this case, the target token is supplied directly or inline in the args. This is the simplest approach.

Key method

-DtesultsTarget=target1

In this case, junit5-tesults will automatically look up the value of the token based on the property provided from a configuration file. The path to the configuration file, specifically, a .properties file must be provided using the -DtesultsConfig=path-to-properties-file/tesults.properties, more details below.

Here is the corresponding tesults.properties file:

target1 = eyJ0eXAiOiJ...
target2 = ...
target3 = ...
target4 = ...

Or something more descriptive about the targets:

web-qa-env = eyJ0eXAiOiJ...
web-staging-env = ...
web-prod-env = ...

ios-qa-env = eyJ0eXAiOiK...
ios-staging-env = ...
ios-prod-env = ...

android-qa-env = eyJ0eXAiOiL...
android-staging-env = ...
android-prod-env = ...

tesultsConfigOptional

Use this to provide a path to a configuration properties file

-DtesultsConfig=/Users/admin/Desktop/tesults.properties

The properties file is useful to store several Tesults target tokens that can then be automatically be looked up by supplying an easy to remember target name. See more details above in the -DtesultsTarget arg description. The properties file can also contain all other args (without the -D prefix) to avoid having to pass them as in as system properties args. For example, the property file could contain TesultsFiles=/Users/admin/Desktop/TestFiles so you do not need to provide it as a system property. Then all you would need to pass as system properties are:
-DtesultsTarget=friendlyTargetName
-DtesultsConfig=/Users/admin/Desktop/tesults.properties.

Note: if you encounter issues where tests are not being discovered after adding the Tesults JUnit 5 dependency there may be a conflict related to junit-platform-launcher. Try adding this exclusion and try again. If you still encounter issues please contact help@tesults.com:

<dependency>
  <groupId>com.tesults.junit5</groupId>
  <artifactId>tesults-junit5</artifactId>
  <version>1.2.0</version>
  <exclusions>
    <exclusion>
      <groupId>org.junit.platform</groupId>
      <artifactId>junit-platform-launcher</artifactId>
    </exclusion>
  </exclusions>
</dependency>

Do not add the exclusion above unless you are encountering the issue mentioned about test discoverability.

Recommended

import com.tesults.junit5.TesultsListener;
import org.junit.jupiter.api.TestInfo;

public class TestSuiteA {
  @Test
  void Test1 (TestInfo testInfo) {
    TesultsListener.file(testInfo, "/full/path/to/file/log.txt");
    TesultsListener.file(testInfo, "/full/path/to/file/screenshot.png");
    assertEquals(1, 1);
  }
}

Not Recommended

This second method is no longer recommended but can be used if desired.

tesultsFilesOptional

Provide the top-level directory where files generated during testing are saved for the running test run. Files, including logs, screen captures and other artifacts will be automatically uploaded.

-DtesultsFiles=/Users/admin/Desktop/temporary

This is one area where junit5-tesults is opinionated and requires that files generated during a test run be saved locally temporarily within a specific directory structure.

Store all files in a temporary directory as your tests run. After Tesults upload is complete, delete the temporary directory or just have it overwritten on the next test run.

You can utilize a function such as this one to create a file at a path that meets this requirement:

public File createFile (String suite, String test, String file) {
  String temp = "/Users/admin/Desktop/temp"; // tesultsFiles arg value
  String path = temp + File.separator + suite;
  path = path + File.separator + test;
  path = path + File.separator + file;
  File f = new File(path);
  File dir = f.getParentFile();
  if (dir != null) {
    dir.mkdirs();
  }
  try {
    f.createNewFile();
    return f;
  } catch (IOException ex) {
    System.out.println("saveFile error: " + ex.getMessage());
    return null;
  }
}

Please see the tags section for more details on how to provide a suite name and also take a look at the -DtesultsNoSuites flag below. The default behavior of junit5-tesults is to set the class name as the test suite if a test suite is not explicitly provided using a tag. Also be aware that if providing build files, the build suite is always set to [build] and files are expected to be located in temporary/[build]/buildname

Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.

• temporary folder
• Test Suite A
• Test 1
• test.log
• screenshot.png
• Test 2
• test.log
• screenshot.png
• Test Suite B
• Test 3
• metrics.csv
• error.log
• Test 4
• test.log

tesultsBuildNameOptional

Use this to report a build version or name for reporting purposes.

-DtesultsBuildName=1.0.0

tesultsBuildResultOptional

Use this to report the build result, must be one of [pass, fail, unknown].

-DtesultsBuildResult=pass

tesultsBuildDescOptional

Use this to report a build description for reporting purposes.

-DtesultsBuildDesc=added new feature

tesultsBuildReasonOptional

Use this to report a build failure reason.

tesultsBuildReason=build error line 201 somefile.py

No Test Suites

tesultsNoSuitesOptional

Use this flag to stop automatic setting of the class name as the test suite in the case where a suite is not explicitly supplied using @Tag("suite=SuiteName")

-DtesultsNoSuites

If you are using Cucumber, the class name is not used as the name of the test suite and the JUnit 5 @Tag is not recognized. Do not set the tesultsNoSuite option when using Cucumber. Instead to set a test suite name add this to the top of your feature file: @suite=Test-Suite-A. Replace 'Test-Suite-A' with whatever you want for the name of the suite, without spaces.

Result interpretation is not currently supported by this integration. If you are interested in support please contact help@tesults.com.