This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 3544ecf5 Purge the split local repository prefixes
3544ecf5 is described below
commit 3544ecf53cf112825affa221284aea5387e9e542
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Sun Nov 1 19:50:50 2026 +0000
Purge the split local repository prefixes
Delete targets are looked up under every prefix the local repository
manager reports, and only targets that exist are deleted, so a missing
file no longer logs "Unable to purge local repository location immediately".
Fixes #1782
---
.../dependency/PurgeLocalRepositoryMojo.java | 78 ++++++++++++++++++----
.../dependency/PurgeLocalRepositoryMojoTest.java | 61 ++++++++++++++++-
2 files changed, 125 insertions(+), 14 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
b/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
index 67ac4cb3..4231305f 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojo.java
@@ -66,6 +66,8 @@ import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.graph.DefaultDependencyNode;
import org.eclipse.aether.graph.DependencyFilter;
import org.eclipse.aether.graph.DependencyNode;
+import org.eclipse.aether.repository.LocalRepositoryManager;
+import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.resolution.ArtifactDescriptorException;
import org.eclipse.aether.resolution.DependencyResolutionException;
@@ -438,18 +440,57 @@ public class PurgeLocalRepositoryMojo extends
AbstractMojo {
continue;
}
- File purgeDir = new File(localRepository.getBasedir(),
relativePath);
- if (purgeDir.exists()) {
- getLog().debug("Deleting directory: " + purgeDir);
- try {
- FileUtils.deleteDirectory(purgeDir);
- } catch (IOException e) {
- throw new MojoExecutionException("Unable to purge
directory: " + purgeDir);
+ String[] gav = gavPattern.split(":");
+ for (File root : localRepositoryRoots(project, gav[0], gav.length
> 1 ? gav[1] : "x")) {
+ File purgeDir = new File(root, relativePath);
+ if (purgeDir.exists()) {
+ getLog().debug("Deleting directory: " + purgeDir);
+ try {
+ FileUtils.deleteDirectory(purgeDir);
+ } catch (IOException e) {
+ throw new MojoExecutionException("Unable to purge
directory: " + purgeDir);
+ }
+ } else {
+ getLog().debug("Directory: " + purgeDir + " doesn't
exist");
+ }
+ }
+ }
+ }
+
+ /**
+ * Returns the directories the local repository lays artifacts out under:
its base directory and, for a split
+ * local repository, the prefixed directories that hold installed and
cached artifacts.
+ *
+ * @param theProject the project whose remote repositories may have cached
the artifact
+ * @param groupId the groupId of the artifact
+ * @param artifactId the artifactId of the artifact
+ * @return the base directory followed by any prefixed directories
+ */
+ private Set<File> localRepositoryRoots(MavenProject theProject, String
groupId, String artifactId) {
+ LocalRepositoryManager localRepositoryManager =
+ session.getRepositorySession().getLocalRepositoryManager();
+ if (localRepositoryManager == null) {
+ return Collections.singleton(new
File(localRepository.getBasedir()));
+ }
+ File basedir = localRepositoryManager.getRepository().getBasedir();
+ Set<File> roots = new LinkedHashSet<>();
+ roots.add(basedir);
+ // A split prefix depends only on installed or cached, the remote
repository, and release or snapshot.
+ for (String version : Arrays.asList("0", "0-SNAPSHOT")) {
+ DefaultArtifact probe = new DefaultArtifact(groupId, artifactId,
"pom", version);
+ String layoutPath =
localRepository.pathOf(RepositoryUtils.toArtifact(probe));
+ List<String> paths = new ArrayList<>();
+ paths.add(localRepositoryManager.getPathForLocalArtifact(probe));
+ for (RemoteRepository repository :
theProject.getRemoteProjectRepositories()) {
+
paths.add(localRepositoryManager.getPathForRemoteArtifact(probe, repository,
""));
+ }
+ for (String path : paths) {
+ if (path != null && path.endsWith(layoutPath)) {
+ roots.add(new File(basedir, path.substring(0,
path.length() - layoutPath.length())));
}
- } else {
- getLog().debug("Directory: " + purgeDir + " doesn't exist");
}
}
+ return roots;
}
/**
@@ -626,7 +667,7 @@ public class PurgeLocalRepositoryMojo extends AbstractMojo {
for (Artifact artifact : artifacts) {
verbose("Purging artifact: " + artifact.getId());
- for (File deleteTarget : findDeleteTargets(artifact)) {
+ for (File deleteTarget : findDeleteTargets(theProject, artifact)) {
verbose("Deleting: " + deleteTarget);
if (deleteTarget.isDirectory()) {
@@ -675,10 +716,21 @@ public class PurgeLocalRepositoryMojo extends
AbstractMojo {
}
}
- private List<File> findDeleteTargets(Artifact artifact) {
- // Use localRepository.pathOf() in case artifact.getFile() is not set
- File deleteTarget = new File(localRepository.getBasedir(),
localRepository.pathOf(artifact));
+ private List<File> findDeleteTargets(MavenProject theProject, Artifact
artifact) {
+ List<File> deleteTargets = new ArrayList<>();
+ for (File root : localRepositoryRoots(theProject,
artifact.getGroupId(), artifact.getArtifactId())) {
+ // Use localRepository.pathOf() in case artifact.getFile() is not
set
+ File deleteTarget = new File(root,
localRepository.pathOf(artifact));
+ for (File target : findDeleteTargets(deleteTarget)) {
+ if (target.exists()) {
+ deleteTargets.add(target);
+ }
+ }
+ }
+ return deleteTargets;
+ }
+ private List<File> findDeleteTargets(File deleteTarget) {
if (GROUP_ID_FUZZINESS.equals(resolutionFuzziness)) {
// get the groupId dir.
deleteTarget =
deleteTarget.getParentFile().getParentFile().getParentFile();
diff --git
a/src/test/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojoTest.java
b/src/test/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojoTest.java
index 57503444..88ead49a 100644
---
a/src/test/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojoTest.java
+++
b/src/test/java/org/apache/maven/plugins/dependency/PurgeLocalRepositoryMojoTest.java
@@ -40,6 +40,8 @@ import org.eclipse.aether.artifact.DefaultArtifactType;
import org.eclipse.aether.graph.DefaultDependencyNode;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.graph.DependencyFilter;
+import org.eclipse.aether.repository.LocalRepository;
+import org.eclipse.aether.repository.LocalRepositoryManager;
import org.eclipse.aether.repository.RemoteRepository;
import org.eclipse.aether.util.artifact.DefaultArtifactTypeRegistry;
import org.junit.jupiter.api.BeforeEach;
@@ -69,6 +71,8 @@ class PurgeLocalRepositoryMojoTest {
private ResolverUtil resolverUtil;
+ private RepositorySystemSession repositorySession;
+
private PurgeLocalRepositoryMojo mojo;
@BeforeEach
@@ -80,7 +84,7 @@ class PurgeLocalRepositoryMojoTest {
DefaultArtifactTypeRegistry typeRegistry = new
DefaultArtifactTypeRegistry();
typeRegistry.add(new DefaultArtifactType("jar", "jar", "", "java"));
typeRegistry.add(new DefaultArtifactType("custom", "cext", "",
"java"));
- RepositorySystemSession repositorySession =
mock(RepositorySystemSession.class);
+ repositorySession = mock(RepositorySystemSession.class);
when(repositorySession.getArtifactTypeRegistry()).thenReturn(typeRegistry);
when(session.getRepositorySession()).thenReturn(repositorySession);
@@ -130,6 +134,61 @@ class PurgeLocalRepositoryMojoTest {
return new DefaultArtifact("org.example", artifactId, "jar", version);
}
+ /**
+ * Lays installed artifacts out under {@code installed/tag-1/} and cached
ones under {@code cached/<repository>/},
+ * like a split enhanced local repository.
+ */
+ private void splitLocalRepository() {
+ LocalRepositoryManager localRepositoryManager =
mock(LocalRepositoryManager.class);
+ when(localRepositoryManager.getRepository()).thenReturn(new
LocalRepository(localRepo.toFile()));
+
when(localRepositoryManager.getPathForLocalArtifact(any(Artifact.class)))
+ .thenAnswer(invocation -> "installed/tag-1/" +
layoutPath(invocation.getArgument(0)));
+
when(localRepositoryManager.getPathForRemoteArtifact(any(Artifact.class),
any(RemoteRepository.class), any()))
+ .thenAnswer(invocation ->
+ "cached/" +
invocation.<RemoteRepository>getArgument(1).getId() + "/"
+ + layoutPath(invocation.getArgument(0)));
+
when(repositorySession.getLocalRepositoryManager()).thenReturn(localRepositoryManager);
+ when(project.getRemoteProjectRepositories())
+ .thenReturn(Collections.singletonList(
+ new RemoteRepository.Builder("central", "default",
"https://repo.example").build()));
+ }
+
+ private static String layoutPath(Artifact artifact) {
+ return artifact.getGroupId().replace('.', '/') + "/" +
artifact.getArtifactId() + "/"
+ + artifact.getBaseVersion() + "/" + artifact.getArtifactId() +
"-" + artifact.getVersion() + "."
+ + artifact.getExtension();
+ }
+
+ @Test
+ void splitLocalRepositoryDeletesInstalledAndCachedCopies() throws
Exception {
+ Path plain = artifactFile("lib", "1.0");
+ Path installed = file("installed/tag-1/" + GROUP_PATH +
"/lib/1.0/lib-1.0.jar");
+ Path cached = file("cached/central/" + GROUP_PATH +
"/lib/1.0/lib-1.0.jar");
+ Path otherVersion = file("installed/tag-1/" + GROUP_PATH +
"/lib/2.0/lib-2.0.jar");
+ splitLocalRepository();
+ resolvesTo(artifact("lib", "1.0"));
+
+ mojo.execute();
+
+ assertThat(plain.getParent()).doesNotExist();
+ assertThat(installed.getParent()).doesNotExist();
+ assertThat(cached.getParent()).doesNotExist();
+ assertThat(otherVersion).exists();
+ }
+
+ @Test
+ void splitLocalRepositoryManualIncludeDeletesInstalledCopy() throws
Exception {
+ Path installed = file("installed/tag-1/" + GROUP_PATH +
"/lib/1.0-SNAPSHOT/lib-1.0-SNAPSHOT.pom");
+ Path sibling = file("installed/tag-1/" + GROUP_PATH +
"/sibling/1.0/sibling-1.0.pom");
+ splitLocalRepository();
+ setVariableValueToObject(mojo, "manualInclude", "org.example:lib");
+
+ mojo.execute();
+
+ assertThat(installed.getParent().getParent()).doesNotExist();
+ assertThat(sibling).exists();
+ }
+
@Test
void artifactIdFuzzinessWithSnapshotsOnlyDeletesOnlySnapshotVersions()
throws Exception {
Path snapshot = artifactFile("lib", "1.0-SNAPSHOT");