Handle SNAPSHOT versions in with overrideWar
#478
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
if the war scanning encounters a SNAPSHOT build of a plugin then then manifest file will contain a `Plugin-Version` entry like `1.2.3-4-SNAPSHOT (private abcd1234-username)`. This causes a failure when updating the dependencies as the plugin will try and use that directly without stripping off the extra parts. THis strips off any extra parts should they be present so that the version number matches a valid maven version number and also emits a warning to the log about non repeatable builds if any snapshots are encountered.
jtnord
changed the title
overrideWar
jtnord
commented
May 3, 2023
| @@ -517,8 +517,7 @@ private static void appendEntries(String property, Collection<String> additions, | |||
| * @param war The WAR to scan. | |||
| * @return The bundled plugins in the WAR. | |||
| */ | |||
| private static Map<String, String> scanWar(File war, MavenSession session, MavenProject project) | |||
| throws MojoExecutionException { | |||
| private Map<String, String> scanWar(File war) throws MojoExecutionException { | |||
There was a problem hiding this comment.
getLog() is set for the mojo object, so this needs to be non-static. the MavenSession and MavenProject are already set in the Mojo - so these are used directly.
| @@ -550,6 +549,12 @@ private static Map<String, String> scanWar(File war, MavenSession session, Maven | |||
| if (version == null) { | |||
| throw new IllegalArgumentException("Failed to determine version for " + name); | |||
| } | |||
| // handle any extra info in snapshots e.g. " (private-abcd1234-username)" | |||
There was a problem hiding this comment.
Whilst we could use Implementation-Version and then fall back - some plugins (gradle) do not provide this due to tooling or being too old (this was added approx. 2 years ago). Given the need to fallback, it is easier just to handle the legacy case here.
6 tasks
basil
approved these changes
May 9, 2023
src/main/java/org/jenkinsci/maven/plugins/hpi/TestDependencyMojo.java
Outdated
Show resolved
Hide resolved
…jo.java Co-authored-by: Basil Crow <me@basilcrow.com>
Merged
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
if the war scanning encounters a SNAPSHOT build of a plugin then then manifest file will contain a
Plugin-Versionentry like1.2.3-4-SNAPSHOT (private abcd1234-username).This causes a failure when updating the dependencies (
resolve-test-dependencies) as the plugin will try and use that directly without stripping off the extra parts.This strips off any extra parts should they be present so that the version number matches a valid maven version number and also emits a warning to the log about non repeatable builds if any snapshots are encountered.
Testing done
manually tested with a war containing a snapshot using the command
mvn.cmd -B -V -e -DoverrideWar=C:\workarea\myWarWithSnapshot.war -Djenkins.version=2.387.3-cb-2 -DuseUpperBounds=true org.jenkins-ci.tools:maven-hpi-plugin:3.44-20230503.112206-2:resolve-test-dependenciesmojo no longer fails and the log is present in the output
IT in #480
Submitter checklist