plugin: CheckstyleExecutor: extracted from AbstractCheckMojo
This commit is contained in:
parent
e46f8d5d1f
commit
337524ed97
3 changed files with 211 additions and 114 deletions
|
|
@ -25,13 +25,8 @@ SOFTWARE.
|
||||||
package net.kemitix.checkstyle.ruleset.plugin;
|
package net.kemitix.checkstyle.ruleset.plugin;
|
||||||
|
|
||||||
import lombok.Setter;
|
import lombok.Setter;
|
||||||
import lombok.val;
|
|
||||||
import org.apache.maven.artifact.DefaultArtifact;
|
|
||||||
import org.apache.maven.artifact.handler.DefaultArtifactHandler;
|
|
||||||
import org.apache.maven.artifact.repository.ArtifactRepository;
|
import org.apache.maven.artifact.repository.ArtifactRepository;
|
||||||
import org.apache.maven.execution.MavenSession;
|
import org.apache.maven.execution.MavenSession;
|
||||||
import org.apache.maven.model.Plugin;
|
|
||||||
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
|
|
||||||
import org.apache.maven.plugin.AbstractMojo;
|
import org.apache.maven.plugin.AbstractMojo;
|
||||||
import org.apache.maven.plugin.BuildPluginManager;
|
import org.apache.maven.plugin.BuildPluginManager;
|
||||||
import org.apache.maven.plugin.MojoExecutionException;
|
import org.apache.maven.plugin.MojoExecutionException;
|
||||||
|
|
@ -39,11 +34,6 @@ import org.apache.maven.plugin.MojoFailureException;
|
||||||
import org.apache.maven.plugins.annotations.Component;
|
import org.apache.maven.plugins.annotations.Component;
|
||||||
import org.apache.maven.plugins.annotations.Parameter;
|
import org.apache.maven.plugins.annotations.Parameter;
|
||||||
import org.apache.maven.project.MavenProject;
|
import org.apache.maven.project.MavenProject;
|
||||||
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
|
|
||||||
|
|
||||||
import java.io.FileReader;
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.util.Properties;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Runs the Checkstyle Maven Plugin with the Kemitix Checkstyle Ruleset.
|
* Runs the Checkstyle Maven Plugin with the Kemitix Checkstyle Ruleset.
|
||||||
|
|
@ -52,28 +42,6 @@ import java.util.Properties;
|
||||||
*/
|
*/
|
||||||
abstract class AbstractCheckMojo extends AbstractMojo {
|
abstract class AbstractCheckMojo extends AbstractMojo {
|
||||||
|
|
||||||
private static final String CHECKSTYLE_GROUPID = "com.puppycrawl.tools";
|
|
||||||
|
|
||||||
private static final String CHECKSTYLE_ARTIFACTID = "checkstyle";
|
|
||||||
|
|
||||||
private static final String SEVNTU_GROUPID = "com.github.sevntu.checkstyle";
|
|
||||||
|
|
||||||
private static final String SEVNTU_ARTIFACTID = "sevntu-checkstyle-maven-plugin";
|
|
||||||
|
|
||||||
private static final String KEMITIX_GROUPID = "net.kemitix";
|
|
||||||
|
|
||||||
private static final String KEMITIX_ARTIFACTID = "kemitix-checkstyle-ruleset";
|
|
||||||
|
|
||||||
private static final String APACHE_PLUGIN_GROUPID = "org.apache.maven.plugins";
|
|
||||||
|
|
||||||
private static final String APACHE_PLUGIN_ARTIFACTID = "maven-checkstyle-plugin";
|
|
||||||
|
|
||||||
private static final String CONFIG_LOCATION = "configLocation";
|
|
||||||
|
|
||||||
private static final String SOURCE_DIR = "sourceDirectory";
|
|
||||||
|
|
||||||
private String rulesetVersion;
|
|
||||||
|
|
||||||
@Setter
|
@Setter
|
||||||
@Parameter(defaultValue = "${project}", readonly = true)
|
@Parameter(defaultValue = "${project}", readonly = true)
|
||||||
private MavenProject mavenProject;
|
private MavenProject mavenProject;
|
||||||
|
|
@ -88,93 +56,16 @@ abstract class AbstractCheckMojo extends AbstractMojo {
|
||||||
@Component
|
@Component
|
||||||
private BuildPluginManager pluginManager = null;
|
private BuildPluginManager pluginManager = null;
|
||||||
|
|
||||||
private final PluginExecutor pluginExecutor;
|
private final CheckstyleExecutor checkstyleExecutor;
|
||||||
|
|
||||||
AbstractCheckMojo(final PluginExecutor pluginExecutor) {
|
AbstractCheckMojo(final PluginExecutor pluginExecutor) {
|
||||||
this.pluginExecutor = pluginExecutor;
|
checkstyleExecutor = new DefaultCheckstyleExecutor(getLog(), getLevel(), pluginExecutor);
|
||||||
}
|
|
||||||
|
|
||||||
@Override
|
|
||||||
public void execute() throws MojoExecutionException, MojoFailureException {
|
|
||||||
performCheck(getLevel());
|
|
||||||
}
|
}
|
||||||
|
|
||||||
abstract String getLevel();
|
abstract String getLevel();
|
||||||
|
|
||||||
/**
|
@Override
|
||||||
* Execute Checkstyle Check.
|
public void execute() throws MojoExecutionException, MojoFailureException {
|
||||||
*
|
checkstyleExecutor.performCheck(mavenProject, mavenSession, artifactRepository, pluginManager);
|
||||||
* @param level The level of config file to use.
|
|
||||||
*
|
|
||||||
* @throws MojoExecutionException on execution error
|
|
||||||
* @throws MojoFailureException on execution failure
|
|
||||||
*/
|
|
||||||
final void performCheck(final String level) throws MojoExecutionException, MojoFailureException {
|
|
||||||
rulesetVersion = mavenProject.getPlugin(KEMITIX_GROUPID + ":" + KEMITIX_ARTIFACTID + "-maven-plugin")
|
|
||||||
.getVersion();
|
|
||||||
debug("rulesetVersion: %s", rulesetVersion);
|
|
||||||
val properties = getProperties();
|
|
||||||
debug("properties: %s", properties);
|
|
||||||
|
|
||||||
// get versions from pom.xml properties
|
|
||||||
val pluginVersion = getProperty(properties, "maven-checkstyle-plugin.version");
|
|
||||||
val checkstyleVersion = getProperty(properties, "checkstyle.version");
|
|
||||||
val sevntuVersion = getProperty(properties, "sevntu.version");
|
|
||||||
|
|
||||||
// configure
|
|
||||||
val checkstylePlugin = getPlugin(pluginVersion, checkstyleVersion, sevntuVersion);
|
|
||||||
val configuration = pluginExecutor.configuration(
|
|
||||||
pluginExecutor.element(CONFIG_LOCATION, String.format("net/kemitix/checkstyle-%s.xml", level)),
|
|
||||||
pluginExecutor.element(SOURCE_DIR, mavenProject.getBuild()
|
|
||||||
.getSourceDirectory())
|
|
||||||
);
|
|
||||||
val environment = pluginExecutor.executionEnvironment(mavenProject, mavenSession, pluginManager);
|
|
||||||
|
|
||||||
// run
|
|
||||||
info("Running Checkstyle %s (sevntu: %s) with ruleset %s (%s)", checkstyleVersion, sevntuVersion, level,
|
|
||||||
rulesetVersion
|
|
||||||
);
|
|
||||||
pluginExecutor.executeMojo(checkstylePlugin, "check", configuration, environment);
|
|
||||||
info("Checkstyle complete");
|
|
||||||
}
|
|
||||||
|
|
||||||
private String getProperty(final Properties properties, final String key) {
|
|
||||||
val property = properties.getProperty(key);
|
|
||||||
debug(key + ": %s", property);
|
|
||||||
return property;
|
|
||||||
}
|
|
||||||
|
|
||||||
private Plugin getPlugin(final String pluginVersion, final String checkstyleVersion, final String sevntuVersion) {
|
|
||||||
// create checkstyle dependencies
|
|
||||||
val checkstyle = pluginExecutor.dependency(CHECKSTYLE_GROUPID, CHECKSTYLE_ARTIFACTID, checkstyleVersion);
|
|
||||||
val sevntu = pluginExecutor.dependency(SEVNTU_GROUPID, SEVNTU_ARTIFACTID, sevntuVersion);
|
|
||||||
val ruleset = pluginExecutor.dependency(KEMITIX_GROUPID, KEMITIX_ARTIFACTID, rulesetVersion);
|
|
||||||
val dependencies = pluginExecutor.dependencies(checkstyle, sevntu, ruleset);
|
|
||||||
|
|
||||||
return pluginExecutor.plugin(APACHE_PLUGIN_GROUPID, APACHE_PLUGIN_ARTIFACTID, pluginVersion, dependencies);
|
|
||||||
}
|
|
||||||
|
|
||||||
private Properties getProperties() throws MojoFailureException {
|
|
||||||
// load properties from the plugin pom.xml
|
|
||||||
val pluginArtifactId = KEMITIX_ARTIFACTID + "-parent";
|
|
||||||
val pluginArtifact = new DefaultArtifact(KEMITIX_GROUPID, pluginArtifactId, rulesetVersion, null, "", null,
|
|
||||||
new DefaultArtifactHandler("pom")
|
|
||||||
);
|
|
||||||
try {
|
|
||||||
val pomReader = new FileReader(artifactRepository.find(pluginArtifact)
|
|
||||||
.getFile());
|
|
||||||
return new MavenXpp3Reader().read(pomReader)
|
|
||||||
.getProperties();
|
|
||||||
} catch (XmlPullParserException | IOException e) {
|
|
||||||
throw new MojoFailureException("Can't load properties from plugin's pom.xml", e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private void info(final String format, final Object... args) {
|
|
||||||
getLog().info(String.format(format, args));
|
|
||||||
}
|
|
||||||
|
|
||||||
private void debug(final String format, final Object... args) {
|
|
||||||
getLog().debug(String.format(format, args));
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,53 @@
|
||||||
|
/**
|
||||||
|
* The MIT License (MIT)
|
||||||
|
*
|
||||||
|
* Copyright (c) 2017 Paul Campbell
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software
|
||||||
|
* and associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||||
|
* including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||||
|
* and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
* subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in all copies
|
||||||
|
* or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||||
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
* AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||||
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.kemitix.checkstyle.ruleset.plugin;
|
||||||
|
|
||||||
|
import org.apache.maven.artifact.repository.ArtifactRepository;
|
||||||
|
import org.apache.maven.execution.MavenSession;
|
||||||
|
import org.apache.maven.plugin.BuildPluginManager;
|
||||||
|
import org.apache.maven.plugin.MojoExecutionException;
|
||||||
|
import org.apache.maven.plugin.MojoFailureException;
|
||||||
|
import org.apache.maven.project.MavenProject;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Executes the Checkstyle plugin.
|
||||||
|
*
|
||||||
|
* @author Paul Campbell (pcampbell@kemitix.net)
|
||||||
|
*/
|
||||||
|
interface CheckstyleExecutor {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute Checkstyle Check.
|
||||||
|
*
|
||||||
|
* @param mavenProject The Maven Project
|
||||||
|
* @param mavenSession The Maven Session
|
||||||
|
* @param artifactRepository The Artifact Repository
|
||||||
|
* @param pluginManager The Maven Plugin Manager
|
||||||
|
*
|
||||||
|
* @throws MojoExecutionException on execution error
|
||||||
|
* @throws MojoFailureException on execution failure
|
||||||
|
*/
|
||||||
|
void performCheck(
|
||||||
|
final MavenProject mavenProject, final MavenSession mavenSession,
|
||||||
|
final ArtifactRepository artifactRepository, final BuildPluginManager pluginManager
|
||||||
|
) throws MojoExecutionException, MojoFailureException;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,153 @@
|
||||||
|
/**
|
||||||
|
* The MIT License (MIT)
|
||||||
|
*
|
||||||
|
* Copyright (c) 2017 Paul Campbell
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software
|
||||||
|
* and associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||||
|
* including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||||
|
* and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
* subject to the following conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be included in all copies
|
||||||
|
* or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||||
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
|
||||||
|
* AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||||
|
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package net.kemitix.checkstyle.ruleset.plugin;
|
||||||
|
|
||||||
|
import lombok.Getter;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
|
import lombok.val;
|
||||||
|
import org.apache.maven.artifact.DefaultArtifact;
|
||||||
|
import org.apache.maven.artifact.handler.DefaultArtifactHandler;
|
||||||
|
import org.apache.maven.artifact.repository.ArtifactRepository;
|
||||||
|
import org.apache.maven.execution.MavenSession;
|
||||||
|
import org.apache.maven.model.Plugin;
|
||||||
|
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
|
||||||
|
import org.apache.maven.plugin.BuildPluginManager;
|
||||||
|
import org.apache.maven.plugin.MojoExecutionException;
|
||||||
|
import org.apache.maven.plugin.MojoFailureException;
|
||||||
|
import org.apache.maven.plugin.logging.Log;
|
||||||
|
import org.apache.maven.project.MavenProject;
|
||||||
|
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
|
||||||
|
|
||||||
|
import java.io.FileReader;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default implementation of {@link CheckstyleExecutor}.
|
||||||
|
*
|
||||||
|
* @author Paul Campbell (pcampbell@kemitix.net)
|
||||||
|
*/
|
||||||
|
@RequiredArgsConstructor
|
||||||
|
class DefaultCheckstyleExecutor implements CheckstyleExecutor {
|
||||||
|
|
||||||
|
private static final String CHECKSTYLE_GROUPID = "com.puppycrawl.tools";
|
||||||
|
|
||||||
|
private static final String CHECKSTYLE_ARTIFACTID = "checkstyle";
|
||||||
|
|
||||||
|
private static final String SEVNTU_GROUPID = "com.github.sevntu.checkstyle";
|
||||||
|
|
||||||
|
private static final String SEVNTU_ARTIFACTID = "sevntu-checkstyle-maven-plugin";
|
||||||
|
|
||||||
|
private static final String KEMITIX_GROUPID = "net.kemitix";
|
||||||
|
|
||||||
|
private static final String KEMITIX_ARTIFACTID = "kemitix-checkstyle-ruleset";
|
||||||
|
|
||||||
|
private static final String APACHE_PLUGIN_GROUPID = "org.apache.maven.plugins";
|
||||||
|
|
||||||
|
private static final String APACHE_PLUGIN_ARTIFACTID = "maven-checkstyle-plugin";
|
||||||
|
|
||||||
|
private static final String CONFIG_LOCATION = "configLocation";
|
||||||
|
|
||||||
|
private static final String SOURCE_DIR = "sourceDirectory";
|
||||||
|
|
||||||
|
@Getter
|
||||||
|
private final Log log;
|
||||||
|
|
||||||
|
private final String level;
|
||||||
|
|
||||||
|
private final PluginExecutor pluginExecutor;
|
||||||
|
|
||||||
|
private String rulesetVersion;
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public final void performCheck(
|
||||||
|
final MavenProject mavenProject, final MavenSession mavenSession,
|
||||||
|
final ArtifactRepository artifactRepository, final BuildPluginManager pluginManager
|
||||||
|
) throws MojoExecutionException, MojoFailureException {
|
||||||
|
rulesetVersion = mavenProject.getPlugin(KEMITIX_GROUPID + ":" + KEMITIX_ARTIFACTID + "-maven-plugin")
|
||||||
|
.getVersion();
|
||||||
|
debug("rulesetVersion: %s", rulesetVersion);
|
||||||
|
val properties = getProperties(artifactRepository);
|
||||||
|
debug("properties: %s", properties);
|
||||||
|
|
||||||
|
// get versions from pom.xml properties
|
||||||
|
val pluginVersion = getProperty(properties, "maven-checkstyle-plugin.version");
|
||||||
|
val checkstyleVersion = getProperty(properties, "checkstyle.version");
|
||||||
|
val sevntuVersion = getProperty(properties, "sevntu.version");
|
||||||
|
|
||||||
|
// configure
|
||||||
|
val checkstylePlugin = getPlugin(pluginVersion, checkstyleVersion, sevntuVersion);
|
||||||
|
val configuration = pluginExecutor.configuration(
|
||||||
|
pluginExecutor.element(CONFIG_LOCATION, String.format("net/kemitix/checkstyle-%s.xml", level)),
|
||||||
|
pluginExecutor.element(SOURCE_DIR, mavenProject.getBuild()
|
||||||
|
.getSourceDirectory())
|
||||||
|
);
|
||||||
|
val environment = pluginExecutor.executionEnvironment(mavenProject, mavenSession, pluginManager);
|
||||||
|
|
||||||
|
// run
|
||||||
|
info("Running Checkstyle %s (sevntu: %s) with ruleset %s (%s)", checkstyleVersion, sevntuVersion, level,
|
||||||
|
rulesetVersion
|
||||||
|
);
|
||||||
|
pluginExecutor.executeMojo(checkstylePlugin, "check", configuration, environment);
|
||||||
|
info("Checkstyle complete");
|
||||||
|
}
|
||||||
|
|
||||||
|
private String getProperty(final Properties properties, final String key) {
|
||||||
|
val property = properties.getProperty(key);
|
||||||
|
debug(key + ": %s", property);
|
||||||
|
return property;
|
||||||
|
}
|
||||||
|
|
||||||
|
private Plugin getPlugin(final String pluginVersion, final String checkstyleVersion, final String sevntuVersion) {
|
||||||
|
// create checkstyle dependencies
|
||||||
|
val checkstyle = pluginExecutor.dependency(CHECKSTYLE_GROUPID, CHECKSTYLE_ARTIFACTID, checkstyleVersion);
|
||||||
|
val sevntu = pluginExecutor.dependency(SEVNTU_GROUPID, SEVNTU_ARTIFACTID, sevntuVersion);
|
||||||
|
val ruleset = pluginExecutor.dependency(KEMITIX_GROUPID, KEMITIX_ARTIFACTID, rulesetVersion);
|
||||||
|
val dependencies = pluginExecutor.dependencies(checkstyle, sevntu, ruleset);
|
||||||
|
|
||||||
|
return pluginExecutor.plugin(APACHE_PLUGIN_GROUPID, APACHE_PLUGIN_ARTIFACTID, pluginVersion, dependencies);
|
||||||
|
}
|
||||||
|
|
||||||
|
private Properties getProperties(final ArtifactRepository artifactRepository) throws MojoFailureException {
|
||||||
|
// load properties from the plugin pom.xml
|
||||||
|
val pluginArtifactId = KEMITIX_ARTIFACTID + "-parent";
|
||||||
|
val pluginArtifact = new DefaultArtifact(KEMITIX_GROUPID, pluginArtifactId, rulesetVersion, null, "", null,
|
||||||
|
new DefaultArtifactHandler("pom")
|
||||||
|
);
|
||||||
|
try {
|
||||||
|
val pomReader = new FileReader(artifactRepository.find(pluginArtifact)
|
||||||
|
.getFile());
|
||||||
|
return new MavenXpp3Reader().read(pomReader)
|
||||||
|
.getProperties();
|
||||||
|
} catch (XmlPullParserException | IOException e) {
|
||||||
|
throw new MojoFailureException("Can't load properties from plugin's pom.xml", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void info(final String format, final Object... args) {
|
||||||
|
getLog().info(String.format(format, args));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void debug(final String format, final Object... args) {
|
||||||
|
getLog().debug(String.format(format, args));
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in a new issue