You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Hervé BOUTEMY <he...@free.fr> on 2013/11/23 16:57:31 UTC

Re: git commit: MNG-5530 Introduced mojo execution guice component scope

nice new feature

a few remarks:

- IMHO, such a feature deserve a 3.2 Maven version instead of 3.1.2

- explanations in the commit comment are a good start for a documentation page 
in the component, no?

- for the TODOs in MojoExecutionListener interface, I think both methods 
should be added, beforeExecution just because it is more expressive than a 
constructor, and afterExecutionFailure because it adds an argument to other 
after* methods

- after that, I don't really understand the implementation, the "seed" meaning 
(probably need some javadoc)

but it's good to see a new idea like that

tell me if I can help more than with this feedback

Regards,

Hervé

Le jeudi 31 octobre 2013 11:51:11 ifedorenko@apache.org a écrit :
> Updated Branches:
>   refs/heads/master 70218af1c -> 8700b0585
> 
> 
> MNG-5530 Introduced mojo execution guice component scope
> 
> Mojo execution scoped components are annotated with @MojoExecutionScoped
> They are created just before configured mojo instance is created
> and disposed immediately after mojo execution finishes.
> 
> Execution scoped components can request @Inject MavenSession,
> MavenProject and MojoExecution instances in addition to any
> standard Maven core components and components defined in
> maven plugin contributing execution scoped components.
> 
> Execution scoped components can be injected into Mojos using
> standard /* @component */ javadoc (and likely new mojo
> annotations).
> 
> If execution scoped component implements MojoExecutionListener
> callback interface, its #afterMojoExecutionSuccess method will be
> invoked after successful mojo execution and #afterMojoExecutionAlways
> method will be executed after both successful and failed mojo
> executions.
> 
> Signed-off-by: Igor Fedorenko <ig...@ifedorenko.com>
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/maven/repo
> Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/8700b058
> Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/8700b058
> Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/8700b058
> 
> Branch: refs/heads/master
> Commit: 8700b058574ea79544603ee4eacd6171ef03aa46
> Parents: 70218af
> Author: Igor Fedorenko <ig...@ifedorenko.com>
> Authored: Sun Nov 25 01:34:53 2012 -0500
> Committer: Igor Fedorenko <ig...@ifedorenko.com>
> Committed: Thu Oct 31 07:49:54 2013 -0400
> 
> ----------------------------------------------------------------------
>  maven-core/pom.xml                              |  13 ++
>  .../classrealm/DefaultClassRealmManager.java    |   1 +
>  .../execution/scope/MojoExecutionListener.java  |  48 +++++
>  .../execution/scope/MojoExecutionScoped.java    |  42 ++++
>  .../scope/internal/MojoExecutionModule.java     |  45 +++++
>  .../scope/internal/MojoExecutionScope.java      | 200 +++++++++++++++++++
>  .../maven/plugin/DefaultBuildPluginManager.java |  17 +-
>  .../internal/DefaultMavenPluginManager.java     |   7 +-
>  .../project/DefaultProjectBuildingHelper.java   |   5 +-
>  .../AbstractCoreMavenComponentTestCase.java     |   3 +-
>  .../scope/internal/MojoExecutionScopeTest.java  |  53 +++++
>  11 files changed, 429 insertions(+), 5 deletions(-)
> ----------------------------------------------------------------------
> 
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/pom.xm
> l ----------------------------------------------------------------------
> diff --git a/maven-core/pom.xml b/maven-core/pom.xml
> index ce86e3b..66e39ba 100644
> --- a/maven-core/pom.xml
> +++ b/maven-core/pom.xml
> @@ -162,6 +162,19 @@
>          <artifactId>plexus-component-metadata</artifactId>
>        </plugin>
>        <plugin>
> +        <groupId>org.sonatype.plugins</groupId>
> +        <artifactId>sisu-maven-plugin</artifactId>
> +        <version>1.1</version>
> +        <executions>
> +          <execution>
> +            <goals>
> +              <goal>main-index</goal>
> +              <goal>test-index</goal>
> +            </goals>
> +          </execution>
> +        </executions>
> +      </plugin>
> +      <plugin>
>          <groupId>org.codehaus.modello</groupId>
>          <artifactId>modello-maven-plugin</artifactId>
>          <configuration>
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/classrealm/DefaultClassRealmManager.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
> ager.java
> b/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
> ager.java index 41c7dc2..a30a47e 100644
> ---
> a/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
> ager.java +++
> b/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
> ager.java @@ -139,6 +139,7 @@ public class DefaultClassRealmManager
>          imports.put( "org.apache.maven.configuration", coreRealm );
>          imports.put( "org.apache.maven.exception", coreRealm );
>          imports.put( "org.apache.maven.execution", coreRealm );
> +        imports.put( "org.apache.maven.execution.scope", coreRealm );
>          imports.put( "org.apache.maven.lifecycle", coreRealm );
>          imports.put( "org.apache.maven.model", coreRealm );
>          imports.put( "org.apache.maven.monitor", coreRealm );
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/execution/scope/MojoExecutionListener.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
> stener.java
> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
> stener.java new file mode 100644
> index 0000000..7a9c84b
> --- /dev/null
> +++
> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
> stener.java @@ -0,0 +1,48 @@
> +package org.apache.maven.execution.scope;
> +
> +/*
> + * 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.
> + */
> +
> +import org.apache.maven.plugin.MojoExecutionException;
> +
> +/**
> + * Helper interface that allows mojo execution scoped components to be
> notified before execution start and after + * execution completion. The
> main purpose of this interface is to allow mojo execution scoped components
> perform setup + * before and cleanup after mojo execution.
> + * <p>
> + * TODO decide if Mojo should be passed as parameter of callback methods
> + *
> + * @author igor
> + * @since 3.1.2
> + * @provisional This interface is part of work in progress and can be
> changed or removed without notice. + */
> +public interface MojoExecutionListener
> +{
> +    // TODO decide if this is needed
> +    // public void beforeExecution() throws MojoExecutionException;
> +
> +    public void afterMojoExecutionSuccess()
> +        throws MojoExecutionException;
> +
> +    // TODO decide if this is needed.
> +    // public void afterExecutionFailure(Throwable t) throws
> MojoExecutionException; +
> +    public void afterMojoExecutionAlways()
> +        throws MojoExecutionException;
> +}
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/execution/scope/MojoExecutionScoped.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
> oped.java
> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
> oped.java new file mode 100644
> index 0000000..c53297c
> --- /dev/null
> +++
> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
> oped.java @@ -0,0 +1,42 @@
> +package org.apache.maven.execution.scope;
> +
> +/*
> + * 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.
> + */
> +
> +import static java.lang.annotation.ElementType.TYPE;
> +import static java.lang.annotation.RetentionPolicy.RUNTIME;
> +
> +import java.lang.annotation.Retention;
> +import java.lang.annotation.Target;
> +
> +import com.google.inject.ScopeAnnotation;
> +
> +/**
> + * Indicates that annotated component should be instantiated before mojo
> execution starts and discarded after mojo + * execution completes.
> + *
> + * @author igor
> + * @since 3.1.2
> + */
> +@Target( { TYPE } )
> +@Retention( RUNTIME )
> +@ScopeAnnotation
> +public @interface MojoExecutionScoped
> +{
> +}
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/execution/scope/internal/MojoExecutionModule.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionModule.java
> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionModule.java new file mode 100644
> index 0000000..65ba181
> --- /dev/null
> +++
> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionModule.java @@ -0,0 +1,45 @@
> +package org.apache.maven.execution.scope.internal;
> +
> +/*
> + * 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.
> + */
> +
> +import javax.inject.Named;
> +
> +import org.apache.maven.execution.scope.MojoExecutionScoped;
> +
> +import com.google.inject.Binder;
> +import com.google.inject.Module;
> +import com.google.inject.name.Names;
> +
> +@Named
> +public class MojoExecutionModule
> +    implements Module
> +{
> +
> +    public void configure( Binder binder )
> +    {
> +        final MojoExecutionScope executionScope = new MojoExecutionScope();
> +
> +        // tell Guice about the scope
> +        binder.bindScope( MojoExecutionScoped.class, executionScope );
> +
> +        // make our scope instance injectable
> +        binder.bind( MojoExecutionScope.class ).annotatedWith( Names.named(
> MojoExecutionScope.SCOPE_NAME ) ).toInstance( executionScope ); +    }
> +}
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/execution/scope/internal/MojoExecutionScope.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScope.java
> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScope.java new file mode 100644
> index 0000000..3d021fd
> --- /dev/null
> +++
> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScope.java @@ -0,0 +1,200 @@
> +package org.apache.maven.execution.scope.internal;
> +
> +/*
> + * 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.
> + */
> +
> +import java.util.LinkedList;
> +import java.util.Map;
> +
> +import org.apache.maven.execution.MavenSession;
> +import org.apache.maven.execution.scope.MojoExecutionListener;
> +import org.apache.maven.execution.scope.MojoExecutionScoped;
> +import org.apache.maven.plugin.MojoExecution;
> +import org.apache.maven.plugin.MojoExecutionException;
> +import org.apache.maven.project.MavenProject;
> +import org.codehaus.plexus.PlexusContainer;
> +import
> org.codehaus.plexus.component.repository.exception.ComponentLookupException
> ; +
> +import com.google.common.collect.Maps;
> +import com.google.inject.AbstractModule;
> +import com.google.inject.Key;
> +import com.google.inject.Module;
> +import com.google.inject.OutOfScopeException;
> +import com.google.inject.Provider;
> +import com.google.inject.Scope;
> +import com.google.inject.util.Providers;
> +
> +public class MojoExecutionScope
> +    implements Scope
> +{
> +    public static final String SCOPE_NAME = "mojoExecution";
> +
> +    private static final Provider<Object> SEEDED_KEY_PROVIDER = new
> Provider<Object>() +    {
> +        public Object get()
> +        {
> +            throw new IllegalStateException();
> +        }
> +    };
> +
> +    private static final class ScopeState
> +    {
> +        public final Map<Key<?>, Provider<?>> seeded = Maps.newHashMap();
> +
> +        public final Map<Key<?>, Object> provided = Maps.newHashMap();
> +    }
> +
> +    private final ThreadLocal<LinkedList<ScopeState>> values = new
> ThreadLocal<LinkedList<ScopeState>>(); +
> +    public MojoExecutionScope()
> +    {
> +    }
> +
> +    public void enter()
> +    {
> +        LinkedList<ScopeState> stack = values.get();
> +        if ( stack == null )
> +        {
> +            stack = new LinkedList<ScopeState>();
> +            values.set( stack );
> +        }
> +        stack.addFirst( new ScopeState() );
> +    }
> +
> +    private ScopeState getScopeState()
> +    {
> +        LinkedList<ScopeState> stack = values.get();
> +        if ( stack == null || stack.isEmpty() )
> +        {
> +            throw new IllegalStateException();
> +        }
> +        return stack.getFirst();
> +    }
> +
> +    public void exit()
> +        throws MojoExecutionException
> +    {
> +        final LinkedList<ScopeState> stack = values.get();
> +        if ( stack == null || stack.isEmpty() )
> +        {
> +            throw new IllegalStateException();
> +        }
> +        stack.removeFirst();
> +        if ( stack.isEmpty() )
> +        {
> +            values.remove();
> +        }
> +    }
> +
> +    public <T> void seed( Class<T> clazz, Provider<T> value )
> +    {
> +        getScopeState().seeded.put( Key.get( clazz ), value );
> +    }
> +
> +    public <T> void seed( Class<T> clazz, final T value )
> +    {
> +        getScopeState().seeded.put( Key.get( clazz ), Providers.of( value )
> ); +    }
> +
> +    public <T> Provider<T> scope( final Key<T> key, final Provider<T>
> unscoped ) +    {
> +        return new Provider<T>()
> +        {
> +            @SuppressWarnings( "unchecked" )
> +            public T get()
> +            {
> +                LinkedList<ScopeState> stack = values.get();
> +                if ( stack == null || stack.isEmpty() )
> +                {
> +                    throw new OutOfScopeException( "Cannot access " + key +
> " outside of a scoping block" ); +                }
> +
> +                ScopeState state = stack.getFirst();
> +
> +                Provider<?> seeded = state.seeded.get( key );
> +
> +                if ( seeded != null )
> +                {
> +                    return (T) seeded.get();
> +                }
> +
> +                T provided = (T) state.provided.get( key );
> +                if ( provided == null )
> +                {
> +                    provided = unscoped.get();
> +                    state.provided.put( key, provided );
> +                }
> +
> +                return provided;
> +            }
> +        };
> +    }
> +
> +    @SuppressWarnings( { "unchecked" } )
> +    public static <T> Provider<T> seededKeyProvider()
> +    {
> +        return (Provider<T>) SEEDED_KEY_PROVIDER;
> +    }
> +
> +    public static Module getScopeModule( PlexusContainer container )
> +        throws ComponentLookupException
> +    {
> +        final MojoExecutionScope scope = container.lookup(
> MojoExecutionScope.class ); +        return new AbstractModule()
> +        {
> +            @Override
> +            protected void configure()
> +            {
> +                bindScope( MojoExecutionScoped.class, scope );
> +
> +                // standard scope bindings
> +                bind( MavenSession.class ).toProvider(
> MojoExecutionScope.<MavenSession> seededKeyProvider() ).in( scope ); +     
>           bind( MavenProject.class ).toProvider(
> MojoExecutionScope.<MavenProject> seededKeyProvider() ).in( scope ); +     
>           bind( MojoExecution.class ).toProvider(
> MojoExecutionScope.<MojoExecution> seededKeyProvider() ).in( scope ); +    
>        }
> +        };
> +    }
> +
> +    public void afterExecutionSuccess()
> +        throws MojoExecutionException
> +    {
> +        for ( Object provided : getScopeState().provided.values() )
> +        {
> +            if ( provided instanceof MojoExecutionListener )
> +            {
> +                ( (MojoExecutionListener) provided
> ).afterMojoExecutionSuccess(); +                // TODO maybe deal with
> multiple MojoExecutionExceptions +            }
> +        }
> +    }
> +
> +    public void afterExecutionAlways()
> +        throws MojoExecutionException
> +    {
> +        for ( Object provided : getScopeState().provided.values() )
> +        {
> +            if ( provided instanceof MojoExecutionListener )
> +            {
> +                ( (MojoExecutionListener) provided
> ).afterMojoExecutionAlways(); +                // TODO maybe deal with
> multiple MojoExecutionExceptions +            }
> +        }
> +    }
> +
> +}
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/plugin/DefaultBuildPluginManager.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
> r.java
> b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
> r.java index 178f4c8..6fe5daa 100644
> ---
> a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
> r.java +++
> b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
> r.java @@ -24,6 +24,7 @@ import java.io.PrintStream;
>  import java.util.List;
> 
>  import org.apache.maven.execution.MavenSession;
> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>  import org.apache.maven.model.Plugin;
>  import org.apache.maven.plugin.descriptor.MojoDescriptor;
>  import org.apache.maven.plugin.descriptor.PluginDescriptor;
> @@ -48,8 +49,10 @@ public class DefaultBuildPluginManager
>      @Requirement
>      private LegacySupport legacySupport;
> 
> +    @Requirement( hint = MojoExecutionScope.SCOPE_NAME )
> +    private MojoExecutionScope scope;
> +
>      /**
> -     *
>       * @param plugin
>       * @param repositories
>       * @param session
> @@ -92,8 +95,14 @@ public class DefaultBuildPluginManager
> 
>          MavenSession oldSession = legacySupport.getSession();
> 
> +        scope.enter();
> +
>          try
>          {
> +            scope.seed( MavenSession.class, session );
> +            scope.seed( MavenProject.class, project );
> +            scope.seed( MojoExecution.class, mojoExecution );
> +
>              mojo = mavenPluginManager.getConfiguredMojo( Mojo.class,
> session, mojoExecution );
> 
>              legacySupport.setSession( session );
> @@ -104,6 +113,8 @@ public class DefaultBuildPluginManager
>              try
>              {
>                  mojo.execute();
> +
> +                scope.afterExecutionSuccess();
>              }
>              catch ( ClassCastException e )
>              {
> @@ -155,8 +166,12 @@ public class DefaultBuildPluginManager
>          }
>          finally
>          {
> +            scope.afterExecutionAlways();
> +
>              mavenPluginManager.releaseMojo( mojo, mojoExecution );
> 
> +            scope.exit();
> +
>              Thread.currentThread().setContextClassLoader( oldClassLoader );
> 
>              legacySupport.setSession( oldSession );
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
> ginManager.java
> b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
> ginManager.java index 8f22abe..8c8f507 100644
> ---
> a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
> ginManager.java +++
> b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
> ginManager.java @@ -41,6 +41,7 @@ import org.apache.maven.RepositoryUtils;
>  import org.apache.maven.artifact.Artifact;
>  import org.apache.maven.classrealm.ClassRealmManager;
>  import org.apache.maven.execution.MavenSession;
> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>  import org.apache.maven.model.Plugin;
>  import org.apache.maven.monitor.logging.DefaultLog;
>  import org.apache.maven.plugin.ContextEnabled;
> @@ -66,6 +67,7 @@ import
> org.apache.maven.plugin.descriptor.PluginDescriptor; import
> org.apache.maven.plugin.descriptor.PluginDescriptorBuilder; import
> org.apache.maven.project.MavenProject;
>  import org.apache.maven.rtinfo.RuntimeInformation;
> +import org.codehaus.plexus.DefaultPlexusContainer;
>  import org.codehaus.plexus.PlexusContainer;
>  import org.codehaus.plexus.classworlds.realm.ClassRealm;
>  import org.codehaus.plexus.component.annotations.Component;
> @@ -389,9 +391,10 @@ public class DefaultMavenPluginManager
>                  container.addComponentDescriptor( componentDescriptor );
>              }
> 
> -            container.discoverComponents( pluginRealm );
> +            ( (DefaultPlexusContainer) container ).discoverComponents(
> pluginRealm, +                                                             
>          MojoExecutionScope.getScopeModule( container ) ); }
> -        catch ( PlexusConfigurationException e )
> +        catch ( ComponentLookupException e )
>          {
>              throw new PluginContainerException( plugin, pluginRealm, "Error
> in component graph of plugin " + plugin.getId() + ": " + e.getMessage(), e
> );
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
> in/java/org/apache/maven/project/DefaultProjectBuildingHelper.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
> elper.java
> b/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
> elper.java index 1d99343..cba7432 100644
> ---
> a/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
> elper.java +++
> b/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
> elper.java @@ -33,6 +33,7 @@ import java.util.Set;
>  import org.apache.maven.artifact.InvalidRepositoryException;
>  import org.apache.maven.artifact.repository.ArtifactRepository;
>  import org.apache.maven.classrealm.ClassRealmManager;
> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>  import org.apache.maven.model.Build;
>  import org.apache.maven.model.Extension;
>  import org.apache.maven.model.Model;
> @@ -47,6 +48,7 @@ import
> org.apache.maven.plugin.version.PluginVersionRequest; import
> org.apache.maven.plugin.version.PluginVersionResolutionException; import
> org.apache.maven.plugin.version.PluginVersionResolver;
>  import org.apache.maven.repository.RepositorySystem;
> +import org.codehaus.plexus.DefaultPlexusContainer;
>  import org.codehaus.plexus.PlexusContainer;
>  import org.codehaus.plexus.classworlds.realm.ClassRealm;
>  import org.codehaus.plexus.component.annotations.Component;
> @@ -266,7 +268,8 @@ public class DefaultProjectBuildingHelper
> 
>                  try
>                  {
> -                    container.discoverComponents( extensionRealm );
> +                    ( (DefaultPlexusContainer) container
> ).discoverComponents( extensionRealm, +                                    
>                                          
> MojoExecutionScope.getScopeModule( container ) ); }
>                  catch ( Exception e )
>                  {
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/te
> st/java/org/apache/maven/AbstractCoreMavenComponentTestCase.java
> ---------------------------------------------------------------------- diff
> --git
> a/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
> ase.java
> b/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
> ase.java index 6534fc1..283a83c 100644
> ---
> a/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
> ase.java +++
> b/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
> ase.java @@ -44,6 +44,7 @@ import
> org.apache.maven.project.ProjectBuildingRequest; import
> org.apache.maven.repository.RepositorySystem;
>  import org.apache.maven.repository.internal.MavenRepositorySystemUtils;
>  import org.codehaus.plexus.ContainerConfiguration;
> +import org.codehaus.plexus.PlexusConstants;
>  import org.codehaus.plexus.PlexusTestCase;
>  import org.codehaus.plexus.component.annotations.Requirement;
>  import org.codehaus.plexus.util.FileUtils;
> @@ -98,7 +99,7 @@ public abstract class AbstractCoreMavenComponentTestCase
>       */
>      protected void customizeContainerConfiguration( ContainerConfiguration
> containerConfiguration ) {
> -        containerConfiguration.setAutoWiring( true );
> +        containerConfiguration.setAutoWiring( true ).setClassPathScanning(
> PlexusConstants.SCANNING_INDEX );; }
> 
>      protected MavenExecutionRequest createMavenExecutionRequest( File pom )
> 
> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/te
> st/java/org/apache/maven/execution/scope/internal/MojoExecutionScopeTest.jav
> a ----------------------------------------------------------------------
> diff --git
> a/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScopeTest.java
> b/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScopeTest.java new file mode 100644
> index 0000000..6e6f9fe
> --- /dev/null
> +++
> b/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
> ecutionScopeTest.java @@ -0,0 +1,53 @@
> +/*
> + * 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.execution.scope.internal;
> +
> +import junit.framework.TestCase;
> +
> +import com.google.inject.Key;
> +
> +public class MojoExecutionScopeTest
> +    extends TestCase
> +{
> +    public void testNestedEnter()
> +        throws Exception
> +    {
> +        MojoExecutionScope scope = new MojoExecutionScope();
> +
> +        scope.enter();
> +
> +        Object o1 = new Object();
> +        scope.seed( Object.class, o1 );
> +        assertSame( o1, scope.scope( Key.get( Object.class ), null ).get()
> ); +
> +        scope.enter();
> +        Object o2 = new Object();
> +        scope.seed( Object.class, o2 );
> +        assertSame( o2, scope.scope( Key.get( Object.class ), null ).get()
> ); +
> +        scope.exit();
> +        assertSame( o1, scope.scope( Key.get( Object.class ), null ).get()
> ); +
> +        scope.exit();
> +
> +        try
> +        {
> +            scope.exit();
> +        }
> +        catch ( IllegalStateException expected )
> +        {
> +        }
> +    }
> +}


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: git commit: MNG-5530 Introduced mojo execution guice component scope

Posted by Igor Fedorenko <ig...@ifedorenko.com>.

On 11/27/2013, 3:08, Hervé BOUTEMY wrote:
> Le samedi 23 novembre 2013 11:43:54 Igor Fedorenko a écrit :
>>> but it's good to see a new idea like that
>>>
>>> tell me if I can help more than with this feedback
>>
>> Do you have any specific maven plugin in mind where this feature can be
>> useful?
> Not for the moment. That's exactly why i was thinking at documentation, to
> avoid both unused and undocumented feature stay in place.
>
>> Do you think current implementation will work as is or will have
>> to be extended or adjusted before it will work?
> You did an IT that proves the code effectively works, no?
>

I guess I wasn't clear. What I am trying to find is whether the proposed
API is sufficient, whether class and method names make sense, etc. I
don't think it's possible to tell this without specific components one
has to implement, this is why I asked if you have specific usecase for
this feature in mind.

--
Regards,
Igor



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: git commit: MNG-5530 Introduced mojo execution guice component scope

Posted by Hervé BOUTEMY <he...@free.fr>.
Le samedi 23 novembre 2013 11:43:54 Igor Fedorenko a écrit :
> > but it's good to see a new idea like that
> > 
> > tell me if I can help more than with this feedback
> 
> Do you have any specific maven plugin in mind where this feature can be
> useful?
Not for the moment. That's exactly why i was thinking at documentation, to 
avoid both unused and undocumented feature stay in place.

> Do you think current implementation will work as is or will have
> to be extended or adjusted before it will work?
You did an IT that proves the code effectively works, no?

Regards,

Hervé

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


Re: git commit: MNG-5530 Introduced mojo execution guice component scope

Posted by Igor Fedorenko <ig...@ifedorenko.com>.

On 11/23/2013, 10:57, Hervé BOUTEMY wrote:
> nice new feature
>
> a few remarks:
>
> - IMHO, such a feature deserve a 3.2 Maven version instead of 3.1.2

I don't feel particularly strong about this. On one hand, this does not
introduce any user-visible change in behaviour, so from user point of
view this may be confusing. On the other hand, Eclipse committer in me
tells every new API requires minor version change.

Having said that, I believe the plan is to bump the version to 3.2
because of java6 requirement, so we can postpone decision about how we
version API changes little bit longer :-)

>
> - explanations in the commit comment are a good start for a documentation page
> in the component, no?
>
> - for the TODOs in MojoExecutionListener interface, I think both methods
> should be added, beforeExecution just because it is more expressive than a
> constructor, and afterExecutionFailure because it adds an argument to other
> after* methods

This new API is still work in progress. I plan to make some adjustments
to it before next release is out, so writing detailed documentation is
premature at this point.

I also think it makes sense to keep @provisional status of
MojoExecutionListener at least for one release and "promote" it to
official API only after we have several plugins using it.

> - after that, I don't really understand the implementation, the "seed" meaning
> (probably need some javadoc)
>

Yeah, I agree, Guice does sometime feel like (black) magic. The
implementation is largely based on this [1] wiki, adjusted to work with
multiple injectors we have in maven.

[1] http://code.google.com/p/google-guice/wiki/CustomScopes

> but it's good to see a new idea like that
>
> tell me if I can help more than with this feedback
>

Do you have any specific maven plugin in mind where this feature can be
useful? Do you think current implementation will work as is or will have
to be extended or adjusted before it will work?

--
Regards,
Igor



> Regards,
>
> Hervé
>
> Le jeudi 31 octobre 2013 11:51:11 ifedorenko@apache.org a écrit :
>> Updated Branches:
>>    refs/heads/master 70218af1c -> 8700b0585
>>
>>
>> MNG-5530 Introduced mojo execution guice component scope
>>
>> Mojo execution scoped components are annotated with @MojoExecutionScoped
>> They are created just before configured mojo instance is created
>> and disposed immediately after mojo execution finishes.
>>
>> Execution scoped components can request @Inject MavenSession,
>> MavenProject and MojoExecution instances in addition to any
>> standard Maven core components and components defined in
>> maven plugin contributing execution scoped components.
>>
>> Execution scoped components can be injected into Mojos using
>> standard /* @component */ javadoc (and likely new mojo
>> annotations).
>>
>> If execution scoped component implements MojoExecutionListener
>> callback interface, its #afterMojoExecutionSuccess method will be
>> invoked after successful mojo execution and #afterMojoExecutionAlways
>> method will be executed after both successful and failed mojo
>> executions.
>>
>> Signed-off-by: Igor Fedorenko <ig...@ifedorenko.com>
>>
>>
>> Project: http://git-wip-us.apache.org/repos/asf/maven/repo
>> Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/8700b058
>> Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/8700b058
>> Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/8700b058
>>
>> Branch: refs/heads/master
>> Commit: 8700b058574ea79544603ee4eacd6171ef03aa46
>> Parents: 70218af
>> Author: Igor Fedorenko <ig...@ifedorenko.com>
>> Authored: Sun Nov 25 01:34:53 2012 -0500
>> Committer: Igor Fedorenko <ig...@ifedorenko.com>
>> Committed: Thu Oct 31 07:49:54 2013 -0400
>>
>> ----------------------------------------------------------------------
>>   maven-core/pom.xml                              |  13 ++
>>   .../classrealm/DefaultClassRealmManager.java    |   1 +
>>   .../execution/scope/MojoExecutionListener.java  |  48 +++++
>>   .../execution/scope/MojoExecutionScoped.java    |  42 ++++
>>   .../scope/internal/MojoExecutionModule.java     |  45 +++++
>>   .../scope/internal/MojoExecutionScope.java      | 200 +++++++++++++++++++
>>   .../maven/plugin/DefaultBuildPluginManager.java |  17 +-
>>   .../internal/DefaultMavenPluginManager.java     |   7 +-
>>   .../project/DefaultProjectBuildingHelper.java   |   5 +-
>>   .../AbstractCoreMavenComponentTestCase.java     |   3 +-
>>   .../scope/internal/MojoExecutionScopeTest.java  |  53 +++++
>>   11 files changed, 429 insertions(+), 5 deletions(-)
>> ----------------------------------------------------------------------
>>
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/pom.xm
>> l ----------------------------------------------------------------------
>> diff --git a/maven-core/pom.xml b/maven-core/pom.xml
>> index ce86e3b..66e39ba 100644
>> --- a/maven-core/pom.xml
>> +++ b/maven-core/pom.xml
>> @@ -162,6 +162,19 @@
>>           <artifactId>plexus-component-metadata</artifactId>
>>         </plugin>
>>         <plugin>
>> +        <groupId>org.sonatype.plugins</groupId>
>> +        <artifactId>sisu-maven-plugin</artifactId>
>> +        <version>1.1</version>
>> +        <executions>
>> +          <execution>
>> +            <goals>
>> +              <goal>main-index</goal>
>> +              <goal>test-index</goal>
>> +            </goals>
>> +          </execution>
>> +        </executions>
>> +      </plugin>
>> +      <plugin>
>>           <groupId>org.codehaus.modello</groupId>
>>           <artifactId>modello-maven-plugin</artifactId>
>>           <configuration>
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/classrealm/DefaultClassRealmManager.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
>> ager.java
>> b/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
>> ager.java index 41c7dc2..a30a47e 100644
>> ---
>> a/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
>> ager.java +++
>> b/maven-core/src/main/java/org/apache/maven/classrealm/DefaultClassRealmMan
>> ager.java @@ -139,6 +139,7 @@ public class DefaultClassRealmManager
>>           imports.put( "org.apache.maven.configuration", coreRealm );
>>           imports.put( "org.apache.maven.exception", coreRealm );
>>           imports.put( "org.apache.maven.execution", coreRealm );
>> +        imports.put( "org.apache.maven.execution.scope", coreRealm );
>>           imports.put( "org.apache.maven.lifecycle", coreRealm );
>>           imports.put( "org.apache.maven.model", coreRealm );
>>           imports.put( "org.apache.maven.monitor", coreRealm );
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/execution/scope/MojoExecutionListener.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
>> stener.java
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
>> stener.java new file mode 100644
>> index 0000000..7a9c84b
>> --- /dev/null
>> +++
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionLi
>> stener.java @@ -0,0 +1,48 @@
>> +package org.apache.maven.execution.scope;
>> +
>> +/*
>> + * 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.
>> + */
>> +
>> +import org.apache.maven.plugin.MojoExecutionException;
>> +
>> +/**
>> + * Helper interface that allows mojo execution scoped components to be
>> notified before execution start and after + * execution completion. The
>> main purpose of this interface is to allow mojo execution scoped components
>> perform setup + * before and cleanup after mojo execution.
>> + * <p>
>> + * TODO decide if Mojo should be passed as parameter of callback methods
>> + *
>> + * @author igor
>> + * @since 3.1.2
>> + * @provisional This interface is part of work in progress and can be
>> changed or removed without notice. + */
>> +public interface MojoExecutionListener
>> +{
>> +    // TODO decide if this is needed
>> +    // public void beforeExecution() throws MojoExecutionException;
>> +
>> +    public void afterMojoExecutionSuccess()
>> +        throws MojoExecutionException;
>> +
>> +    // TODO decide if this is needed.
>> +    // public void afterExecutionFailure(Throwable t) throws
>> MojoExecutionException; +
>> +    public void afterMojoExecutionAlways()
>> +        throws MojoExecutionException;
>> +}
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/execution/scope/MojoExecutionScoped.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
>> oped.java
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
>> oped.java new file mode 100644
>> index 0000000..c53297c
>> --- /dev/null
>> +++
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/MojoExecutionSc
>> oped.java @@ -0,0 +1,42 @@
>> +package org.apache.maven.execution.scope;
>> +
>> +/*
>> + * 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.
>> + */
>> +
>> +import static java.lang.annotation.ElementType.TYPE;
>> +import static java.lang.annotation.RetentionPolicy.RUNTIME;
>> +
>> +import java.lang.annotation.Retention;
>> +import java.lang.annotation.Target;
>> +
>> +import com.google.inject.ScopeAnnotation;
>> +
>> +/**
>> + * Indicates that annotated component should be instantiated before mojo
>> execution starts and discarded after mojo + * execution completes.
>> + *
>> + * @author igor
>> + * @since 3.1.2
>> + */
>> +@Target( { TYPE } )
>> +@Retention( RUNTIME )
>> +@ScopeAnnotation
>> +public @interface MojoExecutionScoped
>> +{
>> +}
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/execution/scope/internal/MojoExecutionModule.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionModule.java
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionModule.java new file mode 100644
>> index 0000000..65ba181
>> --- /dev/null
>> +++
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionModule.java @@ -0,0 +1,45 @@
>> +package org.apache.maven.execution.scope.internal;
>> +
>> +/*
>> + * 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.
>> + */
>> +
>> +import javax.inject.Named;
>> +
>> +import org.apache.maven.execution.scope.MojoExecutionScoped;
>> +
>> +import com.google.inject.Binder;
>> +import com.google.inject.Module;
>> +import com.google.inject.name.Names;
>> +
>> +@Named
>> +public class MojoExecutionModule
>> +    implements Module
>> +{
>> +
>> +    public void configure( Binder binder )
>> +    {
>> +        final MojoExecutionScope executionScope = new MojoExecutionScope();
>> +
>> +        // tell Guice about the scope
>> +        binder.bindScope( MojoExecutionScoped.class, executionScope );
>> +
>> +        // make our scope instance injectable
>> +        binder.bind( MojoExecutionScope.class ).annotatedWith( Names.named(
>> MojoExecutionScope.SCOPE_NAME ) ).toInstance( executionScope ); +    }
>> +}
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/execution/scope/internal/MojoExecutionScope.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScope.java
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScope.java new file mode 100644
>> index 0000000..3d021fd
>> --- /dev/null
>> +++
>> b/maven-core/src/main/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScope.java @@ -0,0 +1,200 @@
>> +package org.apache.maven.execution.scope.internal;
>> +
>> +/*
>> + * 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.
>> + */
>> +
>> +import java.util.LinkedList;
>> +import java.util.Map;
>> +
>> +import org.apache.maven.execution.MavenSession;
>> +import org.apache.maven.execution.scope.MojoExecutionListener;
>> +import org.apache.maven.execution.scope.MojoExecutionScoped;
>> +import org.apache.maven.plugin.MojoExecution;
>> +import org.apache.maven.plugin.MojoExecutionException;
>> +import org.apache.maven.project.MavenProject;
>> +import org.codehaus.plexus.PlexusContainer;
>> +import
>> org.codehaus.plexus.component.repository.exception.ComponentLookupException
>> ; +
>> +import com.google.common.collect.Maps;
>> +import com.google.inject.AbstractModule;
>> +import com.google.inject.Key;
>> +import com.google.inject.Module;
>> +import com.google.inject.OutOfScopeException;
>> +import com.google.inject.Provider;
>> +import com.google.inject.Scope;
>> +import com.google.inject.util.Providers;
>> +
>> +public class MojoExecutionScope
>> +    implements Scope
>> +{
>> +    public static final String SCOPE_NAME = "mojoExecution";
>> +
>> +    private static final Provider<Object> SEEDED_KEY_PROVIDER = new
>> Provider<Object>() +    {
>> +        public Object get()
>> +        {
>> +            throw new IllegalStateException();
>> +        }
>> +    };
>> +
>> +    private static final class ScopeState
>> +    {
>> +        public final Map<Key<?>, Provider<?>> seeded = Maps.newHashMap();
>> +
>> +        public final Map<Key<?>, Object> provided = Maps.newHashMap();
>> +    }
>> +
>> +    private final ThreadLocal<LinkedList<ScopeState>> values = new
>> ThreadLocal<LinkedList<ScopeState>>(); +
>> +    public MojoExecutionScope()
>> +    {
>> +    }
>> +
>> +    public void enter()
>> +    {
>> +        LinkedList<ScopeState> stack = values.get();
>> +        if ( stack == null )
>> +        {
>> +            stack = new LinkedList<ScopeState>();
>> +            values.set( stack );
>> +        }
>> +        stack.addFirst( new ScopeState() );
>> +    }
>> +
>> +    private ScopeState getScopeState()
>> +    {
>> +        LinkedList<ScopeState> stack = values.get();
>> +        if ( stack == null || stack.isEmpty() )
>> +        {
>> +            throw new IllegalStateException();
>> +        }
>> +        return stack.getFirst();
>> +    }
>> +
>> +    public void exit()
>> +        throws MojoExecutionException
>> +    {
>> +        final LinkedList<ScopeState> stack = values.get();
>> +        if ( stack == null || stack.isEmpty() )
>> +        {
>> +            throw new IllegalStateException();
>> +        }
>> +        stack.removeFirst();
>> +        if ( stack.isEmpty() )
>> +        {
>> +            values.remove();
>> +        }
>> +    }
>> +
>> +    public <T> void seed( Class<T> clazz, Provider<T> value )
>> +    {
>> +        getScopeState().seeded.put( Key.get( clazz ), value );
>> +    }
>> +
>> +    public <T> void seed( Class<T> clazz, final T value )
>> +    {
>> +        getScopeState().seeded.put( Key.get( clazz ), Providers.of( value )
>> ); +    }
>> +
>> +    public <T> Provider<T> scope( final Key<T> key, final Provider<T>
>> unscoped ) +    {
>> +        return new Provider<T>()
>> +        {
>> +            @SuppressWarnings( "unchecked" )
>> +            public T get()
>> +            {
>> +                LinkedList<ScopeState> stack = values.get();
>> +                if ( stack == null || stack.isEmpty() )
>> +                {
>> +                    throw new OutOfScopeException( "Cannot access " + key +
>> " outside of a scoping block" ); +                }
>> +
>> +                ScopeState state = stack.getFirst();
>> +
>> +                Provider<?> seeded = state.seeded.get( key );
>> +
>> +                if ( seeded != null )
>> +                {
>> +                    return (T) seeded.get();
>> +                }
>> +
>> +                T provided = (T) state.provided.get( key );
>> +                if ( provided == null )
>> +                {
>> +                    provided = unscoped.get();
>> +                    state.provided.put( key, provided );
>> +                }
>> +
>> +                return provided;
>> +            }
>> +        };
>> +    }
>> +
>> +    @SuppressWarnings( { "unchecked" } )
>> +    public static <T> Provider<T> seededKeyProvider()
>> +    {
>> +        return (Provider<T>) SEEDED_KEY_PROVIDER;
>> +    }
>> +
>> +    public static Module getScopeModule( PlexusContainer container )
>> +        throws ComponentLookupException
>> +    {
>> +        final MojoExecutionScope scope = container.lookup(
>> MojoExecutionScope.class ); +        return new AbstractModule()
>> +        {
>> +            @Override
>> +            protected void configure()
>> +            {
>> +                bindScope( MojoExecutionScoped.class, scope );
>> +
>> +                // standard scope bindings
>> +                bind( MavenSession.class ).toProvider(
>> MojoExecutionScope.<MavenSession> seededKeyProvider() ).in( scope ); +
>>            bind( MavenProject.class ).toProvider(
>> MojoExecutionScope.<MavenProject> seededKeyProvider() ).in( scope ); +
>>            bind( MojoExecution.class ).toProvider(
>> MojoExecutionScope.<MojoExecution> seededKeyProvider() ).in( scope ); +
>>         }
>> +        };
>> +    }
>> +
>> +    public void afterExecutionSuccess()
>> +        throws MojoExecutionException
>> +    {
>> +        for ( Object provided : getScopeState().provided.values() )
>> +        {
>> +            if ( provided instanceof MojoExecutionListener )
>> +            {
>> +                ( (MojoExecutionListener) provided
>> ).afterMojoExecutionSuccess(); +                // TODO maybe deal with
>> multiple MojoExecutionExceptions +            }
>> +        }
>> +    }
>> +
>> +    public void afterExecutionAlways()
>> +        throws MojoExecutionException
>> +    {
>> +        for ( Object provided : getScopeState().provided.values() )
>> +        {
>> +            if ( provided instanceof MojoExecutionListener )
>> +            {
>> +                ( (MojoExecutionListener) provided
>> ).afterMojoExecutionAlways(); +                // TODO maybe deal with
>> multiple MojoExecutionExceptions +            }
>> +        }
>> +    }
>> +
>> +}
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/plugin/DefaultBuildPluginManager.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
>> r.java
>> b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
>> r.java index 178f4c8..6fe5daa 100644
>> ---
>> a/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
>> r.java +++
>> b/maven-core/src/main/java/org/apache/maven/plugin/DefaultBuildPluginManage
>> r.java @@ -24,6 +24,7 @@ import java.io.PrintStream;
>>   import java.util.List;
>>
>>   import org.apache.maven.execution.MavenSession;
>> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>>   import org.apache.maven.model.Plugin;
>>   import org.apache.maven.plugin.descriptor.MojoDescriptor;
>>   import org.apache.maven.plugin.descriptor.PluginDescriptor;
>> @@ -48,8 +49,10 @@ public class DefaultBuildPluginManager
>>       @Requirement
>>       private LegacySupport legacySupport;
>>
>> +    @Requirement( hint = MojoExecutionScope.SCOPE_NAME )
>> +    private MojoExecutionScope scope;
>> +
>>       /**
>> -     *
>>        * @param plugin
>>        * @param repositories
>>        * @param session
>> @@ -92,8 +95,14 @@ public class DefaultBuildPluginManager
>>
>>           MavenSession oldSession = legacySupport.getSession();
>>
>> +        scope.enter();
>> +
>>           try
>>           {
>> +            scope.seed( MavenSession.class, session );
>> +            scope.seed( MavenProject.class, project );
>> +            scope.seed( MojoExecution.class, mojoExecution );
>> +
>>               mojo = mavenPluginManager.getConfiguredMojo( Mojo.class,
>> session, mojoExecution );
>>
>>               legacySupport.setSession( session );
>> @@ -104,6 +113,8 @@ public class DefaultBuildPluginManager
>>               try
>>               {
>>                   mojo.execute();
>> +
>> +                scope.afterExecutionSuccess();
>>               }
>>               catch ( ClassCastException e )
>>               {
>> @@ -155,8 +166,12 @@ public class DefaultBuildPluginManager
>>           }
>>           finally
>>           {
>> +            scope.afterExecutionAlways();
>> +
>>               mavenPluginManager.releaseMojo( mojo, mojoExecution );
>>
>> +            scope.exit();
>> +
>>               Thread.currentThread().setContextClassLoader( oldClassLoader );
>>
>>               legacySupport.setSession( oldSession );
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/plugin/internal/DefaultMavenPluginManager.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
>> ginManager.java
>> b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
>> ginManager.java index 8f22abe..8c8f507 100644
>> ---
>> a/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
>> ginManager.java +++
>> b/maven-core/src/main/java/org/apache/maven/plugin/internal/DefaultMavenPlu
>> ginManager.java @@ -41,6 +41,7 @@ import org.apache.maven.RepositoryUtils;
>>   import org.apache.maven.artifact.Artifact;
>>   import org.apache.maven.classrealm.ClassRealmManager;
>>   import org.apache.maven.execution.MavenSession;
>> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>>   import org.apache.maven.model.Plugin;
>>   import org.apache.maven.monitor.logging.DefaultLog;
>>   import org.apache.maven.plugin.ContextEnabled;
>> @@ -66,6 +67,7 @@ import
>> org.apache.maven.plugin.descriptor.PluginDescriptor; import
>> org.apache.maven.plugin.descriptor.PluginDescriptorBuilder; import
>> org.apache.maven.project.MavenProject;
>>   import org.apache.maven.rtinfo.RuntimeInformation;
>> +import org.codehaus.plexus.DefaultPlexusContainer;
>>   import org.codehaus.plexus.PlexusContainer;
>>   import org.codehaus.plexus.classworlds.realm.ClassRealm;
>>   import org.codehaus.plexus.component.annotations.Component;
>> @@ -389,9 +391,10 @@ public class DefaultMavenPluginManager
>>                   container.addComponentDescriptor( componentDescriptor );
>>               }
>>
>> -            container.discoverComponents( pluginRealm );
>> +            ( (DefaultPlexusContainer) container ).discoverComponents(
>> pluginRealm, +
>>           MojoExecutionScope.getScopeModule( container ) ); }
>> -        catch ( PlexusConfigurationException e )
>> +        catch ( ComponentLookupException e )
>>           {
>>               throw new PluginContainerException( plugin, pluginRealm, "Error
>> in component graph of plugin " + plugin.getId() + ": " + e.getMessage(), e
>> );
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/ma
>> in/java/org/apache/maven/project/DefaultProjectBuildingHelper.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
>> elper.java
>> b/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
>> elper.java index 1d99343..cba7432 100644
>> ---
>> a/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
>> elper.java +++
>> b/maven-core/src/main/java/org/apache/maven/project/DefaultProjectBuildingH
>> elper.java @@ -33,6 +33,7 @@ import java.util.Set;
>>   import org.apache.maven.artifact.InvalidRepositoryException;
>>   import org.apache.maven.artifact.repository.ArtifactRepository;
>>   import org.apache.maven.classrealm.ClassRealmManager;
>> +import org.apache.maven.execution.scope.internal.MojoExecutionScope;
>>   import org.apache.maven.model.Build;
>>   import org.apache.maven.model.Extension;
>>   import org.apache.maven.model.Model;
>> @@ -47,6 +48,7 @@ import
>> org.apache.maven.plugin.version.PluginVersionRequest; import
>> org.apache.maven.plugin.version.PluginVersionResolutionException; import
>> org.apache.maven.plugin.version.PluginVersionResolver;
>>   import org.apache.maven.repository.RepositorySystem;
>> +import org.codehaus.plexus.DefaultPlexusContainer;
>>   import org.codehaus.plexus.PlexusContainer;
>>   import org.codehaus.plexus.classworlds.realm.ClassRealm;
>>   import org.codehaus.plexus.component.annotations.Component;
>> @@ -266,7 +268,8 @@ public class DefaultProjectBuildingHelper
>>
>>                   try
>>                   {
>> -                    container.discoverComponents( extensionRealm );
>> +                    ( (DefaultPlexusContainer) container
>> ).discoverComponents( extensionRealm, +
>>
>> MojoExecutionScope.getScopeModule( container ) ); }
>>                   catch ( Exception e )
>>                   {
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/te
>> st/java/org/apache/maven/AbstractCoreMavenComponentTestCase.java
>> ---------------------------------------------------------------------- diff
>> --git
>> a/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
>> ase.java
>> b/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
>> ase.java index 6534fc1..283a83c 100644
>> ---
>> a/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
>> ase.java +++
>> b/maven-core/src/test/java/org/apache/maven/AbstractCoreMavenComponentTestC
>> ase.java @@ -44,6 +44,7 @@ import
>> org.apache.maven.project.ProjectBuildingRequest; import
>> org.apache.maven.repository.RepositorySystem;
>>   import org.apache.maven.repository.internal.MavenRepositorySystemUtils;
>>   import org.codehaus.plexus.ContainerConfiguration;
>> +import org.codehaus.plexus.PlexusConstants;
>>   import org.codehaus.plexus.PlexusTestCase;
>>   import org.codehaus.plexus.component.annotations.Requirement;
>>   import org.codehaus.plexus.util.FileUtils;
>> @@ -98,7 +99,7 @@ public abstract class AbstractCoreMavenComponentTestCase
>>        */
>>       protected void customizeContainerConfiguration( ContainerConfiguration
>> containerConfiguration ) {
>> -        containerConfiguration.setAutoWiring( true );
>> +        containerConfiguration.setAutoWiring( true ).setClassPathScanning(
>> PlexusConstants.SCANNING_INDEX );; }
>>
>>       protected MavenExecutionRequest createMavenExecutionRequest( File pom )
>>
>> http://git-wip-us.apache.org/repos/asf/maven/blob/8700b058/maven-core/src/te
>> st/java/org/apache/maven/execution/scope/internal/MojoExecutionScopeTest.jav
>> a ----------------------------------------------------------------------
>> diff --git
>> a/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScopeTest.java
>> b/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScopeTest.java new file mode 100644
>> index 0000000..6e6f9fe
>> --- /dev/null
>> +++
>> b/maven-core/src/test/java/org/apache/maven/execution/scope/internal/MojoEx
>> ecutionScopeTest.java @@ -0,0 +1,53 @@
>> +/*
>> + * 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.execution.scope.internal;
>> +
>> +import junit.framework.TestCase;
>> +
>> +import com.google.inject.Key;
>> +
>> +public class MojoExecutionScopeTest
>> +    extends TestCase
>> +{
>> +    public void testNestedEnter()
>> +        throws Exception
>> +    {
>> +        MojoExecutionScope scope = new MojoExecutionScope();
>> +
>> +        scope.enter();
>> +
>> +        Object o1 = new Object();
>> +        scope.seed( Object.class, o1 );
>> +        assertSame( o1, scope.scope( Key.get( Object.class ), null ).get()
>> ); +
>> +        scope.enter();
>> +        Object o2 = new Object();
>> +        scope.seed( Object.class, o2 );
>> +        assertSame( o2, scope.scope( Key.get( Object.class ), null ).get()
>> ); +
>> +        scope.exit();
>> +        assertSame( o1, scope.scope( Key.get( Object.class ), null ).get()
>> ); +
>> +        scope.exit();
>> +
>> +        try
>> +        {
>> +            scope.exit();
>> +        }
>> +        catch ( IllegalStateException expected )
>> +        {
>> +        }
>> +    }
>> +}
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org