Make expected document assertions more flexible

Normalizing top-level documents as arrays will allow single and multi-document checks to be more flexible. This will not extend to embedded documents, where we'll still need to be explicit.

Additionally, assertSameDocuments can now operate on any array or Traversable without needing to set its own type map.

Author: jmikola

tests/Collection/CrudSpec/AggregateFunctionalTest.php

@@ -32,12 +32,11 @@ public function testAggregateWithMultipleStages()
         );
 
         $expected = array(
-            (object) array('_id' => 2, 'x' => 22),
-            (object) array('_id' => 3, 'x' => 33),
+            array('_id' => 2, 'x' => 22),
+            array('_id' => 3, 'x' => 33),
         );
 
-        // Use iterator_to_array() here since aggregate() may return an ArrayIterator
-        $this->assertEquals($expected, iterator_to_array($cursor));
+        $this->assertSameDocuments($expected, $cursor);
     }
 
     public function testAggregateWithOut()

tests/Collection/CrudSpec/FindOneAndDeleteFunctionalTest.php

@@ -25,7 +25,7 @@ public function testFindOneAndDeleteWhenManyDocumentsMatch()
         );
 
         $document = $this->collection->findOneAndDelete($filter, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -44,7 +44,7 @@ public function testFindOneAndDeleteWhenOneDocumentMatches()
         );
 
         $document = $this->collection->findOneAndDelete($filter, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),

tests/Collection/CrudSpec/FindOneAndReplaceFunctionalTest.php

@@ -29,7 +29,7 @@ public function testFindOneAndReplaceWhenManyDocumentsMatchReturningDocumentBefo
         );
 
         $document = $this->collection->findOneAndReplace($filter, $replacement, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -51,7 +51,7 @@ public function testFindOneAndReplaceWhenManyDocumentsMatchReturningDocumentAfte
         );
 
         $document = $this->collection->findOneAndReplace($filter, $replacement, $options);
-        $this->assertEquals((object) array('x' => 32), $document);
+        $this->assertSameDocument(array('x' => 32), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -72,7 +72,7 @@ public function testFindOneAndReplaceWhenOneDocumentMatchesReturningDocumentBefo
         );
 
         $document = $this->collection->findOneAndReplace($filter, $replacement, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -94,7 +94,7 @@ public function testFindOneAndReplaceWhenOneDocumentMatchesReturningDocumentAfte
         );
 
         $document = $this->collection->findOneAndReplace($filter, $replacement, $options);
-        $this->assertEquals((object) array('x' => 32), $document);
+        $this->assertSameDocument(array('x' => 32), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -185,7 +185,7 @@ public function testFindOneAndReplaceWithUpsertWhenNoDocumentsMatchReturningDocu
         );
 
         $document = $this->collection->findOneAndReplace($filter, $replacement, $options);
-        $this->assertEquals((object) array('x' => 44), $document);
+        $this->assertSameDocument(array('x' => 44), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),

tests/Collection/CrudSpec/FindOneAndUpdateFunctionalTest.php

@@ -29,7 +29,7 @@ public function testFindOneAndUpdateWhenManyDocumentsMatchReturningDocumentBefor
         );
 
         $document = $this->collection->findOneAndUpdate($filter, $update, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -51,7 +51,7 @@ public function testFindOneAndUpdateWhenManyDocumentsMatchReturningDocumentAfter
         );
 
         $document = $this->collection->findOneAndUpdate($filter, $update, $options);
-        $this->assertEquals((object) array('x' => 23), $document);
+        $this->assertSameDocument(array('x' => 23), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -72,7 +72,7 @@ public function testFindOneAndUpdateWhenOneDocumentMatchesReturningDocumentBefor
         );
 
         $document = $this->collection->findOneAndUpdate($filter, $update, $options);
-        $this->assertEquals((object) array('x' => 22), $document);
+        $this->assertSameDocument(array('x' => 22), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -94,7 +94,7 @@ public function testFindOneAndUpdateWhenOneDocumentMatchesReturningDocumentAfter
         );
 
         $document = $this->collection->findOneAndUpdate($filter, $update, $options);
-        $this->assertEquals((object) array('x' => 23), $document);
+        $this->assertSameDocument(array('x' => 23), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),
@@ -183,7 +183,7 @@ public function testFindOneAndUpdateWithUpsertWhenNoDocumentsMatchReturningDocum
         );
 
         $document = $this->collection->findOneAndUpdate($filter, $update, $options);
-        $this->assertEquals((object) array('x' => 1), $document);
+        $this->assertSameDocument(array('x' => 1), $document);
 
         $expected = array(
             array('_id' => 1, 'x' => 11),

tests/FunctionalTestCase.php

@@ -6,6 +6,8 @@
 use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Manager;
 use MongoDB\Driver\ReadPreference;
+use stdClass;
+use Traversable;
 
 abstract class FunctionalTestCase extends TestCase
 {
@@ -38,10 +40,32 @@ protected function assertCommandSucceeded($document)
         $this->assertEquals(1, $document['ok']);
     }
 
-    protected function assertSameDocuments(array $expected, $cursor)
+    protected function assertSameDocument($expectedDocument, $actualDocument)
     {
-        $cursor->setTypeMap(array('document' => 'array'));
-        $this->assertEquals($expected, iterator_to_array($cursor));
+        $this->assertEquals(
+            ($expectedDocument instanceof stdClass) ? (array) $expectedDocument : $expectedDocument,
+            ($actualDocument instanceof stdClass) ? (array) $actualDocument : $actualDocument
+        );
+    }
+
+    protected function assertSameDocuments(array $expectedDocuments, $actualDocuments)
+    {
+        if ($actualDocuments instanceof Traversable) {
+            $actualDocuments = iterator_to_array($actualDocuments);
+        }
+
+        if ( ! is_array($actualDocuments)) {
+            throw new InvalidArgumentException('$actualDocuments is not an array or Traversable');
+        }
+
+        $normalizeRootDocuments = function($document) {
+            return ($document instanceof stdClass) ? (array) $document : $document;
+        };
+
+        $this->assertEquals(
+            array_map($normalizeRootDocuments, $expectedDocuments),
+            array_map($normalizeRootDocuments, $actualDocuments)
+        );
     }
 
     protected function getServerVersion(ReadPreference $readPreference = null)