inteligr8/conditional-maven-plugin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial checkin

Browse Source
This commit is contained in:
brian.long
2021-05-18 12:30:26 -04:00
commit 4925d66cb1
12 changed files with 1518 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/it/boolean-property/pom.xml
+177
View File
@@ -0,0 +1,177 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.inteligr8</groupId>
<artifactId>conditional-maven-plugin-boolean-property</artifactId>
<version>@pom.version@</version>
<packaging>pom</packaging>
<name>Boolean Property Plugin Tests</name>
<properties>
<prop.true>true</prop.true>
<prop.false>false</prop.false>
<prop.neither>none</prop.neither>
<prop.empty></prop.empty>
</properties>
<build>
<plugins>
<plugin>
<groupId>${project.groupId}</groupId>
<artifactId>conditional-maven-plugin</artifactId>
<version>@pom.version@</version>
<executions>
<execution>
<id>check-true-null</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.true</booleanProperty>
<newProperty>prop.true-null</newProperty>
</configuration>
</execution>
<execution>
<id>check-true-empty</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.true</booleanProperty>
<trueValue></trueValue>
<newProperty>prop.true-empty</newProperty>
</configuration>
</execution>
<execution>
<id>check-true</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.true</booleanProperty>
<trueValue>condition was true</trueValue>
<newProperty>prop.true-valued</newProperty>
</configuration>
</execution>
<execution>
<id>check-false-null</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.false</booleanProperty>
<newProperty>prop.false-null</newProperty>
</configuration>
</execution>
<execution>
<id>check-false-empty</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.false</booleanProperty>
<falseValue></falseValue>
<newProperty>prop.false-empty</newProperty>
</configuration>
</execution>
<execution>
<id>check-false</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.false</booleanProperty>
<falseValue>condition was false</falseValue>
<newProperty>prop.false-valued</newProperty>
</configuration>
</execution>
<execution>
<id>check-neither</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.neither</booleanProperty>
<trueValue>condition was true</trueValue>
<falseValue>condition was false</falseValue>
<newProperty>prop.neither-valued</newProperty>
</configuration>
</execution>
<execution>
<id>check-empty</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.empty</booleanProperty>
<trueValue>condition was true</trueValue>
<falseValue>condition was false</falseValue>
<newProperty>prop.empty-valued</newProperty>
</configuration>
</execution>
<execution>
<id>check-null</id>
<phase>validate</phase>
<goals>
<goal>boolean-property</goal>
</goals>
<configuration>
<booleanProperty>prop.null</booleanProperty>
<trueValue>condition was true</trueValue>
<falseValue>condition was false</falseValue>
<newProperty>prop.null-valued</newProperty>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-enforcer-plugin</artifactId>
<version>1.4.1</version>
<executions>
<execution>
<id>assert</id>
<goals><goal>enforce</goal></goals>
<configuration>
<rules>
<requireProperty>
<property>prop.true-valued</property>
<regex>condition was true</regex>
</requireProperty>
<requireProperty>
<property>prop.false-valued</property>
<regex>condition was false</regex>
</requireProperty>
<requireProperty>
<property>prop.neither-valued</property>
<regex>condition was false</regex>
</requireProperty>
<requireProperty>
<property>prop.empty-valued</property>
<regex>condition was false</regex>
</requireProperty>
<requireProperty>
<property>prop.null-valued</property>
<regex>condition was false</regex>
</requireProperty>
</rules>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
src/main/java/com/inteligr8/maven/ProjectPropertyResolver.java
+27
View File
@@ -0,0 +1,27 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.maven;
import java.util.Properties;
public interface ProjectPropertyResolver {
Properties resolveScope(String propertyName);
String resolve(String propertyName);
String resolve(String propertyName, String defaultValue);
}
src/main/java/com/inteligr8/maven/StandardProjectPropertyResolver.java
+86
View File
@@ -0,0 +1,86 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.maven;
import java.util.Properties;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Profile;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
@Component(role = ProjectPropertyResolver.class)
public class StandardProjectPropertyResolver implements ProjectPropertyResolver {
@Requirement
private MavenSession session;
@Requirement
private MavenProject project;
@Override
public String resolve(String propertyName) {
Properties props = this.findPropertiesObject(propertyName);
return props == null ? null : props.getProperty(propertyName);
}
@Override
public String resolve(String propertyName, String defaultValue) {
Properties props = this.findPropertiesObject(propertyName);
return props == null ? null : props.getProperty(propertyName, defaultValue);
}
@Override
public Properties resolveScope(String propertyName) {
return this.findPropertiesObject(propertyName);
}
private Properties findPropertiesObject(String key) {
// search the user/cli properties first
Properties props = this.session.getUserProperties();
if (props.containsKey(key))
return props;
// search the profiles next; in order (FIXME maybe we should go backwards?)
for (Profile profile : this.project.getActiveProfiles()) {
props = profile.getProperties();
if (props.containsKey(key))
return props;
}
// now look at the project props
props = this.project.getProperties();
if (props.containsKey(key))
return props;
// now recursively look up the parent project props
MavenProject ancestor = this.project.getParent();
while (ancestor != null) {
props = ancestor.getProperties();
if (props.containsKey(key))
return props;
ancestor = ancestor.getParent();
}
// search the system properties last (FIXME is this right?)
props = this.session.getSystemProperties();
if (props.containsKey(key))
return props;
return null;
}
}
src/main/java/com/inteligr8/maven/conditional/AbstractPropertyMojo.java
+102
View File
@@ -0,0 +1,102 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.maven.conditional;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Requirement;
import com.inteligr8.maven.ProjectPropertyResolver;
public abstract class AbstractPropertyMojo extends AbstractMojo {
@Parameter( defaultValue = "${project}", readonly = true )
protected MavenProject project;
@Parameter( defaultValue = "${session}", readonly = true )
protected MavenSession session;
@Requirement
private ProjectPropertyResolver propResolver;
@Parameter( property = "newProperty", required = true )
protected String newProperty;
@Parameter( property = "trueValue" )
protected String trueValue;
@Parameter( property = "falseValue" )
protected String falseValue;
@Parameter( property = "charset", required = true, defaultValue = "utf-8" )
protected String charsetName = "utf-8";
@Parameter( property = "skip", required = true, defaultValue = "false" )
protected boolean skip = false;
public final void execute() throws MojoExecutionException, MojoFailureException {
if (this.skip) {
this.getLog().debug("Skipped execution");
return;
}
this.validateParamsPreNormalization();
this.normalizeParameters();
this.validateParamsPostNormalization();
this.go();
}
protected abstract void go() throws MojoExecutionException, MojoFailureException;
@OverridingMethodsMustInvokeSuper
protected void validateParamsPreNormalization() throws MojoFailureException {
this.getLog().debug("Validating parameters before their normalization");
if (this.newProperty == null)
throw new MojoFailureException("The 'newProperty' element is required");
}
@OverridingMethodsMustInvokeSuper
protected void normalizeParameters() throws MojoFailureException {
this.getLog().debug("Normalizing parameters");
this.newProperty = StringUtils.trimToNull(this.newProperty);
}
@OverridingMethodsMustInvokeSuper
protected void validateParamsPostNormalization() throws MojoFailureException {
this.getLog().debug("Validating parameters after their normalization");
if (this.newProperty == null)
throw new MojoFailureException("The 'newProperty' element is required");
}
protected final void executeOnCondition(boolean condition) {
if (condition && this.trueValue != null) {
this.project.getProperties().setProperty(this.newProperty, this.trueValue);
} else if (!condition && this.falseValue != null) {
this.project.getProperties().setProperty(this.newProperty, this.falseValue);
}
}
}
src/main/java/com/inteligr8/maven/conditional/BooleanPropertyMojo.java
+84
View File
@@ -0,0 +1,84 @@
/*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <https://www.gnu.org/licenses/>.
*/
package com.inteligr8.maven.conditional;
import java.util.Properties;
import javax.annotation.OverridingMethodsMustInvokeSuper;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import com.inteligr8.maven.ProjectPropertyResolver;
@Mojo( name = "boolean-property", threadSafe = true )
@Component( role = org.apache.maven.plugin.Mojo.class )
public class BooleanPropertyMojo extends AbstractPropertyMojo {
@Parameter( property = "booleanProperty", required = true )
protected String booleanProperty;
@Requirement
private ProjectPropertyResolver propResolver;
@Override
public void go() throws MojoExecutionException {
this.getLog().debug("Executing boolean property condition");
boolean value = false;
Properties props = this.propResolver.resolveScope(this.booleanProperty);
if (props == null) {
// assume false if it doesn't exist
} else {
String strValue = props.getProperty(this.booleanProperty);
value = Boolean.parseBoolean(strValue);
}
this.executeOnCondition(value);
}
@Override
@OverridingMethodsMustInvokeSuper
protected void validateParamsPreNormalization() throws MojoFailureException {
super.validateParamsPreNormalization();
if (this.booleanProperty == null)
throw new MojoFailureException("The 'booleanProperty' element is required");
}
@Override
@OverridingMethodsMustInvokeSuper
protected void normalizeParameters() throws MojoFailureException {
super.normalizeParameters();
this.booleanProperty = StringUtils.trimToNull(this.booleanProperty);
}
@Override
@OverridingMethodsMustInvokeSuper
protected void validateParamsPostNormalization() throws MojoFailureException {
super.validateParamsPostNormalization();
if (this.booleanProperty == null)
throw new MojoFailureException("The 'booleanProperty' element is required");
}
}
src/test/resources/blank-first-last-lines.file
+2
View File
@@ -0,0 +1,2 @@
here is a line
src/test/resources/empty.file
View File
src/test/resources/used-first-last-lines.file
+2
View File
@@ -0,0 +1,2 @@
the first line
the last line