PHPLIB-1369 Upgrade to PHPUnit 10 (#1412)

* Migration from @annotations to #[Attributes]
* Replace hasFailed with the method onNotSuccessfulTest in FunctionalTestCase
* User createStub in getInvalidDocumentCodecValues
* Update custom constraints (TestCase::exporter() is deprecated and ComparisonFailure 5th argument was removed)
* Use xxh faster algorithm for temp collection name

Author: GromNaN

.evergreen/run-tests.sh

@@ -43,7 +43,7 @@ if [ "${IS_MATRIX_TESTING}" = "true" ]; then
 fi
 
 # Enable verbose output to see skipped and incomplete tests
-PHPUNIT_OPTS="${PHPUNIT_OPTS} -v --configuration phpunit.evergreen.xml"
+PHPUNIT_OPTS="${PHPUNIT_OPTS} --configuration phpunit.evergreen.xml"
 
 if [ "$SSL" = "yes" ]; then
    SSL_OPTS="ssl=true&sslallowinvalidcertificates=true"

.github/workflows/tests.yml

@@ -75,7 +75,6 @@ jobs:
           php-ini-values: "zend.assertions=1"
 
       - name: "Run PHPUnit"
-        run: "vendor/bin/phpunit -v"
+        run: "vendor/bin/phpunit"
         env:
-          SYMFONY_DEPRECATIONS_HELPER: 999999
           MONGODB_URI: ${{ steps.setup-mongodb.outputs.cluster-uri }}

composer.json

@@ -21,8 +21,8 @@
     },
     "require-dev": {
         "doctrine/coding-standard": "^12.0",
-        "phpunit/phpunit": "^9.6.11",
-        "rector/rector": "^1.1",
+        "phpunit/phpunit": "^10.5.35",
+        "rector/rector": "^1.2",
         "squizlabs/php_codesniffer": "^3.7",
         "vimeo/psalm": "^5.13"
     },

rector.php

@@ -3,8 +3,10 @@
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\ClassLike\RemoveAnnotationRector;
 use Rector\Php70\Rector\StmtsAwareInterface\IfIssetToCoalescingRector;
+use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
 use Rector\Php80\Rector\Switch_\ChangeSwitchToMatchRector;
 use Rector\PHPUnit\PHPUnit100\Rector\Class_\StaticDataProviderClassMethodRector;
+use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Set\ValueObject\LevelSetList;
 
 return static function (RectorConfig $rectorConfig): void {
@@ -16,13 +18,17 @@
     ]);
 
     // Modernize code
-    $rectorConfig->sets([LevelSetList::UP_TO_PHP_74]);
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_74,
+        PHPUnitSetList::PHPUNIT_100,
+    ]);
 
     $rectorConfig->rule(ChangeSwitchToMatchRector::class);
     $rectorConfig->rule(StaticDataProviderClassMethodRector::class);
 
     // phpcs:disable Squiz.Arrays.ArrayDeclaration.KeySpecified
     $rectorConfig->skip([
+        RemoveExtraParametersRector::class,
         // Do not use ternaries extensively
         IfIssetToCoalescingRector::class,
         ChangeSwitchToMatchRector::class => [

tests/Builder/BuilderEncoderTest.php

@@ -14,6 +14,7 @@
 use MongoDB\Builder\Stage;
 use MongoDB\Builder\Type\Sort;
 use MongoDB\Builder\Variable;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 use function array_merge;
@@ -153,9 +154,8 @@ public function testPerformCount(): void
      *
      * @param list<int>          $limit
      * @param array<string, int> $expectedLimit
-     *
-     * @dataProvider provideExpressionFilterLimit
      */
+    #[DataProvider('provideExpressionFilterLimit')]
     public function testExpressionFilter(array $limit, array $expectedLimit): void
     {
         $pipeline = new Pipeline(

tests/Builder/FieldPathTest.php

@@ -8,14 +8,15 @@
 use MongoDB\Builder\Expression;
 use MongoDB\Builder\Type\FieldPathInterface;
 use MongoDB\Exception\InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 use function is_subclass_of;
 use function sprintf;
 
 class FieldPathTest extends TestCase
 {
-    /** @dataProvider provideFieldPath */
+    #[DataProvider('provideFieldPath')]
     public function testFieldPath(string $fieldPathClass, string $resolveClass): void
     {
         $fieldPath = Expression::{$fieldPathClass}('foo');
@@ -27,7 +28,7 @@ public function testFieldPath(string $fieldPathClass, string $resolveClass): voi
         $this->assertTrue(is_subclass_of(Expression\FieldPath::class, $resolveClass), sprintf('%s instanceof %s', Expression\FieldPath::class, $resolveClass));
     }
 
-    /** @dataProvider provideFieldPath */
+    #[DataProvider('provideFieldPath')]
     public function testRejectDollarPrefix(string $fieldPathClass): void
     {
         $this->expectException(InvalidArgumentException::class);

tests/Builder/Type/CombinedFieldQueryTest.php

@@ -9,6 +9,7 @@
 use MongoDB\Builder\Query\GtOperator;
 use MongoDB\Builder\Type\CombinedFieldQuery;
 use MongoDB\Exception\InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class CombinedFieldQueryTest extends TestCase
@@ -47,7 +48,7 @@ public function testFlattenCombinedFieldQueries(): void
         $this->assertCount(3, $fieldQueries->fieldQueries);
     }
 
-    /** @dataProvider provideInvalidFieldQuery */
+    #[DataProvider('provideInvalidFieldQuery')]
     public function testRejectInvalidFieldQueries(mixed $invalidQuery, string $message = '-'): void
     {
         $this->expectException(InvalidArgumentException::class);
@@ -71,11 +72,8 @@ public static function provideInvalidFieldQuery(): Generator
         yield 'object key without $' => [(object) ['eq' => 1], 'Operator must contain exactly one key starting with $, "eq" given'];
     }
 
-    /**
-     * @param array<mixed> $fieldQueries
-     *
-     * @dataProvider provideDuplicateOperator
-     */
+    /** @param array<mixed> $fieldQueries */
+    #[DataProvider('provideDuplicateOperator')]
     public function testRejectDuplicateOperator(array $fieldQueries): void
     {
         $this->expectException(InvalidArgumentException::class);

tests/Builder/Type/OutputWindowTest.php

@@ -10,6 +10,7 @@
 use MongoDB\Builder\Type\TimeUnit;
 use MongoDB\Builder\Type\WindowInterface;
 use MongoDB\Exception\InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class OutputWindowTest extends TestCase
@@ -57,11 +58,8 @@ public function testWithUnit(): void
         $this->assertEquals((object) ['unit' => TimeUnit::Day], $outputWindow->window);
     }
 
-    /**
-     * @param array<mixed> $documents
-     *
-     * @dataProvider provideInvalidDocuments
-     */
+    /** @param array<mixed> $documents */
+    #[DataProvider('provideInvalidDocuments')]
     public function testRejectInvalidDocuments(array $documents): void
     {
         $this->expectException(InvalidArgumentException::class);
@@ -82,11 +80,8 @@ public static function provideInvalidDocuments(): Generator
         yield 'not a list' => [['foo' => 1, 'bar' => 2]];
     }
 
-    /**
-     * @param array<mixed> $range
-     *
-     * @dataProvider provideInvalidRange
-     */
+    /** @param array<mixed> $range */
+    #[DataProvider('provideInvalidRange')]
     public function testRejectInvalidRange(array $range): void
     {
         $this->expectException(InvalidArgumentException::class);

tests/Builder/Type/QueryObjectTest.php

@@ -13,6 +13,7 @@
 use MongoDB\Builder\Type\CombinedFieldQuery;
 use MongoDB\Builder\Type\QueryInterface;
 use MongoDB\Builder\Type\QueryObject;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class QueryObjectTest extends TestCase
@@ -32,23 +33,17 @@ public function testShortCutQueryObject(): void
         $this->assertSame($query, $queryObject);
     }
 
-    /**
-     * @param array<array-key, mixed> $value
-     *
-     * @dataProvider provideQueryObjectValue
-     */
+    /** @param array<array-key, mixed> $value */
+    #[DataProvider('provideQueryObjectValue')]
     public function testCreateQueryObject(array $value, int $expectedCount = 1): void
     {
         $queryObject = QueryObject::create($value);
 
         $this->assertCount($expectedCount, $queryObject->queries);
     }
 
-    /**
-     * @param array<array-key, mixed> $value
-     *
-     * @dataProvider provideQueryObjectValue
-     */
+    /** @param array<array-key, mixed> $value */
+    #[DataProvider('provideQueryObjectValue')]
     public function testCreateQueryObjectFromArray(array $value, int $expectedCount = 1): void
     {
         // $value is wrapped in an array as if the user used an array instead of variadic arguments

tests/Builder/VariableTest.php

@@ -8,6 +8,7 @@
 use MongoDB\Builder\Expression;
 use MongoDB\Builder\Variable;
 use MongoDB\Exception\InvalidArgumentException;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class VariableTest extends TestCase
@@ -27,7 +28,7 @@ public function testVariableRejectDollarPrefix(): void
         new Expression\Variable('$$foo');
     }
 
-    /** @dataProvider provideVariableBuilders */
+    #[DataProvider('provideVariableBuilders')]
     public function testSystemVariables($factory): void
     {
         $variable = $factory();