diff options
author | Bjørn Christian Seime <bjorncs@yahooinc.com> | 2023-09-27 16:45:35 +0200 |
---|---|---|
committer | Bjørn Christian Seime <bjorncs@yahooinc.com> | 2023-09-27 16:45:35 +0200 |
commit | cd633c8cadc784bc28b5c080c7bfd7756f8fa8ff (patch) | |
tree | 6a7e5e04285c69d67237657165a5a74136ef8124 /vespa-enforcer-extensions/src | |
parent | 22c0ed22e2db624475a62f5c3bba6559f7a06e5d (diff) |
Allow properties in rule set
Diffstat (limited to 'vespa-enforcer-extensions/src')
4 files changed, 305 insertions, 438 deletions
diff --git a/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/AllowedDependencies.java b/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/AllowedDependencies.java new file mode 100644 index 00000000000..656e2f52558 --- /dev/null +++ b/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/AllowedDependencies.java @@ -0,0 +1,305 @@ +package com.yahoo.vespa.maven.plugin.enforcer; + +import org.apache.maven.artifact.Artifact; +import org.apache.maven.enforcer.rule.api.AbstractEnforcerRule; +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.execution.MavenSession; +import org.apache.maven.project.DefaultProjectBuildingRequest; +import org.apache.maven.project.MavenProject; +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 javax.inject.Inject; +import javax.inject.Named; +import java.io.File; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Properties; +import java.util.Set; +import java.util.TreeMap; +import java.util.TreeSet; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +/** + * @author bjorncs + */ +@Named("allowedDependencies") +@SuppressWarnings("deprecation") +public class AllowedDependencies extends AbstractEnforcerRule implements EnforcerRule { + + private static final String WRITE_SPEC_PROP = "dependencyEnforcer.writeSpec"; + private static final String GUESS_VERSION = "dependencyEnforcer.guessProperty"; + + @Inject private MavenProject project; + @Inject private MavenSession session; + @Inject private DependencyGraphBuilder graphBuilder; + + // Injected parameters + public List<String> ignored; + public String rootProjectId; + public String specFile; + + @Override + public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { + try { + project = (MavenProject) helper.evaluate("${project}"); + session = (MavenSession) helper.evaluate("${session}"); + graphBuilder = helper.getComponent(DependencyGraphBuilder.class); + } catch (ExpressionEvaluationException | ComponentLookupException e) { + throw new RuntimeException(e); + } + execute(); + } + + public void execute() throws EnforcerRuleException { + var dependencies = getDependenciesOfAllProjects(); + getLog().info("Found %d unique dependencies ".formatted(dependencies.size())); + var specFile = Paths.get(project.getBasedir() + File.separator + this.specFile).normalize(); + var spec = loadDependencySpec(specFile); + var resolved = resolve(spec, dependencies); + if (System.getProperties().containsKey(WRITE_SPEC_PROP)) { + writeDependencySpec(specFile, resolved, System.getProperties().containsKey(GUESS_VERSION)); + getLog().info("Updated spec file '%s'".formatted(specFile.toString())); + } else { + warnOnDuplicateVersions(resolved); + validateDependencies(resolved, session.getRequest().getPom().toPath(), project.getArtifactId()); + } + getLog().info("The dependency enforcer completed successfully"); + } + + private static void validateDependencies(Resolved resolved, Path aggregatorPomRoot, String moduleName) + throws EnforcerRuleException { + if (!resolved.unmatchedRules().isEmpty() || !resolved.unmatchedDeps().isEmpty()) { + var errorMsg = new StringBuilder("The dependency enforcer failed:\n"); + if (!resolved.unmatchedRules().isEmpty()) { + errorMsg.append("Rules not matching any dependency:\n"); + resolved.unmatchedRules().forEach(r -> errorMsg.append(" - ").append(r.asString()).append('\n')); + } + if (!resolved.unmatchedDeps().isEmpty()) { + errorMsg.append("Dependencies not matching any rule:\n"); + resolved.unmatchedDeps().forEach(d -> errorMsg.append(" - ").append(d.asString(null)).append('\n')); + } + throw new EnforcerRuleException( + errorMsg.append("Maven dependency validation failed. ") + .append("If this change was intentional, update the dependency spec by running:\n") + .append("$ mvn validate -D").append(WRITE_SPEC_PROP).append(" -pl :").append(moduleName) + .append(" -f ").append(aggregatorPomRoot).append("\n").toString()); + } + } + + private Set<Dependency> getDependenciesOfAllProjects() throws EnforcerRuleException { + try { + Pattern depIgnorePattern = Pattern.compile( + ignored.stream() + .map(s -> s.replace(".", "\\.").replace("*", ".*").replace(":", "\\:").replace('?', '.')) + .collect(Collectors.joining(")|(", "^(", ")$"))); + List<MavenProject> projects = getAllProjects(session, rootProjectId); + Set<Dependency> dependencies = new HashSet<>(); + for (MavenProject project : projects) { + var req = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest()); + req.setProject(project); + var root = graphBuilder.buildDependencyGraph(req, null); + addDependenciesRecursive(root, dependencies, depIgnorePattern); + } + return Set.copyOf(dependencies); + } catch (DependencyGraphBuilderException e) { + throw new RuntimeException(e.getMessage(), e); + } + } + + private static void addDependenciesRecursive(DependencyNode node, Set<Dependency> dependencies, Pattern ignored) { + if (node.getChildren() != null) { + for (DependencyNode dep : node.getChildren()) { + Artifact a = dep.getArtifact(); + Dependency dependency = Dependency.fromArtifact(a); + if (!ignored.matcher(dependency.asString(null)).matches()) { + dependencies.add(dependency); + } + addDependenciesRecursive(dep, dependencies, ignored); + } + } + } + + /** Only return the projects we'd like to enforce dependencies for: the root project, its modules, their modules, etc. */ + private static List<MavenProject> getAllProjects(MavenSession session, String rootProjectId) throws EnforcerRuleException { + if (rootProjectId == null) throw new EnforcerRuleException("Missing required <rootProjectId> in <enforceDependencies> in pom.xml"); + + List<MavenProject> allProjects = session.getAllProjects(); + if (allProjects.size() == 1) { + throw new EnforcerRuleException( + "Only a single Maven module detected. Enforcer must be executed from root of aggregator pom."); + } + MavenProject rootProject = allProjects + .stream() + .filter(project -> rootProjectId.equals(projectIdOf(project))) + .findAny() + .orElseThrow(() -> new EnforcerRuleException("Root project not found: " + rootProjectId)); + + Map<Path, MavenProject> projectsByBaseDir = allProjects + .stream() + .collect(Collectors.toMap(project -> project.getBasedir().toPath().normalize(), project -> project)); + + var projects = new ArrayList<MavenProject>(); + + var pendingProjects = new ArrayDeque<MavenProject>(); + pendingProjects.add(rootProject); + + while (!pendingProjects.isEmpty()) { + MavenProject project = pendingProjects.pop(); + projects.add(project); + + for (var module : project.getModules()) { + // Assumption: The module is a relative path to a project base directory. + Path moduleBaseDir = project.getBasedir().toPath().resolve(module).normalize(); + MavenProject moduleProject = projectsByBaseDir.get(moduleBaseDir); + if (moduleProject == null) + throw new EnforcerRuleException("Failed to find module '" + module + "' in project " + project.getBasedir()); + pendingProjects.add(moduleProject); + } + } + + projects.sort(Comparator.comparing(AllowedDependencies::projectIdOf)); + return projects; + } + + private List<Rule> loadDependencySpec(Path specFile) { + try (Stream<String> s = Files.lines(specFile)) { + return s.map(String::trim) + .filter(l -> !l.isEmpty() && !l.startsWith("#")) + .map(Rule::fromString) + .toList(); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private Resolved resolve(List<Rule> spec, Set<Dependency> dependencies) { + var resolvedDeps = new HashSet<Dependency>(); + var resolveRules = new HashSet<Rule>(); + var unmatchedDeps = new HashSet<Dependency>(); + var unmatchedRules = new HashSet<Rule>(); + for (var rule : spec) { + var requiredDependency = rule.resolveToDependency(project.getProperties()); + if (dependencies.contains(requiredDependency)) { + resolvedDeps.add(requiredDependency); + resolveRules.add(rule); + } else { + unmatchedRules.add(rule); + } + } + for (var dependency : dependencies) { + if (!resolvedDeps.contains(dependency)) { + unmatchedDeps.add(dependency); + } + } + return new Resolved(resolvedDeps, resolveRules, unmatchedDeps, unmatchedRules); + } + + void writeDependencySpec(Path specFile, Resolved resolved, boolean guessVersion) { + var content = new TreeSet<String>(); + resolved.matchedRules().forEach(r -> content.add(r.asString())); + resolved.unmatchedDeps().forEach(d -> content.add(d.asString(guessVersion ? project.getProperties() : null))); + try (var out = Files.newBufferedWriter(specFile)) { + out.write("# Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.\n\n"); + for (var line : content) { + out.write(line); out.write('\n'); + } + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + private void warnOnDuplicateVersions(Resolved resolved) { + Map<String, Set<String>> versionsForDependency = new TreeMap<>(); + Set<Dependency> allDeps = new HashSet<>(resolved.matchedDeps()); + allDeps.addAll(resolved.unmatchedDeps()); + for (Dependency d : allDeps) { + String id = "%s:%s".formatted(d.groupId(), d.artifactId()); + versionsForDependency.computeIfAbsent(id, __ -> new TreeSet<>()).add(d.version()); + } + versionsForDependency.forEach((dependency, versions) -> { + if (versions.size() > 1) { + getLog().warn("'%s' has multiple versions %s".formatted(dependency, versions)); + } + }); + } + + private static String projectIdOf(MavenProject project) { return "%s:%s".formatted(project.getGroupId(), project.getArtifactId()); } + + private record Rule(String groupId, String artifactId, String version, Optional<String> classifier){ + static final Pattern PROPERTY_PATTERN = Pattern.compile("\\$\\{(.+?)}"); + + static Rule fromString(String s) { + String[] splits = s.split(":"); + return splits.length == 3 + ? new Rule(splits[0], splits[1], splits[2], Optional.empty()) + : new Rule(splits[0], splits[1], splits[2], Optional.of(splits[3])); + } + + Dependency resolveToDependency(Properties props) { + // Replace expressions on form ${property} in 'version' field with value from properties + var matcher = PROPERTY_PATTERN.matcher(version); + var resolvedVersion = version; + while (matcher.find()) { + String property = matcher.group(1); + String value = props.getProperty(property); + if (value == null) throw new IllegalArgumentException("Missing property: " + property); + resolvedVersion = version.replace(matcher.group(), value); + } + return new Dependency(groupId, artifactId, resolvedVersion, classifier); + } + + String asString() { + var b = new StringBuilder(groupId).append(':').append(artifactId).append(':').append(version); + classifier.ifPresent(c -> b.append(':').append(c)); + return b.toString(); + } + } + + record Dependency(String groupId, String artifactId, String version, Optional<String> classifier) { + static Dependency fromArtifact(Artifact a) { + return new Dependency( + a.getGroupId(), a.getArtifactId(), a.getVersion(), Optional.ofNullable(a.getClassifier())); + } + + String asString(Properties props) { + String versionStr = version; + if (props != null) { + // Guess property name if properties are provided + var matchingProps = props.entrySet().stream() + .filter(e -> e.getValue().equals(version)) + .map(v -> "${%s}".formatted(v.getKey())) + .collect(Collectors.joining("|")); + if (!matchingProps.isEmpty()) versionStr = matchingProps; + } + var b = new StringBuilder(groupId).append(':').append(artifactId).append(':').append(versionStr); + classifier.ifPresent(c -> b.append(':').append(c)); + return b.toString(); + } + } + + record Resolved(Set<Dependency> matchedDeps, Set<Rule> matchedRules, + Set<Dependency> unmatchedDeps, Set<Rule> unmatchedRules) {} + + // Mark rule as not cachable + @Override public boolean isCacheable() { return false; } + @Override public boolean isResultValid(EnforcerRule r) { return false; } + @Override public String getCacheId() { return ""; } +} diff --git a/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjects.java b/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjects.java deleted file mode 100644 index 3db1019a2b1..00000000000 --- a/vespa-enforcer-extensions/src/main/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjects.java +++ /dev/null @@ -1,319 +0,0 @@ -// Copyright Yahoo. 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.enforcer.rule.api.EnforcerRule; -import org.apache.maven.enforcer.rule.api.EnforcerRuleException; -import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; -import org.apache.maven.execution.MavenSession; -import org.apache.maven.plugin.logging.Log; -import org.apache.maven.project.DefaultProjectBuildingRequest; -import org.apache.maven.project.MavenProject; -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.io.File; -import java.io.IOException; -import java.io.UncheckedIOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.ArrayDeque; -import java.util.ArrayList; -import java.util.Comparator; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.Set; -import java.util.SortedSet; -import java.util.TreeMap; -import java.util.TreeSet; -import java.util.regex.Pattern; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -/** - * @author bjorncs - */ -@SuppressWarnings("deprecation") -public class EnforceDependenciesAllProjects implements EnforcerRule { - - private static final String WRITE_SPEC_PROP = "dependencyEnforcer.writeSpec"; - private static final String NON_TEST_HEADER = "#[non-test]"; - private static final String TEST_ONLY_HEADER = "#[test-only]"; - - private String rootProjectId; - private String specFile; - private List<String> ignored = List.of(); - private List<String> testUtilProjects = List.of(); - - @Override - public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { - Log log = helper.getLog(); - Dependencies deps = getDependenciesOfAllProjects(helper, ignored, testUtilProjects, rootProjectId); - log.info("Found %d unique dependencies (%d non-test, %d test only)".formatted( - deps.nonTest().size() + deps.testOnly().size(), deps.nonTest().size(), deps.testOnly().size())); - Path specFile = resolveSpecFile(helper, this.specFile); - if (System.getProperties().containsKey(WRITE_SPEC_PROP)) { - writeDependencySpec(specFile, deps); - log.info("Updated spec file '%s'".formatted(specFile.toString())); - } else { - warnOnDuplicateVersions(log, deps); - validateDependencies(deps, specFile, aggregatorPomRoot(helper), projectName(helper)); - } - log.info("The dependency enforcer completed successfully"); - } - - // Config injection for rule configuration. Method names must match config XML elements. - @SuppressWarnings("unused") public void setRootProjectId(String l) { this.rootProjectId = l; } - @SuppressWarnings("unused") public String getRootProjectId() { return rootProjectId; } - @SuppressWarnings("unused") public void setSpecFile(String f) { this.specFile = f; } - @SuppressWarnings("unused") public String getSpecFile() { return specFile; } - @SuppressWarnings("unused") public void setIgnored(List<String> l) { this.ignored = l; } - @SuppressWarnings("unused") public List<String> getIgnored() { return ignored; } - @SuppressWarnings("unused") public void setTestUtilProjects(List<String> l) { this.testUtilProjects = l; } - @SuppressWarnings("unused") public List<String> getTestUtilProjects() { return testUtilProjects; } - - record Dependency(String groupId, String artifactId, String version, Optional<String> classifier) - implements Comparable<Dependency> { - static Dependency fromArtifact(Artifact a) { - return new Dependency( - a.getGroupId(), a.getArtifactId(), a.getVersion(), Optional.ofNullable(a.getClassifier())); - } - - static Dependency fromString(String s) { - String[] splits = s.split(":"); - return splits.length == 3 - ? new Dependency(splits[0], splits[1], splits[2], Optional.empty()) - : new Dependency(splits[0], splits[1], splits[2], Optional.of(splits[3])); - } - - String asString() { - var b = new StringBuilder(groupId).append(':').append(artifactId).append(':').append(version); - classifier.ifPresent(c -> b.append(':').append(c)); - return b.toString(); - } - - static final Comparator<Dependency> COMPARATOR = Comparator.comparing(Dependency::groupId) - .thenComparing(Dependency::artifactId).thenComparing(Dependency::version) - .thenComparing(d -> d.classifier().orElse("")); - @Override public int compareTo(Dependency o) { return COMPARATOR.compare(this, o); } - } - - record Dependencies(SortedSet<Dependency> nonTest, SortedSet<Dependency> testOnly) {} - - static void validateDependencies(Dependencies dependencies, Path specFile, Path aggregatorPomRoot, - String moduleName) - throws EnforcerRuleException { - Dependencies allowedDependencies = loadDependencySpec(specFile); - if (!allowedDependencies.equals(dependencies)) { - StringBuilder errorMsg = new StringBuilder("The dependency enforcer failed:\n"); - generateDiff(errorMsg, "non-test", dependencies.nonTest(), allowedDependencies.nonTest()); - generateDiff(errorMsg, "test-only", dependencies.testOnly(), allowedDependencies.testOnly()); - throw new EnforcerRuleException( - errorMsg.append("Maven dependency validation failed. ") - .append("If this change was intentional, update the dependency spec by running:\n") - .append("$ mvn validate -D").append(WRITE_SPEC_PROP).append(" -pl :").append(moduleName) - .append(" -f ").append(aggregatorPomRoot).append("\n").toString()); - } - } - - static void generateDiff( - StringBuilder errorMsg, String label, SortedSet<Dependency> actual, SortedSet<Dependency> expected) { - SortedSet<Dependency> forbidden = new TreeSet<>(actual); - forbidden.removeAll(expected); - SortedSet<Dependency> removed = new TreeSet<>(expected); - removed.removeAll(actual); - if (!forbidden.isEmpty()) { - errorMsg.append("Forbidden ").append(label).append(" dependencies:\n"); - forbidden.forEach(d -> errorMsg.append(" - ").append(d.asString()).append('\n')); - } - if (!removed.isEmpty()) { - errorMsg.append("Removed ").append(label).append(" dependencies:\n"); - removed.forEach(d -> errorMsg.append(" - ").append(d.asString()).append('\n')); - } - } - - private static Dependencies getDependenciesOfAllProjects(EnforcerRuleHelper helper, List<String> ignored, - List<String> testUtilProjects, String rootProjectId) - throws EnforcerRuleException { - try { - Pattern depIgnorePattern = Pattern.compile( - ignored.stream() - .map(s -> s.replace(".", "\\.").replace("*", ".*").replace(":", "\\:").replace('?', '.')) - .collect(Collectors.joining(")|(", "^(", ")$"))); - Pattern projectIgnorePattern = Pattern.compile( - testUtilProjects.stream() - .map(s -> s.replace(".", "\\.").replace("*", ".*").replace(":", "\\:").replace('?', '.')) - .collect(Collectors.joining(")|(", "^(", ")$"))); - SortedSet<Dependency> nonTestDeps = new TreeSet<>(); - SortedSet<Dependency> testDeps = new TreeSet<>(); - MavenSession session = mavenSession(helper); - var graphBuilder = helper.getComponent(DependencyGraphBuilder.class); - List<MavenProject> projects = getAllProjects(session, rootProjectId); - for (MavenProject project : projects) { - var req = new DefaultProjectBuildingRequest(session.getProjectBuildingRequest()); - req.setProject(project); - DependencyNode root = graphBuilder.buildDependencyGraph(req, null); - String projectId = projectIdOf(project); - boolean overrideToTest = projectIgnorePattern.matcher(projectId).matches(); - if (overrideToTest) helper.getLog().info("Treating dependencies of '%s' as 'test'".formatted(projectId)); - addDependenciesRecursive(root, nonTestDeps, testDeps, depIgnorePattern, overrideToTest); - } - testDeps.removeAll(nonTestDeps); - return new Dependencies(nonTestDeps, testDeps); - } catch (DependencyGraphBuilderException | ComponentLookupException e) { - throw new RuntimeException(e.getMessage(), e); - } - } - - private static String projectIdOf(MavenProject project) { return "%s:%s".formatted(project.getGroupId(), project.getArtifactId()); } - - /** Only return the projects we'd like to enforce dependencies for: the root project, its modules, their modules, etc. */ - private static List<MavenProject> getAllProjects(MavenSession session, String rootProjectId) throws EnforcerRuleException { - if (rootProjectId == null) throw new EnforcerRuleException("Missing required <rootProjectId> in <enforceDependencies> in pom.xml"); - - List<MavenProject> allProjects = session.getAllProjects(); - if (allProjects.size() == 1) { - throw new EnforcerRuleException( - "Only a single Maven module detected. Enforcer must be executed from root of aggregator pom."); - } - MavenProject rootProject = allProjects - .stream() - .filter(project -> rootProjectId.equals(projectIdOf(project))) - .findAny() - .orElseThrow(() -> new EnforcerRuleException("Root project not found: " + rootProjectId)); - - Map<Path, MavenProject> projectsByBaseDir = allProjects - .stream() - .collect(Collectors.toMap(project -> project.getBasedir().toPath().normalize(), project -> project)); - - var projects = new ArrayList<MavenProject>(); - - var pendingProjects = new ArrayDeque<MavenProject>(); - pendingProjects.add(rootProject); - - while (!pendingProjects.isEmpty()) { - MavenProject project = pendingProjects.pop(); - projects.add(project); - - for (var module : project.getModules()) { - // Assumption: The module is a relative path to a project base directory. - Path moduleBaseDir = project.getBasedir().toPath().resolve(module).normalize(); - MavenProject moduleProject = projectsByBaseDir.get(moduleBaseDir); - if (moduleProject == null) - throw new EnforcerRuleException("Failed to find module '" + module + "' in project " + project.getBasedir()); - pendingProjects.add(moduleProject); - } - } - - projects.sort(Comparator.comparing(EnforceDependenciesAllProjects::projectIdOf)); - return projects; - } - - private static void addDependenciesRecursive( - DependencyNode node, Set<Dependency> nonTestDeps, Set<Dependency> testDeps, Pattern ignored, - boolean overrideToTest) { - if (node.getChildren() != null) { - for (DependencyNode dep : node.getChildren()) { - Artifact a = dep.getArtifact(); - Dependency dependency = Dependency.fromArtifact(a); - if (!ignored.matcher(dependency.asString()).matches()) { - if (a.getScope().equals("test") || overrideToTest) { - testDeps.add(dependency); - } else { - nonTestDeps.add(dependency); - } - } - addDependenciesRecursive(dep, nonTestDeps, testDeps, ignored, overrideToTest); - } - } - } - - private static void warnOnDuplicateVersions(Log log, Dependencies deps) { - Map<String, Set<String>> versionsForDependency = new TreeMap<>(); - Set<Dependency> allDeps = new TreeSet<>(deps.nonTest()); - allDeps.addAll(deps.testOnly()); - for (Dependency d : allDeps) { - String id = "%s:%s".formatted(d.groupId(), d.artifactId()); - versionsForDependency.computeIfAbsent(id, __ -> new TreeSet<>()).add(d.version()); - } - versionsForDependency.forEach((dependency, versions) -> { - if (versions.size() > 1) { - log.warn("'%s' has multiple versions %s".formatted(dependency, versions)); - } - }); - } - - private static Path resolveSpecFile(EnforcerRuleHelper helper, String specFile) { - return Paths.get(mavenProject(helper).getBasedir() + File.separator + specFile).normalize(); - } - - private static String projectName(EnforcerRuleHelper helper) { return mavenProject(helper).getArtifactId(); } - - private static Path aggregatorPomRoot(EnforcerRuleHelper helper) { - return mavenSession(helper).getRequest().getPom().toPath(); - } - - private static MavenProject mavenProject(EnforcerRuleHelper helper) { - try { - return (MavenProject) helper.evaluate("${project}"); - } catch (ExpressionEvaluationException e) { - throw new RuntimeException(e.getMessage(), e); - } - } - - private static MavenSession mavenSession(EnforcerRuleHelper helper) { - try { - return (MavenSession) helper.evaluate("${session}"); - } catch (ExpressionEvaluationException e) { - throw new RuntimeException(e.getMessage(), e); - } - } - - static void writeDependencySpec(Path specFile, Dependencies dependencies) { - try (var out = Files.newBufferedWriter(specFile)) { - out.write("# Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.\n\n"); - out.write(NON_TEST_HEADER); out.write('\n'); - out.write("# Contains dependencies that are not used exclusively in 'test' scope\n"); - for (Dependency d : dependencies.nonTest()) { - out.write(d.asString()); out.write('\n'); - } - out.write("\n"); out.write(TEST_ONLY_HEADER); out.write('\n'); - out.write("# Contains dependencies that are used exclusively in 'test' scope\n"); - for (Dependency d : dependencies.testOnly()) { - out.write(d.asString()); out.write('\n'); - } - } catch (IOException e) { - throw new UncheckedIOException(e); - } - } - - private static Dependencies loadDependencySpec(Path specFile) { - try { - List<String> lines; - try (Stream<String> s = Files.lines(specFile)) { - lines = s.map(String::trim).filter(l -> !l.isEmpty()).toList(); - } - SortedSet<Dependency> nonTest = parseDependencies(lines.stream().takeWhile(l -> !l.equals(TEST_ONLY_HEADER))); - SortedSet<Dependency> testOnly = parseDependencies(lines.stream().dropWhile(l -> !l.equals(TEST_ONLY_HEADER))); - return new Dependencies(nonTest, testOnly); - } catch (IOException e) { - throw new UncheckedIOException(e); - } - } - - private static SortedSet<Dependency> parseDependencies(Stream<String> lines) { - return lines.filter(l -> !l.startsWith("#")).map(Dependency::fromString) - .collect(Collectors.toCollection(TreeSet::new)); - } - - // Mark rule as not cachable - @Override public boolean isCacheable() { return false; } - @Override public boolean isResultValid(EnforcerRule r) { return false; } - @Override public String getCacheId() { return ""; } - -} diff --git a/vespa-enforcer-extensions/src/test/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjectsTest.java b/vespa-enforcer-extensions/src/test/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjectsTest.java deleted file mode 100644 index 59062cbd61c..00000000000 --- a/vespa-enforcer-extensions/src/test/java/com/yahoo/vespa/maven/plugin/enforcer/EnforceDependenciesAllProjectsTest.java +++ /dev/null @@ -1,108 +0,0 @@ -// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -package com.yahoo.vespa.maven.plugin.enforcer; - -import com.yahoo.vespa.maven.plugin.enforcer.EnforceDependenciesAllProjects.Dependencies; -import com.yahoo.vespa.maven.plugin.enforcer.EnforceDependenciesAllProjects.Dependency; -import org.apache.maven.enforcer.rule.api.EnforcerRuleException; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.io.TempDir; - -import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.Set; -import java.util.SortedSet; -import java.util.TreeSet; - -import static com.yahoo.vespa.maven.plugin.enforcer.EnforceDependenciesAllProjects.validateDependencies; -import static com.yahoo.vespa.maven.plugin.enforcer.EnforceDependenciesAllProjects.writeDependencySpec; -import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertThrows; - -/** - * @author bjorncs - */ -class EnforceDependenciesAllProjectsTest { - - private static final Path POM_FILE = Paths.get("/vespa-src/pom.xml"); - - @Test - void succeeds_dependencies_matches_spec() { - SortedSet<Dependency> nonTest = new TreeSet<>(Set.of( - Dependency.fromString("com.example:foo:1.2.3"), - Dependency.fromString("com.example:bar:2.3.4"))); - SortedSet<Dependency> testOnly = new TreeSet<>(Set.of( - Dependency.fromString("com.example:testfoo:1.2.3"), - Dependency.fromString("com.example:testbar:2.3.4"))); - Path specFile = Paths.get("src/test/resources/allowed-dependencies.txt"); - Dependencies deps = new Dependencies(nonTest, testOnly); - assertDoesNotThrow(() -> validateDependencies(deps, specFile, POM_FILE, "my-dep-enforcer")); - } - - @Test - void fails_on_forbidden_dependency() { - SortedSet<Dependency> nonTest = new TreeSet<>(Set.of( - Dependency.fromString("com.example:foo:1.2.3"), - Dependency.fromString("com.example:bar:2.3.4"), - Dependency.fromString("com.example:foobar:3.4.5"))); - SortedSet<Dependency> testOnly = new TreeSet<>(Set.of( - Dependency.fromString("com.example:testfoo:1.2.3"), - Dependency.fromString("com.example:testbar:2.3.4"))); - Path specFile = Paths.get("src/test/resources/allowed-dependencies.txt"); - Dependencies deps = new Dependencies(nonTest, testOnly); - var exception = assertThrows(EnforcerRuleException.class, - () -> validateDependencies(deps, specFile, POM_FILE, "my-dep-enforcer")); - String expectedErrorMessage = - """ - The dependency enforcer failed: - Forbidden non-test dependencies: - - com.example:foobar:3.4.5 - Maven dependency validation failed. If this change was intentional, update the dependency spec by running: - $ mvn validate -DdependencyEnforcer.writeSpec -pl :my-dep-enforcer -f /vespa-src/pom.xml - """; - assertEquals(expectedErrorMessage, exception.getMessage()); - } - - @Test - void fails_on_missing_dependency() { - SortedSet<Dependency> nonTest = new TreeSet<>(Set.of( - Dependency.fromString("com.example:bar:2.3.4"))); - SortedSet<Dependency> testOnly = new TreeSet<>(Set.of( - Dependency.fromString("com.example:testfoo:1.2.3"))); - Path specFile = Paths.get("src/test/resources/allowed-dependencies.txt"); - Dependencies deps = new Dependencies(nonTest, testOnly); - var exception = assertThrows(EnforcerRuleException.class, - () -> validateDependencies(deps, specFile, POM_FILE, "my-dep-enforcer")); - String expectedErrorMessage = - """ - The dependency enforcer failed: - Removed non-test dependencies: - - com.example:foo:1.2.3 - Removed test-only dependencies: - - com.example:testbar:2.3.4 - Maven dependency validation failed. If this change was intentional, update the dependency spec by running: - $ mvn validate -DdependencyEnforcer.writeSpec -pl :my-dep-enforcer -f /vespa-src/pom.xml - """; - assertEquals(expectedErrorMessage, exception.getMessage()); - } - - @Test - void writes_valid_spec_file(@TempDir Path tempDir) throws IOException { - SortedSet<Dependency> nonTest = new TreeSet<>(Set.of( - Dependency.fromString("com.example:foo:1.2.3"), - Dependency.fromString("com.example:bar:2.3.4"))); - SortedSet<Dependency> testOnly = new TreeSet<>(Set.of( - Dependency.fromString("com.example:testfoo:1.2.3"), - Dependency.fromString("com.example:testbar:2.3.4"))); - Dependencies deps = new Dependencies(nonTest, testOnly); - Path outputFile = tempDir.resolve("allowed-dependencies.txt"); - writeDependencySpec(outputFile, deps); - assertEquals( - Files.readString(Paths.get("src/test/resources/allowed-dependencies.txt")), - Files.readString(outputFile)); - - } - -}
\ No newline at end of file diff --git a/vespa-enforcer-extensions/src/test/resources/allowed-dependencies.txt b/vespa-enforcer-extensions/src/test/resources/allowed-dependencies.txt deleted file mode 100644 index 2ef0f9e0c0c..00000000000 --- a/vespa-enforcer-extensions/src/test/resources/allowed-dependencies.txt +++ /dev/null @@ -1,11 +0,0 @@ -# Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. - -#[non-test] -# Contains dependencies that are not used exclusively in 'test' scope -com.example:bar:2.3.4 -com.example:foo:1.2.3 - -#[test-only] -# Contains dependencies that are used exclusively in 'test' scope -com.example:testbar:2.3.4 -com.example:testfoo:1.2.3 |