Awesome

Violations Gradle Plugin

This is a Gradle plugin for Violations Lib. There is also a Maven plugin for this.

Published to plugins.gradle.org.

It can parse results from static code analysis and:

• Report violations in the build log.
• Optionally fail the build depending on violations found.

You can also do this with a command line tool.

A snippet of the output may look like this:

...
se/bjurr/violations/lib/example/OtherClass.java
╔══════════╤════════════╤══════════╤══════╤════════════════════════════════════════════════════╗
║ Reporter │ Rule       │ Severity │ Line │ Message                                            ║
╠══════════╪════════════╪══════════╪══════╪════════════════════════════════════════════════════╣
║ Findbugs │ MS_SHOULD_ │ INFO     │ 7    │ Field isn't final but should be                    ║
║          │ BE_FINAL   │          │      │                                                    ║
║          │            │          │      │                                                    ║
║          │            │          │      │    <p>                                             ║
║          │            │          │      │ This static field public but not final, and        ║
║          │            │          │      │ could be changed by malicious code or              ║
║          │            │          │      │         by accident from another package.          ║
║          │            │          │      │         The field could be made final to avoid     ║
║          │            │          │      │         this vulnerability.</p>                    ║
╟──────────┼────────────┼──────────┼──────┼────────────────────────────────────────────────────╢
║ Findbugs │ NM_FIELD_N │ INFO     │ 6    │ Field names should start with a lower case letter  ║
║          │ AMING_CONV │          │      │                                                    ║
║          │ ENTION     │          │      │                                                    ║
║          │            │          │      │   <p>                                              ║
║          │            │          │      │ Names of fields that are not final should be in mi ║
║          │            │          │      │ xed case with a lowercase first letter and the fir ║
║          │            │          │      │ st letters of subsequent words capitalized.        ║
║          │            │          │      │ </p>                                               ║
╚══════════╧════════════╧══════════╧══════╧════════════════════════════════════════════════════╝

Summary of se/bjurr/violations/lib/example/OtherClass.java
╔══════════╤══════╤══════╤═══════╤═══════╗
║ Reporter │ INFO │ WARN │ ERROR │ Total ║
╠══════════╪══════╪══════╪═══════╪═══════╣
║ Findbugs │ 2    │ 0    │ 0     │ 2     ║
╟──────────┼──────┼──────┼───────┼───────╢
║          │ 2    │ 0    │ 0     │ 2     ║
╚══════════╧══════╧══════╧═══════╧═══════╝


Summary
╔════════════╤══════╤══════╤═══════╤═══════╗
║ Reporter   │ INFO │ WARN │ ERROR │ Total ║
╠════════════╪══════╪══════╪═══════╪═══════╣
║ Checkstyle │ 4    │ 1    │ 1     │ 6     ║
╟────────────┼──────┼──────┼───────┼───────╢
║ Findbugs   │ 2    │ 2    │ 5     │ 9     ║
╟────────────┼──────┼──────┼───────┼───────╢
║            │ 6    │ 3    │ 6     │ 15    ║
╚════════════╧══════╧══════╧═══════╧═══════╝

Example of supported reports are available here.

A number of parsers have been implemented. Some parsers can parse output from several reporters.

52 parsers and 79 reporters.

Missing a format? Open an issue here!

Usage

There is a running example here.

Having the following in the build script will make the plugin run with ./gradlew build.

plugins {
  id "se.bjurr.violations.violations-gradle-plugin" version "X"
}

task violations(type: se.bjurr.violations.gradle.plugin.ViolationsTask) {
    //
    // Optional config
    //
    maxReporterColumnWidth.set(0) // 0 is disabled
    maxRuleColumnWidth.set(10)
    maxSeverityColumnWidth.set(0)
    maxLineColumnWidth.set(0)
    maxMessageColumnWidth.set(50)
    codeClimateFile.set(file('code-climate-file.json')) // Will create a CodeClimate JSON report.
    violationsFile.set(file('violations-file.json')) // Will create a normalized JSON report.

    //
    // Global configuration, remove if you dont want to report violations for
    // the entire repo.
    //
    minSeverity.set(se.bjurr.violations.lib.model.SEVERITY.INFO) // INFO, WARN or ERROR
    detailLevel.set(se.bjurr.violations.git.ViolationsReporterDetailLevel.VERBOSE) // PER_FILE_COMPACT, COMPACT or VERBOSE
    maxViolations.set(99999999) // Will fail the build if total number of found violations is higher
    printViolations.set(true) // Will print violations found in diff


    //
    // Diff configuration, remove if you dont want to report violations for
    // files changed between specific revisions.
    //
    // diff-properties can be supplied with something like:
    //
    // ./gradlew violations -i -PdiffFrom=e4de20e -PdiffTo=HEAD
    //
    // And in Travis, you could add:
    //
    //  script:
    //   - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then bash ./gradlew check -PdiffFrom=$TRAVIS_PULL_REQUEST_BRANCH -PdiffTo=$TRAVIS_BRANCH ; fi'
    //
    diffFrom.set(project.properties.diffFrom) // Can be empty (ignored), Git-commit or any Git-reference
    diffTo.set(project.properties.diffTo) // Same as above
    diffMinSeverity.set(se.bjurr.violations.lib.model.SEVERITY.INFO) // INFO, WARN or ERROR
    diffDetailLevel.set(se.bjurr.violations.git.ViolationsReporterDetailLevel.VERBOSE) // PER_FILE_COMPACT, COMPACT or VERBOSE
    diffMaxViolations.set(99) // Will fail the build if number of violations, in the diff within from/to, is higher
    diffPrintViolations.set(true) // Will print violations found in diff
    gitRepo.set(file('.')) // Where to look for Git


    //
    // This is mandatory regardless of if you want to report violations between
    // revisions or the entire repo.
    //
    // Many more formats available, see: https://github.com/tomasbjerre/violations-lib
    violationConfig()
        .setFolder(projectDir.path)
        .setParser(se.bjurr.violations.lib.reports.Parser.FINDBUGS)
        .setPattern(".*/findbugs/.*\\.xml\$")
        .setReporter("Findbugs")
    violationConfig()
        .setFolder(projectDir.path)
        .setParser(se.bjurr.violations.lib.reports.Parser.PMD)
        .setPattern(".*/pmd/.*\\.xml\$")
        .setReporter("PMD")
}

check.finalizedBy violations