001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.resolver.examples;
020
021import org.apache.maven.resolver.examples.util.Booter;
022import org.eclipse.aether.RepositorySystem;
023import org.eclipse.aether.RepositorySystemSession.CloseableSession;
024import org.eclipse.aether.RepositorySystemSession.SessionBuilder;
025import org.eclipse.aether.artifact.Artifact;
026import org.eclipse.aether.artifact.DefaultArtifact;
027import org.eclipse.aether.collection.CollectRequest;
028import org.eclipse.aether.collection.UnsolvableVersionConflictException;
029import org.eclipse.aether.resolution.ArtifactDescriptorRequest;
030import org.eclipse.aether.resolution.ArtifactDescriptorResult;
031import org.eclipse.aether.util.graph.manager.DependencyManagerUtils;
032import org.eclipse.aether.util.graph.transformer.ChainedDependencyGraphTransformer;
033import org.eclipse.aether.util.graph.transformer.ClassicConflictResolver;
034import org.eclipse.aether.util.graph.transformer.ConfigurableVersionSelector;
035import org.eclipse.aether.util.graph.transformer.ConflictResolver;
036import org.eclipse.aether.util.graph.transformer.JavaDependencyContextRefiner;
037import org.eclipse.aether.util.graph.transformer.JavaScopeDeriver;
038import org.eclipse.aether.util.graph.transformer.JavaScopeSelector;
039import org.eclipse.aether.util.graph.transformer.SimpleOptionalitySelector;
040
041/**
042 * Visualizes the transitive dependencies of an artifact similar to m2e's dependency hierarchy view.
043 */
044public class GetDependencyHierarchyWithConflicts {
045
046    /**
047     * Main.
048     * @param args
049     * @throws Exception
050     */
051    public static void main(String[] args) throws Exception {
052        System.out.println("------------------------------------------------------------");
053        System.out.println(GetDependencyHierarchyWithConflicts.class.getSimpleName());
054
055        // incompatible versions: two incompatible versions present in graph
056        try (RepositorySystem system = Booter.newRepositorySystem(Booter.selectFactory(args))) {
057            SessionBuilder sessionBuilder = Booter.newRepositorySystemSession(system);
058            sessionBuilder.setConfigProperty(ConflictResolver.CONFIG_PROP_VERBOSE, true);
059            sessionBuilder.setConfigProperty(DependencyManagerUtils.CONFIG_PROP_VERBOSE, true);
060            try (CloseableSession session = sessionBuilder
061                    .setDependencyGraphTransformer(new ChainedDependencyGraphTransformer(
062                            new ClassicConflictResolver(
063                                    new ConfigurableVersionSelector(
064                                            new ConfigurableVersionSelector.MajorVersionConvergence(
065                                                    new ConfigurableVersionSelector.Nearest())),
066                                    new JavaScopeSelector(),
067                                    new SimpleOptionalitySelector(),
068                                    new JavaScopeDeriver()),
069                            new JavaDependencyContextRefiner()))
070                    .build()) {
071                Artifact artifact = new DefaultArtifact("org.apache.maven.shared:maven-dependency-tree:3.0.1");
072
073                ArtifactDescriptorRequest descriptorRequest = new ArtifactDescriptorRequest();
074                descriptorRequest.setArtifact(artifact);
075                descriptorRequest.setRepositories(Booter.newRepositories(system, session));
076                ArtifactDescriptorResult descriptorResult = system.readArtifactDescriptor(session, descriptorRequest);
077
078                CollectRequest collectRequest = new CollectRequest();
079                collectRequest.setRootArtifact(descriptorResult.getArtifact());
080                collectRequest.setDependencies(descriptorResult.getDependencies());
081                collectRequest.setManagedDependencies(descriptorResult.getManagedDependencies());
082                collectRequest.setRepositories(descriptorRequest.getRepositories());
083
084                system.collectDependencies(session, collectRequest);
085                throw new IllegalStateException("should fail");
086            }
087        } catch (Exception e) {
088            e.printStackTrace();
089            if (e.getCause() instanceof UnsolvableVersionConflictException) {
090                String cause = e.getCause().getMessage();
091                if (!cause.contains(
092                        "Incompatible versions for org.apache.maven:maven-core, incompatible versions: [2.0], all versions [2.0, 3.0.4]")) {
093                    throw new IllegalStateException("should fail due incompatible versions");
094                }
095            } else {
096                throw new IllegalStateException("should fail due incompatible versions");
097            }
098        }
099
100        // dependency divergence: multiple versions of same GA present in graph
101        try (RepositorySystem system = Booter.newRepositorySystem(Booter.selectFactory(args))) {
102            SessionBuilder sessionBuilder = Booter.newRepositorySystemSession(system);
103            sessionBuilder.setConfigProperty(ConflictResolver.CONFIG_PROP_VERBOSE, true);
104            sessionBuilder.setConfigProperty(DependencyManagerUtils.CONFIG_PROP_VERBOSE, true);
105            try (CloseableSession session = sessionBuilder
106                    .setDependencyGraphTransformer(new ChainedDependencyGraphTransformer(
107                            new ClassicConflictResolver(
108                                    new ConfigurableVersionSelector(new ConfigurableVersionSelector.VersionConvergence(
109                                            new ConfigurableVersionSelector.Nearest())),
110                                    new JavaScopeSelector(),
111                                    new SimpleOptionalitySelector(),
112                                    new JavaScopeDeriver()),
113                            new JavaDependencyContextRefiner()))
114                    .build()) {
115                Artifact artifact = new DefaultArtifact("org.apache.maven.shared:maven-dependency-tree:3.1.0");
116
117                ArtifactDescriptorRequest descriptorRequest = new ArtifactDescriptorRequest();
118                descriptorRequest.setArtifact(artifact);
119                descriptorRequest.setRepositories(Booter.newRepositories(system, session));
120                ArtifactDescriptorResult descriptorResult = system.readArtifactDescriptor(session, descriptorRequest);
121
122                CollectRequest collectRequest = new CollectRequest();
123                collectRequest.setRootArtifact(descriptorResult.getArtifact());
124                collectRequest.setDependencies(descriptorResult.getDependencies());
125                collectRequest.setManagedDependencies(descriptorResult.getManagedDependencies());
126                collectRequest.setRepositories(descriptorRequest.getRepositories());
127
128                system.collectDependencies(session, collectRequest);
129                throw new IllegalStateException("should fail");
130            }
131        } catch (Exception e) {
132            e.printStackTrace();
133            if (e.getCause() instanceof UnsolvableVersionConflictException) {
134                String cause = e.getCause().getMessage();
135                if (!cause.contains(
136                        "Convergence violated for org.codehaus.plexus:plexus-utils, versions present: [2.1, 1.5.5, 2.0.6]")) {
137                    throw new IllegalStateException("should fail due convergence violation");
138                }
139            } else {
140                throw new IllegalStateException("should fail due convergence violation");
141            }
142        }
143    }
144}