PHPLIB-909: expectedError.errorResponse assertion

Author: jmikola

tests/UnifiedSpecTests/ExpectedError.php

@@ -7,6 +7,7 @@
 use MongoDB\Driver\Exception\ExecutionTimeoutException;
 use MongoDB\Driver\Exception\RuntimeException;
 use MongoDB\Driver\Exception\ServerException;
+use MongoDB\Tests\UnifiedSpecTests\Constraint\Matches;
 use PHPUnit\Framework\Assert;
 use stdClass;
 use Throwable;
@@ -19,13 +20,15 @@
 use function PHPUnit\Framework\assertIsArray;
 use function PHPUnit\Framework\assertIsBool;
 use function PHPUnit\Framework\assertIsInt;
+use function PHPUnit\Framework\assertIsObject;
 use function PHPUnit\Framework\assertIsString;
 use function PHPUnit\Framework\assertNotInstanceOf;
 use function PHPUnit\Framework\assertNotNull;
 use function PHPUnit\Framework\assertNull;
 use function PHPUnit\Framework\assertObjectHasAttribute;
 use function PHPUnit\Framework\assertSame;
 use function PHPUnit\Framework\assertStringContainsStringIgnoringCase;
+use function PHPUnit\Framework\assertThat;
 use function PHPUnit\Framework\assertTrue;
 use function property_exists;
 use function sprintf;
@@ -59,6 +62,9 @@ final class ExpectedError
     /** @var string|null */
     private $codeName;
 
+    /** @var Matches|null */
+    private $matchesResultDocument;
+
     /** @var array */
     private $includedLabels = [];
 
@@ -100,6 +106,11 @@ public function __construct(?stdClass $o, EntityMap $entityMap)
             $this->codeName = $o->errorCodeName;
         }
 
+        if (isset($o->errorResponse)) {
+            assertIsObject($o->errorResponse);
+            $this->matchesResultDocument = new Matches($o->errorResponse, $entityMap);
+        }
+
         if (isset($o->errorLabelsContain)) {
             assertIsArray($o->errorLabelsContain);
             assertContainsOnly('string', $o->errorLabelsContain);
@@ -154,6 +165,11 @@ public function assert(?Throwable $e = null): void
             $this->assertCodeName($e);
         }
 
+        if (isset($this->matchesResultDocument)) {
+            assertInstanceOf(CommandException::class, $e);
+            assertThat($e->getResultDocument(), $this->matchesResultDocument, 'CommandException result document matches');
+        }
+
         if (! empty($this->excludedLabels) || ! empty($this->includedLabels)) {
             assertInstanceOf(RuntimeException::class, $e);
 

tests/UnifiedSpecTests/UnifiedTestRunner.php

@@ -64,7 +64,9 @@ final class UnifiedTestRunner
 
     public const MIN_SCHEMA_VERSION = '1.0';
 
-    public const MAX_SCHEMA_VERSION = '1.8';
+    /* Note: This is necessary to support expectedError.errorResponse from 1.12;
+     * however, syntax from 1.9, 1.10, and 1.11 has not been implemented. */
+    public const MAX_SCHEMA_VERSION = '1.12';
 
     /** @var MongoDB\Client */
     private $internalClient;

tests/UnifiedSpecTests/Util.php

@@ -77,7 +77,7 @@ final class Util
             'dropCollection' => ['collection', 'session'],
             'listCollectionNames' => ['authorizedCollections', 'filter', 'maxTimeMS', 'session'],
             'listCollections' => ['authorizedCollections', 'filter', 'maxTimeMS', 'session'],
-            'modifyCollection' => ['collection', 'changeStreamPreAndPostImages'],
+            'modifyCollection' => ['collection', 'changeStreamPreAndPostImages', 'index', 'validator'],
             // Note: commandName is not used by PHP
             'runCommand' => ['command', 'session', 'commandName'],
         ],
@@ -86,7 +86,7 @@ final class Util
             'bulkWrite' => ['let', 'requests', 'session', 'ordered', 'bypassDocumentValidation', 'comment'],
             'createChangeStream' => ['pipeline', 'session', 'fullDocument', 'fullDocumentBeforeChange', 'resumeAfter', 'startAfter', 'startAtOperationTime', 'batchSize', 'collation', 'maxAwaitTimeMS', 'comment', 'showExpandedEvents'],
             'createFindCursor' => ['filter', 'session', 'allowDiskUse', 'allowPartialResults', 'batchSize', 'collation', 'comment', 'cursorType', 'hint', 'limit', 'max', 'maxAwaitTimeMS', 'maxScan', 'maxTimeMS', 'min', 'modifiers', 'noCursorTimeout', 'oplogReplay', 'projection', 'returnKey', 'showRecordId', 'skip', 'snapshot', 'sort'],
-            'createIndex' => ['keys', 'commitQuorum', 'maxTimeMS', 'name', 'session', 'comment'],
+            'createIndex' => ['keys', 'comment', 'commitQuorum', 'maxTimeMS', 'name', 'session', 'unique'],
             'dropIndex' => ['name', 'session', 'maxTimeMS', 'comment'],
             'count' => ['filter', 'session', 'collation', 'hint', 'limit', 'maxTimeMS', 'skip', 'comment'],
             'countDocuments' => ['filter', 'session', 'limit', 'skip', 'collation', 'hint', 'maxTimeMS', 'comment'],