Code checked in from the last spotbugs PR push caused issues with the

DeviceTest unit test. The issue revolved around the equals and hashCode mehtods that were initially be done by lombok. Auto generated by an IDE also failed (using Objects). The issue came up because the methods all called super.equals(). I took this out and all issues were resolved. Lastly the null timestamp unit test was changed because the value will never be null.
nsacyber · Jan 23, 2024 · d6af9fd · d6af9fd
1 parent 2e1ac19
commit d6af9fd
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 4 deletions.
diff --git a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/Device.java b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/Device.java
@@ -20,6 +20,7 @@
 
 import java.sql.Timestamp;
 import java.time.LocalDateTime;
+import java.util.Objects;
 
 @Entity
 @Table(name = "Device")
@@ -112,9 +113,33 @@ public void setLastReportTimestamp(final Timestamp lastReportTimestamp) {
     }
 
     public String toString() {
-        return String.format("Device Name: %s%nStatus: %s%nSummary: %s",
+        return String.format("Device Name: %s%nStatus: %s%nSummary: %s%n",
                 name, healthStatus.getStatus(),
                 supplyChainValidationStatus.toString(),
                 summaryId);
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof Device)) {
+            return false;
+        }
+
+        Device device = (Device) o;
+        return isStateOverridden == device.isStateOverridden
+                && Objects.equals(name, device.name)
+                && healthStatus == device.healthStatus
+                && supplyChainValidationStatus == device.supplyChainValidationStatus
+                && Objects.equals(lastReportTimestamp, device.lastReportTimestamp)
+                && Objects.equals(overrideReason, device.overrideReason)
+                && Objects.equals(summaryId, device.summaryId);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), name, healthStatus,
+                supplyChainValidationStatus, lastReportTimestamp,
+                isStateOverridden, overrideReason, summaryId);
+    }
 }
diff --git a/...ationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/info/NetworkInfo.java b/...ationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/info/NetworkInfo.java
@@ -10,11 +10,12 @@
 
 import java.io.Serializable;
 import java.net.InetAddress;
+import java.util.Arrays;
+import java.util.Objects;
 
 /**
  * This class is used to represent the network info of a device.
  */
-@EqualsAndHashCode
 @Log4j2
 @Embeddable
 public class NetworkInfo implements Serializable {
@@ -112,4 +113,23 @@ private void setMacAddress(final byte[] macAddress) {
         log.debug("setting MAC address to: {}", sb);
         this.macAddress = macAddress;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof NetworkInfo)) {
+            return false;
+        }
+        NetworkInfo that = (NetworkInfo) o;
+        return Objects.equals(hostname, that.hostname)
+                && Objects.equals(ipAddress, that.ipAddress)
+                && Arrays.equals(macAddress, that.macAddress);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = Objects.hash(hostname, ipAddress);
+        result = 31 * result + Arrays.hashCode(macAddress);
+        return result;
+    }
 }
diff --git a/.../src/main/java/hirs/attestationca/persist/entity/userdefined/report/DeviceInfoReport.java b/.../src/main/java/hirs/attestationca/persist/entity/userdefined/report/DeviceInfoReport.java
@@ -20,6 +20,7 @@
 
 import java.io.Serializable;
 import java.net.InetAddress;
+import java.util.Objects;
 
 /**
  * A <code>DeviceInfoReport</code> is a <code>Report</code> used to transfer the
@@ -230,4 +231,27 @@ private void setHardwareInfo(HardwareInfo hardwareInfo) {
     private void setTPMInfo(TPMInfo tpmInfo) {
         this.tpmInfo = tpmInfo;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof DeviceInfoReport)) {
+            return false;
+        }
+        DeviceInfoReport that = (DeviceInfoReport) o;
+        return Objects.equals(networkInfo, that.networkInfo)
+                && Objects.equals(osInfo, that.osInfo)
+                && Objects.equals(firmwareInfo, that.firmwareInfo)
+                && Objects.equals(hardwareInfo, that.hardwareInfo)
+                && Objects.equals(tpmInfo, that.tpmInfo)
+                && Objects.equals(clientApplicationVersion, that.clientApplicationVersion)
+                && Objects.equals(paccorOutputString, that.paccorOutputString);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), networkInfo, osInfo,
+                firmwareInfo, hardwareInfo, tpmInfo,
+                clientApplicationVersion, paccorOutputString);
+    }
 }
diff --git a/...AttestationCA/src/test/java/hirs/attestationca/persist/entity/userdefined/DeviceTest.java b/...AttestationCA/src/test/java/hirs/attestationca/persist/entity/userdefined/DeviceTest.java
@@ -100,11 +100,11 @@ public void testSetNullDeviceInfo() {
      * Tests that retrieving a null LastReportTimestamp will not trigger an exception.
      */
     @Test
-    public void testNullLastReportTimeStamp() {
+    public void testNotNullLastReportTimeStamp() {
         final String name = "my-laptop";
         final DeviceInfoReport deviceInfo = DeviceInfoReportTest.getTestReport();
         final Device device = new Device(name, deviceInfo, HealthStatus.UNKNOWN, AppraisalStatus.Status.UNKNOWN, null, false, null, null);
-        assertNull(device.getLastReportTimestamp());
+        assertNotNull(device.getLastReportTimestamp());
     }
 
     /**