Merge branch 'fix-versionnumber-on-modulepath'

Author: jqno

CHANGELOG.md

@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+
+- EqualsVerifier's version number was reported as 'null' when run on the modulepath.
+
 ## [4.2.2] - 2025-11-09
 
 ### Fixed

equalsverifier-core/pom.xml

@@ -22,6 +22,16 @@
     </properties>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+                <includes>
+                    <include>version.properties</include>
+                </includes>
+            </resource>
+        </resources>
+
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>

equalsverifier-core/src/main/java/nl/jqno/equalsverifier/internal/util/ErrorMessage.java

@@ -1,5 +1,8 @@
 package nl.jqno.equalsverifier.internal.util;
 
+import java.io.IOException;
+import java.util.Properties;
+
 import nl.jqno.equalsverifier.internal.reflection.ModuleProbe;
 
 public final class ErrorMessage {
@@ -14,11 +17,22 @@ public static String suffix() {
                 .of(
                     "%%\n(EqualsVerifier %%, JDK %% running on %%, on %%. Mockito: %%.)",
                     WEBSITE_URL,
-                    ErrorMessage.class.getPackage().getImplementationVersion(),
+                    getVersion(),
                     System.getProperty("java.version"),
                     ModuleProbe.runsOnModulePath() ? "modulepath" : "classpath",
                     System.getProperty("os.name"),
                     ExternalLibs.isMockitoAvailable() ? "available" : "not available")
                 .format();
     }
+
+    private static String getVersion() {
+        var props = new Properties();
+        try (var is = ErrorMessage.class.getResourceAsStream("/version.properties")) {
+            props.load(is);
+            return props.getProperty("version");
+        }
+        catch (IOException ignored) {
+            return "unknown";
+        }
+    }
 }

equalsverifier-core/src/main/resources/version.properties

@@ -0,0 +1 @@
+version=${project.version}

equalsverifier-test/src/test/java/nl/jqno/equalsverifier/integration/operational/OutputTest.java

@@ -1,5 +1,7 @@
 package nl.jqno.equalsverifier.integration.operational;
 
+import java.util.regex.Pattern;
+
 import nl.jqno.equalsverifier.EqualsVerifier;
 import nl.jqno.equalsverifier.internal.exceptions.AssertionException;
 import nl.jqno.equalsverifier.internal.util.Formatter;
@@ -13,16 +15,18 @@ class OutputTest {
 
     private static final String SEE_ALSO = "For more information, go to";
     private static final String WEBSITE_URL = "https://www.jqno.nl/equalsverifier/errormessages";
-    private static final String SUFFIX = "(EqualsVerifier null, JDK";
     private static final String CLASSPATH = "running on classpath";
     private static final String MESSAGE = "a message for an exception";
+    private static final Pattern SUFFIX =
+            Pattern.compile("\\(EqualsVerifier .*, JDK .* running on (class|module)path, on .*. Mockito: .*\\)");
 
     @Test
     void messageIsValidForSingleType_whenEqualsVerifierFails_givenExceptionIsGeneratedByEqualsVerifierItself() {
         ExpectedException
                 .when(() -> EqualsVerifier.forClass(Point.class).verify())
                 .assertCause(AssertionException.class)
-                .assertMessageContains(Point.class.getSimpleName(), SEE_ALSO, WEBSITE_URL, SUFFIX, CLASSPATH);
+                .assertMessageContains(Point.class.getSimpleName(), SEE_ALSO, WEBSITE_URL, CLASSPATH)
+                .assertMessageMatches(SUFFIX);
     }
 
     @Test
@@ -33,8 +37,8 @@ void messageIsValidForMultipleTypes_whenEqualsVerifierFails_givenExceptionIsGene
                 .assertMessageContains("---")
                 .assertMessageContainsOnce(SEE_ALSO)
                 .assertMessageContainsOnce(WEBSITE_URL)
-                .assertMessageContainsOnce(SUFFIX)
-                .assertMessageContainsOnce(CLASSPATH);
+                .assertMessageContainsOnce(CLASSPATH)
+                .assertMessageMatches(SUFFIX);
     }
 
     @Test
@@ -47,7 +51,8 @@ void messageIsValidAndCauseHasCause_whenEqualsVerifierFails_givenOriginalExcepti
         ExpectedException
                 .when(() -> EqualsVerifier.forClass(AssertionExceptionWithCauseThrower.class).verify())
                 .assertMessageContains(AssertionExceptionWithCauseThrower.class.getSimpleName())
-                .assertMessageContains(SEE_ALSO, WEBSITE_URL, SUFFIX, CLASSPATH, MESSAGE)
+                .assertMessageContains(SEE_ALSO, WEBSITE_URL, CLASSPATH, MESSAGE)
+                .assertMessageMatches(SUFFIX)
                 .assertMessageDoesNotContain(NullPointerException.class.getSimpleName())
                 .assertCause(AssertionException.class)
                 .assertCause(NullPointerException.class);
@@ -59,7 +64,8 @@ void originalMessageIsPresentInOutput_whenEqualsVerifierFails_givenOriginalExcep
                 .when(() -> EqualsVerifier.forClass(UnsupportedOperationExceptionWithMessageThrower.class).verify())
                 .assertMessageContains(UnsupportedOperationExceptionWithMessageThrower.class.getSimpleName())
                 .assertMessageContains(UnsupportedOperationException.class.getSimpleName())
-                .assertMessageContains(SEE_ALSO, WEBSITE_URL, SUFFIX, MESSAGE)
+                .assertMessageContains(SEE_ALSO, WEBSITE_URL, MESSAGE)
+                .assertMessageMatches(SUFFIX)
                 .assertMessageDoesNotContainAfterRemove("EqualsVerifier null", "null")
                 .assertCause(UnsupportedOperationException.class)
                 .assertCauseMessageContains(MESSAGE);
@@ -70,7 +76,8 @@ void messageIsValidAndDoesNotContainStringNull_whenEqualsVerifierFails_givenOrig
         ExpectedException
                 .when(() -> EqualsVerifier.forClass(IllegalStateExceptionThrower.class).verify())
                 .assertMessageContains(IllegalStateExceptionThrower.class.getSimpleName())
-                .assertMessageContains(SEE_ALSO, WEBSITE_URL, SUFFIX, "<no message>")
+                .assertMessageContains(SEE_ALSO, WEBSITE_URL, "<no message>")
+                .assertMessageMatches(SUFFIX)
                 .assertMessageDoesNotContainAfterRemove("EqualsVerifier null", "null")
                 .assertCause(IllegalStateException.class);
     }
@@ -79,7 +86,8 @@ void messageIsValidAndDoesNotContainStringNull_whenEqualsVerifierFails_givenOrig
     void noStackOverflowErrorIsThrown_whenClassIsARecursiveDatastructure() {
         ExpectedException
                 .when(() -> EqualsVerifier.forClass(Node.class).verify())
-                .assertMessageContains(Node.class.getSimpleName(), SEE_ALSO, WEBSITE_URL, SUFFIX)
+                .assertMessageContains(Node.class.getSimpleName(), SEE_ALSO, WEBSITE_URL)
+                .assertMessageMatches(SUFFIX)
                 .assertNotCause(StackOverflowError.class);
     }
 

equalsverifier-testhelpers/src/main/java/nl/jqno/equalsverifier_testhelpers/ExpectedException.java

@@ -1,5 +1,7 @@
 package nl.jqno.equalsverifier_testhelpers;
 
+import java.util.regex.Pattern;
+
 public final class ExpectedException {
 
     private final Throwable e;
@@ -90,6 +92,14 @@ public ExpectedException assertMessageContains(String... fragments) {
         return this;
     }
 
+    public ExpectedException assertMessageMatches(Pattern regex) {
+        String message = e.getMessage();
+        if (!regex.matcher(message).find()) {
+            fail("Message [" + message + "] does not match regex /" + regex + "/");
+        }
+        return this;
+    }
+
     public ExpectedException assertMessageContainsOnce(String fragment) {
         int occurrences = 0;
         String message = e.getMessage();