package org.apache.maven.plugin.assembly.artifact;
/*
* 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.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
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.MultipleArtifactsNotFoundException;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.plugin.assembly.AssemblerConfigurationSource;
import org.apache.maven.plugin.assembly.archive.ArchiveCreationException;
import org.apache.maven.plugin.assembly.archive.phase.ModuleSetAssemblyPhase;
import org.apache.maven.plugin.assembly.model.Assembly;
import org.apache.maven.plugin.assembly.model.DependencySet;
import org.apache.maven.plugin.assembly.model.ModuleBinaries;
import org.apache.maven.plugin.assembly.model.ModuleSet;
import org.apache.maven.plugin.assembly.model.Repository;
import org.apache.maven.plugin.assembly.resolved.AssemblyId;
import org.apache.maven.plugin.assembly.utils.FilterUtils;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.artifact.InvalidDependencyVersionException;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.logging.Logger;
import org.codehaus.plexus.util.StringUtils;
/**
* @author jdcasey
* @version $Id$
*/
@Component( role = DependencyResolver.class )
public class DefaultDependencyResolver
extends AbstractLogEnabled
implements DependencyResolver
{
@Requirement
private ArtifactResolver resolver;
@Requirement
private ArtifactMetadataSource metadataSource;
@Requirement
private ArtifactFactory factory;
@SuppressWarnings( "UnusedDeclaration" )
public DefaultDependencyResolver()
{
// for plexus init
}
protected DefaultDependencyResolver( final ArtifactResolver resolver, final ArtifactMetadataSource metadataSource,
final ArtifactFactory factory, final Logger logger )
{
this.resolver = resolver;
this.metadataSource = metadataSource;
this.factory = factory;
enableLogging( logger );
}
public Map<DependencySet, Set<Artifact>> resolveDependencySets( final Assembly assembly, ModuleSet moduleSet,
final AssemblerConfigurationSource configSource,
List<DependencySet> dependencySets )
throws DependencyResolutionException
{
Map<DependencySet, Set<Artifact>> result = new LinkedHashMap<DependencySet, Set<Artifact>>();
for ( DependencySet dependencySet : dependencySets )
{
final MavenProject currentProject = configSource.getProject();
final ResolutionManagementInfo info = new ResolutionManagementInfo( currentProject );
updateRepositoryResolutionRequirements( assembly, info );
final AssemblyId assemblyId = AssemblyId.createAssemblyId( assembly );
updateDependencySetResolutionRequirements( dependencySet, info, assemblyId, currentProject );
updateModuleSetResolutionRequirements( assemblyId, moduleSet, dependencySet, info, configSource );
Set<Artifact> artifacts;
if ( info.isResolutionRequired() )
{
final List<ArtifactRepository> repos =
aggregateRemoteArtifactRepositories( configSource.getRemoteRepositories(),
info.getEnabledProjects() );
artifacts = info.getArtifacts();
if ( info.isResolvedTransitively() )
{
getLogger().debug( "Resolving project dependencies transitively." );
artifacts = resolveTransitively( artifacts, repos, info, configSource );
}
else
{
getLogger().debug(
"Resolving project dependencies ONLY. Transitive dependencies WILL NOT be included in the results." );
artifacts = resolveNonTransitively( assembly, artifacts, configSource, repos );
}
}
else
{
artifacts = new HashSet<Artifact>();
}
result.put( dependencySet, artifacts );
}
return result;
}
public Map<DependencySet, Set<Artifact>> resolveDependencySets( final Assembly assembly,
final AssemblerConfigurationSource configSource,
List<DependencySet> dependencySets )
throws DependencyResolutionException
{
Map<DependencySet, Set<Artifact>> result = new LinkedHashMap<DependencySet, Set<Artifact>>();
for ( DependencySet dependencySet : dependencySets )
{
final MavenProject currentProject = configSource.getProject();
final ResolutionManagementInfo info = new ResolutionManagementInfo( currentProject );
updateRepositoryResolutionRequirements( assembly, info );
final AssemblyId assemblyId = AssemblyId.createAssemblyId( assembly );
updateDependencySetResolutionRequirements( dependencySet , info, assemblyId, currentProject );
Set<Artifact> artifacts;
if ( info.isResolutionRequired() )
{
final List<ArtifactRepository> repos =
aggregateRemoteArtifactRepositories( configSource.getRemoteRepositories(),
info.getEnabledProjects() );
artifacts = info.getArtifacts();
if ( info.isResolvedTransitively() )
{
getLogger().debug( "Resolving project dependencies transitively." );
artifacts = resolveTransitively( artifacts, repos, info, configSource );
}
else
{
getLogger().debug(
"Resolving project dependencies ONLY. Transitive dependencies WILL NOT be included in the results." );
artifacts = resolveNonTransitively( assembly, artifacts, configSource, repos );
}
}
else
{
artifacts = new HashSet<Artifact>();
}
result.put( dependencySet, artifacts );
}
return result;
}
Set<Artifact> resolveNonTransitively( final Assembly assembly, final Set<Artifact> dependencyArtifacts,
final AssemblerConfigurationSource configSource,
final List<ArtifactRepository> repos )
throws DependencyResolutionException
{
final List<Artifact> missing = new ArrayList<Artifact>();
final Set<Artifact> resolved = new LinkedHashSet<Artifact>();
for ( final Artifact depArtifact : dependencyArtifacts )
{
try
{
resolver.resolve( depArtifact, repos, configSource.getLocalRepository() );
resolved.add( depArtifact );
}
catch ( final ArtifactResolutionException e )
{
if ( getLogger().isDebugEnabled() )
{
getLogger().debug(
"Failed to resolve: " + depArtifact.getId() + " for assembly: " + assembly.getId() );
}
missing.add( depArtifact );
}
catch ( final ArtifactNotFoundException e )
{
if ( getLogger().isDebugEnabled() )
{
getLogger().debug(
"Failed to resolve: " + depArtifact.getId() + " for assembly: " + assembly.getId() );
}
missing.add( depArtifact );
}
}
if ( !missing.isEmpty() )
{
final MavenProject project = configSource.getProject();
final Artifact rootArtifact = project.getArtifact();
final Throwable error =
new MultipleArtifactsNotFoundException( rootArtifact, new ArrayList<Artifact>( resolved ), missing,
repos );
throw new DependencyResolutionException( "Failed to resolve dependencies for: " + assembly.getId(), error );
}
return resolved;
}
@SuppressWarnings( "unchecked" )
private Set<Artifact> resolveTransitively( final Set<Artifact> dependencyArtifacts,
final List<ArtifactRepository> repos,
final ResolutionManagementInfo info,
final AssemblerConfigurationSource configSource )
throws DependencyResolutionException
{
final MavenProject project = configSource.getProject();
final ArtifactFilter filter = info.getScopeFilter();
final ArtifactRepository localRepository = configSource.getLocalRepository();
ArtifactResolutionResult result;
try
{
result = resolver.resolveTransitively( dependencyArtifacts, project.getArtifact(),
project.getManagedVersionMap(), localRepository, repos,
metadataSource, filter );
}
catch ( final ArtifactResolutionException e )
{
throw new DependencyResolutionException( "Failed to resolve dependencies for assembly: ", e );
}
catch ( final ArtifactNotFoundException e )
{
throw new DependencyResolutionException( "Failed to resolve dependencies for assembly: ", e );
}
getLogger().debug( "While resolving dependencies of " + project.getId() + ":" );
FilterUtils.reportFilteringStatistics( Collections.singleton( filter ), getLogger() );
return result.getArtifacts();
}
void updateRepositoryResolutionRequirements( final Assembly assembly, final ResolutionManagementInfo requirements )
{
final List<Repository> repositories = assembly.getRepositories();
if ( repositories != null && !repositories.isEmpty() )
{
requirements.setResolutionRequired( true );
for ( final Repository repo : repositories )
{
enableScope( repo.getScope(), requirements );
}
}
}
void updateModuleSetResolutionRequirements( AssemblyId assemblyId, ModuleSet set, DependencySet dependencySet,
final ResolutionManagementInfo requirements,
final AssemblerConfigurationSource configSource )
throws DependencyResolutionException
{
final ModuleBinaries binaries = set.getBinaries();
if ( binaries != null )
{
Set<MavenProject> projects;
try
{
projects = ModuleSetAssemblyPhase.getModuleProjects( set, configSource, getLogger() );
}
catch ( final ArchiveCreationException e )
{
throw new DependencyResolutionException( "Error determining project-set for moduleSet with binaries.",
e );
}
if ( !projects.isEmpty() )
{
for ( final MavenProject p : projects )
{
requirements.enableProjectResolution( p );
if ( p.getArtifact() == null )
{
// TODO: such a call in MavenMetadataSource too - packaging not really the intention of
// type
final Artifact artifact =
factory.createBuildArtifact( p.getGroupId(), p.getArtifactId(), p.getVersion(),
p.getPackaging() );
p.setArtifact( artifact );
}
}
}
if ( binaries.isIncludeDependencies() )
{
updateDependencySetResolutionRequirements( dependencySet,
requirements, assemblyId,
projects.toArray( new MavenProject[projects.size()] ) );
}
}
}
@SuppressWarnings( "unchecked" )
void updateDependencySetResolutionRequirements( final DependencySet set,
final ResolutionManagementInfo requirements, AssemblyId assemblyId,
final MavenProject... projects )
throws DependencyResolutionException
{
requirements.setResolutionRequired( true );
requirements.setResolvedTransitively( set.isUseTransitiveDependencies() );
enableScope( set.getScope(), requirements );
for ( final MavenProject project : projects )
{
if ( project == null )
{
continue;
}
Set<Artifact> dependencyArtifacts = project.getDependencyArtifacts();
if ( dependencyArtifacts == null )
{
try
{
dependencyArtifacts = project.createArtifacts( factory, null, requirements.getScopeFilter() );
project.setDependencyArtifacts( dependencyArtifacts );
}
catch ( final InvalidDependencyVersionException e )
{
throw new DependencyResolutionException(
"Failed to create dependency artifacts for resolution. Assembly: " + assemblyId, e );
}
}
requirements.addArtifacts( dependencyArtifacts );
getLogger().debug( "Dependencies for project: " + project.getId() + " are:\n" + StringUtils.join(
dependencyArtifacts.iterator(), "\n" ) );
}
}
private void enableScope( final String scope, final ResolutionManagementInfo requirements )
{
if ( Artifact.SCOPE_COMPILE.equals( scope ) )
{
requirements.enableCompileScope();
}
else if ( Artifact.SCOPE_PROVIDED.equals( scope ) )
{
requirements.enableProvidedScope();
}
else if ( Artifact.SCOPE_RUNTIME.equals( scope ) )
{
requirements.enableRuntimeScope();
}
else if ( Artifact.SCOPE_SYSTEM.equals( scope ) )
{
requirements.enableSystemScope();
}
else if ( Artifact.SCOPE_TEST.equals( scope ) )
{
requirements.enableTestScope();
}
}
@SuppressWarnings( "unchecked" )
List<ArtifactRepository> aggregateRemoteArtifactRepositories( final List<ArtifactRepository> remoteRepositories,
final Set<MavenProject> projects )
{
final List<List<ArtifactRepository>> repoLists = new ArrayList<List<ArtifactRepository>>();
repoLists.add( remoteRepositories );
for ( final MavenProject project : projects )
{
repoLists.add( project.getRemoteArtifactRepositories() );
}
final List<ArtifactRepository> remoteRepos = new ArrayList<ArtifactRepository>();
final Set<String> encounteredUrls = new HashSet<String>();
for ( final List<ArtifactRepository> repositoryList : repoLists )
{
if ( ( repositoryList != null ) && !repositoryList.isEmpty() )
{
for ( final ArtifactRepository repo : repositoryList )
{
if ( !encounteredUrls.contains( repo.getUrl() ) )
{
remoteRepos.add( repo );
encounteredUrls.add( repo.getUrl() );
}
}
}
}
return remoteRepos;
}
}