Hardening Maestro CI: Resolve SpotBugs violations and enable static analysis

build.gradle

@@ -81,7 +81,15 @@ configure(allprojects - project(':netflix-sel')) {
     }
 
     spotbugs {
-        ignoreFailures = true
+        ignoreFailures = false
+    }
+
+    tasks.withType(com.github.spotbugs.snom.SpotBugsTask) {
+        enabled = name.contains("Main")
+        reports {
+            xml.enabled = true
+            html.enabled = true
+        }
     }
 
     group = 'com.netflix.maestro'

maestro-common/src/main/java/com/netflix/maestro/exceptions/MaestroBadRequestException.java

@@ -12,6 +12,7 @@
  */
 package com.netflix.maestro.exceptions;
 
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
@@ -20,6 +21,7 @@
 
 /** Maestro Workflow Bad Request exception. */
 @Getter
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class MaestroBadRequestException extends MaestroRuntimeException {
   private static final long serialVersionUID = -5554778492523995123L;
 

maestro-common/src/main/java/com/netflix/maestro/models/api/JobTemplateCreateRequest.java

@@ -18,6 +18,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.definition.GitInfo;
 import com.netflix.maestro.models.definition.User;
 import com.netflix.maestro.models.stepruntime.JobTemplate;
@@ -39,6 +40,7 @@
     value = {"owner", "status", "support", "test_workflows", "git_info", "definition"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class JobTemplateCreateRequest {
   /** reserved fields cannot be set within extraInfo. */
   private static final Set<String> RESERVED_FIELDS =

maestro-common/src/main/java/com/netflix/maestro/models/api/SignalCreateRequest.java

@@ -7,6 +7,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.netflix.maestro.annotations.Nullable;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.signal.SignalParamValue;
 import com.netflix.maestro.validations.MaestroNameConstraint;
 import java.util.LinkedHashMap;
@@ -26,6 +27,7 @@
     alphabetic = true)
 @Data
 @ToString
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class SignalCreateRequest {
   /** Name of the signal. */
   @MaestroNameConstraint private String name;

maestro-common/src/main/java/com/netflix/maestro/models/api/StepOutputDataRequest.java

@@ -6,6 +6,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.artifact.Artifact;
 import com.netflix.maestro.models.parameter.Parameter;
 import jakarta.validation.Valid;
@@ -20,6 +21,7 @@
     value = {"params", "artifacts"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class StepOutputDataRequest {
   @Valid private Map<String, Parameter> params;
   @Valid private Map<String, Artifact> artifacts;

maestro-common/src/main/java/com/netflix/maestro/models/api/WorkflowCreateRequest.java

@@ -18,6 +18,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.Defaults;
 import com.netflix.maestro.models.definition.GitInfo;
 import com.netflix.maestro.models.definition.Properties;
@@ -36,6 +37,7 @@
     value = {"properties", "workflow", "is_active", "git_info"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class WorkflowCreateRequest {
   @Valid @PropertiesConstraint private Properties properties;
   @Valid @WorkflowConstraint private Workflow workflow;

maestro-common/src/main/java/com/netflix/maestro/models/api/WorkflowPropertiesUpdateRequest.java

@@ -18,6 +18,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.exceptions.MaestroValidationException;
 import com.netflix.maestro.models.definition.AccessControl;
 import com.netflix.maestro.models.definition.Alerting;
@@ -40,6 +41,7 @@
     },
     alphabetic = true)
 @Data
+@SuppressFBWarnings({"EI_EXPOSE_REP", "CT_CONSTRUCTOR_THROW"})
 public class WorkflowPropertiesUpdateRequest {
   @Valid @PropertiesConstraint private Properties properties;
 

maestro-common/src/main/java/com/netflix/maestro/models/artifact/DefaultArtifact.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import lombok.EqualsAndHashCode;
@@ -30,6 +31,7 @@
 @JsonPropertyOrder(alphabetic = true)
 @EqualsAndHashCode
 @ToString
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class DefaultArtifact implements Artifact {
   private static final String VALUE_FIELD = "value";
   private final Map<String, Object> data = new LinkedHashMap<>();

maestro-common/src/main/java/com/netflix/maestro/models/definition/Metadata.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.utils.Checks;
 import java.util.Arrays;
 import java.util.HashSet;
@@ -37,6 +38,7 @@
     value = {"workflow_id", "workflow_version_id", "create_time", "version_author", "git_info"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class Metadata {
   /** Constants for extra info key mappings. */
   private static final String SOURCE = "source";

maestro-common/src/main/java/com/netflix/maestro/models/definition/StepTransition.java

@@ -16,6 +16,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.utils.Checks;
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -31,6 +32,7 @@
     value = {"predecessors", "successors"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class StepTransition {
   /**
    * This is optional. Callers do not need to provide it. If empty, will derive it from DAG during

maestro-common/src/main/java/com/netflix/maestro/models/definition/Tag.java

@@ -20,6 +20,7 @@
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.validations.MaestroNameConstraint;
 import java.util.HashMap;
 import java.util.Locale;
@@ -33,6 +34,7 @@
     value = {"name", "namespace", "permit", "attributes"},
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class Tag {
   @MaestroNameConstraint private String name;
   private Namespace namespace;

maestro-common/src/main/java/com/netflix/maestro/models/definition/TagList.java

@@ -20,6 +20,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.netflix.maestro.annotations.Nullable;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.utils.Checks;
 import jakarta.validation.Valid;
 import java.util.ArrayList;
@@ -34,6 +35,7 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class TagList {
   /** singleton object for empty tag list. */
   public static final TagList EMPTY_TAG_LIST = new TagList(Collections.emptyList());

maestro-common/src/main/java/com/netflix/maestro/models/initiator/UpstreamInitiator.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.netflix.maestro.annotations.Nullable;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.exceptions.MaestroInternalError;
 import com.netflix.maestro.exceptions.MaestroUnprocessableEntityException;
 import com.netflix.maestro.models.parameter.ParamSource;
@@ -37,6 +38,7 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public abstract class UpstreamInitiator implements Initiator {
   private List<Info> ancestors;
 

maestro-common/src/main/java/com/netflix/maestro/models/instance/ForeachDetails.java

@@ -23,6 +23,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.utils.Checks;
 import jakarta.validation.constraints.NotNull;
 import java.io.IOException;
@@ -46,6 +47,7 @@
 @EqualsAndHashCode
 @Getter
 @SuppressWarnings("PMD.LooseCoupling")
+@SuppressFBWarnings({"EI_EXPOSE_REP", "NP_NULL_ON_SOME_PATH"})
 public class ForeachDetails {
   @JsonValue @NotNull private final EnumMap<WorkflowInstance.Status, List<Interval>> info;
 

maestro-common/src/main/java/com/netflix/maestro/models/instance/WorkflowInstance.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.netflix.maestro.annotations.Nullable;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.artifact.Artifact;
 import com.netflix.maestro.models.definition.StepTransition;
 import com.netflix.maestro.models.definition.Workflow;
@@ -70,6 +71,7 @@
     },
     alphabetic = true)
 @Data
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class WorkflowInstance {
   @Valid @NotNull private String workflowId;
 

maestro-common/src/main/java/com/netflix/maestro/models/instance/WorkflowRuntimeOverview.java

@@ -18,6 +18,7 @@
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.netflix.maestro.annotations.Nullable;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.definition.StepTransition;
 import com.netflix.maestro.utils.Checks;
 import java.util.EnumMap;
@@ -37,8 +38,9 @@
     alphabetic = true)
 @Data
 @SuppressWarnings("PMD.LooseCoupling")
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public class WorkflowRuntimeOverview {
-  private long totalStepCount;
+  private volatile long totalStepCount;
   private EnumMap<StepInstance.Status, WorkflowStepStatusSummary> stepOverview =
       new EnumMap<>(StepInstance.Status.class);
 

maestro-common/src/main/java/com/netflix/maestro/models/parameter/AbstractParameter.java

@@ -18,6 +18,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.models.Constants;
 import com.netflix.maestro.models.definition.TagList;
 import com.netflix.maestro.utils.Checks;
@@ -36,6 +37,7 @@
 @Getter
 @SuperBuilder(toBuilder = true)
 @EqualsAndHashCode
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public abstract class AbstractParameter implements Parameter {
   @Setter @JsonIgnore @MaestroReferenceIdConstraint private String name;
 

maestro-common/src/main/java/com/netflix/maestro/models/parameter/BooleanArrayParamDefinition.java

@@ -31,7 +31,6 @@
  *
  * <p>SHOULD NOT mutate the returned array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -42,6 +41,7 @@
 @SuperBuilder(toBuilder = true)
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class BooleanArrayParamDefinition extends AbstractParamDefinition {
   private final boolean[] value;
 

maestro-common/src/main/java/com/netflix/maestro/models/parameter/BooleanArrayParameter.java

@@ -31,7 +31,6 @@
  *
  * <p>SHOULD NOT mutate the evaluated array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -51,6 +50,7 @@
 @Getter(onMethod = @__({@Override}))
 @SuperBuilder(toBuilder = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class BooleanArrayParameter extends AbstractParameter {
   private final boolean[] value;
   private boolean[] evaluatedResult;

maestro-common/src/main/java/com/netflix/maestro/models/parameter/DoubleArrayParamDefinition.java

@@ -34,7 +34,6 @@
  *
  * <p>SHOULD NOT mutate the returned array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -45,6 +44,7 @@
 @SuperBuilder(toBuilder = true)
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class DoubleArrayParamDefinition extends AbstractParamDefinition {
   private final BigDecimal[] value;
 

maestro-common/src/main/java/com/netflix/maestro/models/parameter/DoubleArrayParameter.java

@@ -31,7 +31,6 @@
  *
  * <p>SHOULD NOT mutate the evaluated array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -51,6 +50,7 @@
 @Getter(onMethod = @__({@Override}))
 @SuperBuilder(toBuilder = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class DoubleArrayParameter extends AbstractParameter {
   private final BigDecimal[] value;
   private double[] evaluatedResult;

maestro-common/src/main/java/com/netflix/maestro/models/parameter/LongArrayParamDefinition.java

@@ -31,7 +31,6 @@
  *
  * <p>SHOULD NOT mutate the returned array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -42,6 +41,7 @@
 @SuperBuilder(toBuilder = true)
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class LongArrayParamDefinition extends AbstractParamDefinition {
   private final long[] value;
 

maestro-common/src/main/java/com/netflix/maestro/models/parameter/LongArrayParameter.java

@@ -31,7 +31,6 @@
  *
  * <p>SHOULD NOT mutate the evaluated array data.
  */
-@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder(
@@ -51,6 +50,7 @@
 @Getter(onMethod = @__({@Override}))
 @SuperBuilder(toBuilder = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class LongArrayParameter extends AbstractParameter {
   private final long[] value;
   private long[] evaluatedResult;

maestro-common/src/main/java/com/netflix/maestro/models/parameter/MapParameter.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
 import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+import com.netflix.maestro.annotations.SuppressFBWarnings;
 import com.netflix.maestro.exceptions.MaestroInternalError;
 import com.netflix.maestro.utils.Checks;
 import com.netflix.maestro.utils.MapHelper;
@@ -67,6 +68,7 @@
 @Getter(onMethod = @__({@Override}))
 @SuperBuilder(toBuilder = true)
 @EqualsAndHashCode(callSuper = true)
+@SuppressFBWarnings("EI_EXPOSE_REP")
 public final class MapParameter extends AbstractParameter {
   @Valid private final Map<String, ParamDefinition> value;