Upgrade to beta-4-SNAPSHOT

Author: gnodet

maven-plugin-plugin/src/it/v4api/invoker.properties

@@ -17,3 +17,4 @@
 
 invoker.java.version = 17+
 invoker.goals.1 = clean install
+invoker.goals.2 = org.apache.maven.its:v4api:1.0-SNAPSHOT:first

maven-plugin-plugin/src/it/v4api/src/main/java/org/apache/maven/its/v4api/FirstMojo.java

@@ -19,19 +19,17 @@
 package org.apache.maven.its.v4api;
 
 import java.nio.file.Path;
+import java.util.List;
 
 import org.apache.maven.api.MojoExecution;
 import org.apache.maven.api.Project;
 import org.apache.maven.api.Session;
 import org.apache.maven.api.di.Inject;
-import org.apache.maven.api.di.Named;
 import org.apache.maven.api.plugin.Log;
 import org.apache.maven.api.plugin.MojoException;
-import org.apache.maven.api.plugin.annotations.Execute;
+import org.apache.maven.api.plugin.annotations.Dependencies;
 import org.apache.maven.api.plugin.annotations.Mojo;
 import org.apache.maven.api.plugin.annotations.Parameter;
-import org.apache.maven.api.services.ArtifactInstaller;
-import org.apache.maven.api.settings.Settings;
 
 /**
  * Test mojo for the v4 api plugin descriptor generation.
@@ -42,7 +40,6 @@
  * @since 1.2
  */
 @Mojo(name = "first", defaultPhase = "integration-test")
-@Execute(phase = "generate-sources", lifecycle = "cobertura")
 public class FirstMojo implements org.apache.maven.api.plugin.Mojo {
 
     /**
@@ -62,6 +59,9 @@ public class FirstMojo implements org.apache.maven.api.plugin.Mojo {
     @Parameter(name = "namedParam", alias = "alias")
     private String aliasedParam;
 
+    @Dependencies(pathScope = "main-runtime")
+    private List<Path> classPath;
+
     @Inject
     private Session session;
 
@@ -71,15 +71,13 @@ public class FirstMojo implements org.apache.maven.api.plugin.Mojo {
     @Inject
     private MojoExecution mojo;
 
-    @Inject
-    private Settings settings;
-
     @Inject
     private Log log;
 
-    @Inject
-    @Named("test")
-    private ArtifactInstaller custom;
-
-    public void execute() throws MojoException {}
+    public void execute() throws MojoException {
+        log.info("Executing first");
+        for (Path path : classPath) {
+            log.info(path.toString());
+        }
+    }
 }

maven-plugin-plugin/src/it/v4api/verify.groovy

@@ -25,7 +25,7 @@ assert descriptorFile.isFile()
 def pluginDescriptor = new XmlParser().parse( descriptorFile );
 
 assert pluginDescriptor.requiredJavaVersion.text() == '17'
-assert pluginDescriptor.requiredMavenVersion.text() == '4.0.0-beta-3'
+assert pluginDescriptor.requiredMavenVersion.text() == '4.0.0-beta-4-SNAPSHOT'
 
 def mojo = pluginDescriptor.mojos.mojo.findAll{ it.goal.text() == "first" }[0]
 
@@ -37,8 +37,6 @@ assert mojo.projectRequired.text() == 'true'
 assert mojo.onlineRequired.text() == 'false'
 assert mojo.aggregator.text() == 'false'
 assert mojo.phase.text() == 'integration-test'
-assert mojo.executePhase.text() == 'generate-sources'
-assert mojo.executeLifecycle.text() == 'cobertura'
 
 assert mojo.parameters.parameter.size() == 3
 
@@ -78,6 +76,13 @@ assert parameter.description.text() == ''
 assert parameter.defaultValue.isEmpty()
 assert parameter.expression.isEmpty()
 
+assert mojo.dependencies.dependency.size() == 1
+
+dependency = mojo.dependencies.dependency[0]
+assert dependency.field.text() == 'classPath'
+assert dependency.pathScope.text() == 'main-runtime'
+assert dependency.requestType.text() == ''
+
 // check help mojo source and class
 assert new File( basedir, "target/classes/org/apache/maven/its/v4api/HelpMojo.class" ).isFile()
 assert new File( basedir, "target/generated-sources/plugin/org/apache/maven/its/v4api/HelpMojo.java" ).isFile()

maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/JavaAnnotationsMojoDescriptorExtractor.java

@@ -58,6 +58,7 @@
 import org.apache.maven.plugin.descriptor.PluginDescriptor;
 import org.apache.maven.plugin.descriptor.Requirement;
 import org.apache.maven.project.MavenProject;
+import org.apache.maven.tools.plugin.Dependencies;
 import org.apache.maven.tools.plugin.ExtendedMojoDescriptor;
 import org.apache.maven.tools.plugin.PluginToolsRequest;
 import org.apache.maven.tools.plugin.extractor.ExtractionException;
@@ -68,6 +69,7 @@
 import org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocBlockTagsToXhtmlConverter;
 import org.apache.maven.tools.plugin.extractor.annotations.converter.JavadocInlineTagsToXhtmlConverter;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent;
+import org.apache.maven.tools.plugin.extractor.annotations.datamodel.DependenciesAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent;
@@ -791,6 +793,18 @@ private List<MojoDescriptor> toMojoDescriptors(
                 mojoDescriptor.addParameter(parameter);
             }
 
+            // Dependencies annotations
+            Map<String, DependenciesAnnotationContent> dependenciess =
+                    getDependenciesParentHierarchy(mojoAnnotatedClass, mojoAnnotatedClasses);
+
+            for (DependenciesAnnotationContent dependenciesAnnotationContent : new TreeSet<>(dependenciess.values())) {
+                Dependencies dependencies = new Dependencies();
+                dependencies.setField(dependenciesAnnotationContent.getFieldName());
+                dependencies.setPathScope(dependenciesAnnotationContent.getPathScope());
+                dependencies.setRequestType(dependenciesAnnotationContent.getRequestType());
+                mojoDescriptor.addDependencies(dependencies);
+            }
+
             mojoDescriptor.setPluginDescriptor(pluginDescriptor);
 
             mojoDescriptors.add(mojoDescriptor);
@@ -847,6 +861,40 @@ protected List<ParameterAnnotationContent> getParametersParent(
         return parameterAnnotationContents;
     }
 
+    protected Map<String, DependenciesAnnotationContent> getDependenciesParentHierarchy(
+            MojoAnnotatedClass mojoAnnotatedClass, Map<String, MojoAnnotatedClass> mojoAnnotatedClasses) {
+        List<DependenciesAnnotationContent> dependenciesAnnotationContents = new ArrayList<>();
+
+        dependenciesAnnotationContents =
+                getDependenciesParent(mojoAnnotatedClass, dependenciesAnnotationContents, mojoAnnotatedClasses);
+
+        // move to parent first to build the Map
+        Collections.reverse(dependenciesAnnotationContents);
+
+        Map<String, DependenciesAnnotationContent> map = new HashMap<>(dependenciesAnnotationContents.size());
+
+        for (DependenciesAnnotationContent dependenciesAnnotationContent : dependenciesAnnotationContents) {
+            map.put(dependenciesAnnotationContent.getFieldName(), dependenciesAnnotationContent);
+        }
+        return map;
+    }
+
+    protected List<DependenciesAnnotationContent> getDependenciesParent(
+            MojoAnnotatedClass mojoAnnotatedClass,
+            List<DependenciesAnnotationContent> dependenciesAnnotationContents,
+            Map<String, MojoAnnotatedClass> mojoAnnotatedClasses) {
+        dependenciesAnnotationContents.addAll(
+                mojoAnnotatedClass.getDependencies().values());
+        String parentClassName = mojoAnnotatedClass.getParentClassName();
+        if (parentClassName != null) {
+            MojoAnnotatedClass parent = mojoAnnotatedClasses.get(parentClassName);
+            if (parent != null) {
+                return getDependenciesParent(parent, dependenciesAnnotationContents, mojoAnnotatedClasses);
+            }
+        }
+        return dependenciesAnnotationContents;
+    }
+
     protected Map<String, ComponentAnnotationContent> getComponentsParentHierarchy(
             MojoAnnotatedClass mojoAnnotatedClass, Map<String, MojoAnnotatedClass> mojoAnnotatedClasses) {
         List<ComponentAnnotationContent> componentAnnotationContents = new ArrayList<>();

maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/datamodel/DependenciesAnnotationContent.java

@@ -0,0 +1,72 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.tools.plugin.extractor.annotations.datamodel;
+
+import java.lang.annotation.Annotation;
+
+/**
+ * @author Olivier Lamy
+ * @since 3.0
+ */
+public class DependenciesAnnotationContent extends AnnotatedField {
+    private String pathScope;
+
+    private String requestType;
+
+    public DependenciesAnnotationContent(String fieldName) {
+        super(fieldName);
+    }
+
+    public DependenciesAnnotationContent(String fieldName, String pathScope, String requestType) {
+        this(fieldName);
+        this.pathScope = pathScope;
+        this.requestType = requestType;
+    }
+
+    public String getPathScope() {
+        return pathScope;
+    }
+
+    public void setPathScope(String pathScope) {
+        this.pathScope = pathScope;
+    }
+
+    public String getRequestType() {
+        return requestType;
+    }
+
+    public void setRequestType(String requestType) {
+        this.requestType = requestType;
+    }
+
+    public Class<? extends Annotation> annotationType() {
+        return null;
+    }
+
+    @Override
+    public String toString() {
+        final StringBuilder sb = new StringBuilder();
+        sb.append(super.toString());
+        sb.append("DependenciesAnnotationContent");
+        sb.append("{pathScope='").append(pathScope).append('\'');
+        sb.append(", requestType='").append(requestType).append('\'');
+        sb.append('}');
+        return sb.toString();
+    }
+}

maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/DefaultMojoAnnotationsScanner.java

@@ -27,6 +27,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -43,6 +44,7 @@
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.tools.plugin.extractor.ExtractionException;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent;
+import org.apache.maven.tools.plugin.extractor.annotations.datamodel.DependenciesAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent;
@@ -71,6 +73,7 @@ public class DefaultMojoAnnotationsScanner extends AbstractLogEnabled implements
     public static final String MOJO_V4 = MVN4_API + "Mojo";
     public static final String EXECUTE_V4 = MVN4_API + "Execute";
     public static final String PARAMETER_V4 = MVN4_API + "Parameter";
+    public static final String DEPENDENCIES_V4 = MVN4_API + "Dependencies";
 
     public static final String MOJO_V3 = Mojo.class.getName();
     public static final String EXECUTE_V3 = Execute.class.getName();
@@ -339,13 +342,14 @@ protected void analyzeVisitors(MojoClassVisitor mojoClassVisitor) throws Extract
             }
 
             // @Component annotations
-            List<MojoFieldVisitor> mojoFieldVisitors =
+            List<MojoFieldVisitor> mojoComponentVisitors =
                     mojoClassVisitor.findFieldWithAnnotation(new HashSet<>(Arrays.asList(COMPONENT_V3)));
-            for (MojoFieldVisitor mojoFieldVisitor : mojoFieldVisitors) {
+            for (MojoFieldVisitor mojoComponentVisitor : mojoComponentVisitors) {
                 ComponentAnnotationContent componentAnnotationContent =
-                        new ComponentAnnotationContent(mojoFieldVisitor.getFieldName());
+                        new ComponentAnnotationContent(mojoComponentVisitor.getFieldName());
 
-                Map<String, MojoAnnotationVisitor> annotationVisitorMap = mojoFieldVisitor.getAnnotationVisitorMap();
+                Map<String, MojoAnnotationVisitor> annotationVisitorMap =
+                        mojoComponentVisitor.getAnnotationVisitorMap();
                 MojoAnnotationVisitor annotationVisitor = annotationVisitorMap.get(COMPONENT_V3);
 
                 if (annotationVisitor != null) {
@@ -362,13 +366,44 @@ protected void analyzeVisitors(MojoClassVisitor mojoClassVisitor) throws Extract
                     }
 
                     if (StringUtils.isEmpty(componentAnnotationContent.getRoleClassName())) {
-                        componentAnnotationContent.setRoleClassName(mojoFieldVisitor.getClassName());
+                        componentAnnotationContent.setRoleClassName(mojoComponentVisitor.getClassName());
                     }
                 }
                 mojoAnnotatedClass
                         .getComponents()
                         .put(componentAnnotationContent.getFieldName(), componentAnnotationContent);
             }
+
+            // @Dependencies annotations
+            List<MojoFieldVisitor> mojoDependenciesVisitors =
+                    mojoClassVisitor.findFieldWithAnnotation(Collections.singleton(DEPENDENCIES_V4));
+            for (MojoFieldVisitor mojoDependenciesVisitor : mojoDependenciesVisitors) {
+                DependenciesAnnotationContent dependenciesAnnotationContent =
+                        new DependenciesAnnotationContent(mojoDependenciesVisitor.getFieldName());
+
+                Map<String, MojoAnnotationVisitor> annotationVisitorMap =
+                        mojoDependenciesVisitor.getAnnotationVisitorMap();
+                MojoAnnotationVisitor annotationVisitor = annotationVisitorMap.get(DEPENDENCIES_V4);
+
+                if (annotationVisitor != null) {
+                    for (Map.Entry<String, Object> entry :
+                            annotationVisitor.getAnnotationValues().entrySet()) {
+                        String methodName = entry.getKey();
+                        if ("pathScope".equals(methodName)) {
+                            dependenciesAnnotationContent.setPathScope((String) entry.getValue());
+                        } else if ("requestType".equals(methodName)) {
+                            dependenciesAnnotationContent.setRequestType((String) entry.getValue());
+                        } else {
+                            throw new IllegalStateException("Unsupported method: " + methodName);
+                        }
+                    }
+                }
+
+                mojoAnnotatedClass
+                        .getDependencies()
+                        .put(dependenciesAnnotationContent.getFieldName(), dependenciesAnnotationContent);
+            }
+
         } catch (ReflectorException e) {
             throw new ExtractionException(e.getMessage(), e);
         }

maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotatedClass.java

@@ -23,6 +23,7 @@
 
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ComponentAnnotationContent;
+import org.apache.maven.tools.plugin.extractor.annotations.datamodel.DependenciesAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ExecuteAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.MojoAnnotationContent;
 import org.apache.maven.tools.plugin.extractor.annotations.datamodel.ParameterAnnotationContent;
@@ -52,6 +53,11 @@ public class MojoAnnotatedClass {
      */
     private Map<String, ComponentAnnotationContent> components;
 
+    /**
+     * key is field name
+     */
+    private Map<String, DependenciesAnnotationContent> dependencies;
+
     /**
      * artifact which contains this annotation
      */
@@ -123,6 +129,18 @@ public MojoAnnotatedClass setComponents(Map<String, ComponentAnnotationContent>
         return this;
     }
 
+    public Map<String, DependenciesAnnotationContent> getDependencies() {
+        if (this.dependencies == null) {
+            this.dependencies = new HashMap<>();
+        }
+        return dependencies;
+    }
+
+    public MojoAnnotatedClass setDependencies(Map<String, DependenciesAnnotationContent> dependencies) {
+        this.dependencies = dependencies;
+        return this;
+    }
+
     public String getParentClassName() {
         return parentClassName;
     }
@@ -163,6 +181,7 @@ public String toString() {
         sb.append(", execute=").append(execute);
         sb.append(", parameters=").append(parameters);
         sb.append(", components=").append(components);
+        sb.append(", dependencies=").append(dependencies);
         sb.append(", v4api=").append(v4Api);
         sb.append('}');
         return sb.toString();

maven-plugin-tools-annotations/src/main/java/org/apache/maven/tools/plugin/extractor/annotations/scanner/MojoAnnotationsScanner.java

@@ -51,7 +51,8 @@ public interface MojoAnnotationsScanner {
             Component.class.getName(),
             Deprecated.class.getName(),
             V4_API_ANNOTATIONS_PACKAGE + ".Parameter",
-            V4_API_ANNOTATIONS_PACKAGE + ".Component");
+            V4_API_ANNOTATIONS_PACKAGE + ".Component",
+            V4_API_ANNOTATIONS_PACKAGE + ".Dependencies");
 
     List<String> METHOD_LEVEL_ANNOTATIONS = Arrays.asList(
             Parameter.class.getName(), Deprecated.class.getName(), V4_API_ANNOTATIONS_PACKAGE + ".Parameter");