001package org.apache.maven.plugin.plugin; 002 003/* 004 * Licensed to the Apache Software Foundation (ASF) under one 005 * or more contributor license agreements. See the NOTICE file 006 * distributed with this work for additional information 007 * regarding copyright ownership. The ASF licenses this file 008 * to you under the Apache License, Version 2.0 (the 009 * "License"); you may not use this file except in compliance 010 * with the License. You may obtain a copy of the License at 011 * 012 * http://www.apache.org/licenses/LICENSE-2.0 013 * 014 * Unless required by applicable law or agreed to in writing, 015 * software distributed under the License is distributed on an 016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 017 * KIND, either express or implied. See the License for the 018 * specific language governing permissions and limitations 019 * under the License. 020 */ 021 022import org.apache.maven.artifact.Artifact; 023import org.apache.maven.artifact.repository.ArtifactRepository; 024import org.apache.maven.artifact.resolver.filter.ArtifactFilter; 025import org.apache.maven.artifact.resolver.filter.IncludesArtifactFilter; 026import org.apache.maven.plugin.AbstractMojo; 027import org.apache.maven.plugin.MojoExecutionException; 028import org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException; 029import org.apache.maven.plugin.descriptor.PluginDescriptor; 030import org.apache.maven.plugins.annotations.Component; 031import org.apache.maven.plugins.annotations.Parameter; 032import org.apache.maven.project.MavenProject; 033import org.apache.maven.tools.plugin.DefaultPluginToolsRequest; 034import org.apache.maven.tools.plugin.PluginToolsRequest; 035import org.apache.maven.tools.plugin.extractor.ExtractionException; 036import org.apache.maven.tools.plugin.generator.Generator; 037import org.apache.maven.tools.plugin.generator.GeneratorException; 038import org.apache.maven.tools.plugin.generator.GeneratorUtils; 039import org.apache.maven.tools.plugin.scanner.MojoScanner; 040import org.codehaus.plexus.component.repository.ComponentDependency; 041import org.codehaus.plexus.util.ReaderFactory; 042 043import java.io.File; 044import java.util.Arrays; 045import java.util.LinkedHashSet; 046import java.util.List; 047import java.util.Set; 048 049/** 050 * Abstract class for this Plugin. 051 * 052 * @author <a href="mailto:jason@maven.org">Jason van Zyl</a> 053 * @version $Id: AbstractGeneratorMojo.html 995996 2016-08-26 22:31:42Z rfscholte $ 054 */ 055public abstract class AbstractGeneratorMojo 056 extends AbstractMojo 057{ 058 /** 059 * The project currently being built. 060 */ 061 @Parameter( defaultValue = "${project}", readonly = true ) 062 protected MavenProject project; 063 064 /** 065 * The component used for scanning the source tree for mojos. 066 */ 067 @Component 068 protected MojoScanner mojoScanner; 069 070 /** 071 * The file encoding of the source files. 072 * 073 * @since 2.5 074 */ 075 @Parameter( property = "encoding", defaultValue = "${project.build.sourceEncoding}" ) 076 protected String encoding; 077 078 /** 079 * The goal prefix that will appear before the ":". 080 */ 081 @Parameter 082 protected String goalPrefix; 083 084 /** 085 * By default an exception is throw if no mojo descriptor is found. As the maven-plugin is defined in core, the 086 * descriptor generator mojo is bound to generate-resources phase. 087 * But for annotations, the compiled classes are needed, so skip error 088 * 089 * @since 3.0 090 */ 091 @Parameter( property = "maven.plugin.skipErrorNoDescriptorsFound", defaultValue = "false" ) 092 protected boolean skipErrorNoDescriptorsFound; 093 094 /** 095 * The role names of mojo extractors to use. 096 * <p/> 097 * If not set, all mojo extractors will be used. If set to an empty extractor name, no mojo extractors 098 * will be used. 099 * <p/> 100 * Example: 101 * <p/> 102 * <pre> 103 * <!-- Use all mojo extractors --> 104 * <extractors/> 105 * 106 * <!-- Use no mojo extractors --> 107 * <extractors> 108 * <extractor/> 109 * </extractors> 110 * 111 * <!-- Use only bsh mojo extractor --> 112 * <extractors> 113 * <extractor>bsh</extractor> 114 * </extractors> 115 * </pre> 116 */ 117 @Parameter 118 protected Set<String> extractors; 119 120 /** 121 * Set this to "true" to skip invoking any goals or reports of the plugin. 122 * 123 * @since 2.8 124 */ 125 @Parameter( defaultValue = "false", property = "maven.plugin.skip" ) 126 protected boolean skip; 127 128 /** 129 * The set of dependencies for the current project 130 * 131 * @since 3.0 132 */ 133 @Parameter( defaultValue = "${project.artifacts}", required = true, readonly = true ) 134 protected Set<Artifact> dependencies; 135 136 /** 137 * Specify the dependencies as {@code groupId:artifactId} containing (abstract) Mojos. 138 * If not specified in the configuration, this is {@code null} and all dependencies are scanned. 139 * If specified with no children, no dependencies are scanned. 140 * 141 * @since 3.5 142 */ 143 @Parameter 144 private List<String> mojoDependencies; 145 146 /** 147 * List of Remote Repositories used by the resolver 148 * 149 * @since 3.0 150 */ 151 @Parameter( defaultValue = "${project.remoteArtifactRepositories}", required = true, readonly = true ) 152 protected List<ArtifactRepository> remoteRepos; 153 154 /** 155 * Location of the local repository. 156 * 157 * @since 3.0 158 */ 159 @Parameter( defaultValue = "${localRepository}", required = true, readonly = true ) 160 protected ArtifactRepository local; 161 162 /** 163 * Maven plugin packaging types. Default is single "maven-plugin". 164 * 165 * @since 3.3 166 */ 167 @Parameter 168 protected List<String> packagingTypes = Arrays.asList( "maven-plugin" ); 169 170 /** 171 * @return the output directory where files will be generated. 172 */ 173 protected abstract File getOutputDirectory(); 174 175 /** 176 * @return the wanted <code>Generator</code> implementation. 177 */ 178 protected abstract Generator createGenerator(); 179 180 /** 181 * {@inheritDoc} 182 */ 183 public void execute() 184 throws MojoExecutionException 185 { 186 if ( !packagingTypes.contains( project.getPackaging() ) ) 187 { 188 getLog().warn( "Unsupported packaging type " + project.getPackaging() + ", execution skipped" ); 189 return; 190 } 191 if ( skip ) 192 { 193 getLog().warn( "Execution skipped" ); 194 return; 195 } 196 197 if ( project.getArtifactId().toLowerCase().startsWith( "maven-" ) 198 && project.getArtifactId().toLowerCase().endsWith( "-plugin" ) && !"org.apache.maven.plugins".equals( 199 project.getGroupId() ) ) 200 { 201 getLog().error( "\n\nArtifact Ids of the format maven-___-plugin are reserved for \n" 202 + "plugins in the Group Id org.apache.maven.plugins\n" 203 + "Please change your artifactId to the format ___-maven-plugin\n" 204 + "In the future this error will break the build.\n\n" ); 205 } 206 207 String defaultGoalPrefix = PluginDescriptor.getGoalPrefixFromArtifactId( project.getArtifactId() ); 208 if ( goalPrefix == null ) 209 { 210 goalPrefix = defaultGoalPrefix; 211 } 212 else if ( !goalPrefix.equals( defaultGoalPrefix ) ) 213 { 214 getLog().warn( 215 "\n\nGoal prefix is specified as: '" + goalPrefix + "'. " + "Maven currently expects it to be '" 216 + defaultGoalPrefix + "'.\n" ); 217 } 218 219 mojoScanner.setActiveExtractors( extractors ); 220 221 // TODO: could use this more, eg in the writing of the plugin descriptor! 222 PluginDescriptor pluginDescriptor = new PluginDescriptor(); 223 224 pluginDescriptor.setGroupId( project.getGroupId() ); 225 226 pluginDescriptor.setArtifactId( project.getArtifactId() ); 227 228 pluginDescriptor.setVersion( project.getVersion() ); 229 230 pluginDescriptor.setGoalPrefix( goalPrefix ); 231 232 pluginDescriptor.setName( project.getName() ); 233 234 pluginDescriptor.setDescription( project.getDescription() ); 235 236 if ( encoding == null || encoding.length() < 1 ) 237 { 238 getLog().warn( "Using platform encoding (" + ReaderFactory.FILE_ENCODING 239 + " actually) to read mojo source files, i.e. build is platform dependent!" ); 240 } 241 else 242 { 243 getLog().info( "Using '" + encoding + "' encoding to read mojo source files." ); 244 } 245 246 Set<Artifact> requestDependencies; 247 if ( mojoDependencies == null ) 248 { 249 requestDependencies = dependencies; 250 } 251 else if ( mojoDependencies == null ) 252 { 253 requestDependencies = null; 254 } 255 else 256 { 257 requestDependencies = new LinkedHashSet<Artifact>(); 258 259 ArtifactFilter filter = new IncludesArtifactFilter( mojoDependencies ); 260 261 for ( Artifact artifact : dependencies ) 262 { 263 if ( filter.include( artifact ) ) 264 { 265 requestDependencies.add( artifact ); 266 } 267 } 268 } 269 270 271 try 272 { 273 List<ComponentDependency> deps = GeneratorUtils.toComponentDependencies( project.getRuntimeDependencies() ); 274 pluginDescriptor.setDependencies( deps ); 275 276 PluginToolsRequest request = new DefaultPluginToolsRequest( project, pluginDescriptor ); 277 request.setEncoding( encoding ); 278 request.setSkipErrorNoDescriptorsFound( skipErrorNoDescriptorsFound ); 279 request.setDependencies( requestDependencies ); 280 request.setLocal( this.local ); 281 request.setRemoteRepos( this.remoteRepos ); 282 283 mojoScanner.populatePluginDescriptor( request ); 284 285 getOutputDirectory().mkdirs(); 286 287 createGenerator().execute( getOutputDirectory(), request ); 288 } 289 catch ( GeneratorException e ) 290 { 291 throw new MojoExecutionException( "Error writing plugin descriptor", e ); 292 } 293 catch ( InvalidPluginDescriptorException e ) 294 { 295 throw new MojoExecutionException( "Error extracting plugin descriptor: \'" + e.getLocalizedMessage() + "\'", 296 e ); 297 } 298 catch ( ExtractionException e ) 299 { 300 throw new MojoExecutionException( "Error extracting plugin descriptor: \'" + e.getLocalizedMessage() + "\'", 301 e ); 302 } 303 catch ( LinkageError e ) 304 { 305 throw new MojoExecutionException( "The API of the mojo scanner is not compatible with this plugin version." 306 + " Please check the plugin dependencies configured in the POM and ensure the versions match.", e ); 307 } 308 } 309 310}