♻️ minor tweaks to workflow tests (#129)

Author: ianardee

.github/workflows/_test-integrations.yml

@@ -12,6 +12,7 @@ env:
   MINDEE_ENDPOINT_SE_TESTS: ${{ secrets.MINDEE_ENDPOINT_SE_TESTS }}
   MINDEE_API_KEY: ${{ secrets.MINDEE_API_KEY_SE_TESTS }}
   WORKFLOW_ID: ${{ secrets.WORKFLOW_ID_SE_TESTS }}
+
 jobs:
   integration-tests-ubuntu:
     name: Run Integration Tests on Ubuntu

src/Client.php

@@ -278,10 +278,12 @@ private function makeEnqueueRequest(
                 );
             }
         }
-        $response = ResponseValidation::cleanRequestData($options->endpoint->predictAsyncRequestPost(
-            $inputDoc,
-            $options
-        ));
+        $response = ResponseValidation::cleanRequestData(
+            $options->endpoint->predictAsyncRequestPost(
+                $inputDoc,
+                $options
+            )
+        );
         if (!ResponseValidation::isValidAsyncResponse($response)) {
             throw MindeeHttpException::handleError(
                 $options->endpoint->settings->endpointName,
@@ -436,7 +438,13 @@ public function enqueueAndParse(
         $options->endpoint = $options->endpoint ?? $this->constructOTSEndpoint(
             $predictionType,
         );
-        $enqueueResponse = $this->enqueue($predictionType, $inputDoc, $options, $pageOptions);
+
+        $enqueueResponse = $this->enqueue(
+            $predictionType,
+            $inputDoc,
+            $options,
+            $pageOptions
+        );
         error_log("Successfully enqueued document with job id: " . $enqueueResponse->job->id);
 
         sleep($asyncOptions->initialDelaySec);
@@ -455,7 +463,7 @@ public function enqueueAndParse(
         if ($pollResults->job->status != "completed") {
             throw new MindeeApiException(
                 "Couldn't retrieve document " . $enqueueResponse->job->id . " after $retryCounter tries.",
-                ErrorCode::API_TIMEOUT
+                ErrorCode::API_TIMEOUT,
             );
         }
         return $pollResults;

src/Http/BaseEndpoint.php

@@ -67,9 +67,10 @@ public function setFinalCurlOpts(
         ?array $postFields,
         ?string $workflowId = null
     ): array {
-        $url = $this->settings->urlRoot . $suffix;
         if (isset($workflowId)) {
             $url = $this->settings->baseUrl . "/workflows/" . $workflowId . $suffix;
+        } else {
+            $url = $this->settings->urlRoot . $suffix;
         }
         curl_setopt($ch, CURLOPT_URL, $url);
         if ($postFields !== null) {

tests/ClientTest.php

@@ -27,21 +27,22 @@ class ClientTest extends TestCase
 
     protected function setUp(): void
     {
+        $rootPath = (getenv('GITHUB_WORKSPACE') ?: ".");
         $this->oldKey = getenv('MINDEE_API_KEY');
         $this->dummyClient = new Client("dummy-key");
         putenv('MINDEE_API_KEY=');
         $this->emptyClient = new Client();
         putenv('MINDEE_API_KEY=dummy-env-key');
         $this->envClient = new Client();
         $this->fileTypesDir = (
-            getenv('GITHUB_WORKSPACE') ?: "."
-            ) . "/tests/resources/file_types/";
+            $rootPath . "/tests/resources/file_types/"
+        );
         $this->invoicePath = (
-            getenv('GITHUB_WORKSPACE') ?: "."
-            ) . "/tests/resources/products/invoices/response_v4/complete.json";
+            $rootPath . "/tests/resources/products/invoices/response_v4/complete.json"
+        );
         $this->failedJobPath = (
-            getenv('GITHUB_WORKSPACE') ?: "."
-            ) . "/tests/resources/async/get_failed_job_error.json";
+            $rootPath . "/tests/resources/async/get_failed_job_error.json"
+        );
     }
 
 

tests/Workflow/WorkflowTest.php

@@ -13,12 +13,13 @@ class WorkflowTest extends TestCase
 
     protected function setUp(): void
     {
+        $rootPath = (getenv('GITHUB_WORKSPACE') ?: ".");
         $this->findocSamplePath = (
-            getenv('GITHUB_WORKSPACE') ?: "."
-            ) . "/tests/resources/products/financial_document/default_sample.jpg";
+            $rootPath . "/tests/resources/products/financial_document/default_sample.jpg"
+        );
         $this->workflowDir = (
-            getenv('GITHUB_WORKSPACE') ?: "."
-            ) . "/tests/resources/workflows/";
+            $rootPath . "/tests/resources/workflows/"
+        );
     }
 
     public function testDeserializeWorkflow()

tests/Workflow/WorkflowTestFunctional.php

@@ -15,13 +15,16 @@ class WorkflowTestFunctional extends TestCase
     private $workflowId;
     private $mindeeClient;
     private $inputSource;
+    private $predictionType;
 
     protected function setUp(): void
     {
+        $rootPath = (getenv('GITHUB_WORKSPACE') ?: ".");
         $this->mindeeClient = new Client();
         $this->workflowId = getenv('WORKFLOW_ID') ?: '';
+        $this->predictionType = FinancialDocumentV1::class;
         $this->inputSource = $this->mindeeClient->sourceFromPath(
-            (getenv('GITHUB_WORKSPACE') ?: ".") . "/tests/resources/products/financial_document/default_sample.jpg"
+            $rootPath . "/tests/resources/products/financial_document/default_sample.jpg"
         );
     }
 
@@ -34,7 +37,9 @@ public function testWorkflow() {
             null,
             true
         );
-        $response = $this->mindeeClient->executeWorkflow($this->inputSource, $this->workflowId, $options);
+        $response = $this->mindeeClient->executeWorkflow(
+            $this->inputSource, $this->workflowId, $options
+        );
         $this->assertEquals(202, $response->apiRequest->statusCode);
         $this->assertEquals("php-$currentDateTime", $response->execution->file->alias);
         $this->assertEquals("low", $response->execution->priority);
@@ -44,7 +49,7 @@ public function testWorkflowPollingWithRAG() {
         $options = new PredictMethodOptions();
         $options->setRAG(true)->setWorkflowId($this->workflowId);
         $response = $this->mindeeClient->enqueueAndParse(
-            FinancialDocumentV1::class,
+            $this->predictionType,
             $this->inputSource,
             $options
         );
@@ -57,7 +62,7 @@ public function testWorkflowPollingWithoutRAG() {
         $options = new PredictMethodOptions();
         $options->setWorkflowId($this->workflowId);
         $response = $this->mindeeClient->enqueueAndParse(
-            FinancialDocumentV1::class,
+            $this->predictionType,
             $this->inputSource,
             $options
         );