gradle-animalsniffer-plugin

Additional

Language
Groovy
Version
1.4.3 (Dec 6, 2017)
Created
Dec 20, 2015
Updated
Mar 27, 2018
Owner
Vyacheslav Rusakov (xvik)
Contributor
Vyacheslav Rusakov (xvik)
1
Activity
Badge
Generate
Download
Source code

Commercial

gradle-animalsniffer-plugin

About

Gradle AnimalSniffer plugin for Java or groovy projects. AnimalSniffer used to check compatibility with lower java version (when compiling with newer java) or android (sdk version).

Implemented the same way as core gradle qulity plugins (checkstyle, pmd etc): task registered for each source set (animalsnifferMain, animalsnifferTest) and attached to check task

Advanced features:

Summary
  • Configuration extensions:
    • animalsniffer - check configuration
    • animalsnifferSignature - signature build configuration (optional)
  • Tasks:
    • check[Main] - check source set task
    • animalsnifferSignature - build signature (active when animalsnifferSignature configuration declared)
    • type:BuildSignatureTask - custom signature build task may be used to merge signatures
    • type:SignatureInfoTask - view signature "contents"
  • Dependencies configuration: signature - signatures for check

Setup

Releases are published to bintray jcenter, maven central and gradle plugins portal.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'ru.vyarus:gradle-animalsniffer-plugin:1.4.3'
    }
}
apply plugin: 'ru.vyarus.animalsniffer'

OR

plugins {
    id 'ru.vyarus.animalsniffer' version '1.4.3'
}

IMPORTANT: plugin must be declared after java or groovy plugin, otherwise nothing will be registered.

Starting from version 1.1.0 gradle >= 2.14 is required. For older gradle use version 1.0.1.

Usage

Additional tasks will be assigned to check task. So animalsniffer checks will be executed during:

$ gradlew check

Signatures

AnimalSniffer requires signature file to check against. To define signature (or multiple signatures) use signature configuration.

Check java version compatibility:

repositories { mavenCentral() }
dependencies {
    signature 'org.codehaus.mojo.signature:java16:1.1@signature'
}

Java signatures

Check android compatibility:

repositories { mavenCentral() }
dependencies {
    signature 'net.sf.androidscents.signature:android-api-level-14:4.0_r4@signature'
}

Android signatures

Check both java version and android compatibility:

dependencies {
    signature 'org.codehaus.mojo.signature:java16:1.1@signature'
    signature 'net.sf.androidscents.signature:android-api-level-14:4.0_r4@signature'
}

In the last case animalsniffer will run 2 times for each signature. You may see the same errors two times if class/method is absent in both signatures. Each error message in log (and file) will also contain signature name to avoid confusion.

When no signatures defined animalsniffer tasks will always pass.

You can also use custom libraries signatures to check version compatibility.

Scope

All project dependencies are excluded from analysis: only classes from your source set are checked.

By default, all source sets are checked. To check only main sources:

animalsniffer {
    sourceSets = [sourceSets.main]
}

Output

Violations are always printed to console. Example output:

2 AnimalSniffer violations were found in 1 files. See the report at: file:///myproject/build/reports/animalsniffer/main.text

[Undefined reference] invalid.(Sample.java:9)
  >> int Boolean.compare(boolean, boolean)

[Undefined reference] invalid.(Sample.java:14)
  >> java.nio.file.Path java.nio.file.Paths.get(String, String[])

NOTE: text report file will contain simplified report (error per line):

invalid.Sample:9  Undefined reference: int Boolean.compare(boolean, boolean)
invalid.Sample:14  Undefined reference: java.nio.file.Path java.nio.file.Paths.get(String, String[])

NOTE: when multiple signatures used, output will contain signature name in the error message to void confusion.

Suppress violations

Annotation could be used to suppress violations: examples

Default annotation

Add dependency on annotation:

compile "org.codehaus.mojo:animal-sniffer-annotations:1.16"

Use provided scope if you can. Annotation is configured by default, so you can simply use annotation to suppress violation:

@IgnoreJRERequirement
private Optional param;
Custom annotation

You can define your own annotation:

package com.mycompany

@Retention(RetentionPolicy.CLASS)
@Documented
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.TYPE})
public @interface SuppressSignatureCheck {}

Configure annotation:

animalsniffer {
    annotation = 'com.mycompany.SuppressSignatureCheck'
}

Now check will skip blocks annotated with your annotation:

@SuppressSignatureCheck
private Optional param;

Extend signature

Project could target multiple java versions and so reference classes, not present in signature.

For example, implementation could try to use java 7 Paths and if class is not available, fall back to java 6 implementation. In this case Paths could be added to ignored classes:

animalsniffer {
    ignore 'java.nio.file.Paths'
}

Now usages of Paths will not cause warnings.

Multiple ignored classes could be defined:

animalsniffer {
    ignore 'java.nio.file.Paths', 'some.other.Class'
}

Or

animalsniffer {
    ignore 'java.nio.file.Paths'
    ignore 'some.other.Class'
}

Or by directly assigning collection:

animalsniffer {
    ignore  = ['java.nio.file.Paths', 'some.other.Class']
}

Entire packages could be ignored using asterisk:

animalsniffer {
    ignore 'some.pkg.*'
}

See more info in documentation.

Configuration

Configuration example:

animalsniffer {
    toolVersion = '1.16'
    sourceSets = [sourceSets.main]
    ignoreFailures = true
    reportsDir = file("$project.buildDir/animalsnifferReports")
    annotation = 'com.mypackage.MyAnnotation'
    ignore = ['java.nio.file.Paths']
}

There are no required configurations - plugin will generate defaults for all of them.

Property Description Default value
toolVersion AnimalSniffer version 1.16
sourceSets Source sets to check all source sets
ignoreFailures False to stop build when violations found, true to continue false
reportsDir Reports directory file("$project.buildDir/reports/animalsniffer")
annotation Annotation class to avoid check under annotated block
ignore Ignore usage of classes, not mentioned in signature
signatures Signatures to use for check configurations.signature
excludeJars Patterns to exclude jar names from classpath. Required for library signatures usage
cache Cache configuration By default, cache disabled

NOTE: ignore does not exclude your classes from check, it allows you using classes not mentioned in signature. See more details above.

Tasks

Animalsniffer task is registered for each source set:

  • animalsnifferMain - run AnimalAniffer for compiled main classes
  • animalsnifferTest - run AnimalSniffer for compiled test classes
  • animalsnifferSourceSet - run AnimalSniffer for compiled SourceSet classes

check task will depend only on tasks from configured in animalsniffer.sourceSets source sets.

Tasks support text report, enabled by default.

To disable reports for task:

animalsnifferMain.reports.text.enabled = false

or for all tasks:

tasks.withType(AnimalSniffer) {
    reports.text.enabled = false
}

Animalsniffer task is a SourceTask and may be configured to include/exclude classes from check.

NOTE: task operate on compiled classes and not sources! Be careful when defining patterns.

For example, to exclude classes in 'invalid' subpackage from check:

animalsnifferMain {
    exclude('**/invalid/*')
}

Advanced features

Read wiki for advanced features:

Might also like