add missing keys to workflow + add test + fix shell script

Author: sebastianMindee

src/main/java/com/mindee/MindeeClient.java

@@ -13,12 +13,12 @@
 import com.mindee.parsing.common.AsyncPredictResponse;
 import com.mindee.parsing.common.Inference;
 import com.mindee.parsing.common.PredictResponse;
+import com.mindee.parsing.common.WorkflowResponse;
 import com.mindee.pdf.PdfBoxApi;
 import com.mindee.pdf.PdfOperation;
 import com.mindee.pdf.SplitQuery;
 import com.mindee.product.custom.CustomV1;
 import com.mindee.product.generated.GeneratedV1;
-import com.mindee.parsing.common.WorkflowResponse;
 import java.io.IOException;
 import java.net.URL;
 

src/main/java/com/mindee/parsing/common/Execution.java

@@ -19,38 +19,62 @@
 @AllArgsConstructor
 @NoArgsConstructor
 public class Execution<DocT extends Inference> implements ApiObject {
+  /**
+   * Identifier for the batch to which the execution belongs.
+   */
+  @JsonProperty("batch_name")
+  private String batchName;
+
+  /**
+   * The time at which the execution started.
+   */
+  @JsonProperty("created_at")
+  @JsonDeserialize(using = LocalDateTimeDeserializer.class)
+  private LocalDateTime createdAt;
+
+  /**
+   * File representation within a workflow execution.
+   */
+  @JsonProperty("file")
+  private ExecutionFile file;
+
   /**
    * Identifier for the execution.
    */
   @JsonProperty("id")
   private String id;
 
   /**
-   * Identifier for the workflow.
+   * Deserialized inference object.
    */
-  @JsonProperty("workflow_id")
-  private String workflowId;
+  @JsonProperty("inference")
+  private DocT inference;
 
   /**
-   * The time at which the execution started.
+   * Priority of the execution.
    */
-  @JsonProperty("created_at")
+  @JsonProperty("priority")
+  private String priority;
+
+  /**
+   * The time at which the file was tagged as reviewed.
+   */
+  @JsonProperty("reviewed_at")
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
-  private LocalDateTime createdAt;
+  private LocalDateTime reviewedAt;
 
   /**
    * The time at which the file was uploaded to a workflow.
    */
-  @JsonProperty("uploaded_at")
+  @JsonProperty("available_at")
   @JsonDeserialize(using = LocalDateTimeDeserializer.class)
   private LocalDateTime availableAt;
 
   /**
-   * The time at which the file was tagged as reviewed.
+   * Reviewed fields and values.
    */
-  @JsonProperty("reviewed_at")
-  @JsonDeserialize(using = LocalDateTimeDeserializer.class)
-  private LocalDateTime reviewedAt;
+  @JsonProperty("reviewed_prediction")
+  private GeneratedV1Document reviewedPrediction;
 
   /**
    * Execution Status.
@@ -65,21 +89,15 @@ public class Execution<DocT extends Inference> implements ApiObject {
   private String type;
 
   /**
-   * Information about an error that occurred during the job processing.
-   */
-  @JsonProperty("error")
-  private Error error;
-
-
-  /**
-   * Deserialized inference object.
+   * The time at which the file was uploaded to a workflow.
    */
-  @JsonProperty("inference")
-  private DocT inference;
+  @JsonProperty("uploaded_at")
+  @JsonDeserialize(using = LocalDateTimeDeserializer.class)
+  private LocalDateTime uploadedAt;
 
   /**
-   * Reviewed fields and values.
+   * Identifier for the workflow.
    */
-  @JsonProperty("reviewed_prediction")
-  private GeneratedV1Document reviewedPrediction;
+  @JsonProperty("workflow_id")
+  private String workflowId;
 }

src/main/java/com/mindee/parsing/common/WorkflowResponse.java

@@ -20,6 +20,8 @@ public class WorkflowResponse<DocT extends Inference> extends ApiResponse {
   @JsonProperty("execution")
   Execution<DocT> execution;
 
-  // Type alias for default type parameter
+  /**
+   * Default product is GeneratedV1.
+   */
   public static class Default extends WorkflowResponse<GeneratedV1> {}
 }

src/test/java/com/mindee/workflow/WorkflowTest.java

@@ -1,36 +1,43 @@
 package com.mindee.workflow;
 
+import static org.mockito.Mockito.when;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.mindee.MindeeClient;
-import com.mindee.http.Endpoint;
 import com.mindee.http.MindeeApi;
 import com.mindee.input.LocalInputSource;
-import com.mindee.parsing.common.Document;
 import com.mindee.parsing.common.Execution;
-import com.mindee.parsing.common.PredictResponse;
 import com.mindee.parsing.common.WorkflowResponse;
 import com.mindee.pdf.PdfOperation;
-import com.mindee.product.custom.CustomV1;
 import com.mindee.product.generated.GeneratedV1;
 import java.io.File;
 import java.io.IOException;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
 import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
 import org.mockito.junit.jupiter.MockitoExtension;
 
 @ExtendWith(MockitoExtension.class)
 public class WorkflowTest {
   MindeeClient client;
+  @Mock
+  MindeeClient mockedClient;
   MindeeApi mindeeApi;
   PdfOperation pdfOperation;
 
+  private ObjectMapper objectMapper;
   @BeforeEach
   public void setUp() {
     mindeeApi = Mockito.mock(MindeeApi.class);
     pdfOperation = Mockito.mock(PdfOperation.class);
     client = new MindeeClient(pdfOperation, mindeeApi);
+
+    MockitoAnnotations.openMocks(this);
+    objectMapper = new ObjectMapper();
   }
 
   @Test
@@ -39,23 +46,62 @@ void givenAWorkflowMockFileShouldReturnAValidWorkflowObject()
 
     File file = new File("src/test/resources/file_types/pdf/blank_1.pdf");
 
-    WorkflowResponse predictResponse = new WorkflowResponse();
-    predictResponse.setExecution(new Execution());
-    predictResponse.setApiRequest(null);
-    Mockito.when(
+    WorkflowResponse workflowResponse = new WorkflowResponse();
+    workflowResponse.setExecution(new Execution());
+    workflowResponse.setApiRequest(null);
+    when(
             mindeeApi.executeWorkflowPost(
-                GeneratedV1.class,
+                Mockito.any(),
                 Mockito.any(),
                 Mockito.any()))
-        .thenReturn(predictResponse);
+        .thenReturn(workflowResponse);
 
-    WorkflowResponse<GeneratedV1> workflowResponse = client.executeWorkflow(
+    WorkflowResponse<GeneratedV1> execution = client.executeWorkflow(
         "",
         new LocalInputSource(file)
     );
 
-    Assertions.assertNotNull(workflowResponse);
+    Assertions.assertNotNull(execution);
     Mockito.verify(mindeeApi, Mockito.times(1))
-        .predictPost(Mockito.any(), Mockito.any(), Mockito.any());
+        .executeWorkflowPost(Mockito.any(), Mockito.any(), Mockito.any());
+  }
+
+  @Test
+  void sendingADocumentToAnExecutionShouldDeserializeResponseCorrectly() throws IOException {
+    File jsonFile = new File("src/test/resources/workflows/success.json");
+    WorkflowResponse.Default mockResponse =
+        objectMapper.readValue(jsonFile, WorkflowResponse.Default.class);
+
+    // Mock the executeWorkflow method
+    when(mockedClient.executeWorkflow(Mockito.anyString(), Mockito.any(LocalInputSource.class)))
+        .thenReturn(mockResponse);
+
+    // Test execution
+    String workflowId = "workflow-id";
+    String filePath = "src/test/resources/file_types/pdf/blank_1.pdf";
+    LocalInputSource inputSource = new LocalInputSource(filePath);
+
+    WorkflowResponse<GeneratedV1> response = mockedClient.executeWorkflow(workflowId, inputSource);
+
+    // Assertions
+    Assertions.assertNotNull(response);
+    Assertions.assertNotNull(response.getApiRequest());
+    Assertions.assertNull(response.getExecution().getBatchName());
+    Assertions.assertNull(response.getExecution().getCreatedAt());
+    Assertions.assertNull(response.getExecution().getFile().getAlias());
+    Assertions.assertEquals("default_sample.jpg", response.getExecution().getFile().getName());
+     Assertions.assertEquals("8c75c035-e083-4e77-ba3b-7c3598bd1d8a", response.getExecution().getId());
+     Assertions.assertNull(response.getExecution().getInference());
+     Assertions.assertEquals("medium", response.getExecution().getPriority());
+     Assertions.assertNull(response.getExecution().getReviewedAt());
+     Assertions.assertNull(response.getExecution().getReviewedPrediction());
+     Assertions.assertEquals("processing", response.getExecution().getStatus());
+     Assertions.assertEquals("manual", response.getExecution().getType());
+     Assertions.assertEquals("2024-11-13T13:02:31.699190", response.getExecution().getUploadedAt().toString());
+     Assertions.assertEquals("07ebf237-ff27-4eee-b6a2-425df4a5cca6", response.getExecution().getWorkflowId());
+
+    // Verify that executeWorkflow was called with the correct parameters
+    Mockito.verify(mockedClient).executeWorkflow(workflowId, inputSource);
   }
+
 }

tests/test_code_samples.sh

@@ -5,15 +5,14 @@ OUTPUT_FILE='SimpleMindeeClient.java'
 ACCOUNT=$1
 ENDPOINT=$2
 API_KEY=$3
-WORKFLOW_ID=$4
 
 if [ -z "${ACCOUNT}" ]; then echo "ACCOUNT is required"; exit 1; fi
 if [ -z "${ENDPOINT}" ]; then echo "ENDPOINT is required"; exit 1; fi
 
 # We need the dependencies otherwise we get class not found exceptions
 mvn dependency:copy-dependencies
 
-for f in $(find docs/code_samples -maxdepth 1 -name "*.txt" | sort -h)
+for f in $(find docs/code_samples -maxdepth 1 -name "*.txt" -not -name "workflow_execution.txt" | sort -h)
 do
   echo "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
   echo "${f}"
@@ -42,11 +41,6 @@ do
     sed -i "s/my-version/1/" $OUTPUT_FILE
   fi
 
-  if echo "${f}" | grep -q "workflow_execution.txt"
-  then
-    sed -i "s/workflow-id/$WORKFLOW_ID/" $OUTPUT_FILE
-  fi
-
   sed -i "s/my-api-key/$API_KEY/" $OUTPUT_FILE
   sed -i "s/\/path\/to\/the\/file.ext/src\/test\/resources\/file_types\/pdf\/blank_1.pdf/" $OUTPUT_FILE