#23 Remove BaseModel since it breaks equals/hashCode contract

Problem of equals and inheritance:
As described in this[1] blog post the Object#equals() requires that it
fulfills the Liskov Substitution Principle (LSP). Our implemenation
breaks this contract. Even worse, it didn't work at all as descibed
in issue 23[2].

Since the BaseModel class does not have any properties, we can remove it.

This patch removes this obsolete class. Also it makes all model classes
final and all properties private. This is an implicit requirement of the
contract of hashCode() to avoid memory leaks in collections. (See linked
blog post on Artima for more details.)

Actually objects must be immutable -- all fields final -- to guaruantee
a stable equal/hashCode behaviour for the whole lifetime of the objects.
But this must be further investigated, if this is possible. For now we
ignore this warning in the test code.

1: https://www.artima.com/articles/how-to-write-an-equality-method-in-java
2: #23

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>io.securecodebox</groupId>
     <artifactId>defectdojo-client</artifactId>
-    <version>2.0.1-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
     <packaging>jar</packaging>
     <name>DefectDojo Client Java</name>
     <description>

src/main/java/io/securecodebox/persistence/defectdojo/model/BaseModel.java

@@ -14,38 +14,38 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class Endpoint extends BaseModel {
+public final class Endpoint implements Model {
   @JsonProperty
-  Long id;
+  private Long id;// FIXME: Use native type here.
 
   @JsonProperty
-  String protocol;
+  private String protocol;
 
   @JsonProperty
-  String host;
+  private String host;
 
   @JsonProperty("fqdm")
-  String fullyQualifiedDomainName;
+  private String fullyQualifiedDomainName;
 
   @JsonProperty
-  Long port;
+  private Long port;// FIXME: Use native type here.
 
   @JsonProperty
-  String path;
+  private String path;
 
   @JsonProperty
-  String query;
+  private String query;
 
   @JsonProperty
-  String fragment;
+  private String fragment;
 
   @JsonProperty
-  Long product;
+  private Long product;// FIXME: Use native type here.
 
   @JsonProperty
-  Boolean mitigated;
+  private Boolean mitigated;// FIXME: Use native type here.
 
   @Override
   public boolean equalsQueryString(Map<String, Object> queryParams) {

src/main/java/io/securecodebox/persistence/defectdojo/model/Endpoint.java

@@ -15,86 +15,86 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class Engagement extends BaseModel {
+public final class Engagement implements Model {
   @JsonProperty("branch_tag")
-  public String branch;
+  private  String branch;
 
   @JsonProperty
-  protected Long id;
+  private Long id;
 
   @JsonProperty
-  protected String name;
+  private String name;
 
   @JsonProperty
-  protected Long product;
+  private Long product;// FIXME: Use native type here.
 
   @JsonProperty("target_start")
-  protected String targetStart;
+  private String targetStart;
 
   @JsonProperty("target_end")
-  protected String targetEnd;
+  private String targetEnd;
 
   @JsonProperty
-  protected Long lead;
+  private Long lead;// FIXME: Use native type here.
 
   @JsonProperty("engagement_type")
   @Builder.Default
-  protected String engagementType = "CI/CD";
+  private String engagementType = "CI/CD";
 
   @JsonProperty
   @Builder.Default
-  protected Status status = Status.IN_PROGRESS;
+  private Status status = Status.IN_PROGRESS;
 
   @JsonProperty
-  protected List<String> tags;
+  private List<String> tags;
 
   @JsonProperty
-  protected String tracker;
+  private String tracker;
 
   @JsonProperty("build_id")
-  protected String buildID;
+  private String buildID;
 
   @JsonProperty("commit_hash")
-  protected String commitHash;
+  private String commitHash;
 
   @JsonProperty("source_code_management_uri")
-  protected String repo;
+  private String repo;
 
   @JsonProperty("build_server")
-  protected Long buildServer;
+  private Long buildServer; // FIXME: Use native type here.
 
   @JsonProperty("source_code_management_server")
-  protected Long scmServer;
+  private Long scmServer; // FIXME: Use natvive type here.
 
   @JsonProperty("orchestration_engine")
-  protected Long orchestrationEngine;
+  private Long orchestrationEngine; // FIXME: Use natvive type here.
 
   @JsonProperty
-  protected String description;
+  private String description;
 
   @JsonProperty("deduplication_on_engagement")
-  protected boolean deduplicationOnEngagement;
+  private boolean deduplicationOnEngagement;
 
   @JsonProperty("threat_model")
-  @Builder.Default
-  protected Boolean threatModel = false;
+  @Builder.Default // FIXME: Use native type here.
+  private Boolean threatModel = false;
 
   @JsonProperty("api_test")
-  @Builder.Default
-  protected Boolean apiTest = false;
+  @Builder.Default // FIXME: Use native type here.
+  private Boolean apiTest = false;
 
   @JsonProperty("pen_test")
-  @Builder.Default
-  protected Boolean penTest = false;
+  @Builder.Default // FIXME: Use native type here.
+  private Boolean penTest = false;
 
   @JsonProperty("check_list")
-  @Builder.Default
-  protected Boolean checkList = false;
+  @Builder.Default // FIXME: Use native type here.
+  private Boolean checkList = false;
 
   @JsonProperty
-  protected String version;
+  private String version;
 
   @Override
   public boolean equalsQueryString(Map<String, Object> queryParams) {

src/main/java/io/securecodebox/persistence/defectdojo/model/Engagement.java

@@ -19,94 +19,94 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class Finding extends BaseModel {
+public final class Finding implements Model {
     @JsonProperty
-    Long id;
+    private Long id;// FIXME: Use native type here.
 
     @JsonProperty
     @NonNull
-    String title;
+    private String title;
 
     @JsonProperty
     @NonNull
-    String description;
+    private String description;
 
     @JsonProperty("found_by")
     @NonNull
-    List<Long> foundBy;
+    private List<Long> foundBy;
 
     @JsonProperty
     @NonNull
-    Severity severity;
+    private Severity severity;
 
     @JsonProperty
     @NonNull
-    Long test;
+    private Long test;// FIXME: Use native type here.
 
     @JsonProperty
-    String mitigation;
+    private String mitigation;
 
     @JsonProperty
-    String impact;
+    private String impact;
 
     @JsonProperty
     @NonNull
     @Builder.Default
-    Boolean active = true;
+    private Boolean active = true;// FIXME: Use native type here.
 
     @JsonProperty
     @NonNull
     @Builder.Default
-    Boolean verified = true;
+    private Boolean verified = true;// FIXME: Use native type here.
 
     @JsonProperty("risk_accepted")
     @NonNull
     @Builder.Default
-    Boolean riskAccepted = false;
+    private Boolean riskAccepted = false;// FIXME: Use native type here.
 
     @JsonProperty("out_of_scope")
     @NonNull
     @Builder.Default
-    Boolean outOfScope = false;
+    private Boolean outOfScope = false;// FIXME: Use native type here.
 
     @JsonProperty
     @NonNull
     @Builder.Default
-    Boolean duplicate = false;
+    private Boolean duplicate = false;// FIXME: Use native type here.
 
     @JsonProperty("duplicate_finding")
     @Builder.Default
-    Long duplicateFinding = null;
+    private Long duplicateFinding = null;// FIXME: Use native type here.
 
     @JsonProperty("false_p")
     @NonNull
     @Builder.Default
-    Boolean falsePositive = false;
+    private Boolean falsePositive = false;// FIXME: Use native type here.
 
     @JsonProperty("component_name")
-    String componentName;
+    private String componentName;
 
     @JsonProperty("component_version")
-    String componentVersion;
+    private String componentVersion;
 
     @JsonProperty("file_path")
-    String filePath;
+    private String filePath;
 
     @JsonProperty
     @NonNull
     @Builder.Default
-    List<Long> endpoints = new LinkedList<>();
+    private List<Long> endpoints = new LinkedList<>();
 
     @JsonProperty("created")
-    OffsetDateTime createdAt;
+    private OffsetDateTime createdAt;
 
     @JsonProperty("mitigated")
-    OffsetDateTime mitigatedAt;
+    private OffsetDateTime mitigatedAt;
 
     @JsonProperty("accepted_risks")
-    List<RiskAcceptance> acceptedRisks;
+    private List<RiskAcceptance> acceptedRisks;
 
     @JsonProperty("numerical_severity")
     public String getNumericalSeverity() {

src/main/java/io/securecodebox/persistence/defectdojo/model/Finding.java

@@ -15,24 +15,24 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class Group extends BaseModel {
+public final class Group implements Model {
     @JsonProperty
-    Long id;
+    private Long id;// FIXME: Use native type here.
 
     @JsonProperty
     @NonNull
-    String name;
+    private String name;
 
     @JsonProperty
-    String description;
+    private String description;
 
     @JsonProperty
-    List<Long> users;
+    private List<Long> users;
 
     @JsonProperty("social_provider")
-    String socialProvider;
+    private String socialProvider;
 
     @Override
     public boolean equalsQueryString(Map<String, Object> queryParams) {

src/main/java/io/securecodebox/persistence/defectdojo/model/Group.java

@@ -14,20 +14,20 @@
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
-@EqualsAndHashCode(callSuper = true)
+@EqualsAndHashCode
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public class GroupMember extends BaseModel {
+public final class GroupMember implements Model {
     @JsonProperty
-    Long id;
+    private Long id;// FIXME: Use native type here.
 
     @JsonProperty("group_id")
-    Long group;
+    private Long group;// FIXME: Use native type here.
 
     @JsonProperty("user_id")
-    Long user;
+    private Long user;// FIXME: Use native type here.
 
     @JsonProperty
-    Long role;
+    private Long role;// FIXME: Use native type here.
 
     @Override
     public boolean equalsQueryString(Map<String, Object> queryParams) {