PHPLIB-468: Integrate spec tests for Convenient Transactions API

Author: alcaeus

tests/SpecTests/ErrorExpectation.php

@@ -5,6 +5,7 @@
 use Exception;
 use MongoDB\Driver\Exception\BulkWriteException;
 use MongoDB\Driver\Exception\CommandException;
+use MongoDB\Driver\Exception\ExecutionTimeoutException;
 use MongoDB\Driver\Exception\RuntimeException;
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Tests\TestCase;
@@ -26,9 +27,10 @@ final class ErrorExpectation
      */
     private static $codeNameMap = [
         'Interrupted' => 11601,
-        'WriteConflict' => 112,
+        'MaxTimeMSExpired' => 50,
         'NoSuchTransaction' => 251,
         'OperationNotSupportedInTransaction' => 263,
+        'WriteConflict' => 112,
     ];
 
     /** @var integer */
@@ -198,7 +200,7 @@ private function assertCodeName(TestCase $test, Exception $actual = null)
          * around this be comparing the error code against a map.
          *
          * TODO: Remove this once PHPC-1386 is resolved. */
-        if ($actual instanceof BulkWriteException) {
+        if ($actual instanceof BulkWriteException || $actual instanceof ExecutionTimeoutException) {
             $test->assertArrayHasKey($this->codeName, self::$codeNameMap);
             $test->assertSame(self::$codeNameMap[$this->codeName], $actual->getCode());
 
@@ -207,6 +209,14 @@ private function assertCodeName(TestCase $test, Exception $actual = null)
 
         $test->assertInstanceOf(CommandException::class, $actual);
         $result = $actual->getResultDocument();
+
+        if (isset($result->writeConcernError)) {
+            $test->assertObjectHasAttribute('codeName', $result->writeConcernError);
+            $test->assertSame($this->codeName, $result->writeConcernError->codeName);
+
+            return;
+        }
+
         $test->assertObjectHasAttribute('codeName', $result);
         $test->assertSame($this->codeName, $result->codeName);
     }

tests/SpecTests/Operation.php

@@ -20,6 +20,7 @@
 use function fclose;
 use function fopen;
 use function MongoDB\is_last_pipeline_operator_write;
+use function MongoDB\with_transaction;
 use function stream_get_contents;
 use function strtolower;
 
@@ -127,6 +128,29 @@ public static function fromCommandMonitoring(stdClass $operation)
         return $o;
     }
 
+    /**
+     * This method is exclusively used to prepare nested operations for the
+     * withTransaction session operation
+     *
+     * @return Operation
+     */
+    private static function fromConvenientTransactions(stdClass $operation)
+    {
+        $o = new self($operation);
+
+        if (isset($operation->error)) {
+            $o->errorExpectation = ErrorExpectation::fromTransactions($operation);
+        }
+
+        $o->resultExpectation = ResultExpectation::fromTransactions($operation, $o->getResultAssertionType());
+
+        if (isset($operation->collectionOptions)) {
+            $o->collectionOptions = (array) $operation->collectionOptions;
+        }
+
+        return $o;
+    }
+
     public static function fromCrud(stdClass $operation)
     {
         $o = new self($operation);
@@ -177,16 +201,17 @@ public static function fromTransactions(stdClass $operation)
     /**
      * Execute the operation and assert its outcome.
      *
-     * @param FunctionalTestCase $test    Test instance
-     * @param Context            $context Execution context
+     * @param FunctionalTestCase $test             Test instance
+     * @param Context            $context          Execution context
+     * @param bool               $bubbleExceptions If true, any exception that was caught is rethrown
      */
-    public function assert(FunctionalTestCase $test, Context $context)
+    public function assert(FunctionalTestCase $test, Context $context, $bubbleExceptions = false)
     {
         $result = null;
         $exception = null;
 
         try {
-            $result = $this->execute($context);
+            $result = $this->execute($test, $context);
 
             /* Eagerly iterate the results of a cursor. This both allows an
              * exception to be thrown sooner and ensures that any expected
@@ -211,6 +236,10 @@ public function assert(FunctionalTestCase $test, Context $context)
         if (isset($this->resultExpectation)) {
             $this->resultExpectation->assert($test, $result);
         }
+
+        if ($exception && $bubbleExceptions) {
+            throw $exception;
+        }
     }
 
     /**
@@ -220,7 +249,7 @@ public function assert(FunctionalTestCase $test, Context $context)
      * @return mixed
      * @throws LogicException if the operation is unsupported
      */
-    private function execute(Context $context)
+    private function execute(FunctionalTestCase $test, Context $context)
     {
         switch ($this->object) {
             case self::OBJECT_CLIENT:
@@ -248,9 +277,9 @@ private function execute(Context $context)
 
                 return $this->executeForDatabase($database, $context);
             case self::OBJECT_SESSION0:
-                return $this->executeForSession($context->session0, $context);
+                return $this->executeForSession($context->session0, $test, $context);
             case self::OBJECT_SESSION1:
-                return $this->executeForSession($context->session1, $context);
+                return $this->executeForSession($context->session1, $test, $context);
             default:
                 throw new LogicException('Unsupported object: ' . $this->object);
         }
@@ -479,12 +508,13 @@ private function executeForGridFSBucket(Bucket $bucket, Context $context)
     /**
      * Executes the session operation and return its result.
      *
-     * @param Session $session
-     * @param Context $context Execution context
+     * @param Session            $session
+     * @param FunctionalTestCase $test
+     * @param Context            $context Execution context
      * @return mixed
      * @throws LogicException if the session operation is unsupported
      */
-    private function executeForSession(Session $session, Context $context)
+    private function executeForSession(Session $session, FunctionalTestCase $test, Context $context)
     {
         switch ($this->name) {
             case 'abortTransaction':
@@ -495,6 +525,21 @@ private function executeForSession(Session $session, Context $context)
                 $options = isset($this->arguments['options']) ? (array) $this->arguments['options'] : [];
 
                 return $session->startTransaction($context->prepareOptions($options));
+            case 'withTransaction':
+                /** @var self[] $callbackOperations */
+                $callbackOperations = array_map(function ($operation) {
+                    return self::fromConvenientTransactions($operation);
+                }, $this->arguments['callback']->operations);
+
+                $callback = function () use ($callbackOperations, $test, $context) {
+                    foreach ($callbackOperations as $operation) {
+                        $operation->assert($test, $context, true);
+                    }
+                };
+
+                $options = isset($this->arguments['options']) ? (array) $this->arguments['options'] : [];
+
+                return with_transaction($session, $callback, $context->prepareOptions($options));
             default:
                 throw new LogicException('Unsupported session operation: ' . $this->name);
         }

tests/SpecTests/TransactionsSpecTest.php

@@ -12,6 +12,7 @@
 use stdClass;
 use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
 use function basename;
+use function dirname;
 use function file_get_contents;
 use function get_object_vars;
 use function glob;
@@ -34,17 +35,17 @@ class TransactionsSpecTest extends FunctionalTestCase
      * @var array
      */
     private static $incompleteTests = [
-        'read-pref: default readPreference' => 'PHPLIB does not properly inherit readPreference for transactions',
-        'read-pref: primary readPreference' => 'PHPLIB does not properly inherit readPreference for transactions',
-        'run-command: run command with secondary read preference in client option and primary read preference in transaction options' => 'PHPLIB does not properly inherit readPreference for transactions',
-        'transaction-options: transaction options inherited from client' => 'PHPLIB does not properly inherit readConcern for transactions',
-        'transaction-options: readConcern local in defaultTransactionOptions' => 'PHPLIB does not properly inherit readConcern for transactions',
-        'transaction-options: readConcern snapshot in startTransaction options' => 'PHPLIB does not properly inherit readConcern for transactions',
+        'transactions/read-pref: default readPreference' => 'PHPLIB does not properly inherit readPreference for transactions',
+        'transactions/read-pref: primary readPreference' => 'PHPLIB does not properly inherit readPreference for transactions',
+        'transactions/run-command: run command with secondary read preference in client option and primary read preference in transaction options' => 'PHPLIB does not properly inherit readPreference for transactions',
+        'transactions/transaction-options: transaction options inherited from client' => 'PHPLIB does not properly inherit readConcern for transactions',
+        'transactions/transaction-options: readConcern local in defaultTransactionOptions' => 'PHPLIB does not properly inherit readConcern for transactions',
+        'transactions/transaction-options: readConcern snapshot in startTransaction options' => 'PHPLIB does not properly inherit readConcern for transactions',
     ];
 
-    private static function doSetUpBeforeClass()
+    private function doSetUp()
     {
-        parent::setUpBeforeClass();
+        parent::setUp();
 
         static::killAllSessions();
     }
@@ -184,9 +185,9 @@ public function provideTests()
     {
         $testArgs = [];
 
-        foreach (glob(__DIR__ . '/transactions/*.json') as $filename) {
+        foreach (glob(__DIR__ . '/transactions*/*.json') as $filename) {
             $json = $this->decodeJson(file_get_contents($filename));
-            $group = basename($filename, '.json');
+            $group = basename(dirname($filename)) . '/' . basename($filename, '.json');
             $runOn = isset($json->runOn) ? $json->runOn : null;
             $data = isset($json->data) ? $json->data : [];
             $databaseName = isset($json->database_name) ? $json->database_name : null;