Scott Test Reporter

Never debug a test again: Detailed failure reports and hassle free assertions for Java tests - Power Asserts for Java

Description

Scott provides detailed failure messages for tests written in Java, without the use of complex assertion libraries to aid developers in rapid development, troubleshooting and debugging of tests.

It automatically tracks the state of the test to provide the important details for a failing scenario, favoring simple assertions expressed mostly in plain Java over the extensive use of test libraries, such as Hamcrest or AssertJ. (Although it plays nicely with other testing tools and frameworks.)

Scott does not intend to be a testing framework, nor does it provide an API to use in the tests. Instead, it aims to be a small tool that can be dropped into a project to do its job automatically, so you can worry much less about expressing assertions, and still have meaningful failure messages.

Supports Java 7 and above.

Code Quality Rank: L4

Programming language: Java

License: MIT License

Tags: Testing     Automation     Reporting    

Latest version: v3.6.0

README

Scott Test Reporter for Maven and Gradle

Get extremely detailed failure messages for your tests without assertion libraries, additional configuration or changes on existing tests.

As you can see, besides the usual assertion error, Scott reports the state changes and assignments in the test cases, nicely visualized on the source code of the test method.

Works well with other testing tools and frameworks, for example:

• JUnit 5
• JUnit 4
• Cucumber Java
• Mockito

Supports Java 7+ (up to Java 17).

How to use

Just drop it into your project, and Scott will automatically enhance your test reports. You don't have to use its API or modify your existing tests to make it work.

Scott: All systems automated and ready. A chimpanzee and two trainees could run her.

Kirk: Thank you, Mr. Scott. I'll try not to take that personally.

Gradle

Add hu.advanceweb.scott-gradle-plugin to your build.gradle:

plugins {
  id "hu.advanceweb.scott-gradle-plugin" version "4.0.0"
}

Example projects:

• JUnit 4
• JUnit 5

Maven

Add the following to your pom.xml:

<build>
    <plugins>
        <!-- Add the Scott Plugin. -->
        <plugin>
            <groupId>hu.advancedweb</groupId>
            <artifactId>scott-maven-plugin</artifactId>
            <version>4.0.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>prepare-agent</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
<dependencies>
    <!-- Add Scott as a dependency -->
    <dependency>
        <groupId>hu.advancedweb</groupId>
        <artifactId>scott</artifactId>
        <version>4.0.0</version>
        <scope>test</scope>
    </dependency>
</dependencies>

The scott-maven-plugin automatically configures maven-surefire-plugin and maven-failsafe-plugin to use Scott via the argLine project property. If you wish to further customize the argLine property for these plugins, you have to pass the managed argLine as well to ensure Scott works properly. For an example, check the following snippet that configures the surefire plugin to enable preview language features for Java:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-surefire-plugin</artifactId>
    <configuration>
        <argLine>${argLine} --enable-preview</argLine>
    </configuration>
</plugin>

Example projects:

• JUnit 4
• JUnit 5

Cucumber

Scott for Cucumber tracks whole scenarios, and in case of a failure it prints the details of every step involved.

This feature provides valuable information if a test fails in a CI environment, as it can make it much easier to reproduce and fix browser-based tests, especially for flaky tests.

For more info, check the example project using io.cucumber:cucumber-java.

Wire it up manually

If you can't use the Gradle or Maven Plugin for some reason, you can do the necessary steps manually.

Configuration

In case you are not satisfied with the default tracking behavior, the Scott Maven Plugin and Gradle Plugin provides configuration options to fine-tune its behaviour.

Using Scott as an instrumentation library

Scott's instrumentation module can be invoked programmatically with fine-tuned instrumentation rules so you can build your own solution on top of Scott. For more information, check the user guide.

Changelog

See Releases.

Highlights from the latest releases:

• Java 17 support
• Gradle Plugin
• Maven Plugin
• Support for io.cucumber:cucumber-java
• Customizable tracking behavior

Contributing

Contributions are welcome! Please make sure to visit the contribution and development guide for some important notes on how to build and debug Scott. If you are looking for issues that can get you started with the development, see Issues marked with the help-wanted tag.