View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.lifecycle.internal;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.ArrayList;
26  import java.util.LinkedHashMap;
27  import java.util.List;
28  import java.util.Map;
29  import java.util.TreeMap;
30  
31  import org.apache.maven.execution.MavenSession;
32  import org.apache.maven.lifecycle.Lifecycle;
33  import org.apache.maven.lifecycle.LifecycleMappingDelegate;
34  import org.apache.maven.model.Plugin;
35  import org.apache.maven.model.PluginExecution;
36  import org.apache.maven.plugin.BuildPluginManager;
37  import org.apache.maven.plugin.InvalidPluginDescriptorException;
38  import org.apache.maven.plugin.MojoExecution;
39  import org.apache.maven.plugin.MojoNotFoundException;
40  import org.apache.maven.plugin.PluginDescriptorParsingException;
41  import org.apache.maven.plugin.PluginNotFoundException;
42  import org.apache.maven.plugin.PluginResolutionException;
43  import org.apache.maven.plugin.descriptor.MojoDescriptor;
44  import org.apache.maven.project.MavenProject;
45  
46  /**
47   * Lifecycle mapping delegate component interface. Calculates project build execution plan given {@link Lifecycle} and
48   * lifecycle phase. Standard lifecycles use plugin execution {@code <phase>} or mojo default lifecycle phase to
49   * calculate the execution plan, but custom lifecycles can use alternative mapping strategies.
50   */
51  @Named(DefaultLifecycleMappingDelegate.HINT)
52  @Singleton
53  public class DefaultLifecycleMappingDelegate implements LifecycleMappingDelegate {
54      public static final String HINT = "default";
55  
56      private final BuildPluginManager pluginManager;
57  
58      @Inject
59      public DefaultLifecycleMappingDelegate(BuildPluginManager pluginManager) {
60          this.pluginManager = pluginManager;
61      }
62  
63      public Map<String, List<MojoExecution>> calculateLifecycleMappings(
64              MavenSession session, MavenProject project, Lifecycle lifecycle, String lifecyclePhase)
65              throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
66                      MojoNotFoundException, InvalidPluginDescriptorException {
67          /*
68           * Initialize mapping from lifecycle phase to bound mojos. The key set of this map denotes the phases the caller
69           * is interested in, i.e. all phases up to and including the specified phase.
70           */
71  
72          Map<String, Map<Integer, List<MojoExecution>>> mappings = new LinkedHashMap<>();
73  
74          for (String phase : lifecycle.getPhases()) {
75              Map<Integer, List<MojoExecution>> phaseBindings = new TreeMap<>();
76  
77              mappings.put(phase, phaseBindings);
78  
79              if (phase.equals(lifecyclePhase)) {
80                  break;
81              }
82          }
83  
84          /*
85           * Grab plugin executions that are bound to the selected lifecycle phases from project. The effective model of
86           * the project already contains the plugin executions induced by the project's packaging type. Remember, all
87           * phases of interest and only those are in the lifecycle mapping, if a phase has no value in the map, we are
88           * not interested in any of the executions bound to it.
89           */
90  
91          for (Plugin plugin : project.getBuild().getPlugins()) {
92              for (PluginExecution execution : plugin.getExecutions()) {
93                  // if the phase is specified then I don't have to go fetch the plugin yet and pull it down
94                  // to examine the phase it is associated to.
95                  if (execution.getPhase() != null) {
96                      Map<Integer, List<MojoExecution>> phaseBindings = mappings.get(execution.getPhase());
97                      if (phaseBindings != null) {
98                          for (String goal : execution.getGoals()) {
99                              MojoExecution mojoExecution = new MojoExecution(plugin, goal, execution.getId());
100                             mojoExecution.setLifecyclePhase(execution.getPhase());
101                             addMojoExecution(phaseBindings, mojoExecution, execution.getPriority());
102                         }
103                     }
104                 }
105                 // if not then I need to grab the mojo descriptor and look at the phase that is specified
106                 else {
107                     for (String goal : execution.getGoals()) {
108                         MojoDescriptor mojoDescriptor = pluginManager.getMojoDescriptor(
109                                 plugin, goal, project.getRemotePluginRepositories(), session.getRepositorySession());
110 
111                         Map<Integer, List<MojoExecution>> phaseBindings = mappings.get(mojoDescriptor.getPhase());
112                         if (phaseBindings != null) {
113                             MojoExecution mojoExecution = new MojoExecution(mojoDescriptor, execution.getId());
114                             mojoExecution.setLifecyclePhase(mojoDescriptor.getPhase());
115                             addMojoExecution(phaseBindings, mojoExecution, execution.getPriority());
116                         }
117                     }
118                 }
119             }
120         }
121 
122         Map<String, List<MojoExecution>> lifecycleMappings = new LinkedHashMap<>();
123 
124         for (Map.Entry<String, Map<Integer, List<MojoExecution>>> entry : mappings.entrySet()) {
125             List<MojoExecution> mojoExecutions = new ArrayList<>();
126 
127             for (List<MojoExecution> executions : entry.getValue().values()) {
128                 mojoExecutions.addAll(executions);
129             }
130 
131             lifecycleMappings.put(entry.getKey(), mojoExecutions);
132         }
133 
134         return lifecycleMappings;
135     }
136 
137     private void addMojoExecution(
138             Map<Integer, List<MojoExecution>> phaseBindings, MojoExecution mojoExecution, int priority) {
139         List<MojoExecution> mojoExecutions = phaseBindings.computeIfAbsent(priority, k -> new ArrayList<>());
140 
141         mojoExecutions.add(mojoExecution);
142     }
143 }