1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.maven.plugin.enforcer;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.enforcer.rule.api.EnforcerRule;
import org.apache.maven.enforcer.rule.api.EnforcerRuleException;
import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
import org.apache.maven.enforcer.rules.utils.ArtifactMatcher;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.project.DefaultProjectBuildingRequest;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.ProjectBuildingRequest;
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
import org.codehaus.plexus.component.repository.exception.ComponentLookupException;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.regex.Pattern;
/**
* Enforces that all expected dependencies are present.
* Fails by default for rules that do not match any dependencies.
* Similar to the built-in 'bannedDependencies' rule in maven-enforcer-plugin.
*
* @author bjorncs
*/
@SuppressWarnings("deprecation")
public class EnforceDependencies implements EnforcerRule {
private List<String> allowedDependencies = List.of();
private boolean failOnUnmatched = true;
@Override
public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException {
validateDependencies(getAllDependencies(helper), Set.copyOf(allowedDependencies), failOnUnmatched);
helper.getLog().info("The 'enforceDependencies' validation completed successfully");
}
static void validateDependencies(Set<Artifact> dependencies, Set<String> allowedRules, boolean failOnUnmatched)
throws EnforcerRuleException {
SortedSet<Artifact> unmatchedArtifacts = new TreeSet<>();
Set<String> matchedRules = new HashSet<>();
for (Artifact dependency : dependencies) {
boolean matches = false;
for (String rule : allowedRules) {
if (matches(dependency, rule)){
matchedRules.add(rule);
matches = true;
break;
}
}
if (!matches) {
unmatchedArtifacts.add(dependency);
}
}
SortedSet<String> unmatchedRules = new TreeSet<>(allowedRules);
unmatchedRules.removeAll(matchedRules);
if (!unmatchedArtifacts.isEmpty() || (failOnUnmatched && !unmatchedRules.isEmpty())) {
StringBuilder errorMessage = new StringBuilder("Vespa dependency enforcer failed:\n");
if (!unmatchedArtifacts.isEmpty()) {
errorMessage.append("Dependencies not matching any rule:\n");
unmatchedArtifacts.forEach(a -> errorMessage.append(" - ").append(a.toString()).append('\n'));
}
if (failOnUnmatched && !unmatchedRules.isEmpty()) {
errorMessage.append("Rules not matching any dependency:\n");
unmatchedRules.forEach(p -> errorMessage.append(" - ").append(p).append('\n'));
}
throw new EnforcerRuleException(errorMessage.toString());
}
}
private static Set<Artifact> getAllDependencies(EnforcerRuleHelper helper) throws EnforcerRuleException {
try {
MavenProject project = (MavenProject) helper.evaluate("${project}");
MavenSession session = (MavenSession) helper.evaluate("${session}");
DependencyGraphBuilder graphBuilder = helper.getComponent(DependencyGraphBuilder.class);
ProjectBuildingRequest buildingRequest =
new DefaultProjectBuildingRequest(session.getProjectBuildingRequest());
buildingRequest.setProject(project);
DependencyNode root = graphBuilder.buildDependencyGraph(buildingRequest, null);
return getAllRecursive(root);
} catch (ExpressionEvaluationException | DependencyGraphBuilderException | ComponentLookupException e) {
throw new EnforcerRuleException(e.getMessage(), e);
}
}
private static Set<Artifact> getAllRecursive(DependencyNode node) {
Set<Artifact> children = new LinkedHashSet<>();
if (node.getChildren() != null) {
for (DependencyNode dep : node.getChildren()) {
children.add(dep.getArtifact());
children.addAll(getAllRecursive(dep));
}
}
return children;
}
/**
* Rules follows same structure as {@link DefaultArtifact#toString} output.
* Allowed variants:
* - {@code <groupId>:<artifactId>:<version>:<scope>}
* - {@code <groupId>:<artifactId>:<type>:<version>:<scope>}
* - {@code <groupId>:<artifactId>:<type>:<classifier>:<version>:<scope>}
*/
private static boolean matches(Artifact dependency, String rule) throws EnforcerRuleException {
String[] segments = rule.split(":");
if (segments.length < 4 || segments.length > 6) throw new EnforcerRuleException("Invalid rule: " + rule);
int index = 0;
if (!segmentMatches(dependency.getGroupId(), segments[index++])) return false;
if (!segmentMatches(dependency.getArtifactId(), segments[index++])) return false;
if (segments.length >= 5) {
if (!segmentMatches(dependency.getType(), segments[index++])) return false;
}
if (segments.length == 6) {
if (!dependency.hasClassifier() || !segmentMatches(dependency.getClassifier(), segments[index++])) return false;
} else {
if (dependency.hasClassifier()) return false;
}
if (!versionMatches(dependency.getVersion(), segments[index++])) return false;
return segmentMatches(dependency.getScope(), segments[index]);
}
/** Matches simple glob like patterns using '?' and '*' */
private static boolean segmentMatches(String value, String segmentPattern) {
String regex = segmentPattern
.replace(".", "\\.").replace("*", ".*").replace(":", "\\:")
.replace('?', '.').replace("(", "\\(").replace(")", "\\)")
.replace("[", "\\[").replace("]", "\\]");
return Pattern.matches(regex, value);
}
private static boolean versionMatches(String rawVersion, String segmentPattern) throws EnforcerRuleException {
if (segmentMatches(rawVersion, segmentPattern)) return true;
// Handle version ranges. Note that ArtifactMatcher treats a single version without brackets as a minimum version.
if (! (segmentPattern.startsWith("[") || segmentPattern.startsWith("("))) return false;
try {
var range = VersionRange.createFromVersionSpec(segmentPattern);
return ArtifactMatcher.containsVersion(range, new DefaultArtifactVersion(rawVersion));
} catch (InvalidVersionSpecificationException e) {
throw new EnforcerRuleException("Invalid version range: " + segmentPattern, e);
}
}
public void setAllowed(List<String> allowed) { this.allowedDependencies = allowed; }
public List<String> getAllowed() { return allowedDependencies; }
public void setFailOnUnmatchedRule(boolean enabled) { this.failOnUnmatched = enabled; }
public boolean isFailOnUnmatchedRule() { return failOnUnmatched; }
// Mark rule as not cachable
@Override public boolean isCacheable() { return false; }
@Override public boolean isResultValid(EnforcerRule enforcerRule) { return false; }
@Override public String getCacheId() { return ""; }
}
|
