Show classpath/modulepath in error message (#990)

jqno · Aug 20, 2024 · 6d13518 · 6d13518
1 parent d09c305
commit 6d13518
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- The line in the error message that shows the version of EqualsVerifier and the JDK, now also indicates whether EqualsVerifier runs on the classpath or the modulepath.
+
 ## [3.16.1] - 2024-04-03
 
 ### Fixed

diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ Here's a description of the modules:
 | ----------------------------- | --------------------------------------------------------------------- |
 | docs                          | project's Jekyll website                                              |
 | equalsverifier-core           | the actual EqualsVerifier code                                        |
-| equalsverifier-11             | tests for Java 11 and up                                              |
+| equalsverifier-11             | logic for modules, tests for Java 11 and up                           |
 | equalsverifier-16             | logic for records, and corresponding tests                            |
 | equalsverifier-17             | logic for sealed classes, and corresponding tests                     |
 | equalsverifier-21             | tests for record pattern matching                                     |

diff --git a/equalsverifier-11/src/main/java/nl/jqno/equalsverifier/internal/reflection/ModuleHelper.java b/equalsverifier-11/src/main/java/nl/jqno/equalsverifier/internal/reflection/ModuleHelper.java
@@ -0,0 +1,10 @@
+package nl.jqno.equalsverifier.internal.reflection;
+
+public final class ModuleHelper {
+
+    private ModuleHelper() {}
+
+    public static boolean runsOnModulePath() {
+        return ModuleLayer.boot().findModule("nl.jqno.equalsverifier").isPresent();
+    }
+}
diff --git a/equalsverifier-aggregator/src/main/resources/assemblies/assembly.xml b/equalsverifier-aggregator/src/main/resources/assemblies/assembly.xml
@@ -19,6 +19,22 @@
                 </unpackOptions>
             </binaries>
         </moduleSet>
+        <moduleSet>
+            <useAllReactorProjects>true</useAllReactorProjects>
+            <includes>
+                <include>nl.jqno.equalsverifier:equalsverifier-11</include>
+            </includes>
+            <binaries>
+                <outputDirectory>META-INF/versions/11</outputDirectory>
+                <unpack>true</unpack>
+                <includeDependencies>false</includeDependencies>
+                <unpackOptions>
+                    <excludes>
+                        <exclude>/META-INF/**</exclude>
+                    </excludes>
+                </unpackOptions>
+            </binaries>
+        </moduleSet>
         <moduleSet>
             <useAllReactorProjects>true</useAllReactorProjects>
             <includes>

diff --git a/...sverifier-core/src/main/java/nl/jqno/equalsverifier/internal/reflection/ModuleHelper.java b/...sverifier-core/src/main/java/nl/jqno/equalsverifier/internal/reflection/ModuleHelper.java
@@ -0,0 +1,14 @@
+package nl.jqno.equalsverifier.internal.reflection;
+
+/**
+ * Note: this is a generic implementation for a multi-release jar class.
+ * See equalsverifier-11 submodule.
+ */
+public final class ModuleHelper {
+
+    private ModuleHelper() {}
+
+    public static boolean runsOnModulePath() {
+        return false;
+    }
+}
diff --git a/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/ErrorMessage.java b/equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/ErrorMessage.java
@@ -1,5 +1,7 @@
 package nl.jqno.equalsverifier.internal.util;
 
+import nl.jqno.equalsverifier.internal.reflection.ModuleHelper;
+
 public final class ErrorMessage {
 
     private ErrorMessage() {}
@@ -10,10 +12,11 @@ private ErrorMessage() {}
     public static String suffix() {
         return Formatter
             .of(
-                "%%\n(EqualsVerifier %%, JDK %% on %%)",
+                "%%\n(EqualsVerifier %%, JDK %% running on %%, on %%)",
                 WEBSITE_URL,
                 ErrorMessage.class.getPackage().getImplementationVersion(),
                 System.getProperty("java.version"),
+                ModuleHelper.runsOnModulePath() ? "modulepath" : "classpath",
                 System.getProperty("os.name")
             )
             .format();

diff --git a/equalsverifier-release-main/pom.xml b/equalsverifier-release-main/pom.xml
@@ -167,6 +167,13 @@
             <scope>provided</scope>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>nl.jqno.equalsverifier</groupId>
+            <artifactId>equalsverifier-11</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>nl.jqno.equalsverifier</groupId>
             <artifactId>equalsverifier-16</artifactId>

diff --git a/equalsverifier-release-nodep/pom.xml b/equalsverifier-release-nodep/pom.xml
@@ -166,6 +166,12 @@
             <version>${project.version}</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>nl.jqno.equalsverifier</groupId>
+            <artifactId>equalsverifier-11</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>nl.jqno.equalsverifier</groupId>
             <artifactId>equalsverifier-16</artifactId>

diff --git a/...se-verify/src/test/java/nl/jqno/equalsverifier/verify_release/jar/helper/JarAsserter.java b/...se-verify/src/test/java/nl/jqno/equalsverifier/verify_release/jar/helper/JarAsserter.java
@@ -30,6 +30,7 @@ public void assertPresenceOfCoreClasses() {
 
     public void assertPresenceOfMultiReleaseClasses() {
         assertPresenceOf(
+            "/META-INF/versions/11" + EV + "/internal/reflection/ModuleHelper.class",
             "/META-INF/versions/16" + EV + "/internal/reflection/RecordsHelper.class",
             "/META-INF/versions/17" + EV + "/internal/reflection/SealedTypesHelper.class"
         );

diff --git a/...r-release-verify/src/test/java/nl/jqno/equalsverifier/verify_release/pom/MainPomTest.java b/...r-release-verify/src/test/java/nl/jqno/equalsverifier/verify_release/pom/MainPomTest.java
@@ -31,12 +31,13 @@ public void artifactId() {
     @Test
     public void dependencies() {
         assertAll(
-            () -> pom.assertNumberOfDependencies(5),
+            () -> pom.assertNumberOfDependencies(6),
             () -> pom.assertDependencyIsOptional(1),
             () -> pom.assertDependencyIsOptional(2),
             () -> pom.assertDependencyIsOptional(3),
-            () -> pom.assertDependency(4, "org.objenesis", "objenesis"),
-            () -> pom.assertDependency(5, "net.bytebuddy", "byte-buddy")
+            () -> pom.assertDependencyIsOptional(4),
+            () -> pom.assertDependency(5, "org.objenesis", "objenesis"),
+            () -> pom.assertDependency(6, "net.bytebuddy", "byte-buddy")
         );
     }
 }