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

Skip the transformer if log4j-api isn't present #134

Merged
merged 3 commits into from
Oct 15, 2024
+20 −8
Merged

Skip the transformer if log4j-api isn't present #134

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fbf2ff7
Skip the transformer if log4j-api isn't present
rgoers Oct 15, 2024
df3350d
Chanage Log message
rgoers Oct 15, 2024
4b76788
Convert exceptions to just logging errors and returning
rgoers Oct 15, 2024
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
28 changes: 20 additions & 8 deletions ...orm-maven-plugin/src/main/java/org/apache/logging/log4j/transform/maven/LocationMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import org.apache.logging.log4j.transform.maven.scan.ClassFileInclusionScanner;
Expand Down Expand Up @@ -106,7 +107,9 @@ public void execute() throws MojoExecutionException, MojoFailureException {
getLog().info("Skipping project with packaging \"pom\".");
return;
}
validateLog4jVersion();
if (!validateLog4jVersion()) {
return;
}

final Path sourceDirectory = this.sourceDirectory.toPath();
final Path outputDirectory = this.outputDirectory.toPath();
Expand Down Expand Up @@ -189,23 +192,32 @@ private WrappedIOException(IOException cause) {
}
}

private void validateLog4jVersion() throws MojoExecutionException {
Artifact log4jApi = project.getArtifacts().stream()
private boolean validateLog4jVersion() throws MojoExecutionException {
rgoers marked this conversation as resolved.
Show resolved Hide resolved
Optional<Artifact> artifact = project.getArtifacts().stream()
.filter(a -> LOG4J_GROUP_ID.equals(a.getGroupId()) && LOG4J_API_ARTIFACT_ID.equals(a.getArtifactId()))
.findAny()
.orElseThrow(() -> new MojoExecutionException("Missing `log4j-api` dependency."));
.findAny();
Artifact log4jApi;
if (artifact.isPresent()) {
log4jApi = artifact.get();
} else {
getLog().info("Skipping project. Log4j API is not being used.");
return false;
}
try {
if (MIN_SUPPORTED_VERSION.compareTo(log4jApi.getSelectedVersion()) > 0) {
throw new MojoExecutionException("Log4j2 API version " + MIN_SUPPORTED_VERSION
+ " required. Selected version: " + log4jApi.getSelectedVersion());
getLog().error("Log4j2 API version " + MIN_SUPPORTED_VERSION + " required. Selected version: "
+ log4jApi.getSelectedVersion());
return false;
}
// Transitive dependency
if (!project.getDependencyArtifacts().contains(log4jApi)) {
getLog().warn("Log4j2 API should not be a transitive dependency.");
}
} catch (OverConstrainedVersionException e) {
throw new MojoExecutionException("Can not determine `log4j-api` version.", e);
getLog().error("Can not determine `log4j-api` version. " + e.getMessage());
return false;
}
return true;
}

private ClassLoader getProjectDependencies() throws MojoExecutionException {
Expand Down