Skip to content

Commit

Permalink
[MBUILDCACHE-96] Remove use of maven-compat (#171)
Browse files Browse the repository at this point in the history 
* [MBUILDCACHE-96] Remove use of maven-compat


---------

Signed-off-by: Olivier Lamy <[email protected]>
  • Loading branch information
@olamy
olamy authored Aug 12, 2024
1 parent c6bc4bc commit 4c0e754
Show file tree
Hide file tree
Showing 4 changed files with 167 additions and 44 deletions.
8 changes: 1 addition & 7 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,6 @@ under the License.
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-compat</artifactId>
<version>${mavenVersion}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.maven.resolver</groupId>
<artifactId>maven-resolver-transport-http</artifactId>
Expand Down Expand Up @@ -456,7 +450,7 @@ under the License.
<profile>
<id>maven3</id>
<properties>
<mavenVersion>3.9.6</mavenVersion>
<mavenVersion>3.9.8</mavenVersion>
<maven.dir>maven3</maven.dir>
<maven.basedir>${project.build.directory}/${maven.dir}</maven.basedir>
</properties>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/apache/maven/buildcache/CacheControllerImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
import org.apache.maven.plugin.descriptor.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.repository.RepositorySystem;
import org.codehaus.plexus.util.ReflectionUtils;
import org.eclipse.aether.RepositorySystem;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down
11 changes: 8 additions & 3 deletions src/main/java/org/apache/maven/buildcache/DefaultProjectInputCalculator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,14 @@
import java.util.concurrent.ConcurrentMap;

import org.apache.maven.SessionScoped;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.buildcache.checksum.MavenProjectInput;
import org.apache.maven.buildcache.xml.CacheConfig;
import org.apache.maven.buildcache.xml.build.ProjectsInputInfo;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.lifecycle.internal.builder.BuilderCommon;
import org.apache.maven.project.MavenProject;
import org.apache.maven.repository.RepositorySystem;
import org.eclipse.aether.RepositorySystem;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -49,6 +50,7 @@ public class DefaultProjectInputCalculator implements ProjectInputCalculator {
private final RepositorySystem repoSystem;
private final NormalizedModelProvider normalizedModelProvider;
private final MultiModuleSupport multiModuleSupport;
private final ArtifactHandlerManager artifactHandlerManager;

private final ConcurrentMap<String, ProjectsInputInfo> checkSumMap = new ConcurrentHashMap<>();

Expand All @@ -61,13 +63,15 @@ public DefaultProjectInputCalculator(
CacheConfig cacheConfig,
RepositorySystem repoSystem,
NormalizedModelProvider rawModelProvider,
MultiModuleSupport multiModuleSupport) {
MultiModuleSupport multiModuleSupport,
ArtifactHandlerManager artifactHandlerManager) {
this.mavenSession = mavenSession;
this.remoteCache = remoteCache;
this.cacheConfig = cacheConfig;
this.repoSystem = repoSystem;
this.normalizedModelProvider = rawModelProvider;
this.multiModuleSupport = multiModuleSupport;
this.artifactHandlerManager = artifactHandlerManager;
}

@Override
Expand Down Expand Up @@ -108,7 +112,8 @@ private ProjectsInputInfo calculateInputInternal(String key, MavenProject projec
mavenSession,
cacheConfig,
repoSystem,
remoteCache);
remoteCache,
artifactHandlerManager);
return input.calculateChecksum();
} catch (Exception e) {
throw new RuntimeException("Failed to calculate checksums for " + project.getArtifactId(), e);
Expand Down
190 changes: 157 additions & 33 deletions src/main/java/org/apache/maven/buildcache/checksum/MavenProjectInput.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,12 @@

import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.ArtifactResolutionRequest;
import org.apache.maven.artifact.resolver.ArtifactResolutionResult;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.resolver.filter.ExcludesArtifactFilter;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.buildcache.CacheUtils;
import org.apache.maven.buildcache.MultiModuleSupport;
import org.apache.maven.buildcache.NormalizedModelProvider;
Expand All @@ -71,15 +75,20 @@
import org.apache.maven.buildcache.xml.config.Include;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Exclusion;
import org.apache.maven.model.Model;
import org.apache.maven.model.Plugin;
import org.apache.maven.model.PluginExecution;
import org.apache.maven.model.Resource;
import org.apache.maven.model.io.xpp3.MavenXpp3Writer;
import org.apache.maven.project.MavenProject;
import org.apache.maven.repository.RepositorySystem;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.WriterFactory;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.artifact.DefaultArtifactType;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.ArtifactResolutionException;
import org.eclipse.aether.resolution.ArtifactResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -133,6 +142,8 @@ public class MavenProjectInput {
private final MultiModuleSupport multiModuleSupport;
private final ProjectInputCalculator projectInputCalculator;
private final Path baseDirPath;
private final ArtifactHandlerManager artifactHandlerManager;

/**
* The project glob to use every time there is no override
*/
Expand All @@ -152,7 +163,8 @@ public MavenProjectInput(
MavenSession session,
CacheConfig config,
RepositorySystem repoSystem,
RemoteCacheRepository remoteCache) {
RemoteCacheRepository remoteCache,
ArtifactHandlerManager artifactHandlerManager) {
this.project = project;
this.normalizedModelProvider = normalizedModelProvider;
this.multiModuleSupport = multiModuleSupport;
Expand All @@ -171,6 +183,7 @@ public MavenProjectInput(
this.exclusionResolver = new ExclusionResolver(project, config);

this.fileComparator = new PathIgnoringCaseComparator();
this.artifactHandlerManager = artifactHandlerManager;
}

public ProjectsInputInfo calculateChecksum() throws IOException {
Expand Down Expand Up @@ -644,7 +657,7 @@ private SortedMap<String, String> getMutablePluginDependencies() throws IOExcept
continue;
}

String rawKeyPrefix = KeyUtils.getVersionlessArtifactKey(repoSystem.createPluginArtifact(plugin));
String rawKeyPrefix = KeyUtils.getVersionlessArtifactKey(createPluginArtifact(plugin));
int occurrenceIndex = keyPrefixOccurrenceIndex
.computeIfAbsent(rawKeyPrefix, k -> new AtomicInteger())
.getAndIncrement();
Expand All @@ -654,6 +667,110 @@ private SortedMap<String, String> getMutablePluginDependencies() throws IOExcept
return fullMap;
}

public Artifact createPluginArtifact(Plugin plugin) {

VersionRange versionRange;
try {
versionRange = VersionRange.createFromVersionSpec(plugin.getVersion());
} catch (InvalidVersionSpecificationException e) {
LOGGER.error(
String.format(
"Invalid version specification '%s' creating plugin artifact '%s'.",
plugin.getVersion(), plugin),
e);
// should not happen here
throw new RuntimeException(e);
}

return createArtifact(
plugin.getGroupId(),
plugin.getArtifactId(),
versionRange,
"maven-plugin",
null,
Artifact.SCOPE_RUNTIME,
null,
false);
}

private Artifact createArtifact(
String groupId,
String artifactId,
VersionRange versionRange,
String type,
String classifier,
String scope,
String inheritedScope,
boolean optional) {
String desiredScope = Artifact.SCOPE_RUNTIME;

if (inheritedScope == null) {
desiredScope = scope;
} else if (Artifact.SCOPE_TEST.equals(scope) || Artifact.SCOPE_PROVIDED.equals(scope)) {
return null;
} else if (Artifact.SCOPE_COMPILE.equals(scope) && Artifact.SCOPE_COMPILE.equals(inheritedScope)) {
// added to retain compile artifactScope. Remove if you want compile inherited as runtime
desiredScope = Artifact.SCOPE_COMPILE;
}

if (Artifact.SCOPE_TEST.equals(inheritedScope)) {
desiredScope = Artifact.SCOPE_TEST;
}

if (Artifact.SCOPE_PROVIDED.equals(inheritedScope)) {
desiredScope = Artifact.SCOPE_PROVIDED;
}

if (Artifact.SCOPE_SYSTEM.equals(scope)) {
// system scopes come through unchanged...
desiredScope = Artifact.SCOPE_SYSTEM;
}
ArtifactHandler handler = artifactHandlerManager.getArtifactHandler(type);

return new DefaultArtifact(
groupId, artifactId, versionRange, desiredScope, type, classifier, handler, optional);
}

public Artifact createDependencyArtifact(Dependency d) {
VersionRange versionRange;
try {
versionRange = VersionRange.createFromVersionSpec(d.getVersion());
} catch (InvalidVersionSpecificationException e) {
LOGGER.error(
String.format(
"Invalid version specification '%s' creating dependency artifact '%s'.", d.getVersion(), d),
e);
// should not happen here ?
throw new RuntimeException(e);
}

Artifact artifact = createArtifact(
d.getGroupId(),
d.getArtifactId(),
versionRange,
d.getType(),
d.getClassifier(),
d.getScope(),
null,
d.isOptional());

if (Artifact.SCOPE_SYSTEM.equals(d.getScope()) && d.getSystemPath() != null) {
artifact.setFile(new File(d.getSystemPath()));
}

if (!d.getExclusions().isEmpty()) {
List<String> exclusions = new ArrayList<>();

for (Exclusion exclusion : d.getExclusions()) {
exclusions.add(exclusion.getGroupId() + ':' + exclusion.getArtifactId());
}

artifact.setDependencyFilter(new ExcludesArtifactFilter(exclusions));
}

return artifact;
}

private SortedMap<String, String> getMutableDependenciesHashes(String keyPrefix, List<Dependency> dependencies)
throws IOException {
SortedMap<String, String> result = new TreeMap<>();
Expand Down Expand Up @@ -684,51 +801,58 @@ private SortedMap<String, String> getMutableDependenciesHashes(String keyPrefix,
projectInputCalculator.calculateInput(dependencyProject).getChecksum();
} else // this is a snapshot dependency
{
DigestItem resolved = resolveArtifact(repoSystem.createDependencyArtifact(dependency), false);
DigestItem resolved = null;
try {
resolved = resolveArtifact(dependency);
} catch (ArtifactResolutionException | InvalidVersionSpecificationException e) {
throw new IOException(e);
}
projectHash = resolved.getHash();
}
result.put(
keyPrefix + KeyUtils.getVersionlessArtifactKey(repoSystem.createDependencyArtifact(dependency)),
projectHash);
keyPrefix + KeyUtils.getVersionlessArtifactKey(createDependencyArtifact(dependency)), projectHash);
}
return result;
}

@Nonnull
private DigestItem resolveArtifact(final Artifact dependencyArtifact, boolean isOffline) throws IOException {
ArtifactResolutionRequest request = new ArtifactResolutionRequest()
.setArtifact(dependencyArtifact)
.setResolveRoot(true)
.setResolveTransitively(false)
.setLocalRepository(session.getLocalRepository())
.setRemoteRepositories(project.getRemoteArtifactRepositories())
.setOffline(session.isOffline() || isOffline)
.setForceUpdate(session.getRequest().isUpdateSnapshots())
.setServers(session.getRequest().getServers())
.setMirrors(session.getRequest().getMirrors())
.setProxies(session.getRequest().getProxies());

final ArtifactResolutionResult result = repoSystem.resolve(request);

if (!result.isSuccess()) {
private DigestItem resolveArtifact(final Dependency dependency)
throws IOException, ArtifactResolutionException, InvalidVersionSpecificationException {

org.eclipse.aether.artifact.Artifact dependencyArtifact = new org.eclipse.aether.artifact.DefaultArtifact(
dependency.getGroupId(),
dependency.getArtifactId(),
dependency.getClassifier(),
null,
dependency.getVersion(),
new DefaultArtifactType(dependency.getType()));
ArtifactRequest artifactRequest = new ArtifactRequest().setArtifact(dependencyArtifact);

ArtifactResult result = repoSystem.resolveArtifact(session.getRepositorySession(), artifactRequest);

if (!result.isResolved()) {
throw new DependencyNotResolvedException("Cannot resolve in-project dependency: " + dependencyArtifact);
}

if (!result.getMissingArtifacts().isEmpty()) {
throw new DependencyNotResolvedException(
"Cannot resolve artifact: " + dependencyArtifact + ", missing: " + result.getMissingArtifacts());
if (result.isMissing()) {
throw new DependencyNotResolvedException("Cannot resolve missing artifact: " + dependencyArtifact);
}

if (result.getArtifacts().size() != 1) {
throw new IllegalStateException("Unexpected number of artifacts returned. Requested: " + dependencyArtifact
+ ", expected: 1, actual: " + result.getArtifacts());
}
org.eclipse.aether.artifact.Artifact resolved = result.getArtifact();

final Artifact resolved = result.getArtifacts().iterator().next();
Artifact artifact = createArtifact(
resolved.getGroupId(),
resolved.getArtifactId(),
VersionRange.createFromVersionSpec(resolved.getVersion()),
dependency.getType(),
resolved.getClassifier(),
dependency.getType(),
dependency.getScope(),
false);

final HashAlgorithm algorithm = config.getHashFactory().createAlgorithm();
final String hash = algorithm.hash(resolved.getFile().toPath());
return DtoUtils.createDigestedFile(resolved, hash);
return DtoUtils.createDigestedFile(artifact, hash);
}

/**
Expand Down

0 comments on commit 4c0e754

Please sign in to comment.