package org.apache.maven.plugin.surefire;
   
   /*
    * 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.artifact.Artifact;
  import org.apache.maven.artifact.factory.ArtifactFactory;
  import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
  import org.apache.maven.artifact.repository.ArtifactRepository;
  import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
  import org.apache.maven.artifact.resolver.ArtifactResolutionException;
  import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
  import org.apache.maven.artifact.resolver.ArtifactResolver;
  import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
  import org.apache.maven.artifact.resolver.filter.ExcludesArtifactFilter;
  import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
  import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
  import org.apache.maven.artifact.versioning.OverConstrainedVersionException;
  import org.apache.maven.artifact.versioning.VersionRange;
  import org.apache.maven.plugin.logging.Log;
  import org.apache.maven.surefire.booter.Classpath;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.Iterator;
  import java.util.LinkedHashSet;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  
  /**
   * Does dependency resolution and artifact handling for the surefire plugin.
   *
   * @author Stephen Connolly
   * @author Kristian Rosenvold
   */
  public class SurefireDependencyResolver
  {
  
      private final ArtifactResolver artifactResolver;
  
      private final ArtifactFactory artifactFactory;
  
      private final org.apache.maven.plugin.logging.Log log;
  
      private final ArtifactRepository localRepository;
  
      private final List remoteRepositories;
  
      private final ArtifactMetadataSource artifactMetadataSource;
  
      private final String pluginName;
  
      protected SurefireDependencyResolver( ArtifactResolver artifactResolver, ArtifactFactory artifactFactory, Log log,
                                            ArtifactRepository localRepository, List remoteRepositories,
                                            ArtifactMetadataSource artifactMetadataSource, String pluginName )
      {
          this.artifactResolver = artifactResolver;
          this.artifactFactory = artifactFactory;
          this.log = log;
          this.localRepository = localRepository;
          this.remoteRepositories = remoteRepositories;
          this.artifactMetadataSource = artifactMetadataSource;
          this.pluginName = pluginName;
      }
  
  
      public boolean isWithinVersionSpec( Artifact artifact, String versionSpec )
      {
          if ( artifact == null )
          {
              return false;
          }
          try
          {
              VersionRange range = VersionRange.createFromVersionSpec( versionSpec );
              try
              {
                  return range.containsVersion( artifact.getSelectedVersion() );
              }
              catch ( NullPointerException e )
              {
                  return range.containsVersion( new DefaultArtifactVersion( artifact.getBaseVersion() ) );
             }
         }
         catch ( InvalidVersionSpecificationException e )
         {
             throw new RuntimeException( "Bug in plugin. Please report with stacktrace" );
         }
         catch ( OverConstrainedVersionException e )
         {
             throw new RuntimeException( "Bug in plugin. Please report with stacktrace" );
         }
     }
 
     /**
      * Return a new set containing only the artifacts accepted by the given filter.
      *
      * @param artifacts The unfiltered artifacts
      * @param filter    The filter to apply
      * @return The filtered result
      * @noinspection UnusedDeclaration
      */
     public Set filterArtifacts( Set artifacts, ArtifactFilter filter )
     {
         Set filteredArtifacts = new LinkedHashSet();
 
         for ( Iterator iter = artifacts.iterator(); iter.hasNext(); )
         {
             Artifact artifact = (Artifact) iter.next();
             if ( !filter.include( artifact ) )
             {
                 filteredArtifacts.add( artifact );
             }
         }
 
         return filteredArtifacts;
     }
 
 
     public ArtifactResolutionResult resolveArtifact( Artifact filteredArtifact, Artifact providerArtifact )
         throws ArtifactResolutionException, ArtifactNotFoundException
     {
         ArtifactFilter filter = null;
         if ( filteredArtifact != null )
         {
             filter = new ExcludesArtifactFilter(
                 Collections.singletonList( filteredArtifact.getGroupId() + ":" + filteredArtifact.getArtifactId() ) );
         }
 
         Artifact originatingArtifact = artifactFactory.createBuildArtifact( "dummy", "dummy", "1.0", "jar" );
         
         return artifactResolver.resolveTransitively( Collections.singleton( providerArtifact ), originatingArtifact,
                                                      localRepository, remoteRepositories, artifactMetadataSource,
                                                      filter );
     }
 
     public Classpath getProviderClasspath( String provider, String version, Artifact filteredArtifact )
         throws ArtifactNotFoundException, ArtifactResolutionException
     {
         Artifact providerArtifact = artifactFactory.createDependencyArtifact( "org.apache.maven.surefire", provider,
                                                                               VersionRange.createFromVersion( version ),
                                                                               "jar", null, Artifact.SCOPE_TEST );
         ArtifactResolutionResult result = resolveArtifact( filteredArtifact, providerArtifact );
         List files = new ArrayList();
 
         for ( Iterator i = result.getArtifacts().iterator(); i.hasNext(); )
         {
             Artifact artifact = (Artifact) i.next();
 
             log.debug(
                 "Adding to " + pluginName + " test classpath: " + artifact.getFile().getAbsolutePath() + " Scope: "
                     + artifact.getScope() );
 
             files.add( artifact.getFile().getAbsolutePath() );
         }
         return new Classpath( files );
     }
 
     public Classpath addProviderToClasspath( Map pluginArtifactMap, Artifact surefireArtifact )
         throws ArtifactResolutionException, ArtifactNotFoundException
     {
         List files = new ArrayList();
         if ( surefireArtifact != null )
         {
             final ArtifactResolutionResult artifactResolutionResult = resolveArtifact( null, surefireArtifact );
             for ( Iterator iterator = pluginArtifactMap.values().iterator(); iterator.hasNext(); )
             {
                 Artifact artifact = (Artifact) iterator.next();
                 if ( !artifactResolutionResult.getArtifacts().contains( artifact ) )
                 {
                     files.add( artifact.getFile().getAbsolutePath() );
                 }
             }
         }
         else
         {
             // Bit of a brute force strategy if not found. Should probably be improved
             for ( Iterator iterator = pluginArtifactMap.values().iterator(); iterator.hasNext(); )
             {
                 Artifact artifact = (Artifact) iterator.next();
                 files.add( artifact.getFile().getPath() );
             }
         }
         return new Classpath( files );
     }
 
     public Classpath getResolvedArtifactClasspath( Artifact surefireArtifact )
         throws ArtifactNotFoundException, ArtifactResolutionException
     {
         ArtifactResolutionResult result = resolveArtifact( null, surefireArtifact );
         List classpath = new ArrayList();
 
         for ( Iterator i = result.getArtifacts().iterator(); i.hasNext(); )
         {
             Artifact artifact = (Artifact) i.next();
 
             classpath.add( artifact.getFile().getAbsolutePath() );
         }
         return new Classpath( classpath);
     }
 
 }