feat: start implementation on maven-based provisioner

simschla · simschla · commit 7d698a0b2068 · 2025-11-26T16:17:25.000+01:00
diff --git a/provisioner/build.gradle b/provisioner/build.gradle
@@ -1,22 +1,31 @@
 plugins {
-    id 'buildlogic.java-library-conventions'
+	id 'buildlogic.java-library-conventions'
 }
 
 version = rootProject.version
 
 dependencies {
-//
-//    implementation libs.bundles.maven.resolver.libs
+	//
+	//    implementation libs.bundles.maven.resolver.libs
 
-    implementation( platform("org.apache.maven:maven-resolver-provider:3.9.11"))
-    implementation( "org.apache.maven:maven-resolver-provider")
-    implementation "org.apache.maven.resolver:maven-resolver-api"
-    implementation "org.apache.maven.resolver:maven-resolver-spi"
-    implementation "org.apache.maven.resolver:maven-resolver-util"
-    implementation "org.apache.maven.resolver:maven-resolver-impl"
-    implementation "org.apache.maven.resolver:maven-resolver-connector-basic"
-    implementation "org.apache.maven.resolver:maven-resolver-transport-file"
-    implementation "org.apache.maven.resolver:maven-resolver-transport-http"
+	implementation( platform("org.apache.maven:maven-resolver-provider:3.9.11"))
+	implementation "org.apache.maven:maven-resolver-provider"
+	implementation "org.apache.maven.resolver:maven-resolver-api"
+	implementation "org.apache.maven.resolver:maven-resolver-spi"
+	implementation "org.apache.maven.resolver:maven-resolver-util"
+	implementation "org.apache.maven.resolver:maven-resolver-impl"
+	implementation "org.apache.maven.resolver:maven-resolver-connector-basic"
+	implementation "org.apache.maven.resolver:maven-resolver-transport-file"
+	implementation "org.apache.maven.resolver:maven-resolver-transport-http"
+	implementation "org.apache.maven.resolver:maven-resolver-supplier:1.9.24"
 
-    implementation libs.bundles.spotless.libs
+	implementation libs.bundles.spotless.libs
+}
+
+tasks.named("test", Test) {
+	// make sure test is rerun if the local maven test repo changes
+	it.inputs.dir(layout.projectDirectory.dir("maven-test-repo"))
+
+	// provide the path to the local maven test repo as a system property
+	it.systemProperty("local.maven.repo.path", layout.projectDirectory.dir("maven-test-repo").asFile.absolutePath)
 }
diff --git a/provisioner/maven-test-repo/.gitignore b/provisioner/maven-test-repo/.gitignore
@@ -0,0 +1,2 @@
+# we explicitly want to include jar files in this local test maven repository
+!*.jar
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar.md5 b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar.md5
@@ -0,0 +1 @@
+648a20111dbab30d81845cb5207f6f69
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar.sha1 b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.jar.sha1
@@ -0,0 +1 @@
+68809935d5224f870978991395f6edde308ab7a1
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.example</groupId>
+  <artifactId>lib1</artifactId>
+  <version>1.0.0</version>
+  <packaging>jar</packaging>
+  <name>lib1</name>
+</project>
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom.md5 b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom.md5
@@ -0,0 +1 @@
+022ce1375ae41c7016bbbb3a2e17d62d
diff --git a/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom.sha1 b/provisioner/maven-test-repo/com/example/lib1/1.0.0/lib1-1.0.0.pom.sha1
@@ -0,0 +1 @@
+bccf3999f160d9c287bfc4c72187081af7ec3d6f
diff --git a/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml b/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <groupId>com.example</groupId>
+  <artifactId>lib1</artifactId>
+  <versioning>
+    <release>1.0.0</release>
+    <latest>1.0.0</latest>
+    <versions>
+      <version>1.0.0</version>
+    </versions>
+    <lastUpdated>20251126052323</lastUpdated>
+  </versioning>
+</metadata>
diff --git a/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml.md5 b/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml.md5
@@ -0,0 +1 @@
+b621c80f90ed859e069637b21fe38772
diff --git a/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml.sha1 b/provisioner/maven-test-repo/com/example/lib1/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+7ff4cc347ad1bbe3de96f764c1678233af3dbc7d
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar.md5 b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar.md5
@@ -0,0 +1 @@
+d11a0d604b7aaa200a42b6f3fd832ac5
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar.sha1 b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.jar.sha1
@@ -0,0 +1 @@
+c1ab5f0977e05482b8d6ac175e58edcdd4fcb1cc
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.example</groupId>
+  <artifactId>lib2</artifactId>
+  <version>1.0.0</version>
+  <packaging>jar</packaging>
+  <name>lib2</name>
+    <dependencies>
+      <dependency>
+        <groupId>com.example</groupId>
+        <artifactId>lib1</artifactId>
+        <version>1.0.0</version>
+      </dependency>
+    </dependencies>
+
+</project>
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom.md5 b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom.md5
@@ -0,0 +1 @@
+e02707d45b117b267c3ee601693a9a38
diff --git a/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom.sha1 b/provisioner/maven-test-repo/com/example/lib2/1.0.0/lib2-1.0.0.pom.sha1
@@ -0,0 +1 @@
+2e34ad60017f58082125d2c7a047824cb9e0355d
diff --git a/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml b/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+  <groupId>com.example</groupId>
+  <artifactId>lib2</artifactId>
+  <versioning>
+    <release>1.0.0</release>
+    <latest>1.0.0</latest>
+    <versions>
+      <version>1.0.0</version>
+    </versions>
+    <lastUpdated>20251126052323</lastUpdated>
+  </versioning>
+</metadata>
diff --git a/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml.md5 b/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml.md5
@@ -0,0 +1 @@
+a1f6952d80d0180543745449a58f0a74
diff --git a/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml.sha1 b/provisioner/maven-test-repo/com/example/lib2/maven-metadata.xml.sha1
@@ -0,0 +1 @@
+771b8e74d40ea8616336a676ff77950cb043de80
diff --git a/provisioner/src/main/java/com/diffplug/spotless/cli/provisioner/DynamicMavenResolverPublisher.java b/provisioner/src/main/java/com/diffplug/spotless/cli/provisioner/DynamicMavenResolverPublisher.java
@@ -1,40 +1,51 @@
+/*
+ * Copyright 2025 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package com.diffplug.spotless.cli.provisioner;
 
-import com.diffplug.spotless.Provisioner;
+import java.io.File;
+import java.nio.file.Path;
+import java.util.Collection;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+
 import org.apache.maven.repository.internal.MavenRepositorySystemUtils;
 import org.eclipse.aether.DefaultRepositorySystemSession;
 import org.eclipse.aether.RepositorySystem;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.artifact.Artifact;
 import org.eclipse.aether.artifact.DefaultArtifact;
 import org.eclipse.aether.collection.CollectRequest;
-import org.eclipse.aether.connector.basic.BasicRepositoryConnectorFactory;
 import org.eclipse.aether.graph.Dependency;
-import org.eclipse.aether.impl.DefaultServiceLocator;
 import org.eclipse.aether.repository.LocalRepository;
 import org.eclipse.aether.repository.RemoteRepository;
 import org.eclipse.aether.resolution.ArtifactRequest;
 import org.eclipse.aether.resolution.ArtifactResult;
 import org.eclipse.aether.resolution.DependencyRequest;
 import org.eclipse.aether.resolution.DependencyResult;
-import org.eclipse.aether.spi.connector.RepositoryConnectorFactory;
-import org.eclipse.aether.spi.connector.transport.TransporterFactory;
-import org.eclipse.aether.transport.http.HttpTransporterFactory;
+import org.eclipse.aether.supplier.RepositorySystemSupplier;
 import org.eclipse.aether.util.artifact.JavaScopes;
 import org.eclipse.aether.util.filter.DependencyFilterUtils;
 
-import java.io.File;
-import java.nio.file.Path;
-import java.util.Collection;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Set;
+import com.diffplug.spotless.Provisioner;
 
 public class DynamicMavenResolverPublisher implements Provisioner {
 
-    public static final List<RemoteRepository> DEFAULT_REMOTE_REPOSITORIES = List.of(
-            new RemoteRepository.Builder("central", "default", "https://repo1.maven.org/maven2/").build()
-    );
+    public static final List<RemoteRepository> DEFAULT_REMOTE_REPOSITORIES =
+            List.of(new RemoteRepository.Builder("central", "default", "https://repo1.maven.org/maven2/").build());
 
     public static final Path DEFAULT_LOCAL_MAVEN_REPO = defaultLocalMavenRepo();
 
@@ -60,10 +71,7 @@ private static Path defaultLocalMavenRepo() {
     }
 
     private RepositorySystem newRepositorySystem() {
-        DefaultServiceLocator locator = MavenRepositorySystemUtils.newServiceLocator();
-        locator.addService(RepositoryConnectorFactory.class, BasicRepositoryConnectorFactory.class);
-        locator.addService(TransporterFactory.class, HttpTransporterFactory.class);
-        return locator.getService(RepositorySystem.class);
+        return new RepositorySystemSupplier().get();
     }
 
     private RepositorySystemSession newSession(RepositorySystem system) {
@@ -89,10 +97,11 @@ public Set<File> provisionWithTransitives(boolean withTransitives, Collection<St
                     collectRequest.setRoot(new Dependency(artifact, JavaScopes.RUNTIME));
                     remoteRepositories.forEach(collectRequest::addRepository);
 
-                    DependencyRequest dependencyRequest =
-                            new DependencyRequest(collectRequest, DependencyFilterUtils.classpathFilter(JavaScopes.RUNTIME));
+                    DependencyRequest dependencyRequest = new DependencyRequest(
+                            collectRequest, DependencyFilterUtils.classpathFilter(JavaScopes.RUNTIME));
 
-                    DependencyResult result = repositorySystem.resolveDependencies(repositorySystemSession, dependencyRequest);
+                    DependencyResult result =
+                            repositorySystem.resolveDependencies(repositorySystemSession, dependencyRequest);
 
                     result.getArtifactResults().forEach(r -> {
                         File f = r.getArtifact().getFile();
@@ -116,5 +125,4 @@ public Set<File> provisionWithTransitives(boolean withTransitives, Collection<St
 
         return jarFiles;
     }
-
 }
diff --git a/provisioner/src/test/java/com/diffplug/spotless/cli/provisioner/DynamicMavenResolverPublisherTest.java b/provisioner/src/test/java/com/diffplug/spotless/cli/provisioner/DynamicMavenResolverPublisherTest.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2025 DiffPlug
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.diffplug.spotless.cli.provisioner;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.assertj.core.api.SoftAssertions;
+import org.eclipse.aether.repository.RemoteRepository;
+import org.jetbrains.annotations.NotNull;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+class DynamicMavenResolverPublisherTest {
+
+    @Test
+    @Disabled(
+            "Disabled to avoid network dependency during tests, enable when network access is acceptable while developing")
+    void itResolvesDiffplugSpotlessLib(@TempDir Path tempDir) {
+        // Given
+        DynamicMavenResolverPublisher provisioner =
+                new DynamicMavenResolverPublisher(DynamicMavenResolverPublisher.DEFAULT_REMOTE_REPOSITORIES, tempDir);
+        // When
+        Set<File> files = provisioner.provisionWithTransitives(true, "com.diffplug.spotless:spotless-lib:4.1.0");
+        Set<String> fileNames = files.stream().map(File::getName).collect(Collectors.toSet());
+        // Then
+        SoftAssertions.assertSoftly(softly -> {
+            softly.assertThat(files).isNotEmpty();
+            softly.assertThat(fileNames).contains("spotless-lib-4.1.0.jar");
+        });
+    }
+
+    @Test
+    void itResolvesTestLib1(@TempDir Path tempDir) {
+        // Given
+        DynamicMavenResolverPublisher provisioner = provisionerForLocalMavenTestRepo(tempDir);
+        // When
+        Set<File> files = provisioner.provisionWithTransitives(true, "com.example:lib1:1.0.0");
+        Set<String> fileNames = files.stream().map(File::getName).collect(Collectors.toSet());
+        // Then
+        SoftAssertions.assertSoftly(softly -> {
+            softly.assertThat(files).isNotEmpty();
+            softly.assertThat(fileNames).contains("lib1-1.0.0.jar");
+        });
+    }
+
+    @Test
+    void itResolvesTestLib2WithTransitives(@TempDir Path tempDir) {
+        // Given
+        DynamicMavenResolverPublisher provisioner = provisionerForLocalMavenTestRepo(tempDir);
+        // When
+        Set<File> files = provisioner.provisionWithTransitives(true, "com.example:lib2:1.0.0");
+        Set<String> fileNames = files.stream().map(File::getName).collect(Collectors.toSet());
+
+        // Then
+        SoftAssertions.assertSoftly(softly -> {
+            softly.assertThat(files).isNotEmpty();
+            softly.assertThat(fileNames).contains("lib2-1.0.0.jar").contains("lib1-1.0.0.jar");
+        });
+    }
+
+    @Test
+    void itResolvesTestLib2WithoutTransitives(@TempDir Path tempDir) {
+        // Given
+        DynamicMavenResolverPublisher provisioner = provisionerForLocalMavenTestRepo(tempDir);
+        // When
+        Set<File> files = provisioner.provisionWithTransitives(false, "com.example:lib2:1.0.0");
+        Set<String> fileNames = files.stream().map(File::getName).collect(Collectors.toSet());
+
+        // Then
+        SoftAssertions.assertSoftly(softly -> {
+            softly.assertThat(files).isNotEmpty();
+            softly.assertThat(fileNames).contains("lib2-1.0.0.jar").doesNotContain("lib1-1.0.0.jar");
+        });
+    }
+
+    private static @NotNull DynamicMavenResolverPublisher provisionerForLocalMavenTestRepo(Path tempDir) {
+        return new DynamicMavenResolverPublisher(localMavenTestRepo(), tempDir);
+    }
+
+    private static @NotNull List<RemoteRepository> localMavenTestRepo() {
+        String localRepoPath = System.getProperty("local.maven.repo.path");
+        if (localRepoPath == null || localRepoPath.isBlank()) {
+            throw new IllegalStateException("System property 'local.maven.repo.path' must be set for this test.");
+        }
+        return List.of(
+                new RemoteRepository.Builder("local-maven-test-repo", "default", "file://" + localRepoPath).build());
+    }
+}
diff --git a/settings.gradle b/settings.gradle
@@ -37,4 +37,4 @@ rootProject.name = 'spotless-cli'
 
 include 'app'
 include 'testlib'
-include 'provisioner'
+include 'provisioner'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# we explicitly want to include jar files in this local test maven repository`
	`2`	`+!*.jar`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+68809935d5224f870978991395f6edde308ab7a1`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bccf3999f160d9c287bfc4c72187081af7ec3d6f`