https://github.com/dodie/scott

Never debug a test again: Detailed failure reports and hassle free assertions for Java tests - Power Asserts for Java
https://github.com/dodie/scott

asm assertions failure-messages java junit scott testing-tools

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/dodie/scott
Owner: dodie
License: mit
Created: 2015-08-15T19:01:56.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2021-09-29T20:06:52.000Z (over 3 years ago)
Last Synced: 2024-09-09T11:03:33.969Z (8 months ago)
Topics: asm, assertions, failure-messages, java, junit, scott, testing-tools
Language: Java
Homepage: https://advancedweb.hu/junit-and-cucumber-test-reports-based-on-source-code-and-behavior/
Size: 913 KB
Stars: 138
Watchers: 5
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-java - Scott

README

        [![License](https://img.shields.io/github/license/dodie/scott.svg)](https://github.com/dodie/scott/blob/master/LICENSE)

[![Maven Central](https://img.shields.io/maven-central/v/hu.advancedweb/scott.svg?label=Maven%20Central)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22hu.advancedweb%22%20AND%20a%3A%22scott%22)

[![Build Status](https://dev.azure.com/dodiehun/scott/_apis/build/status/dodie.scott?branchName=master)](https://dev.azure.com/dodiehun/scott/_build/latest?definitionId=2&branchName=master)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=hu.advancedweb%3Ascott&metric=alert_status)](https://sonarcloud.io/dashboard?id=hu.advancedweb%3Ascott)

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.

![Scott in Action](https://github.com/dodie/scott/blob/master/docs/scott-in-action.png)

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](https://github.com/dodie/scott/tree/master/scott-examples/junit5)

- [JUnit 4](https://github.com/dodie/scott/tree/master/scott-examples/junit4)

- [Cucumber Java](https://github.com/dodie/scott/tree/master/scott-examples/cucumber-io-cucumber)

- 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 any special APIs

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](https://plugins.gradle.org/plugin/hu.advancedweb.scott-gradle-plugin) to your [build.gradle](https://github.com/dodie/scott/blob/master/scott-examples/junit4/build.gradle):

```groovy

plugins {

  id "hu.advanceweb.scott-gradle-plugin" version "4.0.1"

}

```

Example projects:

- [JUnit 4](https://github.com/dodie/scott/tree/master/scott-examples/junit4)

- [JUnit 5](https://github.com/dodie/scott/tree/master/scott-examples/junit5)

### Maven

Add the following to your [pom.xml](https://github.com/dodie/scott/blob/master/scott-examples/junit4/pom.xml):

```xml

	

		

		

			hu.advancedweb

			scott-maven-plugin

			4.0.1

			

				

					

						prepare-agent

					

				

			

		

	

	

	

		hu.advancedweb

		scott

		4.0.1

		test

	

```

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:

```xml

    org.apache.maven.plugins

    maven-surefire-plugin

    

        ${argLine} --enable-preview

    

```

Example projects:

- [JUnit 4](https://github.com/dodie/scott/tree/master/scott-examples/junit4)

- [JUnit 5](https://github.com/dodie/scott/tree/master/scott-examples/junit5)

### 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.

![HTML](https://github.com/dodie/scott-showcase/blob/master/cucumber_html_main.jpeg "HTML")

Example project:

- [io.cucumber:cucumber-java](https://github.com/dodie/scott/tree/master/scott-examples/cucumber-io-cucumber)

### Wire it up manually

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

[manually](https://github.com/dodie/scott/blob/master/docs/manual_setup.md).

Configuration

-------------

In case you are not satisfied with the default tracking behavior, the Scott Maven Plugin and Gradle Plugin provides [configuration options](https://github.com/dodie/scott/blob/master/docs/configuration.md) 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](https://github.com/dodie/scott/blob/master/docs/scott_as_a_library.md),

and for an actual example, see [GhostWriter](https://github.com/GoodGrind/ghostwriter).

Changelog

---------

See [Releases](https://github.com/dodie/scott/releases).

**Highlights from the latest releases:**

- Java 17 support

- [Gradle Plugin](https://github.com/dodie/scott/blob/master/readme.md#how-to-use)

- [Maven Plugin](https://github.com/dodie/scott/blob/master/readme.md#how-to-use)

- [Support for io.cucumber:cucumber-java](https://github.com/dodie/scott/tree/master/scott-examples/cucumber-io-cucumber)

- [Customizable tracking behavior](https://github.com/dodie/scott/blob/master/docs/configuration.md#configuring-the-automatic-tracking-behavior-with-the-maven-plugin)

Contributing

------------

Contributions are welcome! Please make sure to visit the

[contribution](https://github.com/dodie/scott/tree/master/CONTRIBUTING.md) and 

[development guide](https://github.com/dodie/scott/tree/master/docs/development-guide.md) 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](https://github.com/dodie/scott/issues?q=is%3Aissue+label%3A%22help+wanted%22+is%3Aopen).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/dodie/scott

Awesome Lists containing this project

README