Package org.revapi.maven

Class CheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.revapi.maven.CheckMojo

Direct Known Subclasses:

CheckForkMojo

@Mojo(name="check",
      defaultPhase=VERIFY,
      threadSafe=true,
      requiresDependencyCollection=COMPILE_PLUS_RUNTIME)
public class CheckMojo
extends org.apache.maven.plugin.AbstractMojo

Runs the API check of old and new artifacts using the specified configuration of extensions declared as dependencies of the plugin.

Since:

0.1

Author:

Lukas Krejci

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	alwaysCheckForReleaseVersion	If true (the default) revapi will always download the information about the latest version from the remote repositories (instead of using locally cached info).
protected org.codehaus.plexus.configuration.PlexusConfiguration	analysisConfiguration	The JSON or XML configuration of various analysis options.
protected Object[]	analysisConfigurationFiles	The list of files containing the configuration of various analysis options.
protected boolean	checkDependencies	Whether to include the dependencies in the API checks.
protected String	disallowedExtensions	A comma-separated list of extensions (fully-qualified class names thereof) that are not taken into account during API analysis.
protected boolean	failBuildOnProblemsFound	If true (the default), the maven plugin will fail the build when it finds API problems.
protected boolean	failOnMissingConfigurationFiles	Set to false if you want to tolerate files referenced in the analysisConfigurationFiles missing on the filesystem and therefore not contributing to the analysis configuration.
protected boolean	failOnUnresolvedArtifacts	If true, the build will fail if one of the old or new artifacts fails to be resolved.
protected boolean	failOnUnresolvedDependencies	If true, the build will fail if some of the dependencies of the old or new artifacts fail to be resolved.
protected FailSeverity	failSeverity	The severity of found problems at which to break the build.
protected String[]	newArtifacts	The coordinates of the new artifacts.
protected String	newVersion	The new version of the artifact.
protected String[]	oldArtifacts	The coordinates of the old artifacts.
protected String	oldVersion	If you don't want to compare a different artifact than the one being built, specifying the just the old version is simpler way of specifying the old artifact.
protected org.apache.maven.project.MavenProject	project
protected org.eclipse.aether.RepositorySystem	repositorySystem
protected org.eclipse.aether.RepositorySystemSession	repositorySystemSession
protected boolean	resolveProvidedDependencies	When establishing the API classes, Revapi by default also looks through the provided dependencies.
protected boolean	skip	Whether to skip the mojo execution.
protected String	versionFormat	If set, this property demands a format of the version string when the oldVersion or newVersion parameters are set to RELEASE or LATEST special version strings.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
CheckMojo()

Method Summary

Modifier and Type	Method	Description
protected org.revapi.AnalysisResult	analyze(Class<? extends org.revapi.Reporter> reporter, Object... contextDataKeyValues)
void	execute()
protected boolean	initializeComparisonArtifacts()
protected Analyzer	prepareAnalyzer(org.apache.maven.project.MavenProject project, Class<? extends org.revapi.Reporter> reporter, Map<String,Object> contextData)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

analysisConfiguration

@Parameter(property="",
           defaultValue="")
protected org.codehaus.plexus.configuration.PlexusConfiguration analysisConfiguration

The JSON or XML configuration of various analysis options. The available options depend on what analyzers are present on the plugin classpath through the <dependencies>. Consult configuration documentation for more details.

These settings take precedence over the configuration loaded from analysisConfigurationFiles.

failOnMissingConfigurationFiles

@Parameter(property="revapi.failOnMissingConfigurationFiles",
           defaultValue="true")
protected boolean failOnMissingConfigurationFiles

Set to false if you want to tolerate files referenced in the analysisConfigurationFiles missing on the filesystem and therefore not contributing to the analysis configuration.

The default is true, which means that a missing analysis configuration file will fail the build.

analysisConfigurationFiles

@Parameter(property="revapi.analysisConfigurationFiles",
           defaultValue="")
protected Object[] analysisConfigurationFiles

The list of files containing the configuration of various analysis options. The available options depend on what analyzers are present on the plugins classpath through the <dependencies>.

The analysisConfiguration can override the settings present in the files.

The list is either a list of strings or has the following form:

    <analysisConfigurationFiles>
        <configurationFile>
            <path>path/to/the/file/relative/to/project/base/dir</path>
            <resource>path/to/the/file/in/one/of/the/dependencies</resource>
            <roots>
                <root>configuration/root1</root>
                <root>configuration/root2</root>
                ...
            </roots>
        </configurationFile>
        ...
    </analysisConfigurationFiles>
 

where

• path is the path on the filesystem,
• resource is the path to the resource file in one of the artifacts the plugin depends on
• roots is optional and specifies the subtrees of the JSON/XML config that should be used for configuration. If not specified, the whole file is taken into account.

Either path or resource has to be specified but not both. The configuration/root1 and configuration/root2 are paths to the roots of the configuration inside that JSON/XML config file. This might be used in cases where multiple configurations are stored within a single file and you want to use a particular one.

An example of this might be a config file which contains API changes to be ignored in all past versions of a library. The classes to be ignored are specified in a configuration that is specific for each version:

     {
         "0.1.0" : [
             {
                 "extension": "revapi.ignore",
                 "configuration": [
                     {
                         "code" : "java.method.addedToInterface",
                         "new" : "method void com.example.MyInterface::newMethod()",
                         "justification" : "This interface is not supposed to be implemented by clients."
                     },
                     ...
                 ]
             }
         ],
         "0.2.0" : [
             ...
         ]
     }
 

oldArtifacts

@Parameter(property="revapi.oldArtifacts",
           defaultValue="")
protected String[] oldArtifacts

The coordinates of the old artifacts. Defaults to single artifact with the latest released version of the current project.

If the this property is null, the oldVersion property is checked for a value of the old version of the artifact being built.

See Also:

oldVersion

oldVersion

@Parameter(property="revapi.oldVersion",
           defaultValue="RELEASE")
protected String oldVersion

If you don't want to compare a different artifact than the one being built, specifying the just the old version is simpler way of specifying the old artifact.

The default value is "RELEASE" meaning that the old version is the last released version of the artifact being built (either remote or found locally (to account for artifacts installed into the local repo that are not available in some public remote repository)). The version of the compared artifact will be strictly older than the version of the new artifact.

If you specify "LATEST", the old version will be resolved to the newest version available remotely, including snapshots (if found in one of the repositories active in the build). The version of the compared artifact will be either older or equal to the version of the new artifact in this case to account for comparing a locally built snapshot against the latest published snapshot.

newArtifacts

@Parameter(property="revapi.newArtifacts",
           defaultValue="")
protected String[] newArtifacts

The coordinates of the new artifacts. These are the full GAVs of the artifacts, which means that you can compare different artifacts than the one being built. If you merely want to specify the artifact being built, use newVersion property instead.

newVersion

@Parameter(property="revapi.newVersion",
           defaultValue="${project.version}")
protected String newVersion

The new version of the artifact. Defaults to "${project.version}".

skip

@Parameter(property="revapi.skip",
           defaultValue="false")
protected boolean skip

Whether to skip the mojo execution.

failSeverity

@Parameter(property="revapi.failSeverity",
           defaultValue="potentiallyBreaking")
protected FailSeverity failSeverity

The severity of found problems at which to break the build. Defaults to API breaking changes. Possible values: equivalent, nonBreaking, potentiallyBreaking, breaking.

project

@Parameter(defaultValue="${project}",
           readonly=true)
protected org.apache.maven.project.MavenProject project

repositorySystem

@Component
protected org.eclipse.aether.RepositorySystem repositorySystem

repositorySystemSession

@Parameter(defaultValue="${repositorySystemSession}",
           readonly=true)
protected org.eclipse.aether.RepositorySystemSession repositorySystemSession

alwaysCheckForReleaseVersion

@Parameter(property="revapi.alwaysCheckForReleaseVersion",
           defaultValue="true")
protected boolean alwaysCheckForReleaseVersion

If true (the default) revapi will always download the information about the latest version from the remote repositories (instead of using locally cached info). This will respect the offline settings.

failBuildOnProblemsFound

@Parameter(property="revapi.failBuildOnProblemsFound",
           defaultValue="true")
protected boolean failBuildOnProblemsFound

If true (the default), the maven plugin will fail the build when it finds API problems.

failOnUnresolvedArtifacts

@Parameter(property="revapi.failOnUnresolvedArtifacts",
           defaultValue="false")
protected boolean failOnUnresolvedArtifacts

If true, the build will fail if one of the old or new artifacts fails to be resolved. Defaults to false.

failOnUnresolvedDependencies

@Parameter(property="revapi.failOnUnresolvedDependencies",
           defaultValue="false")
protected boolean failOnUnresolvedDependencies

If true, the build will fail if some of the dependencies of the old or new artifacts fail to be resolved. Defaults to false.

checkDependencies

@Parameter(property="revapi.checkDependencies",
           defaultValue="true")
protected boolean checkDependencies

Whether to include the dependencies in the API checks. This is the default thing to do because your API might be exposing classes from the dependencies and thus classes from your dependencies could become part of your API.

However, setting this to false might be useful in situations where you have checked your dependencies in another module and don't want do that again. In that case, you might want to configure Revapi to ignore missing classes because it might find the classes from your dependencies as used in your API and would complain that it could not find it. See the docs.

resolveProvidedDependencies

@Parameter(property="revapi.resolveProvidedDependencies",
           defaultValue="true")
protected boolean resolveProvidedDependencies

When establishing the API classes, Revapi by default also looks through the provided dependencies. The reason for this is that even though such dependencies do not appear in the transitive dependency set established by maven, they need to be present both on the compilation and runtime classpath of the module. Therefore, the classes in the module are free to expose classes from a provided dependency as API elements.

In rare circumstances this is not a desired behavior though. It is undesired if for example the classes from the provided dependency are used only for establishing desired build order or when they are used in some non-standard scenarios during the build and actually not needed at runtime.

versionFormat

@Parameter(property="revapi.versionFormat",
           defaultValue="")
protected String versionFormat

If set, this property demands a format of the version string when the oldVersion or newVersion parameters are set to RELEASE or LATEST special version strings.

Because Maven will report the newest non-snapshot version as the latest release, we might end up comparing a .Beta or other pre-release versions with the new version. This might not be what you want and setting the versionFormat will make sure that a newest version conforming to the version format is used instead of the one resolved by Maven by default.

This parameter is a regular expression pattern that the version string needs to match in order to be considered a RELEASE.

disallowedExtensions

@Parameter(property="revapi.disallowedExtensions",
           defaultValue="")
protected String disallowedExtensions

A comma-separated list of extensions (fully-qualified class names thereof) that are not taken into account during API analysis. By default, all extensions that are found on the classpath are used.

You can modify this set if you use another extensions that change the found differences in a way that the determined new version would not correspond to what it should be.

Constructor Detail

CheckMojo

public CheckMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

analyze

protected org.revapi.AnalysisResult analyze(Class<? extends org.revapi.Reporter> reporter,
                                            Object... contextDataKeyValues)
                                     throws org.apache.maven.plugin.MojoExecutionException,
                                            org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

prepareAnalyzer

protected Analyzer prepareAnalyzer(org.apache.maven.project.MavenProject project,
                                   Class<? extends org.revapi.Reporter> reporter,
                                   Map<String,Object> contextData)

initializeComparisonArtifacts

protected boolean initializeComparisonArtifacts()

Returns:

true if artifacts are initialized, false if not and the analysis should not proceed