Skip to content
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

Jump to bottom

[tycho-4.0.x] Suggest version updates from API tools #4200

Merged
merged 1 commit into from
Aug 31, 2024
Merged

[tycho-4.0.x] Suggest version updates from API tools #4200

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
72 changes: 59 additions & 13 deletions tycho-apitools-plugin/src/main/java/org/eclipse/tycho/apitools/ApiAnalysisMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.Optional;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;

import org.apache.maven.artifact.Artifact;
Expand Down Expand Up @@ -51,13 +52,15 @@
import org.eclipse.tycho.core.EcJLogFileEnhancer;
import org.eclipse.tycho.core.EcJLogFileEnhancer.Source;
import org.eclipse.tycho.core.TychoProjectManager;
import org.eclipse.tycho.core.exceptions.VersionBumpRequiredException;
import org.eclipse.tycho.core.osgitools.DefaultReactorProject;
import org.eclipse.tycho.model.project.EclipseProject;
import org.eclipse.tycho.osgi.framework.EclipseApplication;
import org.eclipse.tycho.osgi.framework.EclipseFramework;
import org.eclipse.tycho.osgi.framework.EclipseWorkspace;
import org.eclipse.tycho.osgi.framework.EclipseWorkspaceManager;
import org.osgi.framework.BundleException;
import org.osgi.framework.Version;

/**
* Performs a PDE-API Tools analysis of this project.
Expand Down Expand Up @@ -114,25 +117,28 @@ public class ApiAnalysisMojo extends AbstractMojo {
@Parameter(defaultValue = "${project.build.directory}/compile-logs")
private File logDirectory;

@Parameter(defaultValue = "true")
@Parameter(defaultValue = "true", property = "tycho.apitools.printProblems")
private boolean printProblems;

@Parameter(defaultValue = "true")
@Parameter(defaultValue = "true", property = "tycho.apitools.printSummary")
private boolean printSummary;

@Parameter(defaultValue = "false")
private boolean failOnResolutionError;

@Parameter(defaultValue = "true")
@Parameter(defaultValue = "true", property = "tycho.apitools.failOnError")
private boolean failOnError;

@Parameter(defaultValue = "false")
@Parameter(defaultValue = "false", property = "tycho.apitools.failOnWarning")
private boolean failOnWarning;

@Parameter(defaultValue = "false", property = "tycho.apitools.failOnVersion")
private boolean failOnVersion;

@Parameter(defaultValue = "false")
private boolean parallel;

@Parameter(defaultValue = "false")
@Parameter(defaultValue = "false", property = "tycho.apitools.enhanceLogs")
private boolean enhanceLogs;

@Component
Expand Down Expand Up @@ -218,7 +224,6 @@ public void execute() throws MojoExecutionException, MojoFailureException {
try (EcJLogFileEnhancer enhancer = EcJLogFileEnhancer.create(logDirectory)) {
enhanceLog(enhancer, problemsMap);
}
return;
}
} catch (IOException e) {
log.warn("Can't enhance logs in directory " + logDirectory);
Expand All @@ -229,13 +234,11 @@ public void execute() throws MojoExecutionException, MojoFailureException {
log.info(warnings.size() + " API warnings");
}
if (errors.size() > 0 && failOnError) {
String msg = errors.stream().map(problem -> {
if (problem.getResourcePath() == null) {
return problem.getMessage();
}
return problem.getResourcePath() + ":" + problem.getLineNumber() + " " + problem.getMessage();
}).collect(Collectors.joining(System.lineSeparator()));
throw new MojoFailureException("There are API errors:" + System.lineSeparator() + msg);
throw getApiError(errors);
}
if (errors.size() > 0 && failOnVersion
&& errors.stream().anyMatch(problem -> problem.getCategory() == IApiProblem.CATEGORY_VERSION)) {
throw getApiError(errors);
}
if (warnings.size() > 0 && failOnWarning) {
String msg = warnings.stream().map(problem -> {
Expand All @@ -249,6 +252,49 @@ public void execute() throws MojoExecutionException, MojoFailureException {
}
}

private MojoFailureException getApiError(List<IApiProblem> errors) {
String problems = errors.stream().map(problem -> {
if (problem.getResourcePath() == null) {
return problem.getMessage();
}
return problem.getResourcePath() + ":" + problem.getLineNumber() + " " + problem.getMessage();
}).collect(Collectors.joining(System.lineSeparator()));
String message = "There are API errors:" + System.lineSeparator() + problems;
for (IApiProblem problem : errors) {
if (problem.getCategory() == IApiProblem.CATEGORY_VERSION) {
switch (problem.getKind()) {
case IApiProblem.REEXPORTED_MAJOR_VERSION_CHANGE:
case IApiProblem.REEXPORTED_REMOVAL_OF_REEXPORT_MAJOR_VERSION_CHANGE:
case IApiProblem.MAJOR_VERSION_CHANGE:
return new VersionBumpRequiredException(message, project,
getSuggestedVersion(current -> new Version(current.getMajor() + 1, 0, 0)));
case IApiProblem.MINOR_VERSION_CHANGE:
case IApiProblem.MINOR_VERSION_CHANGE_EXECUTION_ENV_CHANGED:
case IApiProblem.REEXPORTED_MINOR_VERSION_CHANGE:
return new VersionBumpRequiredException(message, project,
getSuggestedVersion(current -> new Version(current.getMajor(), current.getMinor() + 1, 0)));
default:
break;
}
}
}
return new MojoFailureException(message);
}

private Version getSuggestedVersion(Function<Version, Version> update) {
try {
Optional<ArtifactKey> key = projectManager.getArtifactKey(project);
if (key.isPresent()) {
String version = key.get().getVersion();
Version current = Version.parseVersion(version);
return update.apply(current);
}
} catch(RuntimeException e) {
getLog().warn("Can't determine suggested version!");
}
return null;
}

private void enhanceLog(EcJLogFileEnhancer enhancer, Map<String, List<IApiProblem>> problemsMap) {
Log log = getLog();
int notMapped = 0;
Expand Down
Loading