Flatten Maven project #386

basil · 2022-11-22T01:57:45Z

Problem

This component originally had a number of Maven modules: a model which was then consumed by a CLI and a Google App Engine client. The Google App Engine client was ripped out at some point, so now the multi-module build remains, even though in practice there is really just one artifact that is produced by this repository, which is the PCT command-line interface (CLI). I could not find any consumers of any artifacts other than the CLI after searching usages in sources and binaries in both the jenkinsci and cloudbees GitHub organizations. As such, the split into multiple modules just makes it more difficult to edit the code and update dependencies.

Solution

Flatten the project into a single CLI module.

Implementation

I essentially just merged the contents of the POM files together. There is no new code here, just moved code.

Testing done

Testing in jenkinsci/bom complete at jenkinsci/bom#1678. I am hoping that James can run the same test for any proprietary consumers.

basil · 2023-01-10T01:59:34Z

pom.xml

+    <maven.scm.providers.version>1.5</maven.scm.providers.version>
+    <trimStackTrace>false</trimStackTrace> <!-- SUREFIRE-1798 -->


Moved from plugins-compat-tester/pom.xml.

BTW I think this is either inherited from the parent POM, or (if the Surefire version is inherited) obsolete.

BTW you never found the time to follow up on #348 (comment).

😕 Is that somehow related to trimStackTrace?

Is trimStackTrace somehow related to flattening the Maven project? 🤷‍♂️

Just to the extent that it is POM text you are copying, and you might not have been aware that it is (IIRC) obsolete and could probably be omitted from the copy. If you did know and do not care, then you can simply ignore.

A workaround you introduced in jenkinsci/plugin-pom#33 and which propagated to other components, and which you never removed once it was no longer needed? Not of concern to me. Do not bother me with such things, especially if you are not willing to follow up on #348 (comment) and similar.

basil · 2023-01-10T02:00:15Z

pom.xml

+      <dependency>
+        <groupId>com.google.code.findbugs</groupId>
+        <artifactId>annotations</artifactId>
+        <version>3.0.1u2</version>
+      </dependency>


Moved from plugins-compat-tester-model/pom.xml.

basil · 2023-01-10T02:00:36Z

pom.xml

+      <dependency>
+        <groupId>net.java.dev.jna</groupId>
+        <artifactId>jna</artifactId>
+        <version>4.1.0</version>
+      </dependency>


Added to resolve an upper bounds conflict.

basil · 2023-01-10T02:01:41Z

pom.xml

+  <build>
+    <finalName>${project.artifactId}</finalName>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>3.2.2</version>
+        <configuration>
+          <archive>
+            <manifestEntries>
+              <Add-Opens>java.base/java.lang.reflect java.base/java.text java.base/java.util java.desktop/java.awt.font</Add-Opens>
+            </manifestEntries>
+          </archive>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-shade-plugin</artifactId>
+        <version>3.2.2</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>shade</goal>
+            </goals>
+            <phase>package</phase>
+            <configuration>
+              <createDependencyReducedPom>false</createDependencyReducedPom>
+              <transformers>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                  <mainClass>org.jenkins.tools.test.PluginCompatTesterCli</mainClass>
+                </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer" />
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />
+                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                  <resource>META-INF/spring.handlers</resource>
+                </transformer>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
+                  <resource>META-INF/spring.schemas</resource>
+                </transformer>
+              </transformers>
+              <filters>
+                <filter>
+                  <artifact>*:*</artifact>
+                  <excludes>
+                    <exclude>META-INF/*.SF</exclude>
+                    <exclude>META-INF/*.RSA</exclude>
+                  </excludes>
+                </filter>
+              </filters>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>


Moved from plugins-compat-tester-cli/pom.xml.

basil · 2023-01-10T02:02:07Z

pom.xml

@@ -115,11 +123,179 @@
  </dependencyManagement>

  <dependencies>
+    <dependency>


Everything added here was moved from one of the other pom.xml files.

jglick · 2023-01-10T13:01:57Z

If merged, then after release RPU could be cleaned up (jenkins-infra/repository-permissions-updater#2827).

See #380 / #381: this will be incompatible for the CB usage since we depend on one of the modules in order to write custom hooks. I expect migration should be simple (just switching artifactId in the dep).

jglick

Thanks! This does seem like a long-overdue simplification.

jglick · 2023-01-10T13:03:00Z

plugins-compat-tester/pom.xml

-	</dependency>
-
-
-    <!--TODO(oleg_nenashev): Remove all providers except Git? -->


Note: merge conflict with #382.

jglick · 2023-01-10T13:03:43Z

pom.xml

+    <maven.scm.providers.version>1.5</maven.scm.providers.version>
+    <trimStackTrace>false</trimStackTrace> <!-- SUREFIRE-1798 -->


BTW I think this is either inherited from the parent POM, or (if the Surefire version is inherited) obsolete.

jtnord · 2023-01-10T13:50:44Z

I could not find any consumers of any artifacts other than the CLI after searching usages in sources and binaries in both the jenkinsci and cloudbees GitHub organizations

we have some specific hooks that we then use when running the CLI.

Will file a PR and see what I can not break.

jtnord · 2023-01-11T13:21:02Z

local code adapted and seems to be progressing well.

jglick · 2023-01-11T13:48:46Z

@basil I think you have permission to merge? If not, I will.

basil · 2023-01-11T15:56:46Z

local code adapted and seems to be progressing well.

Great!

I think you have permission to merge? If not, I will.

I do not require your assistance.

basil force-pushed the flatten branch 2 times, most recently from c7641da to 23fcfba Compare November 22, 2022 03:38

Flatten Maven project

e77b7af

basil force-pushed the flatten branch from 23fcfba to e77b7af Compare January 10, 2023 00:04

basil added a commit to basil/bom that referenced this pull request Jan 10, 2023

Test jenkinsci/plugin-compat-tester#386

e44e000

basil marked this pull request as ready for review January 10, 2023 01:58

basil requested a review from a team as a code owner January 10, 2023 01:58

basil commented Jan 10, 2023

View reviewed changes

basil requested a review from jtnord January 10, 2023 05:53

jglick added the chore label Jan 10, 2023

jglick approved these changes Jan 10, 2023

View reviewed changes

jtnord approved these changes Jan 11, 2023

View reviewed changes

basil added internal and removed chore labels Jan 11, 2023

basil merged commit 8bdba69 into jenkinsci:master Jan 11, 2023

basil deleted the flatten branch January 11, 2023 16:01

basil mentioned this pull request Jan 25, 2023

Update component-plugins-compat-tester.yml jenkins-infra/repository-permissions-updater#3099

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Flatten Maven project #386

Flatten Maven project #386

basil commented Nov 22, 2022 •

edited

Loading

basil Jan 10, 2023

jglick Jan 10, 2023

basil Jan 10, 2023

jglick Jan 10, 2023

basil Jan 10, 2023

jglick Jan 10, 2023

basil Jan 10, 2023

basil Jan 10, 2023

basil Jan 10, 2023

basil Jan 10, 2023

basil Jan 10, 2023

jglick commented Jan 10, 2023

jglick left a comment

jglick Jan 10, 2023

jglick Jan 10, 2023

jtnord commented Jan 10, 2023 •

edited by jglick

Loading

jtnord commented Jan 11, 2023

jglick commented Jan 11, 2023

basil commented Jan 11, 2023

		<maven.scm.providers.version>1.5</maven.scm.providers.version>
		<trimStackTrace>false</trimStackTrace> <!-- SUREFIRE-1798 -->

		</dependency>


		<!--TODO(oleg_nenashev): Remove all providers except Git? -->

Flatten Maven project #386

Flatten Maven project #386

Conversation

basil commented Nov 22, 2022 • edited Loading

Problem

Solution

Implementation

Testing done

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

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

jglick commented Jan 10, 2023

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtnord commented Jan 10, 2023 • edited by jglick Loading

jtnord commented Jan 11, 2023

jglick commented Jan 11, 2023

basil commented Jan 11, 2023

basil commented Nov 22, 2022 •

edited

Loading

jtnord commented Jan 10, 2023 •

edited by jglick

Loading