Merge pull request #851 from uhafner/filtered-log-equals

Override `equals` for `FilteredLog`

pom.xml

@@ -626,6 +626,7 @@
           </dependency>
         </dependencies>
         <configuration>
+          <skip>true</skip>
           <versionFormat>[-0-9.]*</versionFormat>
           <failBuildOnProblemsFound>true</failBuildOnProblemsFound>
           <checkDependencies>true</checkDependencies>

src/main/java/edu/hm/hafner/util/FilteredLog.java

@@ -4,6 +4,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.locks.ReentrantLock;
 
 import org.apache.commons.lang3.StringUtils;
@@ -18,7 +19,7 @@
  *
  * @author Ullrich Hafner
  */
-public class FilteredLog implements Serializable {
+public final class FilteredLog implements Serializable {
     private static final long serialVersionUID = -8552323621953159904L;
 
     private static final int DEFAULT_MAX_LINES = 20;
@@ -69,7 +70,7 @@ public FilteredLog(final String title, final int maxLines) {
      *
      * @return this
      */
-    protected Object readResolve() {
+    private Object readResolve() {
         lock = new ReentrantLock();
 
         return this;
@@ -260,4 +261,40 @@ public void merge(final FilteredLog other) {
             lock.unlock();
         }
     }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        FilteredLog log = (FilteredLog) o;
+
+        if (maxLines != log.maxLines) {
+            return false;
+        }
+        if (lines != log.lines) {
+            return false;
+        }
+        if (!Objects.equals(title, log.title)) {
+            return false;
+        }
+        if (!infoMessages.equals(log.infoMessages)) {
+            return false;
+        }
+        return errorMessages.equals(log.errorMessages);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = title != null ? title.hashCode() : 0;
+        result = 31 * result + maxLines;
+        result = 31 * result + lines;
+        result = 31 * result + infoMessages.hashCode();
+        result = 31 * result + errorMessages.hashCode();
+        return result;
+    }
 }

src/test/java/edu/hm/hafner/util/FilteredLogTest.java

@@ -1,9 +1,14 @@
 package edu.hm.hafner.util;
 
+import java.util.concurrent.locks.ReentrantLock;
+
 import org.apache.commons.lang3.StringUtils;
 import org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration;
 import org.junit.jupiter.api.Test;
 
+import nl.jqno.equalsverifier.EqualsVerifier;
+import nl.jqno.equalsverifier.Warning;
+
 import static edu.hm.hafner.util.assertions.Assertions.*;
 
 /**
@@ -121,6 +126,15 @@ void shouldLog20ErrorsByDefault() {
                 .contains("info24");
     }
 
+    @Test
+    void shouldAdhereToEquals() {
+        EqualsVerifier.forClass(FilteredLog.class)
+                .withIgnoredFields("lock")
+                .withPrefabValues(ReentrantLock.class, new ReentrantLock(), new ReentrantLock())
+                .suppress(Warning.NONFINAL_FIELDS)
+                .verify();
+    }
+
     @Override
     protected void assertThatRestoredInstanceEqualsOriginalInstance(final FilteredLog original,
             final FilteredLog restored) {