|
| 1 | +/* |
| 2 | + * JBoss, Home of Professional Open Source. |
| 3 | + * Copyright 2016, Red Hat, Inc., and individual contributors |
| 4 | + * as indicated by the @author tags. See the copyright.txt file in the |
| 5 | + * distribution for a full listing of individual contributors. |
| 6 | + * |
| 7 | + * This is free software; you can redistribute it and/or modify it |
| 8 | + * under the terms of the GNU Lesser General Public License as |
| 9 | + * published by the Free Software Foundation; either version 2.1 of |
| 10 | + * the License, or (at your option) any later version. |
| 11 | + * |
| 12 | + * This software is distributed in the hope that it will be useful, |
| 13 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15 | + * Lesser General Public License for more details. |
| 16 | + * |
| 17 | + * You should have received a copy of the GNU Lesser General Public |
| 18 | + * License along with this software; if not, write to the Free |
| 19 | + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA |
| 20 | + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. |
| 21 | + */ |
| 22 | +package org.jboss.as.patch.generator.maven.plugin; |
| 23 | + |
| 24 | +import java.io.File; |
| 25 | +import java.io.IOException; |
| 26 | +import java.util.ArrayList; |
| 27 | +import java.util.List; |
| 28 | + |
| 29 | +import org.apache.maven.artifact.Artifact; |
| 30 | +import org.apache.maven.plugin.AbstractMojo; |
| 31 | +import org.apache.maven.plugin.MojoExecutionException; |
| 32 | +import org.apache.maven.plugins.annotations.LifecyclePhase; |
| 33 | +import org.apache.maven.plugins.annotations.Mojo; |
| 34 | +import org.apache.maven.plugins.annotations.Parameter; |
| 35 | +import org.jboss.as.patching.generator.PatchGenerator; |
| 36 | + |
| 37 | +/** |
| 38 | + * Maven plug-in for creating patches for WildFly / JBoss EAP, using the patch-gen tool. |
| 39 | + * <p> |
| 40 | + * All options from {@link PatchGenerator} are supported. The configuration option names are the same as for the CLI |
| 41 | + * options, but without hyphens and camel-cased. E.g. use {@code appliesToDist} as counterpart to |
| 42 | + * {@code --applies-to-dist}. |
| 43 | + * <p> |
| 44 | + * Example usage: |
| 45 | + * <pre> |
| 46 | + * {@code |
| 47 | + * <plugin> |
| 48 | + * <groupId>org.jboss.as</groupId> |
| 49 | + * <artifactId>patch-gen-maven-plugin</artifactId> |
| 50 | + * <version>2.0.1.Alpha2-SNAPSHOT</version> |
| 51 | + * <executions> |
| 52 | + * <execution> |
| 53 | + * <id>create-patch-file</id> |
| 54 | + * <phase>prepare-package</phase> |
| 55 | + * <goals> |
| 56 | + * <goal>GenPatch</goal> |
| 57 | + * </goals> |
| 58 | + * <configuration> |
| 59 | + * <appliesToDist>path/to/source/dist</appliesToDist> |
| 60 | + * <updatedDist>path/to/updated/dist</updatedDist> |
| 61 | + * <patchConfig>path/to/patch.xml</patchConfig> |
| 62 | + * <outputFile>path/to/my-patch.zip</outputFile> |
| 63 | + * <includeVersion>true</includeVersion> |
| 64 | + * </configuration> |
| 65 | + * </execution> |
| 66 | + * </executions> |
| 67 | + * </plugin> |
| 68 | + * } |
| 69 | + * </pre> |
| 70 | + * |
| 71 | + * @author Gunnar Morling |
| 72 | + */ |
| 73 | +@Mojo( name = "generate-patch", defaultPhase = LifecyclePhase.GENERATE_RESOURCES ) |
| 74 | +public class PatchGenMojo extends AbstractMojo { |
| 75 | + |
| 76 | + private static final String LOG_FILE = "patchgen.log"; |
| 77 | + |
| 78 | + @Parameter( property = "patchConfig", required = true ) |
| 79 | + private File patchConfig; |
| 80 | + |
| 81 | + @Parameter( property = "appliesToDist", required = true ) |
| 82 | + private File appliesToDist; |
| 83 | + |
| 84 | + @Parameter( property = "updatedDist", required = true ) |
| 85 | + private File updatedDist; |
| 86 | + |
| 87 | + @Parameter( property = "outputFile", required = true ) |
| 88 | + private File outputFile; |
| 89 | + |
| 90 | + @Parameter( property = "assemblePatchBundle" ) |
| 91 | + private Boolean assemblePatchBundle; |
| 92 | + |
| 93 | + @Parameter( property = "createTemplate" ) |
| 94 | + private Boolean createTemplate; |
| 95 | + |
| 96 | + @Parameter( property = "detailedInspection" ) |
| 97 | + private Boolean detailedInspection; |
| 98 | + |
| 99 | + @Parameter( property = "includeVersion" ) |
| 100 | + private Boolean includeVersion; |
| 101 | + |
| 102 | + @Parameter( property = "combineWith" ) |
| 103 | + private File combineWith; |
| 104 | + |
| 105 | + @Parameter( property = "project.build.directory" ) |
| 106 | + private File buildDirectory; |
| 107 | + |
| 108 | + @Parameter( property = "plugin.artifacts" ) |
| 109 | + protected List<Artifact> pluginArtifacts; |
| 110 | + |
| 111 | + @Override |
| 112 | + public void execute() throws MojoExecutionException { |
| 113 | + List<String> args = new ArrayList<>(); |
| 114 | + |
| 115 | + args.add( "java" ); |
| 116 | + args.add( "-cp" ); |
| 117 | + args.add( getClasspath() ); |
| 118 | + args.add( PatchGenerator.class.getName() ); |
| 119 | + |
| 120 | + args.add( PatchGenerator.APPLIES_TO_DIST + "=" + appliesToDist.getPath() ); |
| 121 | + args.add( PatchGenerator.OUTPUT_FILE + "=" + outputFile.getPath() ); |
| 122 | + args.add( PatchGenerator.PATCH_CONFIG + "=" + patchConfig.getPath() ); |
| 123 | + args.add( PatchGenerator.UPDATED_DIST + "=" + updatedDist.getPath() ); |
| 124 | + |
| 125 | + if ( assemblePatchBundle != null ) { |
| 126 | + args.add( PatchGenerator.ASSEMBLE_PATCH_BUNDLE ); |
| 127 | + } |
| 128 | + |
| 129 | + if ( createTemplate != null ) { |
| 130 | + args.add( PatchGenerator.CREATE_TEMPLATE ); |
| 131 | + } |
| 132 | + |
| 133 | + if ( detailedInspection != null ) { |
| 134 | + args.add( PatchGenerator.DETAILED_INSPECTION ); |
| 135 | + } |
| 136 | + |
| 137 | + if ( includeVersion != null ) { |
| 138 | + args.add( PatchGenerator.INCLUDE_VERSION ); |
| 139 | + } |
| 140 | + |
| 141 | + if ( combineWith != null ) { |
| 142 | + args.add( PatchGenerator.COMBINE_WITH + "=" + combineWith.getPath() ); |
| 143 | + } |
| 144 | + |
| 145 | + // Ideally, we'd just invoke PatchGenerator directly; currently we cannot do so due to https://issues.jboss.org/browse/MODULES-136: |
| 146 | + // JBoss Modules, when used as a library, will set some system properties to values causing trouble for other plug-ins later in the |
| 147 | + // build; e.g. SAXParserFactory is redirected to a JBoss Modules specific variant which then cannot be found by other users such as |
| 148 | + // the Checkstyle plug-in (which naturally doesn't have JBoss Modules on the plug-in dependency path). Hence we start patch-gen in |
| 149 | + // a separate process |
| 150 | + // |
| 151 | + // PatchGenerator.main( args.toArray( new String[0] ) ); |
| 152 | + try { |
| 153 | + Process p = new ProcessBuilder( args ) |
| 154 | + .redirectOutput( new File( buildDirectory, LOG_FILE ) ) |
| 155 | + .redirectError( new File( buildDirectory, LOG_FILE ) ) |
| 156 | + .start(); |
| 157 | + p.waitFor(); |
| 158 | + } |
| 159 | + catch (IOException | InterruptedException e) { |
| 160 | + throw new MojoExecutionException( "Execution of PatchGenerator failed. See " + LOG_FILE + " for details.", e ); |
| 161 | + } |
| 162 | + |
| 163 | + if ( !outputFile.exists() ) { |
| 164 | + throw new MojoExecutionException( "Execution of PatchGenerator failed. See " + LOG_FILE + " for details." ); |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + private String getClasspath() { |
| 169 | + StringBuilder sb = new StringBuilder(); |
| 170 | + boolean first = true; |
| 171 | + |
| 172 | + for ( Artifact artifact : pluginArtifacts ) { |
| 173 | + if ( first ) { |
| 174 | + first = false; |
| 175 | + } |
| 176 | + else { |
| 177 | + sb.append( File.pathSeparator ); |
| 178 | + } |
| 179 | + sb.append( artifact.getFile().getPath() ); |
| 180 | + } |
| 181 | + |
| 182 | + return sb.toString(); |
| 183 | + } |
| 184 | +} |
0 commit comments