PHPLIB-1369 Upgrade to PHPUnit 10 #1412

GromNaN · 2024-09-17T13:22:48Z

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)

composer.json

alcaeus · 2024-09-24T07:08:14Z

tests/FunctionalTestCase.php

@@ -69,12 +70,15 @@ public function setUp(): void
        $this->configuredFailPoints = [];
    }

-    public function tearDown(): void
+    protected function onNotSuccessfulTest(Throwable $t): never


Oh, I like this way of handling failed tests 💪

Available since PHPUnit 3.4 (sebastianbergmann/phpunit@8e6c10c), yet there's no trace of this in the documentation 🤷

alcaeus · 2024-09-24T07:10:18Z

.github/workflows/tests.yml

@@ -77,7 +77,6 @@ jobs:
          php-ini-values: "zend.assertions=1"

      - name: "Run PHPUnit"
-        run: "vendor/bin/phpunit -v"
+        run: "vendor/bin/phpunit"


I was thinking about removing the output of skipped tests, so I agree with this change 👍

It's also, the -v option isn't available on PHPUnit 10

tests/Builder/BuilderEncoderTest.php

tests/TestCase.php

sebastianbergmann/phpunit#5687

https://jira.mongodb.org/browse/PHPC-2456

jmikola

One question about the Rector config, but everything else LGTM.

jmikola · 2024-09-26T22:39:19Z

rector.php

@@ -16,13 +18,17 @@
    ]);

    // Modernize code
-    $rectorConfig->sets([LevelSetList::UP_TO_PHP_74]);
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_74,


Should this have been bumped to PHP 8.1 in 24214b6?

The PHP 8.1 rules have to be tuned. Some like ReadOnlyPropertyRector and ClassPropertyAssignToConstructorPromotionRector need to be challenged.
https://jira.mongodb.org/browse/PHPLIB-1536

jmikola · 2024-09-26T22:42:04Z

tests/Comparator/Int64Comparator.php

@@ -24,16 +25,17 @@ public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = f
            return;
        }

+        $exporter = new Exporter();


Noted that the internal property was removed from the Comparator base class in sebastianbergmann/comparator@bf22fc1

jmikola · 2024-09-26T22:47:41Z

tests/FunctionalTestCase.php

@@ -69,12 +70,15 @@ public function setUp(): void
        $this->configuredFailPoints = [];
    }

-    public function tearDown(): void
+    protected function onNotSuccessfulTest(Throwable $t): never


Available since PHPUnit 3.4 (sebastianbergmann/phpunit@8e6c10c), yet there's no trace of this in the documentation 🤷

jmikola · 2024-09-26T23:43:14Z

tests/Operation/FindFunctionalTest.php

    public function testModifierDocuments($modifiers, stdClass $expectedSort): void
    {
        (new CommandObserver())->observe(
            function () use ($modifiers): void {
+                // @todo revert this lines after PHPC-2457


Technically, this should become irrelevant after #1439

jmikola · 2024-09-26T23:46:34Z

tests/PedantryTest.php

@@ -3,6 +3,7 @@
 namespace MongoDB\Tests;

 use MongoDB;
+use PHPUnit\Framework\Attributes\DataProvider;


Unrelated to this PR, but I'm wondering what use MongoDB; above is used for. Looks like this dates back to eafad05.

This prevent duplication of class names as use statement and in the SKIPPED_CLASSES list.

jmikola · 2024-09-26T23:49:09Z

tests/TestCase.php

@@ -205,7 +208,7 @@ protected function getCollectionName(): string
    {
        $class = new ReflectionClass($this);

-        return sprintf('%s.%s', $class->getShortName(), hash('crc32b', $this->getName()));
+        return sprintf('%s.%s', $class->getShortName(), hash('xxh3', $this->name()));


Noted: https://xxhash.com/ available since PHP 8.1 (see: hash_algos()).

jmikola · 2024-09-26T23:52:31Z

tests/UnifiedSpecTests/Constraint/Matches.php

@@ -256,7 +257,7 @@ private function assertMatchesOperator(BSONDocument $operator, $actual, string $
            $constraint = IsBsonType::anyOf(...(array) $operator['$$type']);

            if (! $constraint->evaluate($actual, '', true)) {
-                self::failAt(sprintf('%s is not an expected BSON type: %s', $this->exporter()->shortenedExport($actual), implode(', ', $types)), $keyPath);


Noted that $types was never defined. This dates back to 4608a73. Curious that it wasn't caught by static analysis, unless this snuck into the baseline.

alcaeus

LGTM

* v1.x: (95 commits) PHPLIB-1369 Upgrade to PHPUnit 10 (#1412) Higher phpunit version required (#1463) Fix deprecations in tests (#1458) Deprecate functionality to be removed (#1441) Expect BulkWriteException (#1455) Merge v1.20 into v1.x (#1447) PHPLIB-1525 Removes dependency to Symfony PHPUnit bridge (#1413) Change deprecated assertObjectHasAttribute to assertObjectHasProperty (#1432) Performance: Keep collections and indexes between GridFS tests (#1421) Add final annotations to non-internal Operation classes (#1410) Fix types accepted by $round (#1401) Replace arrayHasKey with assertArrayHasKey in tests (#1403) PHPLIB-1514 Make data providers static (#1404) PHPLIB-1515 Replace assertObjectHasAttribute with assertObjectHasProperty (#1405) Restore Prose22_RangeExplicitEncryptionTest (#1400) Remove Prose22_RangeExplicitEncryptionTest that requires ext-mongodb < 1.20 (#1394) Use `match` instead of `switch` when a simple value is returned (#1393) Remove PHPUnit functions polyfill (#1395) Update branch names for GHA workflows (#1390) PHPLIB-1419 Encode Agg builder objects in Collection methods (#1383) ...

* v1.x: (101 commits) PHPLIB-1541: Include specs repository as a submodule (#1429) PHPLIB-1548 Inherit `typeMap` option in `Collection::listSearchIndexes()` (#1482) Fix array shape for `Collection::listSearchIndex($options)` (#1480) PHPLIB-1545: Deprecate CreateCollection flags option and related constants (#1477) Fix junit logging (#1475) Deprecate typeMap on operations without meaningful result (#1473) PHPLIB-1369 Upgrade to PHPUnit 10 (#1412) Higher phpunit version required (#1463) Fix deprecations in tests (#1458) Deprecate functionality to be removed (#1441) Expect BulkWriteException (#1455) Merge v1.20 into v1.x (#1447) PHPLIB-1525 Removes dependency to Symfony PHPUnit bridge (#1413) Change deprecated assertObjectHasAttribute to assertObjectHasProperty (#1432) Performance: Keep collections and indexes between GridFS tests (#1421) Add final annotations to non-internal Operation classes (#1410) Fix types accepted by $round (#1401) Replace arrayHasKey with assertArrayHasKey in tests (#1403) PHPLIB-1514 Make data providers static (#1404) PHPLIB-1515 Replace assertObjectHasAttribute with assertObjectHasProperty (#1405) ...

GromNaN force-pushed the PHPLIB-1369 branch from 4cde98f to 83bd963 Compare September 23, 2024 17:33

GromNaN marked this pull request as ready for review September 23, 2024 18:04

GromNaN requested a review from a team as a code owner September 23, 2024 18:04

GromNaN requested a review from alcaeus September 23, 2024 18:04

GromNaN commented Sep 23, 2024

View reviewed changes

composer.json Outdated Show resolved Hide resolved

alcaeus reviewed Sep 24, 2024

View reviewed changes

GromNaN commented Sep 24, 2024

View reviewed changes

tests/TestCase.php Outdated Show resolved Hide resolved

GromNaN force-pushed the PHPLIB-1369 branch 3 times, most recently from a453911 to 2f9bed3 Compare September 25, 2024 17:31

GromNaN added 17 commits September 26, 2024 13:54

Migrate PHPUnit to attributes and static dataprovider

0010813

Replace hasFailed with onNotSuccessfulTest

be20da8

sebastianbergmann/phpunit#5687

Upgrade PHPUnit comparators

cce7cc8

Use internal ->name() function instead of removed ->getName()

4a5c089

Make data providers static

1123687

Remove phpunit bridge

1b9d084

More attributes updates

25bd456

Fix CI

3cac1d4

Lock PHPUnit version until bug fix

ccebc20

https://jira.mongodb.org/browse/PHPC-2456

Upgrade to latests PHPUnit

c04aa83

Use faster algorithm for collection name from test name

078bafd

Fix error message in Match constraint

9f59167

TestCase::exporter() is deprecated, use new Exporter

0d9ce99

Add test helper for warnings

2734c0b

Upgrade DocumentsMatchConstraint

829e2bb

Avoid PHPC-2457

03b1abb

Fixes

08e1870

GromNaN force-pushed the PHPLIB-1369 branch from 996967e to 08e1870 Compare September 26, 2024 11:55

Remove -v from evergreen phpunit command

8236e3e

GromNaN requested a review from alcaeus September 26, 2024 14:49

GromNaN requested a review from jmikola September 26, 2024 14:50

jmikola approved these changes Sep 26, 2024

View reviewed changes

alcaeus approved these changes Sep 27, 2024

View reviewed changes

GromNaN merged commit cb33c1c into mongodb:v1.x Sep 27, 2024
32 checks passed

GromNaN deleted the PHPLIB-1369 branch September 27, 2024 07:07

mongodb-php-bot mentioned this pull request Sep 27, 2024

Merge v1.x into v2.x #1469

Merged

GromNaN mentioned this pull request Sep 27, 2024

Remove deprecated functionality #1439

Merged

alcaeus mentioned this pull request Oct 2, 2024

Fix junit logging #1475

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PHPLIB-1369 Upgrade to PHPUnit 10 #1412

PHPLIB-1369 Upgrade to PHPUnit 10 #1412

GromNaN commented Sep 17, 2024 •

edited

Loading

alcaeus Sep 24, 2024

jmikola Sep 26, 2024

alcaeus Sep 24, 2024

GromNaN Sep 24, 2024

jmikola left a comment

jmikola Sep 26, 2024

GromNaN Sep 27, 2024

jmikola Sep 26, 2024

jmikola Sep 26, 2024

jmikola Sep 26, 2024

jmikola Sep 26, 2024

GromNaN Sep 27, 2024

jmikola Sep 26, 2024

jmikola Sep 26, 2024

alcaeus left a comment

PHPLIB-1369 Upgrade to PHPUnit 10 #1412

PHPLIB-1369 Upgrade to PHPUnit 10 #1412

Conversation

GromNaN commented Sep 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmikola left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alcaeus left a comment

Choose a reason for hiding this comment

GromNaN commented Sep 17, 2024 •

edited

Loading