IT test for resolve-test-dependencies with snapshots #480

jtnord · 2023-05-05T13:06:25Z

this introduces test coverage for both resolve-test-dependencies with overrideWar containing a SNAPSHOT plugin as well as custom-war with addThisPluginToCustomWar

writing the IT was not done separately one for each PR or moved as this would have created more renamed files bloating the diff, or duplicating tests unnecessarily. The commits here are separate for each fix - but review in the respective PRs and the checks and order demonstrates each fix in turn)

the IT here is the first commit 694b0cd
the second e493f34 is Fix creation of Custom Wars #481
the third commit 210884d is Handle SNAPSHOT versions in with overrideWar #478

Testing done

failure without any fixes (custom-war mojo bundles HPI incorrectly #479)

io.jenkins.tools.maven_hpi_plugin.its.override-war-with-snapshot.override-war-with-snapshot
Assertion failed: 

assert jf.getEntry('WEB-INF/plugins/override-war-with-snapshot.hpi') != null
       |  |                                                          |
       |  null                                                       false
       java.util.jar.JarFile@78a96c28

failure with the custom-war fix (Fix creation of Custom Wars #481)

[INFO] --- hpi:3.44-SNAPSHOT:resolve-test-dependencies (default-cli) @ dependant ---
[INFO] Scanned contents of /home/jenkins/agent/workspace/Plugins_maven-hpi-plugin_PR-480/target/its/override-war-with-snapshot/war-with-plugin/target/override-war-with-snapshot.war with 1 bundled plugins
[INFO] Updating direct dependency org.jenkins-ci.tools.hpi.its:override-war-with-snapshot from 1.0.0-SNAPSHOT to 2.0.0-SNAPSHOT (private-e493f342-jenkins)
[INFO] Downloading from do-proxy-incrementals: https://repo.do.jenkins.io/incrementals/org/jenkins-ci/tools/hpi/its/override-war-with-snapshot/2.0.0-SNAPSHOT%20(private-e493f342-jenkins)/override-war-with-snapshot-2.0.0-SNAPSHOT%20(private-e493f342-jenkins).pom
[INFO] Downloading from do-proxy: https://repo.do.jenkins.io/public/org/jenkins-ci/tools/hpi/its/override-war-with-snapshot/2.0.0-SNAPSHOT%20(private-e493f342-jenkins)/override-war-with-snapshot-2.0.0-SNAPSHOT%20(private-e493f342-jenkins).pom
[WARNING] The POM for org.jenkins-ci.tools.hpi.its:override-war-with-snapshot:jar:2.0.0-SNAPSHOT (private-e493f342-jenkins) is missing, no dependency information available
[INFO] Downloading from do-proxy-incrementals: https://repo.do.jenkins.io/incrementals/org/jenkins-ci/tools/hpi/its/override-war-with-snapshot/2.0.0-SNAPSHOT%20(private-e493f342-jenkins)/override-war-with-snapshot-2.0.0-SNAPSHOT%20(private-e493f342-jenkins).jar
[INFO] Downloading from do-proxy: https://repo.do.jenkins.io/public/org/jenkins-ci/tools/hpi/its/override-war-with-snapshot/2.0.0-SNAPSHOT%20(private-e493f342-jenkins)/override-war-with-snapshot-2.0.0-SNAPSHOT%20(private-e493f342-jenkins).jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  6.668 s
[INFO] Finished at: 2023-05-05T16:56:56Z
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.jenkins-ci.tools:maven-hpi-plugin:3.44-SNAPSHOT:resolve-test-dependencies (default-cli) on project dependant: Unable to resolve dependencies: Could not resolve dependencies for project org.jenkins-ci.tools.hpi.its:dependant:hpi:1.0-SNAPSHOT: The following artifacts could not be resolved: org.jenkins-ci.tools.hpi.its:override-war-with-snapshot:jar:2.0.0-SNAPSHOT (private-e493f342-jenkins) (absent): Could not find artifact org.jenkins-ci.tools.hpi.its:override-war-with-snapshot:jar:2.0.0-SNAPSHOT (private-e493f342-jenkins) in do-proxy-incrementals (https://repo.do.jenkins.io/incrementals/) -> [Help 1]
org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.jenkins-ci.tools:maven-hpi-plugin:3.44-SNAPSHOT:resolve-test-dependencies (default-cli) on project dependant: Unable to resolve dependencies

passes with all fixes. (Fix creation of Custom Wars #481 and Handle SNAPSHOT versions in with overrideWar #478)

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests - that demonstrates feature works or fixes the issue

jtnord · 2023-05-05T13:15:48Z

...-snapshot/dependant/src/test/java/org/jenkins_ci/tools/hpi/its/dependant/DependencyTest.java

+
+    @Test
+    public void testVersionOfDependency() throws IOException {
+        Assert.assertEquals("2.0.0-SNAPSHOT", Version.getVersion());


test will fail when run using the dependency declared in the pom, but will pass when using the version of the plugin in the war.

jtnord · 2023-05-05T13:21:07Z

src/it/override-war-with-snapshot/invoker.properties

+# First just build the plugin that we depend on
+invoker.goals.1=-f war-with-plugin -ntp -Dhpi-plugin.version=${project.version} clean install -P quick-build -Drevision=1.0.0-SNAPSHOT
+# Then build another version and create a war containing the newer version
+invoker.goals.2=-f war-with-plugin -ntp -Dhpi-plugin.version=${project.version} clean install -P quick-build -P build-war -Drevision=2.0.0-SNAPSHOT


slightly abnormal syntax of profile activation as invoker will split into multiple invocations on seeing a , so we use -P twice

jtnord · 2023-05-05T13:22:46Z

src/it/override-war-with-snapshot/verify.groovy

+
+assert jf.getEntry('WEB-INF/plugins/override-war-with-snapshot.hpi') != null
+
+return true;


we do not need to perform any checking of the last invocation of the dependant plugin as the junit test will fail if the dependency is not updated.

jtnord · 2023-05-05T13:23:10Z

src/it/override-war-with-snapshot/war-with-plugin/pom.xml

+                  <goal>custom-war</goal>
+                </goals>
+                <configuration>
+                  <addThisPluginToCustomWar>true</addThisPluginToCustomWar>


requires #479

jtnord · 2023-05-05T13:33:16Z

src/it/override-war-with-snapshot/dependant/pom.xml

this plugin depends on the plugin in war-with-plugin

jtnord · 2023-05-05T13:33:59Z

src/it/override-war-with-snapshot/dependant/pom.xml

+    <dependency>
+      <groupId>org.jenkins-ci.tools.hpi.its</groupId>
+      <artifactId>override-war-with-snapshot</artifactId>
+      <version>1.0.0-SNAPSHOT</version>


this version will cause the tests to fail, and will pass when it is updated to 2.0.0-SNAPSHOT

jtnord · 2023-05-05T13:35:23Z

...th-plugin/src/main/java/org/jenkins_ci/tools/hpi/its/override_war_with_snapshot/Version.java

+
+public class Version {
+
+    public static String getVersion() throws IOException {


will return a different version depending on the version of the plugin.

this introduces test coverage for both resolve-test-dependencies with overrideWar containing a SNAPSHOT plugin as well as custom-war with addThisPluginToCustomWar

the paths for files should not be absolute but relative. prior to this change the war contained files like WEB-INF/lib/... (all the usual entries) and /WEB-INF/plugins/.. (for the bundled plugins)

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 · 2023-05-05T16:11:29Z

pom.xml

@@ -372,7 +372,7 @@
          <localRepositoryPath>${basedir}/target/local-repo</localRepositoryPath>
          <settingsFile>src/it/settings.xml</settingsFile>
          <pomIncludes>
-            <pomInclude>*/pom.xml</pomInclude>
+            <pomInclude>*</pomInclude>


any subdirectory (non recursive) of src/it is now a valid IT - we do not need a pom.xml in the root which allows us to have multiple projects for a single IT that do not share an aggregator

jtnord · 2023-05-05T17:16:49Z

src/main/java/org/jenkinsci/maven/plugins/hpi/WarMojo.java

this file is #481

jtnord · 2023-05-05T17:17:27Z

src/main/java/org/jenkinsci/maven/plugins/hpi/TestDependencyMojo.java

this file is #478

basil · 2023-05-09T15:57:20Z

src/it/override-war-with-snapshot/war-with-plugin/pom.xml

+  <developers>
+    <developer>
+      <id>Bob</id>
+      <name>Bob McBobfaceNoam Chomsky</name>


Multiple names when a single name is expected

Suggested change

<name>Bob McBobfaceNoam Chomsky</name>

<name>Bob McBobface</name>

src/main/java/org/jenkinsci/maven/plugins/hpi/TestDependencyMojo.java

This was referenced May 5, 2023

Fix creation of Custom Wars #481

Merged

Handle SNAPSHOT versions in with overrideWar #478

Merged

jtnord force-pushed the ITs branch from d8bf494 to aecbc81 Compare May 5, 2023 13:19

jtnord commented May 5, 2023

View reviewed changes

jtnord added 3 commits May 5, 2023 17:09

IT test for resolve-test-dependencies with snapshots

694b0cd

this introduces test coverage for both resolve-test-dependencies with overrideWar containing a SNAPSHOT plugin as well as custom-war with addThisPluginToCustomWar

Fix creation of Custom Wars

e493f34

the paths for files should not be absolute but relative. prior to this change the war contained files like WEB-INF/lib/... (all the usual entries) and /WEB-INF/plugins/.. (for the bundled plugins)

jtnord force-pushed the ITs branch from aecbc81 to 694b0cd Compare May 5, 2023 16:09

jtnord commented May 5, 2023

View reviewed changes

jtnord requested a review from basil May 5, 2023 17:28

jtnord marked this pull request as ready for review May 5, 2023 17:28

jtnord added the chore label May 5, 2023

basil approved these changes May 9, 2023

View reviewed changes

Merge branch 'master' into ITs

d65f4ba

jtnord merged commit 45dae8d into jenkinsci:master May 11, 2023

jtnord deleted the ITs branch May 11, 2023 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IT test for resolve-test-dependencies with snapshots #480

IT test for resolve-test-dependencies with snapshots #480

jtnord commented May 5, 2023 •

edited

Loading

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023

jtnord May 5, 2023 •

edited

Loading

jtnord May 5, 2023

jtnord May 5, 2023

basil May 9, 2023


		assert jf.getEntry('WEB-INF/plugins/override-war-with-snapshot.hpi') != null

		return true;


		public class Version {

		public static String getVersion() throws IOException {

	<name>Bob McBobfaceNoam Chomsky</name>
	<name>Bob McBobface</name>

IT test for resolve-test-dependencies with snapshots #480

IT test for resolve-test-dependencies with snapshots #480

Conversation

jtnord commented May 5, 2023 • edited Loading

Testing done

Submitter checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtnord May 5, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtnord commented May 5, 2023 •

edited

Loading

jtnord May 5, 2023 •

edited

Loading