Author: ifedorenko
Date: Wed Apr 14 03:09:21 2010
New Revision: 933848
URL: http://svn.apache.org/viewvc?rev=933848&view=rev
Log:
MNG-4634 Allow custom lifecycles
Build extensions plugins can now define new lifecycles. Implementation
guarantees
that standard lifecycles, i.e. default, clean and site, are considered before
custom
lifecycles. It assumes that phase names are globally unique and ignores any
duplicate phase names (with a warning).
Modified:
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java
maven/maven-3/trunk/maven-core/src/main/resources/META-INF/plexus/components.xml
maven/maven-3/trunk/maven-core/src/test/java/org/apache/maven/lifecycle/internal/stub/DefaultLifecyclesStub.java
Modified:
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java
URL:
http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java?rev=933848&r1=933847&r2=933848&view=diff
==============================================================================
---
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java
(original)
+++
maven/maven-3/trunk/maven-core/src/main/java/org/apache/maven/lifecycle/DefaultLifecycles.java
Wed Apr 14 03:09:21 2010
@@ -14,82 +14,65 @@
*/
package org.apache.maven.lifecycle;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
import org.apache.maven.lifecycle.internal.BuilderCommon;
import org.apache.maven.lifecycle.internal.ExecutionPlanItem;
-import org.apache.maven.plugin.*;
+import org.apache.maven.plugin.InvalidPluginDescriptorException;
+import org.apache.maven.plugin.MojoExecution;
+import org.apache.maven.plugin.MojoNotFoundException;
+import org.apache.maven.plugin.PluginDescriptorParsingException;
+import org.apache.maven.plugin.PluginNotFoundException;
+import org.apache.maven.plugin.PluginResolutionException;
import org.apache.maven.plugin.prefix.NoPluginFoundForPrefixException;
import org.apache.maven.plugin.version.PluginVersionResolutionException;
import org.apache.maven.project.MavenProject;
-import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
-import
org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
+import org.codehaus.plexus.logging.Logger;
import org.codehaus.plexus.util.StringUtils;
-import java.util.*;
-
/**
* @author Jason van Zyl
* @author Kristian Rosenvold
*/
-//TODO: The configuration for the lifecycle needs to be externalized so that I
can use the annotations properly for the wiring and reference and external
source for the lifecycle configuration.
+// TODO: The configuration for the lifecycle needs to be externalized so that
I can use the annotations properly for the
+// wiring and reference and external source for the lifecycle configuration.
public class DefaultLifecycles
- implements Initializable
{
- // @Configuration(source="org/apache/maven/lifecycle/lifecycles.xml")
+ public static final String[] STANDARD_LIFECYCLES = { "default", "clean",
"site" };
- private List<Lifecycle> lifecycles;
+ // @Configuration(source="org/apache/maven/lifecycle/lifecycles.xml")
- private List<Scheduling> schedules;
+ // @Requirement(role=Lifecycle.class)
+ private Map<String, Lifecycle> lifecycles;
- /**
- * We use this to display all the lifecycles available and their phases to
users. Currently this is primarily
- * used in the IDE integrations where a UI is presented to the user and
they can select the lifecycle phase
- * they would like to execute.
- */
- private Map<String, Lifecycle> lifecycleMap;
+ // @Requirement
+ private Logger logger;
- /**
- * We use this to map all phases to the lifecycle that contains it. This
is used so that a user can specify the
- * phase they want to execute and we can easily determine what lifecycle
we need to run.
- */
- private Map<String, Lifecycle> phaseToLifecycleMap;
+ private List<Scheduling> schedules;
- @SuppressWarnings({"UnusedDeclaration"})
+ @SuppressWarnings( { "UnusedDeclaration" } )
public DefaultLifecycles()
{
}
public DefaultLifecycles( List<Lifecycle> lifecycles, List<Scheduling>
schedules )
{
- this.lifecycles = lifecycles;
+ this.lifecycles = new LinkedHashMap<String, Lifecycle>();
this.schedules = schedules;
- }
-
- public void initialize()
- throws InitializationException
- {
- lifecycleMap = new HashMap<String, Lifecycle>();
-
- // If people are going to make their own lifecycles then we need to
tell people how to namespace them correctly so
- // that they don't interfere with internally defined lifecycles.
-
- phaseToLifecycleMap = new HashMap<String, Lifecycle>();
for ( Lifecycle lifecycle : lifecycles )
{
- for ( String phase : lifecycle.getPhases() )
- {
- // The first definition wins.
- if ( !phaseToLifecycleMap.containsKey( phase ) )
- {
- phaseToLifecycleMap.put( phase, lifecycle );
- }
- }
-
- lifecycleMap.put( lifecycle.getId(), lifecycle );
+ this.lifecycles.put( lifecycle.getId(), lifecycle );
}
}
-
public List<ExecutionPlanItem> createExecutionPlanItem( MavenProject
mavenProject, List<MojoExecution> executions )
throws PluginNotFoundException, PluginResolutionException,
LifecyclePhaseNotFoundException,
PluginDescriptorParsingException, MojoNotFoundException,
InvalidPluginDescriptorException,
@@ -121,7 +104,7 @@ public class DefaultLifecycles
* Gets scheduling associated with a given phase.
* <p/>
* This is part of the experimental weave mode and therefore not part of
the public api.
- *
+ *
* @param lifecyclePhaseName
* @return
*/
@@ -140,17 +123,62 @@ public class DefaultLifecycles
public Lifecycle get( String key )
{
- return phaseToLifecycleMap.get( key );
+ return getPhaseToLifecycleMap().get( key );
}
+ /**
+ * We use this to map all phases to the lifecycle that contains it. This
is used so that a user can specify the
+ * phase they want to execute and we can easily determine what lifecycle
we need to run.
+ */
public Map<String, Lifecycle> getPhaseToLifecycleMap()
{
+ // If people are going to make their own lifecycles then we need to
tell people how to namespace them correctly
+ // so
+ // that they don't interfere with internally defined lifecycles.
+
+ HashMap<String, Lifecycle> phaseToLifecycleMap = new HashMap<String,
Lifecycle>();
+
+ for ( Lifecycle lifecycle : getLifeCycles() )
+ {
+ if ( logger.isDebugEnabled() )
+ {
+ logger.debug( "Custom lifecycle " + lifecycle.toString() );
+ }
+
+ for ( String phase : lifecycle.getPhases() )
+ {
+ // The first definition wins.
+ if ( !phaseToLifecycleMap.containsKey( phase ) )
+ {
+ phaseToLifecycleMap.put( phase, lifecycle );
+ }
+ else
+ {
+ Lifecycle original = phaseToLifecycleMap.get( phase );
+ logger.warn( "Duplicated lifecycle phase " + phase + ".
Defined in " + original.getId()
+ + " but also in " + lifecycle.getId() );
+ }
+ }
+ }
+
return phaseToLifecycleMap;
}
public List<Lifecycle> getLifeCycles()
{
- return lifecycles;
+ // ensure canonical order of standard lifecycles
+
+ Map<String, Lifecycle> lifecycles = new LinkedHashMap<String,
Lifecycle>( this.lifecycles );
+
+ LinkedHashSet<String> lifecycleNames = new LinkedHashSet<String>(
Arrays.asList( STANDARD_LIFECYCLES ) );
+ lifecycleNames.addAll( lifecycles.keySet() );
+ ArrayList<Lifecycle> result = new ArrayList<Lifecycle>();
+ for ( String name : lifecycleNames )
+ {
+ result.add( lifecycles.get( name ) );
+ }
+
+ return result;
}
public List<Scheduling> getSchedules()
@@ -162,7 +190,7 @@ public class DefaultLifecycles
{
Set<String> phases = new LinkedHashSet<String>();
- for ( Lifecycle lifecycle : lifecycles )
+ for ( Lifecycle lifecycle : lifecycles.values() )
{
phases.addAll( lifecycle.getPhases() );
}
Modified:
maven/maven-3/trunk/maven-core/src/main/resources/META-INF/plexus/components.xml
URL:
http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/main/resources/META-INF/plexus/components.xml?rev=933848&r1=933847&r2=933848&view=diff
==============================================================================
---
maven/maven-3/trunk/maven-core/src/main/resources/META-INF/plexus/components.xml
(original)
+++
maven/maven-3/trunk/maven-core/src/main/resources/META-INF/plexus/components.xml
Wed Apr 14 03:09:21 2010
@@ -57,69 +57,18 @@
<role>org.apache.maven.lifecycle.DefaultLifecycles</role>
<implementation>org.apache.maven.lifecycle.DefaultLifecycles</implementation>
+ <requirements>
+ <requirement>
+ <role>org.codehaus.plexus.logging.Logger</role>
+ <field-name>logger</field-name>
+ </requirement>
+ <requirement>
+ <role>org.apache.maven.lifecycle.Lifecycle</role>
+ <field-name>lifecycles</field-name>
+ </requirement>
+ </requirements>
+
<configuration>
- <lifecycles>
- <lifecycle>
- <id>default</id>
- <!-- START SNIPPET: lifecycle -->
- <phases>
- <phase>validate</phase>
- <phase>initialize</phase>
- <phase>generate-sources</phase>
- <phase>process-sources</phase>
- <phase>generate-resources</phase>
- <phase>process-resources</phase>
- <phase>compile</phase>
- <phase>process-classes</phase>
- <phase>generate-test-sources</phase>
- <phase>process-test-sources</phase>
- <phase>generate-test-resources</phase>
- <phase>process-test-resources</phase>
- <phase>test-compile</phase>
- <phase>process-test-classes</phase>
- <phase>test</phase>
- <phase>prepare-package</phase>
- <phase>package</phase>
- <phase>pre-integration-test</phase>
- <phase>integration-test</phase>
- <phase>post-integration-test</phase>
- <phase>verify</phase>
- <phase>install</phase>
- <phase>deploy</phase>
- </phases>
- <!-- END SNIPPET: lifecycle -->
- </lifecycle>
- <lifecycle>
- <id>clean</id>
- <phases>
- <phase>pre-clean</phase>
- <phase>clean</phase>
- <phase>post-clean</phase>
- </phases>
- <default-phases>
- <clean>
- org.apache.maven.plugins:maven-clean-plugin:2.4:clean
- </clean>
- </default-phases>
- </lifecycle>
- <lifecycle>
- <id>site</id>
- <phases>
- <phase>pre-site</phase>
- <phase>site</phase>
- <phase>post-site</phase>
- <phase>site-deploy</phase>
- </phases>
- <default-phases>
- <site>
- org.apache.maven.plugins:maven-site-plugin:2.0.1:site
- </site>
- <site-deploy>
- org.apache.maven.plugins:maven-site-plugin:2.0.1:deploy
- </site-deploy>
- </default-phases>
- </lifecycle>
- </lifecycles>
<schedules>
<scheduling>
<lifecycle>default</lifecycle>
@@ -142,6 +91,82 @@
</schedules>
</configuration>
</component>
+
+ <component>
+ <role>org.apache.maven.lifecycle.Lifecycle</role>
+ <implementation>org.apache.maven.lifecycle.Lifecycle</implementation>
+ <role-hint>default</role-hint>
+ <configuration>
+ <id>default</id>
+ <!-- START SNIPPET: lifecycle -->
+ <phases>
+ <phase>validate</phase>
+ <phase>initialize</phase>
+ <phase>generate-sources</phase>
+ <phase>process-sources</phase>
+ <phase>generate-resources</phase>
+ <phase>process-resources</phase>
+ <phase>compile</phase>
+ <phase>process-classes</phase>
+ <phase>generate-test-sources</phase>
+ <phase>process-test-sources</phase>
+ <phase>generate-test-resources</phase>
+ <phase>process-test-resources</phase>
+ <phase>test-compile</phase>
+ <phase>process-test-classes</phase>
+ <phase>test</phase>
+ <phase>prepare-package</phase>
+ <phase>package</phase>
+ <phase>pre-integration-test</phase>
+ <phase>integration-test</phase>
+ <phase>post-integration-test</phase>
+ <phase>verify</phase>
+ <phase>install</phase>
+ <phase>deploy</phase>
+ </phases>
+ <!-- END SNIPPET: lifecycle -->
+ </configuration>
+ </component>
+ <component>
+ <role>org.apache.maven.lifecycle.Lifecycle</role>
+ <implementation>org.apache.maven.lifecycle.Lifecycle</implementation>
+ <role-hint>clean</role-hint>
+ <configuration>
+ <id>clean</id>
+ <phases>
+ <phase>pre-clean</phase>
+ <phase>clean</phase>
+ <phase>post-clean</phase>
+ </phases>
+ <default-phases>
+ <clean>
+ org.apache.maven.plugins:maven-clean-plugin:2.4:clean
+ </clean>
+ </default-phases>
+ </configuration>
+ </component>
+ <component>
+ <role>org.apache.maven.lifecycle.Lifecycle</role>
+ <implementation>org.apache.maven.lifecycle.Lifecycle</implementation>
+ <role-hint>site</role-hint>
+ <configuration>
+ <id>site</id>
+ <phases>
+ <phase>pre-site</phase>
+ <phase>site</phase>
+ <phase>post-site</phase>
+ <phase>site-deploy</phase>
+ </phases>
+ <default-phases>
+ <site>
+ org.apache.maven.plugins:maven-site-plugin:2.0.1:site
+ </site>
+ <site-deploy>
+ org.apache.maven.plugins:maven-site-plugin:2.0.1:deploy
+ </site-deploy>
+ </default-phases>
+ </configuration>
+ </component>
<component>
<role>org.apache.maven.lifecycle.LifeCyclePluginAnalyzer</role>
<implementation>org.apache.maven.lifecycle.internal.LifecyclePluginAnalyzerImpl</implementation>
Modified:
maven/maven-3/trunk/maven-core/src/test/java/org/apache/maven/lifecycle/internal/stub/DefaultLifecyclesStub.java
URL:
http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-core/src/test/java/org/apache/maven/lifecycle/internal/stub/DefaultLifecyclesStub.java?rev=933848&r1=933847&r2=933848&view=diff
==============================================================================
---
maven/maven-3/trunk/maven-core/src/test/java/org/apache/maven/lifecycle/internal/stub/DefaultLifecyclesStub.java
(original)
+++
maven/maven-3/trunk/maven-core/src/test/java/org/apache/maven/lifecycle/internal/stub/DefaultLifecyclesStub.java
Wed Apr 14 03:09:21 2010
@@ -15,14 +15,13 @@
package org.apache.maven.lifecycle.internal.stub;
+import java.util.Arrays;
+import java.util.List;
+
import org.apache.maven.lifecycle.DefaultLifecycles;
import org.apache.maven.lifecycle.Lifecycle;
import org.apache.maven.lifecycle.Schedule;
import org.apache.maven.lifecycle.Scheduling;
-import
org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
-
-import java.util.Arrays;
-import java.util.List;
/**
* @author Kristian Rosenvold
@@ -37,14 +36,6 @@ public class DefaultLifecyclesStub
final List<Lifecycle> lifeCycles = Arrays.asList( lifecycle1,
lifecycle2 );
final List<Scheduling> schedulingList = getSchedulingList();
final DefaultLifecycles defaultLifecycles = new DefaultLifecycles(
lifeCycles, schedulingList );
- try
- {
- defaultLifecycles.initialize();
- }
- catch ( InitializationException e )
- {
- throw new RuntimeException( e );
- }
return defaultLifecycles;
}
