Improving unit testing framework for history verification (#63)

* - minor CS

* - more explicit unit test for history verification

Author: wolfy-j

tests/Functional/Client/ClientTestCase.php

@@ -11,6 +11,8 @@
 
 namespace Temporal\Tests\Functional\Client;
 
+use Temporal\Api\Enums\V1\EventType;
+use Temporal\Api\History\V1\HistoryEvent;
 use Temporal\Api\Workflowservice\V1\GetWorkflowExecutionHistoryRequest;
 use Temporal\Client\GRPC\ServiceClient;
 use Temporal\Client\WorkflowClient;
@@ -33,6 +35,23 @@ protected function createClient(string $connection = 'localhost:7233'): Workflow
         );
     }
 
+    protected function assertHistoryContainsActivity(
+        WorkflowClient $client,
+        WorkflowExecution $e,
+        string $activity
+    ) {
+        $this->assertHistoryContains(
+            $client,
+            $e,
+            function (HistoryEvent $e) use ($activity) {
+                return (
+                    $e->getEventType() === EventType::EVENT_TYPE_ACTIVITY_TASK_SCHEDULED
+                    && $e->getActivityTaskScheduledEventAttributes()->getActivityType()->getName() == $activity
+                );
+            }
+        );
+    }
+
     protected function assertHistoryContains(
         WorkflowClient $client,
         WorkflowExecution $e,

tests/Functional/Client/SagaTestCase.php

@@ -11,8 +11,6 @@
 
 namespace Temporal\Tests\Functional\Client;
 
-use Temporal\Api\Enums\V1\EventType;
-use Temporal\Api\History\V1\HistoryEvent;
 use Temporal\Exception\Client\WorkflowFailedException;
 use Temporal\Exception\Failure\ActivityFailure;
 use Temporal\Tests\Workflow\SagaWorkflow;
@@ -36,40 +34,8 @@ public function testGetResult()
             $this->assertInstanceOf(ActivityFailure::class, $e->getPrevious());
         }
 
-        $this->assertHistoryContains(
-            $client,
-            $run->getExecution(),
-            function (HistoryEvent $e) {
-                if ($e->getEventType() === EventType::EVENT_TYPE_ACTIVITY_TASK_SCHEDULED) {
-                    // compensation call
-                    if (
-                        $e->getActivityTaskScheduledEventAttributes()->getActivityType()->getName(
-                        ) === 'SimpleActivity.lower'
-                    ) {
-                        return true;
-                    }
-                }
-
-                return false;
-            }
-        );
-
-        $this->assertHistoryContains(
-            $client,
-            $run->getExecution(),
-            function (HistoryEvent $e) {
-                if ($e->getEventType() === EventType::EVENT_TYPE_ACTIVITY_TASK_SCHEDULED) {
-                    // compensation call
-                    if (
-                        $e->getActivityTaskScheduledEventAttributes()->getActivityType()->getName(
-                        ) === 'SimpleActivity.prefix'
-                    ) {
-                        return true;
-                    }
-                }
-
-                return false;
-            }
-        );
+        $this->assertHistoryContainsActivity($client, $run->getExecution(), 'SimpleActivity.echo');
+        $this->assertHistoryContainsActivity($client, $run->getExecution(), 'SimpleActivity.lower');
+        $this->assertHistoryContainsActivity($client, $run->getExecution(), 'SimpleActivity.prefix');
     }
 }