Implement comparator for Server objects

Author: jmikola

tests/Comparator/ServerComparator.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace MongoDB\Tests\Comparator;
+
+use MongoDB\Driver\Server;
+use SebastianBergmann\Comparator\Comparator;
+use SebastianBergmann\Comparator\ComparisonFailure;
+
+use function sprintf;
+
+class ServerComparator extends Comparator
+{
+    public function accepts($expected, $actual)
+    {
+        return $expected instanceof Server && $actual instanceof Server;
+    }
+
+    public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false): void
+    {
+        if ($expected == $actual) {
+            return;
+        }
+
+        throw new ComparisonFailure(
+            $expected,
+            $actual,
+            '',
+            '',
+            false,
+            sprintf(
+                'Failed asserting that Server("%s:%d") matches expected Server("%s:%d").',
+                $actual->getHost(),
+                $actual->getPort(),
+                $expected->getHost(),
+                $expected->getPort(),
+            ),
+        );
+    }
+}

tests/SpecTests/RetryableReads/Prose2_RetryOnMongosTest.php

@@ -43,6 +43,7 @@ public function testRetryOnDifferentMongos(): void
          */
         $servers = $client->getManager()->getServers();
         assert(count($servers) === 2);
+        $this->assertNotEquals($servers[0], $servers[1]);
 
         // Step 2: Configure the following fail point on each mongos
         foreach ($servers as $server) {
@@ -55,7 +56,7 @@ public function testRetryOnDifferentMongos(): void
                         'errorCode' => self::HOST_UNREACHABLE,
                     ],
                 ],
-                $server
+                $server,
             );
         }
 

tests/SpecTests/RetryableWrites/Prose4_RetryOnDifferentMongosTest.php

@@ -44,6 +44,7 @@ public function testRetryOnDifferentMongos(): void
          */
         $servers = $client->getManager()->getServers();
         assert(count($servers) === 2);
+        $this->assertNotEquals($servers[0], $servers[1]);
 
         // Step 2: Configure the following fail point on each mongos
         foreach ($servers as $server) {

tests/bootstrap.php

@@ -1,13 +1,15 @@
 <?php
 
 use MongoDB\Tests\Comparator\Int64Comparator;
+use MongoDB\Tests\Comparator\ServerComparator;
 use MongoDB\Tests\TestCase;
 use SebastianBergmann\Comparator\Factory as ComparatorFactory;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 // Register custom comparators
 ComparatorFactory::getInstance()->register(new Int64Comparator());
+ComparatorFactory::getInstance()->register(new ServerComparator());
 
 /* Ugly workaround for event system changes in PHPUnit
  * PHPUnit 10 introduces a new event system, and at the same time removes the