add micro-test

Author: sebastianMindee

docs/code_samples/workflow_execution.txt

@@ -0,0 +1,29 @@
+import com.mindee.MindeeClient;
+import com.mindee.input.LocalInputSource;
+import com.mindee.parsing.common.WorkflowResponse;
+import com.mindee.product.generated.GeneratedV1;
+import com.mindee.http.MindeeHttpException;
+import java.io.IOException;
+
+public class SimpleMindeeClient {
+
+  public static void main(String[] args) throws IOException {
+    String apiKey = "my-api-key";
+    String workflowId = "workflow-id";
+    String filePath = "/path/to/the/file.ext";
+
+    // Init a new client
+    MindeeClient mindeeClient = new MindeeClient(apiKey);
+
+    // Load a file from disk
+    LocalInputSource inputSource = new LocalInputSource(filePath);
+
+    // Parse the file
+    WorkflowResponse.Default response = mindeeClient.executeWorkflow(
+      workflowId,
+      inputSource
+    System.out.println(response.toString());
+
+  }
+
+}

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

@@ -18,6 +18,7 @@
 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;
 
@@ -323,6 +324,40 @@ private <T extends Inference> AsyncPredictResponse<T> enqueueAndParse(
     throw new RuntimeException("Max retries exceeded. Failed to get the document.");
   }
 
+  /**
+   * Send a local file to a workflow execution.
+   */
+  public <T extends Inference> WorkflowResponse<T> executeWorkflow(
+      Class<T> type,
+      String workflowId,
+      LocalInputSource localInputSource
+
+  ) throws IOException {
+    return this.mindeeApi.executeWorkflowPost(
+        type,
+        workflowId,
+        RequestParameters.builder()
+            .file(localInputSource.getFile())
+            .fileName(localInputSource.getFilename())
+            .build()
+    );
+  }
+
+  public WorkflowResponse<GeneratedV1> executeWorkflow(
+      String workflowId,
+      LocalInputSource localInputSource
+
+  ) throws IOException {
+    return this.mindeeApi.executeWorkflowPost(
+        GeneratedV1.class,
+        workflowId,
+        RequestParameters.builder()
+            .file(localInputSource.getFile())
+            .fileName(localInputSource.getFilename())
+            .build()
+    );
+  }
+
   /**
    * Send a local file to a Standard prediction API and parse the results.
    */

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

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.mindee.product.generated.GeneratedV1;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 
@@ -18,4 +19,7 @@ public class WorkflowResponse<DocT extends Inference> extends ApiResponse {
    */
   @JsonProperty("execution")
   Execution<DocT> execution;
+
+  // Type alias for default type parameter
+  public static class Default extends WorkflowResponse<GeneratedV1> {}
 }

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

@@ -0,0 +1,61 @@
+package com.mindee.workflow;
+
+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.Mockito;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+@ExtendWith(MockitoExtension.class)
+public class WorkflowTest {
+  MindeeClient client;
+  MindeeApi mindeeApi;
+  PdfOperation pdfOperation;
+
+  @BeforeEach
+  public void setUp() {
+    mindeeApi = Mockito.mock(MindeeApi.class);
+    pdfOperation = Mockito.mock(PdfOperation.class);
+    client = new MindeeClient(pdfOperation, mindeeApi);
+  }
+
+  @Test
+  void givenAWorkflowMockFileShouldReturnAValidWorkflowObject()
+      throws IOException {
+
+    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(
+            mindeeApi.executeWorkflowPost(
+                GeneratedV1.class,
+                Mockito.any(),
+                Mockito.any()))
+        .thenReturn(predictResponse);
+
+    WorkflowResponse<GeneratedV1> workflowResponse = client.executeWorkflow(
+        "",
+        new LocalInputSource(file)
+    );
+
+    Assertions.assertNotNull(workflowResponse);
+    Mockito.verify(mindeeApi, Mockito.times(1))
+        .predictPost(Mockito.any(), Mockito.any(), Mockito.any());
+  }
+}

tests/test_code_samples.sh

@@ -5,6 +5,7 @@ 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
@@ -41,6 +42,11 @@ 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