|
| 1 | +package de.rub.nds.enforcer.rules.dependency; |
| 2 | + |
| 3 | +import org.apache.maven.artifact.Artifact; |
| 4 | +import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule; |
| 5 | +import org.apache.maven.enforcer.rule.api.EnforcerRuleError; |
| 6 | +import org.apache.maven.enforcer.rule.api.EnforcerRuleException; |
| 7 | +import org.apache.maven.execution.MavenSession; |
| 8 | +import org.apache.maven.project.DefaultProjectBuildingRequest; |
| 9 | +import org.apache.maven.project.MavenProject; |
| 10 | +import org.apache.maven.project.ProjectBuildingRequest; |
| 11 | +import org.apache.maven.rtinfo.RuntimeInformation; |
| 12 | +import org.apache.maven.shared.dependency.graph.*; |
| 13 | +import org.apache.maven.shared.dependency.graph.traversal.CollectingDependencyNodeVisitor; |
| 14 | + |
| 15 | +import javax.inject.Inject; |
| 16 | +import javax.inject.Named; |
| 17 | +import java.util.*; |
| 18 | + |
| 19 | +@Named("relaxedDependencyConvergence") |
| 20 | +public class RelaxedDependencyConvergenceRule extends AbstractEnforcerRule { |
| 21 | + |
| 22 | + @Inject |
| 23 | + private MavenProject project; |
| 24 | + |
| 25 | + @Inject |
| 26 | + private MavenSession session; |
| 27 | + |
| 28 | + @Inject |
| 29 | + private DependencyCollectorBuilder dependencyCollectorBuilder; |
| 30 | + |
| 31 | + @Override |
| 32 | + public void execute() throws EnforcerRuleException { |
| 33 | + // Collect major versions of all dependencies |
| 34 | + Map<String, Set<String>> majorVersions = new HashMap<>(); |
| 35 | + |
| 36 | + ProjectBuildingRequest buildingRequest = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest()); |
| 37 | + buildingRequest.setProject(project); |
| 38 | + try { |
| 39 | + DependencyNode rootNode = dependencyCollectorBuilder.collectDependencyGraph(buildingRequest, null); |
| 40 | + collectMajorVersions(rootNode, majorVersions); |
| 41 | + } catch (DependencyCollectorBuilderException e) { |
| 42 | + throw new EnforcerRuleError(e); |
| 43 | + } |
| 44 | + |
| 45 | + // Check for major version conflicts (i.e., set size > 1) |
| 46 | + List<String> conflicts = new ArrayList<>(); |
| 47 | + for (Map.Entry<String, Set<String>> entry : majorVersions.entrySet()) { |
| 48 | + if (entry.getValue().size() > 1) { |
| 49 | + conflicts.add(entry.getKey() + " -> major versions: " + entry.getValue()); |
| 50 | + } |
| 51 | + } |
| 52 | + |
| 53 | + // Throw if at least one major version conflict has been detected |
| 54 | + if (!conflicts.isEmpty()) { |
| 55 | + throw new EnforcerRuleException("Major version conflicts detected:\n" + String.join("\n", conflicts)); |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + private void collectMajorVersions(DependencyNode rootNode, Map<String, Set<String>> versions) { |
| 60 | + CollectingDependencyNodeVisitor visitor = new CollectingDependencyNodeVisitor(); |
| 61 | + rootNode.accept(visitor); |
| 62 | + for (DependencyNode node : visitor.getNodes()) { |
| 63 | + Artifact artifact = node.getArtifact(); |
| 64 | + if (artifact == null) { |
| 65 | + continue; |
| 66 | + } |
| 67 | + String key = artifact.getGroupId() + ":" + artifact.getArtifactId(); |
| 68 | + String major; |
| 69 | + if (node.getPremanagedVersion() != null && !isVersionRange(node.getPremanagedVersion())) { |
| 70 | + major = extractMajorVersion(node.getPremanagedVersion()); |
| 71 | + } else { |
| 72 | + major = extractMajorVersion(artifact.getVersion()); |
| 73 | + } |
| 74 | + if (major != null) { |
| 75 | + versions.computeIfAbsent(key, k -> new HashSet<>()).add(major); |
| 76 | + } |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + private String extractMajorVersion(String version) { |
| 81 | + String baseVersion = version.split("-")[0]; |
| 82 | + String[] parts = baseVersion.split("\\."); |
| 83 | + return parts.length > 0 ? parts[0] : version; |
| 84 | + } |
| 85 | + |
| 86 | + private boolean isVersionRange(String version) { |
| 87 | + return version.contains("[") || version.contains("]") || version.contains("(") || version.contains(")"); |
| 88 | + } |
| 89 | + |
| 90 | + @Override |
| 91 | + public String toString() { |
| 92 | + return "RelaxedDependencyConvergenceRule{}"; |
| 93 | + } |
| 94 | +} |
0 commit comments