Pluggable linting utility for Java tests

The plugin for Java Gradle test task that reports presence of asserts in a test method body.

Features:

1. Prints the number of assert calls in each test method to the console
2. Excludes ignored/disabled test classes and methods from linting
3. Limits the lint to recursively search from a top level package (for ex. 'org.samples')
4. Allows verbose output

Supported Testing Frameworks:

• JUnit 4
• JUnit 5
• TestNG

Supported build types:

• Gradle 4.9 and above

Installation:

1. git clone https://github.com/jpmorganchase/java-lint-assert.git
2. run gradle clean build publish from the root of the project. This will

• build core module
• build plugin module
• install core and plugin jars into your local maven repo and into build dir under the project root

To see the plugin in action, cd .\client and run gradle cleanTest test . You should see the summary table:

Package	Test file name	Test method name	# asserts
sample/junit4	AssertJunit4Style.java	withoutAsserts	0
sample/junit5	AssertJunit5Style.java	withAsserts	2
sample/testng	TestNgStyle.java	withAsserts	1
sample/junit4	AssertJunit4Style.java	withAsserts	1
sample/testng	TestNgStyle.java	withoutAsserts	0
sample	DummyTest.java	dummy	0
sample/junit5	AssertJunit5Style.java	withoutAsserts	0

Use:

Gradle:

In your build.gradle

I: add the java-lint-plugin dependency to the buildscript section:

buildscript {
   dependencies {
        classpath 'org.lint:plugin:0.1.0-SNAPSHOT'
    }
}

II: Add the plugin: apply plugin: org.lint.azzert.LintTestsPlugin

III: Configure lint:

test{
   ...   
    lintAssert{
        packageName = "org.lint" //optional or scan all
        verbose = true //optional, defaults to false
        includeClasspathJars = true //optional, defaults to false, scan alls jars found on the classpath
    }
}

IV: run gradle clean test

Future features:

1. Exclude tests that throw expected exceptions
2. Display results in alphabetic order of fully qualified test class name - org.lint.PlaceholderTest
3. Print the linting summary: number of PASS/FAIL and a list of assertless tests
4. Support a condensed output mode when only assertless tests are being printed
5. Support 3 output modes info, warn, and error:
   • in warn mode, warn if linting found assertless tests
   • in error mode, fail the 'test' phase if linting found assertless tests
6. Allow users to specify additional test frameworks
7. When running in an IntelliJ console, make package.class.method "clickable" and navigate to the method declaration
8. Display a ratio of # of asserts to the size of the "method under test" and number of its conditions
9. Lint for assertness in nested test classes

License

The Apache 2.0 License). Please see License for more information.