001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2011 SonarSource 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.plugins.design.batch; 021 022 import org.apache.maven.artifact.Artifact; 023 import org.apache.maven.artifact.factory.ArtifactFactory; 024 import org.apache.maven.artifact.metadata.ArtifactMetadataSource; 025 import org.apache.maven.artifact.repository.ArtifactRepository; 026 import org.apache.maven.artifact.resolver.ArtifactCollector; 027 import org.apache.maven.shared.dependency.tree.DependencyNode; 028 import org.apache.maven.shared.dependency.tree.DependencyTreeBuilder; 029 import org.apache.maven.shared.dependency.tree.DependencyTreeBuilderException; 030 import org.apache.maven.shared.dependency.tree.filter.AncestorOrSelfDependencyNodeFilter; 031 import org.apache.maven.shared.dependency.tree.filter.DependencyNodeFilter; 032 import org.apache.maven.shared.dependency.tree.filter.StateDependencyNodeFilter; 033 import org.apache.maven.shared.dependency.tree.traversal.BuildingDependencyNodeVisitor; 034 import org.apache.maven.shared.dependency.tree.traversal.CollectingDependencyNodeVisitor; 035 import org.apache.maven.shared.dependency.tree.traversal.DependencyNodeVisitor; 036 import org.apache.maven.shared.dependency.tree.traversal.FilteringDependencyNodeVisitor; 037 import org.sonar.api.batch.SupportedEnvironment; 038 import org.sonar.api.batch.Sensor; 039 import org.sonar.api.batch.SensorContext; 040 import org.sonar.api.batch.SonarIndex; 041 import org.sonar.api.design.Dependency; 042 import org.sonar.api.resources.Library; 043 import org.sonar.api.resources.Project; 044 import org.sonar.api.resources.Resource; 045 import org.sonar.api.utils.SonarException; 046 047 @SupportedEnvironment("maven") 048 public class MavenDependenciesSensor implements Sensor { 049 050 private ArtifactRepository localRepository; 051 private ArtifactFactory artifactFactory; 052 private ArtifactMetadataSource artifactMetadataSource; 053 private ArtifactCollector artifactCollector; 054 private DependencyTreeBuilder treeBuilder; 055 private SonarIndex index; 056 057 public MavenDependenciesSensor(ArtifactRepository localRepository, ArtifactFactory artifactFactory, ArtifactMetadataSource artifactMetadataSource, 058 ArtifactCollector artifactCollector, DependencyTreeBuilder treeBuilder, SonarIndex index) { 059 this.localRepository = localRepository; 060 this.artifactFactory = artifactFactory; 061 this.artifactMetadataSource = artifactMetadataSource; 062 this.artifactCollector = artifactCollector; 063 this.index = index; 064 this.treeBuilder = treeBuilder; 065 } 066 067 public boolean shouldExecuteOnProject(Project project) { 068 return true; 069 } 070 071 public void analyse(final Project project, final SensorContext context) { 072 try { 073 DependencyNode root = treeBuilder.buildDependencyTree(project.getPom(), localRepository, artifactFactory, artifactMetadataSource, null, artifactCollector); 074 075 DependencyNodeVisitor visitor = new BuildingDependencyNodeVisitor(new DependencyNodeVisitor() { 076 public boolean visit(DependencyNode node) { 077 return true; 078 } 079 080 public boolean endVisit(DependencyNode node) { 081 if (node.getParent() != null && node.getParent() != node) { 082 saveDependency(node, context); 083 } 084 return true; 085 } 086 }); 087 088 // mode verbose OFF : do not show the same lib many times 089 DependencyNodeFilter filter = StateDependencyNodeFilter.INCLUDED; 090 091 CollectingDependencyNodeVisitor collectingVisitor = new CollectingDependencyNodeVisitor(); 092 DependencyNodeVisitor firstPassVisitor = new FilteringDependencyNodeVisitor(collectingVisitor, filter); 093 root.accept(firstPassVisitor); 094 095 DependencyNodeFilter secondPassFilter = new AncestorOrSelfDependencyNodeFilter(collectingVisitor.getNodes()); 096 visitor = new FilteringDependencyNodeVisitor(visitor, secondPassFilter); 097 098 root.accept(visitor); 099 100 } catch (DependencyTreeBuilderException e) { 101 throw new SonarException("Can not load the graph of dependencies of the project " + project.getKey(), e); 102 } 103 } 104 105 protected void saveDependency(DependencyNode node, SensorContext context) { 106 Resource from = (node.getParent().getParent() == null) ? index.getProject() : toResource(node.getParent().getArtifact(), context); 107 Resource to = toResource(node.getArtifact(), context); 108 Dependency dependency = new Dependency(from, to); 109 dependency.setUsage(node.getArtifact().getScope()); 110 dependency.setWeight(1); 111 context.saveDependency(dependency); 112 } 113 114 protected static Resource toResource(Artifact artifact, SensorContext context) { 115 Project project = Project.createFromMavenIds(artifact.getGroupId(), artifact.getArtifactId()); 116 Resource result = context.getResource(project); 117 if (result == null || !((Project) result).getAnalysisVersion().equals(artifact.getBaseVersion())) { 118 Library lib = new Library(project.getKey(), artifact.getBaseVersion()); 119 context.saveResource(lib); 120 result = context.getResource(lib); 121 } 122 return result; 123 } 124 125 @Override 126 public String toString() { 127 return "Maven dependencies"; 128 } 129 }