Add FailureState to Result

src/main/java/io/codemodder/codetf/CodeTFResult.java

@@ -12,6 +12,7 @@ public final class CodeTFResult {
   private final String summary;
   private final String description;
   private final DetectionTool detectionTool;
+  private final FailureState failureState;
   private final Set<String> failedFiles;
   private final List<CodeTFReference> references;
   private final Map<String, String> properties;
@@ -24,15 +25,17 @@ public CodeTFResult(
       @JsonProperty(value = "summary", index = 2) final String summary,
       @JsonProperty(value = "description", index = 3) final String description,
       @JsonProperty(value = "detectionTool", index = 4) final DetectionTool detectionTool,
-      @JsonProperty(value = "failedFiles", index = 5) final Set<String> failedFiles,
-      @JsonProperty(value = "references", index = 6) final List<CodeTFReference> references,
-      @JsonProperty(value = "properties", index = 7) final Map<String, String> properties,
-      @JsonProperty(value = "changeset", index = 8) final List<CodeTFChangesetEntry> changeset,
-      @JsonProperty(value = "unfixed", index = 9) final List<UnfixedFinding> unfixedFindings) {
+      @JsonProperty(value = "failureState", index = 5) final FailureState failureState,
+      @JsonProperty(value = "failedFiles", index = 6) final Set<String> failedFiles,
+      @JsonProperty(value = "references", index = 7) final List<CodeTFReference> references,
+      @JsonProperty(value = "properties", index = 8) final Map<String, String> properties,
+      @JsonProperty(value = "changeset", index = 9) final List<CodeTFChangesetEntry> changeset,
+      @JsonProperty(value = "unfixed", index = 10) final List<UnfixedFinding> unfixedFindings) {
     this.codemod = CodeTFValidator.requireNonBlank(codemod);
     this.summary = CodeTFValidator.requireNonBlank(summary);
     this.description = CodeTFValidator.requireNonBlank(description);
     this.detectionTool = detectionTool;
+    this.failureState = failureState;
     this.failedFiles = CodeTFValidator.toImmutableCopyOrEmptyOnNull(failedFiles);
     this.references = CodeTFValidator.toImmutableCopyOrEmptyOnNull(references);
     this.properties = CodeTFValidator.toImmutableCopyOrEmptyOnNull(properties);
@@ -46,7 +49,7 @@ public CodeTFResult(
       final String summary,
       final String description,
       final List<CodeTFChangesetEntry> changeset) {
-    this(codemod, summary, description, null, null, null, null, changeset, null);
+    this(codemod, summary, description, null, null, null, null, null, changeset, null);
   }
 
   public String getCodemod() {
@@ -65,6 +68,10 @@ public DetectionTool getDetectionTool() {
     return detectionTool;
   }
 
+  public FailureState getFailureState() {
+    return failureState;
+  }
+
   public Set<String> getFailedFiles() {
     return failedFiles;
   }
@@ -108,6 +115,8 @@ public static class Builder {
     private final CodeTFResult originalResult;
     private String updatedSummary;
     private String updatedDescription;
+
+    private FailureState failureState;
     private List<CodeTFReference> updatedReferences;
     private DetectionTool detectionTool;
     private List<CodeTFChangesetEntry> changeset;
@@ -131,6 +140,11 @@ public Builder withDescription(final String description) {
       return this;
     }
 
+    public Builder withFailureState(final FailureState failureState) {
+      this.failureState = failureState;
+      return this;
+    }
+
     public Builder withReferences(final List<CodeTFReference> references) {
       Objects.requireNonNull(references);
       this.updatedReferences = references;
@@ -171,6 +185,7 @@ public CodeTFResult build() {
           updatedSummary != null ? updatedSummary : originalResult.getSummary(),
           updatedDescription != null ? updatedDescription : originalResult.getDescription(),
           detectionTool != null ? detectionTool : originalResult.getDetectionTool(),
+          failureState != null ? failureState : originalResult.getFailureState(),
           originalResult.getFailedFiles(),
           updatedReferences != null ? updatedReferences : originalResult.getReferences(),
           originalResult.getProperties(),

src/main/java/io/codemodder/codetf/FailureState.java

@@ -0,0 +1,32 @@
+package io.codemodder.codetf;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class FailureState {
+  private final boolean failed;
+  private final String reason;
+  private final String exception;
+
+  @JsonCreator
+  public FailureState(
+      @JsonProperty("failed") final boolean failed,
+      @JsonProperty("reason") final String reason,
+      @JsonProperty("exception") final String exception) {
+    this.failed = failed;
+    this.reason = reason;
+    this.exception = exception;
+  }
+
+  public boolean failed() {
+    return failed;
+  }
+
+  public String reason() {
+    return reason;
+  }
+
+  public String exception() {
+    return exception;
+  }
+}

src/test/java/io/codemodder/codetf/CodeTFResultTest.java

@@ -16,6 +16,7 @@ void it_creates_result() {
             "Hardened object deserialization calls against attack",
             "Lengthier description about deserialization risks, protections, etc...",
             null,
+            null,
             Set.of("/foo/failed.java"),
             List.of(
                 new CodeTFReference(
@@ -61,6 +62,7 @@ void it_creates_result_with_detection_tool() {
             "Hardened object deserialization calls against attack",
             "Lengthier description about deserialization risks, protections, etc...",
             tool,
+            null,
             Set.of("/foo/failed.java"),
             List.of(
                 new CodeTFReference(
@@ -143,6 +145,7 @@ void it_has_changeset_with_ai() {
             "Hardened object deserialization calls against attack",
             "Lengthier description about deserialization risks, protections, etc...",
             null,
+            null,
             Set.of("/foo/failed.java"),
             List.of(
                 new CodeTFReference(
@@ -154,4 +157,12 @@ void it_has_changeset_with_ai() {
 
     assertTrue(result.usesAi());
   }
+
+  @Test
+  void it_has_failure_state() {
+    FailureState state = new FailureState(true, "reason", "exception");
+    assertTrue(state.failed());
+    assertEquals("reason", state.reason());
+    assertEquals("exception", state.exception());
+  }
 }