PHPLIB-1147, PHPLIB-1148: Int64 improvements (#1112)

* PHPLIB-1147: Create Int64 instances directly * PHPLIB-1148: Add comparator for Int64 objects * Simplify comparison of Int64
mongodb · Jun 22, 2023 · fe47d48 · fe47d48
1 parent eb2a813
commit fe47d48
Show file tree

Hide file tree

Showing 12 changed files with 279 additions and 55 deletions.
diff --git a/phpunit.evergreen.xml b/phpunit.evergreen.xml
@@ -6,7 +6,7 @@
  beStrictAboutOutputDuringTests="true"
  beStrictAboutChangesToGlobalState="true"
  colors="true"
- bootstrap="vendor/autoload.php"
+ bootstrap="tests/bootstrap.php"
  defaultTestSuite="Default Test Suite"
 >
 

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -6,7 +6,7 @@
  beStrictAboutOutputDuringTests="true"
  beStrictAboutChangesToGlobalState="true"
  colors="true"
- bootstrap="vendor/autoload.php"
+ bootstrap="tests/bootstrap.php"
  defaultTestSuite="Default Test Suite"
 >
 

diff --git a/tests/Comparator/Int64Comparator.php b/tests/Comparator/Int64Comparator.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace MongoDB\Tests\Comparator;
+
+use MongoDB\BSON\Int64;
+use SebastianBergmann\Comparator\Comparator;
+use SebastianBergmann\Comparator\ComparisonFailure;
+
+use function is_numeric;
+use function sprintf;
+
+class Int64Comparator extends Comparator
+{
+ public function accepts($expected, $actual)
+ {
+ // Only compare if either value is an Int64 and the other value is numeric
+ return ($expected instanceof Int64 && $this->isComparable($actual))
+ || ($actual instanceof Int64 && $this->isComparable($expected));
+ }
+
+ 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 %s matches expected %s.',
+ $this->exporter->export($actual),
+ $this->exporter->export($expected)
+ )
+ );
+ }
+
+ private function isComparable($value): bool
+ {
+ return $value instanceof Int64 || is_numeric($value);
+ }
+}
diff --git a/tests/Comparator/Int64ComparatorTest.php b/tests/Comparator/Int64ComparatorTest.php
@@ -0,0 +1,211 @@
+<?php
+
+namespace MongoDB\Tests\Comparator;
+
+use Generator;
+use MongoDB\BSON\Int64;
+use PHPUnit\Framework\TestCase;
+use SebastianBergmann\Comparator\ComparisonFailure;
+
+class Int64ComparatorTest extends TestCase
+{
+ /** @dataProvider provideAcceptsValues */
+ public function testAccepts(bool $expectedResult, $expectedValue, $actualValue): void
+ {
+ $this->assertSame($expectedResult, (new Int64Comparator())->accepts($expectedValue, $actualValue));
+ }
+
+ public static function provideAcceptsValues(): Generator
+ {
+ yield 'Expects Int64, Actual Int64' => [
+ 'expectedResult' => true,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects Int64, Actual int' => [
+ 'expectedResult' => true,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => 123,
+ ];
+
+ yield 'Expects Int64, Actual int string' => [
+ 'expectedResult' => true,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => '123',
+ ];
+
+ yield 'Expects Int64, Actual float' => [
+ 'expectedResult' => true,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => 123.0,
+ ];
+
+ yield 'Expects Int64, Actual float string' => [
+ 'expectedResult' => true,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => '123.0',
+ ];
+
+ yield 'Expects Int64, Actual non-numeric string' => [
+ 'expectedResult' => false,
+ 'expectedValue' => new Int64(123),
+ 'actualValue' => 'foo',
+ ];
+
+ yield 'Expects int, Actual Int64' => [
+ 'expectedResult' => true,
+ 'expectedValue' => 123,
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects int string, Actual Int64' => [
+ 'expectedResult' => true,
+ 'expectedValue' => '123',
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects float, Actual Int64' => [
+ 'expectedResult' => true,
+ 'expectedValue' => 123.0,
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects float string, Actual Int64' => [
+ 'expectedResult' => true,
+ 'expectedValue' => '123.0',
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects non-numeric string, Actual Int64' => [
+ 'expectedResult' => false,
+ 'expectedValue' => 'foo',
+ 'actualValue' => new Int64(123),
+ ];
+
+ yield 'Expects float, Actual float' => [
+ 'expectedResult' => false,
+ 'expectedValue' => 123.0,
+ 'actualValue' => 123.0,
+ ];
+
+ yield 'Expects numeric string, Actual numeric string' => [
+ 'expectedResult' => false,
+ 'expectedValue' => '123',
+ 'actualValue' => '123',
+ ];
+ }
+
+ /**
+ * @dataProvider provideMatchingAssertions
+ * @doesNotPerformAssertions
+ */
+ public function testMatchingAssertions($expected, $actual): void
+ {
+ (new Int64Comparator())->assertEquals($expected, $actual);
+ }
+
+ public static function provideMatchingAssertions(): Generator
+ {
+ yield 'Expected Int64, Actual Int64' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => new Int64(8589934592),
+ ];
+
+ yield 'Expected Int64, Actual int' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => 8589934592,
+ ];
+
+ yield 'Expected Int64, Actual int string' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => '8589934592',
+ ];
+
+ yield 'Expected Int64, Actual float' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => 8589934592.0,
+ ];
+
+ yield 'Expected Int64, Actual float string' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => '8589934592.0',
+ ];
+
+ yield 'Expected int, Actual Int64' => [
+ 'expected' => 8589934592,
+ 'actual' => new Int64(8589934592),
+ ];
+
+ yield 'Expected int string, Actual Int64' => [
+ 'expected' => '8589934592',
+ 'actual' => new Int64(8589934592),
+ ];
+
+ yield 'Expected float, Actual Int64' => [
+ 'expected' => 8589934592.0,
+ 'actual' => new Int64(8589934592),
+ ];
+
+ yield 'Expected float string, Actual Int64' => [
+ 'expected' => '8589934592.0',
+ 'actual' => new Int64(8589934592),
+ ];
+ }
+
+ /** @dataProvider provideFailingValues */
+ public function testFailingAssertions($expected, $actual): void
+ {
+ $this->expectException(ComparisonFailure::class);
+
+ (new Int64Comparator())->assertEquals($expected, $actual);
+ }
+
+ public static function provideFailingValues(): Generator
+ {
+ yield 'Expected Int64, Actual Int64' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => new Int64(456),
+ ];
+
+ yield 'Expected Int64, Actual int' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => 456,
+ ];
+
+ yield 'Expected Int64, Actual int string' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => '456',
+ ];
+
+ yield 'Expected Int64, Actual float' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => 8589934592.1,
+ ];
+
+ yield 'Expected Int64, Actual float string' => [
+ 'expected' => new Int64(8589934592),
+ 'actual' => '8589934592.1',
+ ];
+
+ yield 'Expected int, Actual Int64' => [
+ 'expected' => 8589934592,
+ 'actual' => new Int64(456),
+ ];
+
+ yield 'Expected int string, Actual Int64' => [
+ 'expected' => '8589934592',
+ 'actual' => new Int64(456),
+ ];
+
+ yield 'Expected float, Actual Int64' => [
+ 'expected' => 8589934592.1,
+ 'actual' => new Int64(456),
+ ];
+
+ yield 'Expected float string, Actual Int64' => [
+ 'expected' => '8589934592.1',
+ 'actual' => new Int64(456),
+ ];
+ }
+}
diff --git a/tests/SpecTests/ClientSideEncryption/FunctionalTestCase.php b/tests/SpecTests/ClientSideEncryption/FunctionalTestCase.php
@@ -2,7 +2,6 @@
 
 namespace MongoDB\Tests\SpecTests\ClientSideEncryption;
 
-use MongoDB\BSON\Int64;
 use MongoDB\Client;
 use MongoDB\Driver\WriteConcern;
 use MongoDB\Tests\SpecTests\FunctionalTestCase as BaseFunctionalTestCase;
@@ -14,8 +13,6 @@
 use function is_executable;
 use function is_readable;
 use function sprintf;
-use function strlen;
-use function unserialize;
 
 use const DIRECTORY_SEPARATOR;
 use const PATH_SEPARATOR;
@@ -69,14 +66,6 @@ protected static function insertKeyVaultData(Client $client, ?array $keyVaultDat
  $collection->insertMany($keyVaultData);
  }
 
- protected static function createInt64(string $value): Int64
- {
- $array = sprintf('a:1:{s:7:"integer";s:%d:"%s";}', strlen($value), $value);
- $int64 = sprintf('C:%d:"%s":%d:{%s}', strlen(Int64::class), Int64::class, strlen($array), $array);
-
- return unserialize($int64);
- }
-
  private function createTestCollection(?stdClass $encryptedFields = null, ?stdClass $jsonSchema = null): void
  {
  $context = $this->getContext();

diff --git a/tests/SpecTests/ClientSideEncryption/Prose22_RangeExplicitEncryptionTest.php b/tests/SpecTests/ClientSideEncryption/Prose22_RangeExplicitEncryptionTest.php
@@ -8,6 +8,7 @@
 use MongoDB\BSON\Binary;
 use MongoDB\BSON\Decimal128;
 use MongoDB\BSON\Document;
+use MongoDB\BSON\Int64;
 use MongoDB\BSON\UTCDateTime;
 use MongoDB\Driver\ClientEncryption;
 use MongoDB\Driver\Exception\EncryptionException;
@@ -168,8 +169,8 @@ public static function provideTypeAndRangeOpts(): Generator
  yield 'Long' => [
  'Long',
  [
- 'min' => self::createInt64('0'),
- 'max' => self::createInt64('200'),
+ 'min' => new Int64(0),
+ 'max' => new Int64(200),
  'sparsity' => 1,
  ],
  ];
@@ -467,7 +468,7 @@ private static function getCastCallableForType(string $type): callable
 
  case 'Long':
  return function (int $value) {
- return self::createInt64((string) $value);
+ return new Int64($value);
  };
 
  default:

diff --git a/tests/SpecTests/ClientSideEncryptionSpecTest.php b/tests/SpecTests/ClientSideEncryptionSpecTest.php
@@ -43,9 +43,7 @@
 use function json_decode;
 use function sprintf;
 use function str_repeat;
-use function strlen;
 use function substr;
-use function unserialize;
 
 use const DIRECTORY_SEPARATOR;
 use const PATH_SEPARATOR;
@@ -1862,14 +1860,6 @@ public static function provideRewrapManyDataKeySrcAndDstProviders()
  }
  }
 
- private function createInt64(string $value): Int64
- {
- $array = sprintf('a:1:{s:7:"integer";s:%d:"%s";}', strlen($value), $value);
- $int64 = sprintf('C:%d:"%s":%d:{%s}', strlen(Int64::class), Int64::class, strlen($array), $array);
-
- return unserialize($int64);
- }
-
  private function createTestCollection(?stdClass $encryptedFields = null, ?stdClass $jsonSchema = null): void
  {
  $context = $this->getContext();
@@ -1936,7 +1926,7 @@ private function encryptCorpusValue(string $fieldName, stdClass $data, ClientEnc
  /* Note: workaround issue where mongocryptd refuses to encrypt
  * 32-bit integers if schemaMap defines a "long" BSON type. */
  $value = $data->type === 'long' && ! $data->value instanceof Int64
- ? $this->createInt64($data->value)
+ ? new Int64($data->value)
  : $data->value;
 
  $encrypted = $clientEncryption->encrypt($value, $encryptionOptions);
@@ -1987,7 +1977,7 @@ private function prepareCorpusData(string $fieldName, stdClass $data, ClientEncr
  /* Note: workaround issue where mongocryptd refuses to encrypt
  * 32-bit integers if schemaMap defines a "long" BSON type. */
  if ($data->type === 'long' && ! $data->value instanceof Int64) {
- $data->value = $this->createInt64($data->value);
+ $data->value = new Int64($data->value);
  }
 
  return $data;