Skip to content

Linkage Monitor to run 2-phase model building #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
suztomo merged 18 commits into from
Aug 29, 2019
Merged

Linkage Monitor to run 2-phase model building #855

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
7c0bb3b
LinkageMonitor to run two phases model building
suztomo Aug 28, 2019
e79a90e
Added test to confirm findHighestVersions work for pom as well
suztomo Aug 28, 2019
14cda13
LinkageMonitor.buildModelWithSnapshotBom
suztomo Aug 28, 2019
f977173
testBuildModelWithSnapshotBom_BomSnapshotUpdate
suztomo Aug 28, 2019
942397d
format
suztomo Aug 28, 2019
c7e4e02
testBuildModelWithSnapshotBom_BomSnapshotUpdate
suztomo Aug 28, 2019
36f4f17
Format
suztomo Aug 28, 2019
11a2faa
Validation
suztomo Aug 28, 2019
ef48761
Typo
suztomo Aug 28, 2019
c95db0e
Replaced unused variables
suztomo Aug 28, 2019
9946f9e
debugging
suztomo Aug 28, 2019
e561979
debug
suztomo Aug 28, 2019
2b01020
Fixed tests
suztomo Aug 28, 2019
36d62d0
Dummy.xml no longer needed
suztomo Aug 28, 2019
d453741
refactoring
suztomo Aug 28, 2019
b8956f3
Applied review
suztomo Aug 28, 2019
aa66d3c
Comment on spy
suztomo Aug 28, 2019
c928fe5
braces on for
suztomo Aug 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions ...s/src/test/java/com/google/cloud/tools/opensource/dependencies/RepositoryUtilityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,18 +81,22 @@ public void testFindVersions() throws MavenRepositoryException {
public void testFindHighestVersions()
throws MavenRepositoryException, InvalidVersionSpecificationException {
RepositorySystem system = RepositoryUtility.newRepositorySystem();
String guavaHighestVersion =
RepositoryUtility.findHighestVersion(
system, RepositoryUtility.newSession(system), "com.google.guava", "guava");
Assert.assertNotNull(guavaHighestVersion);

// Not comparing alphabetically; otherwise "100.0" would be smaller than "28.0"
VersionScheme versionScheme = new GenericVersionScheme();
Version highestGuava = versionScheme.parseVersion(guavaHighestVersion);
Version guava28 = versionScheme.parseVersion("28.0");
// FindHighestVersion should work for both jar and pom (extension:pom) artifacts
for (String artifactId : ImmutableList.of("guava", "guava-bom")) {
Copy link
Contributor Author

@suztomo suztomo Aug 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is to ensure findHighestVersion works for BOM (extension: pom) too.

Copy link
Contributor

@elharo elharo Aug 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make that a comment in the code

Copy link
Contributor Author

@suztomo suztomo Aug 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

String guavaHighestVersion =
RepositoryUtility.findHighestVersion(
system, RepositoryUtility.newSession(system), "com.google.guava", artifactId);
Assert.assertNotNull(guavaHighestVersion);

Truth.assertWithMessage("Latest guava release is greater than or equal to 28.0")
.that(highestGuava)
.isAtLeast(guava28);
// Not comparing alphabetically; otherwise "100.0" would be smaller than "28.0"
VersionScheme versionScheme = new GenericVersionScheme();
Version highestGuava = versionScheme.parseVersion(guavaHighestVersion);
Version guava28 = versionScheme.parseVersion("28.0");

Truth.assertWithMessage("Latest guava release is greater than or equal to 28.0")
.that(highestGuava)
.isAtLeast(guava28);
}
}
}
117 changes: 110 additions & 7 deletions ...itor/src/main/java/com/google/cloud/tools/dependencies/linkagemonitor/LinkageMonitor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.google.cloud.tools.dependencies.linkagemonitor;

import static com.google.cloud.tools.opensource.dependencies.RepositoryUtility.CENTRAL;
import static com.google.common.collect.ImmutableList.toImmutableList;

import com.google.cloud.tools.opensource.classpath.ClassFile;
Expand All @@ -35,10 +36,27 @@
import java.util.List;
import java.util.Optional;
import java.util.Set;
import org.apache.maven.RepositoryUtils;
import org.apache.maven.model.DependencyManagement;
import org.apache.maven.model.Model;
import org.apache.maven.model.building.DefaultModelBuilder;
import org.apache.maven.model.building.DefaultModelBuilderFactory;
import org.apache.maven.model.building.DefaultModelBuildingRequest;
import org.apache.maven.model.building.ModelBuildingException;
import org.apache.maven.model.building.ModelBuildingRequest;
import org.apache.maven.model.building.ModelBuildingResult;
import org.apache.maven.project.ProjectModelResolver;
import org.eclipse.aether.RepositoryException;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.eclipse.aether.artifact.Artifact;
import org.eclipse.aether.artifact.ArtifactTypeRegistry;
import org.eclipse.aether.artifact.DefaultArtifact;
import org.eclipse.aether.graph.Dependency;
import org.eclipse.aether.internal.impl.DefaultRemoteRepositoryManager;
import org.eclipse.aether.resolution.ArtifactRequest;
import org.eclipse.aether.resolution.ArtifactResolutionException;
import org.eclipse.aether.resolution.ArtifactResult;

/**
* Linkage Monitor detects new linkage errors caused by locally-installed snapshot artifacts for a
Expand All @@ -50,7 +68,8 @@ public class LinkageMonitor {
private final RepositorySystem repositorySystem = RepositoryUtility.newRepositorySystem();

public static void main(String[] arguments)
throws RepositoryException, IOException, LinkageMonitorException, MavenRepositoryException {
throws RepositoryException, IOException, LinkageMonitorException, MavenRepositoryException,
ModelBuildingException {
if (arguments.length < 1 || arguments[0].split(":").length != 2) {
System.err.println(
"Please specify BOM coordinates without version. Example:"
Expand All @@ -64,7 +83,8 @@ public static void main(String[] arguments)
}

private void run(String groupId, String artifactId)
throws RepositoryException, IOException, LinkageMonitorException, MavenRepositoryException {
throws RepositoryException, IOException, LinkageMonitorException, MavenRepositoryException,
ModelBuildingException {
String latestBomCoordinates =
RepositoryUtility.findLatestCoordinates(repositorySystem, groupId, artifactId);
System.out.println("BOM Coordinates: " + latestBomCoordinates);
Expand Down Expand Up @@ -152,17 +172,91 @@ static String messageForFixedErrors(Set<SymbolProblem> fixedProblems) {
return message.toString();
}

/**
* Builds Maven model of {@code bomCoordinates} replacing its importing BOMs with
* locally-installed snapshot versions. The replacement occurs between the two phases of the model
* building.
*
* @see <a href="https://maven.apache.org/ref/3.6.1/maven-model-builder/">Maven Model Builder</a>
*/
@VisibleForTesting
static Model buildModelWithSnapshotBom(
RepositorySystem repositorySystem, RepositorySystemSession session, String bomCoordinates)
throws ModelBuildingException, ArtifactResolutionException, MavenRepositoryException {

// BOM Coordinates might not have extension.
String[] elements = bomCoordinates.split(":");
DefaultArtifact bom;
if (elements.length >= 4) {
bom = new DefaultArtifact(bomCoordinates); // This may throw InvalidArgumentException
} else if (elements.length == 3) {
// When extension is not specified, use "pom"
bom = new DefaultArtifact(elements[0], elements[1], "pom", elements[2]);
} else {
throw new IllegalArgumentException(
"BOM coordinates do not have valid format: " + bomCoordinates);
}

ArtifactResult bomResult =
repositorySystem.resolveArtifact(
session, new ArtifactRequest(bom, ImmutableList.of(CENTRAL), null));

ModelBuildingRequest modelRequest = new DefaultModelBuildingRequest();
modelRequest.setValidationLevel(ModelBuildingRequest.VALIDATION_LEVEL_MINIMAL);
modelRequest.setProcessPlugins(false);
modelRequest.setTwoPhaseBuilding(true); // This forces the builder stop after phase 1
modelRequest.setPomFile(bomResult.getArtifact().getFile());
modelRequest.setModelResolver(new ProjectModelResolver(
session,
null,
repositorySystem,
new DefaultRemoteRepositoryManager(),
ImmutableList.of(),
null,
null));

DefaultModelBuilder modelBuilder = new DefaultModelBuilderFactory().newInstance();
// Phase 1 done. Now variables are interpolated.
ModelBuildingResult resultPhase1 = modelBuilder.build(modelRequest);
DependencyManagement dependencyManagement =
resultPhase1.getEffectiveModel().getDependencyManagement();

for (org.apache.maven.model.Dependency dependency : dependencyManagement.getDependencies()) {
// Replaces the versions of imported BOMs
if ("import".equals(dependency.getScope())) {
findSnapshotVersion(
repositorySystem, session, dependency.getGroupId(), dependency.getArtifactId())
.ifPresent(dependency::setVersion);
}
}

// Phase 2 resolves dependency management imports
ModelBuildingResult resultPhase2 = modelBuilder.build(modelRequest, resultPhase1);
return resultPhase2.getEffectiveModel();
}

/**
* Returns a copy of {@code bom} replacing its managed dependencies that have locally-installed
* snapshot versions.
*/
@VisibleForTesting
static Bom copyWithSnapshot(RepositorySystem repositorySystem, Bom bom)
throws MavenRepositoryException {
throws MavenRepositoryException, ModelBuildingException, ArtifactResolutionException {
ImmutableList.Builder<Artifact> managedDependencies = ImmutableList.builder();
RepositorySystemSession session = RepositoryUtility.newSession(repositorySystem);

for (Artifact managedDependency : bom.getManagedDependencies()) {
Model model = buildModelWithSnapshotBom(repositorySystem, session, bom.getCoordinates());

ArtifactTypeRegistry registry = session.getArtifactTypeRegistry();
ImmutableList<Artifact> newManagedDependencies =
model.getDependencyManagement().getDependencies().stream()
.map(dependency -> RepositoryUtils.toDependency(dependency, registry))
.map(Dependency::getArtifact)
.collect(toImmutableList());
for (Artifact managedDependency : newManagedDependencies) {
if (RepositoryUtility.shouldSkipBomMember(managedDependency)) {
continue;
}
managedDependencies.add(
findSnapshotVersion(repositorySystem, session, managedDependency)
.map(managedDependency::setVersion)
Expand All @@ -172,16 +266,25 @@ static Bom copyWithSnapshot(RepositorySystem repositorySystem, Bom bom)
return new Bom(bom.getCoordinates() + "-SNAPSHOT", managedDependencies.build());
}

private static Optional<String> findSnapshotVersion(
RepositorySystem repositorySystem, RepositorySystemSession session, Artifact artifact)
throws MavenRepositoryException {
return findSnapshotVersion(
repositorySystem, session, artifact.getGroupId(), artifact.getArtifactId());
}

/**
* Returns {@code Optional} describing the highest snapshot version if such version is available
* in {@code repositorySystem}; otherwise an empty {@code Optional}.
*/
private static Optional<String> findSnapshotVersion(
RepositorySystem repositorySystem, RepositorySystemSession session, Artifact artifact)
RepositorySystem repositorySystem,
RepositorySystemSession session,
String groupId,
String artifactId)
throws MavenRepositoryException {
String version =
RepositoryUtility.findHighestVersion(
repositorySystem, session, artifact.getGroupId(), artifact.getArtifactId());
RepositoryUtility.findHighestVersion(repositorySystem, session, groupId, artifactId);
if (version.contains("-SNAPSHOT")) {
return Optional.of(version);
}
Expand Down
Loading