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;
20  
21  import javax.inject.Inject;
22  import javax.inject.Named;
23  import javax.inject.Singleton;
24  
25  import java.util.Arrays;
26  import java.util.List;
27  import java.util.Map;
28  import java.util.Set;
29  
30  import org.apache.maven.execution.MavenSession;
31  import org.apache.maven.lifecycle.internal.LifecycleExecutionPlanCalculator;
32  import org.apache.maven.lifecycle.internal.LifecycleStarter;
33  import org.apache.maven.lifecycle.internal.LifecycleTaskSegmentCalculator;
34  import org.apache.maven.lifecycle.internal.MojoExecutor;
35  import org.apache.maven.lifecycle.internal.ProjectIndex;
36  import org.apache.maven.lifecycle.internal.TaskSegment;
37  import org.apache.maven.model.Plugin;
38  import org.apache.maven.plugin.InvalidPluginDescriptorException;
39  import org.apache.maven.plugin.MojoExecution;
40  import org.apache.maven.plugin.MojoNotFoundException;
41  import org.apache.maven.plugin.PluginDescriptorParsingException;
42  import org.apache.maven.plugin.PluginManagerException;
43  import org.apache.maven.plugin.PluginNotFoundException;
44  import org.apache.maven.plugin.PluginResolutionException;
45  import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
46  import org.apache.maven.plugin.version.PluginVersionResolutionException;
47  import org.apache.maven.project.MavenProject;
48  
49  /**
50   * A facade that provides lifecycle services to components outside maven core.
51   * <p>
52   * Note that this component is not normally used from within core itself.
53   *
54   */
55  @Named
56  @Singleton
57  public class DefaultLifecycleExecutor implements LifecycleExecutor {
58  
59      private final LifeCyclePluginAnalyzer lifeCyclePluginAnalyzer;
60      private final DefaultLifecycles defaultLifeCycles;
61      private final LifecycleTaskSegmentCalculator lifecycleTaskSegmentCalculator;
62      private final LifecycleExecutionPlanCalculator lifecycleExecutionPlanCalculator;
63      private final MojoExecutor mojoExecutor;
64      private final LifecycleStarter lifecycleStarter;
65  
66      @Inject
67      public DefaultLifecycleExecutor(
68              LifeCyclePluginAnalyzer lifeCyclePluginAnalyzer,
69              DefaultLifecycles defaultLifeCycles,
70              LifecycleTaskSegmentCalculator lifecycleTaskSegmentCalculator,
71              LifecycleExecutionPlanCalculator lifecycleExecutionPlanCalculator,
72              MojoExecutor mojoExecutor,
73              LifecycleStarter lifecycleStarter) {
74          this.lifeCyclePluginAnalyzer = lifeCyclePluginAnalyzer;
75          this.defaultLifeCycles = defaultLifeCycles;
76          this.lifecycleTaskSegmentCalculator = lifecycleTaskSegmentCalculator;
77          this.lifecycleExecutionPlanCalculator = lifecycleExecutionPlanCalculator;
78          this.mojoExecutor = mojoExecutor;
79          this.lifecycleStarter = lifecycleStarter;
80      }
81  
82      public void execute(MavenSession session) {
83          lifecycleStarter.execute(session);
84      }
85  
86      // These methods deal with construction intact Plugin object that look like they come from a standard
87      // <plugin/> block in a Maven POM. We have to do some wiggling to pull the sources of information
88      // together and this really shows the problem of constructing a sensible default configuration but
89      // it's all encapsulated here so it appears normalized to the POM builder.
90  
91      // We are going to take the project packaging and find all plugin in the default lifecycle and create
92      // fully populated Plugin objects, including executions with goals and default configuration taken
93      // from the plugin.xml inside a plugin.
94      //
95      // TODO This whole method could probably removed by injecting lifeCyclePluginAnalyzer straight into client site.
96      // TODO But for some reason the whole plexus appcontext refuses to start when I try this.
97  
98      public Set<Plugin> getPluginsBoundByDefaultToAllLifecycles(String packaging) {
99          return lifeCyclePluginAnalyzer.getPluginsBoundByDefaultToAllLifecycles(packaging);
100     }
101 
102     // USED BY MAVEN HELP PLUGIN
103 
104     @Deprecated
105     public Map<String, Lifecycle> getPhaseToLifecycleMap() {
106         return defaultLifeCycles.getPhaseToLifecycleMap();
107     }
108 
109     // Used by m2eclipse
110 
111     @SuppressWarnings({"UnusedDeclaration"})
112     public MavenExecutionPlan calculateExecutionPlan(MavenSession session, boolean setup, String... tasks)
113             throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
114                     MojoNotFoundException, NoPluginFoundForPrefixException, InvalidPluginDescriptorException,
115                     PluginManagerException, LifecyclePhaseNotFoundException, LifecycleNotFoundException,
116                     PluginVersionResolutionException {
117         List<TaskSegment> taskSegments =
118                 lifecycleTaskSegmentCalculator.calculateTaskSegments(session, Arrays.asList(tasks));
119 
120         TaskSegment mergedSegment = new TaskSegment(false);
121 
122         for (TaskSegment taskSegment : taskSegments) {
123             mergedSegment.getTasks().addAll(taskSegment.getTasks());
124         }
125 
126         return lifecycleExecutionPlanCalculator.calculateExecutionPlan(
127                 session, session.getCurrentProject(), mergedSegment.getTasks(), setup);
128     }
129 
130     public MavenExecutionPlan calculateExecutionPlan(MavenSession session, String... tasks)
131             throws PluginNotFoundException, PluginResolutionException, PluginDescriptorParsingException,
132                     MojoNotFoundException, NoPluginFoundForPrefixException, InvalidPluginDescriptorException,
133                     PluginManagerException, LifecyclePhaseNotFoundException, LifecycleNotFoundException,
134                     PluginVersionResolutionException {
135         return calculateExecutionPlan(session, true, tasks);
136     }
137 
138     // Site 3.x
139     public void calculateForkedExecutions(MojoExecution mojoExecution, MavenSession session)
140             throws MojoNotFoundException, PluginNotFoundException, PluginResolutionException,
141                     PluginDescriptorParsingException, NoPluginFoundForPrefixException, InvalidPluginDescriptorException,
142                     LifecyclePhaseNotFoundException, LifecycleNotFoundException, PluginVersionResolutionException {
143         lifecycleExecutionPlanCalculator.calculateForkedExecutions(mojoExecution, session);
144     }
145 
146     // Site 3.x
147     public List<MavenProject> executeForkedExecutions(MojoExecution mojoExecution, MavenSession session)
148             throws LifecycleExecutionException {
149         return mojoExecutor.executeForkedExecutions(mojoExecution, session, new ProjectIndex(session.getProjects()));
150     }
151 }