Updating to phpunit 10 #7339

mamazu · 2024-03-31T14:12:55Z

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Fixed tickets	closes #6988
Related issues/PRs	-
License	MIT
Documentation PR	-

What's in this PR?

Updating phpunit to version 10 and fixing the tests

Updating the dependency in the composer.json
Running rector to upgrade the tests (it's using attributes instead of annotations now)
Fixing the problems with the dataprovider functions being static now (mostly)

Why?

It's always a good idea to have an up to date testing library.

To Do

Fix the tests

alexander-schranz

I did not yet review the whole part. I think we should cherry pick only the required changes out of this pull request. We should not do any type refactoring in it as that makes review here hard and too big, we should keep such things seperated.

On some places prophesize was replaced with PHPUnit mock, we are still using prophosize so that replacement is not required and should stay as it is at current state.

src/Sulu/Bundle/WebsiteBundle/Analytics/AnalyticsManager.php

src/Sulu/Bundle/WebsiteBundle/phpunit.xml.dist

...Bundle/AudienceTargetingBundle/Tests/Unit/Controller/TargetGroupEvaluationControllerTest.php

src/Sulu/Bundle/ContactBundle/Tests/Functional/Controller/AccountMediaControllerTest.php

alexander-schranz · 2024-04-02T09:05:49Z

src/Sulu/Bundle/MediaBundle/Tests/Functional/Entity/MediaDataProviderRepositoryTest.php

@@ -179,7 +177,7 @@ private function createTag($name)
        return $tag;
    }

-    private function createMedia($title, $collection, $mimeType, $type, $tags = [], $targetGroups = [])
+    private function createMedia($title, $collection, $mimeType, $type, $tags = [], $targetGroups = []): Media


we should reallly focus just on the PHPUnit update this get lot of hard to review things if we do here such refactorings.

test method changes should be done on 2.5 branch if possible and non breaking changes

mamazu · 2024-04-07T21:30:01Z

Todos:

You wanted to discuss internally what the best way to go about mocking is
Check if the failing tests should be failing
PhpUnit Config file needs to be reformatted

phpunit.xml.dist

alexander-schranz · 2024-05-15T10:27:41Z

phpunit.xml.dist

         bootstrap="./vendor/autoload.php"
         colors="true"
         failOnIncomplete="true"
         failOnWarning="true"
         failOnRisky="true"
->
-    <coverage>
+         cacheDirectory=".phpunit.cache">


Do we need to configure this? Would keep this on default if possible.

To make switching between 2.5 <-> 2.6 easier for this who don't have such files in there global gitignore we should add the directory also to the .gitignore file of the 2.5 branch. Can you target a merge request for it?

I mean it's the default value for phpunit so we don't have to specify it.

Then I would remove the config and just add the new directory to the .gitignore file

I just saw that the cache file is already in the .gitignore

phpunit.xml.dist

alexander-schranz

Some changes I would backport to the 2.5 branch. Mostly this pull request for 2.6 should then contain only phpunit.xml required changes and data provider changes.

alexander-schranz · 2024-05-16T10:00:50Z

src/Sulu/Component/Webspace/Tests/Unit/Settings/SettingsManagerTest.php

+        yield ['sulu_io', 'test-1', ['property1' => 'test1', 'property2' => 'test2']];
+        yield ['sulu_io', 'test-2', null];
+        yield ['sulu_io', 'test-3', self::createStub(NodeInterface::class)];


Can we do such changes on the 2.5 branch?

alexander-schranz · 2024-05-16T10:01:10Z

src/Sulu/Component/Webspace/Tests/Unit/WebspaceTestCase.php

-        $dir = __DIR__ . '/../../../../../../tests/Resources';
-
-        return $dir;
+        return __DIR__ . '/../../../../../../tests/Resources';


Can we do such changes on the 2.5 branch?

alexander-schranz · 2024-05-16T10:01:25Z

src/Sulu/Component/Webspace/Tests/Unit/Settings/SettingsManagerTest.php

+        yield ['sulu_io', 'test-1', '123-123-123', true];
+        yield ['sulu_io', 'test-1', '123-123-123', false];


Can we do such changes on the 2.5 branch?

alexander-schranz · 2024-05-16T10:01:39Z

src/Sulu/Component/Webspace/Tests/Unit/Settings/SettingsManagerTest.php

+        $webspaceKey = 'sulu_io';
+        $key = 'test-1';
+


??? looks like unexpected change

alexander-schranz · 2024-05-16T10:02:01Z

src/Sulu/Component/Webspace/Tests/Unit/Settings/SettingsManagerTest.php

-     */
-    public function testSave($webspaceKey, $key, $data): void
+    #[\PHPUnit\Framework\Attributes\DataProvider('dataProvider')]
+    public function testSave(string $webspaceKey, string $key, array|NodeInterface|null $data): void


We should do such changes on the 2.5 branch

alexander-schranz · 2024-05-16T10:11:50Z

src/Sulu/Bundle/MediaBundle/Tests/Functional/Entity/MediaDataProviderRepositoryTest.php

@@ -179,7 +177,7 @@ private function createTag($name)
        return $tag;
    }

-    private function createMedia($title, $collection, $mimeType, $type, $tags = [], $targetGroups = [])
+    private function createMedia($title, $collection, $mimeType, $type, $tags = [], $targetGroups = []): Media


test method changes should be done on 2.5 branch if possible and non breaking changes

alexander-schranz · 2024-05-16T10:12:30Z

src/Sulu/Bundle/AudienceTargetingBundle/Tests/Unit/Rule/TargetGroupEvaluatorTest.php

+        array $targetGroups,
+        array $ruleWhitelists,
+        ?string $webspaceKey,
+        ?TargetGroup $evaluatedTargetGroup,
+        int $frequency = TargetGroupRuleInterface::FREQUENCY_SESSION,
+        ?TargetGroup $currentTargetGroup = null


test method changes should be done on 2.5 branch if possible and non breaking changes

alexander-schranz · 2024-05-16T10:12:35Z

src/Sulu/Bundle/AudienceTargetingBundle/Tests/Unit/Rule/TargetGroupEvaluatorTest.php

@@ -99,7 +97,7 @@ public function testEvaluate(
        $this->assertEquals($evaluatedTargetGroup, $this->targetGroupEvaluator->evaluate($frequency, $currentTargetGroup));
    }

-    public static function provideEvaluationData()
+    public static function provideEvaluationData(): array


test method changes should be done on 2.5 branch if possible and non breaking changes

alexander-schranz · 2024-05-16T10:12:44Z

src/Sulu/Bundle/AudienceTargetingBundle/Tests/Unit/EventListener/TargetGroupSubscriberTest.php

@@ -441,7 +429,7 @@ public function testAddTargetGroupHitScript(
        $this->assertEquals('<body><script></script></body>', $response->getContent());
    }

-    public static function provideAddTargetGroupHitScript()
+    public static function provideAddTargetGroupHitScript(): array


test method changes should be done on 2.5 branch if possible and non breaking changes

alexander-schranz · 2024-05-16T10:13:28Z

phpunit.xml.dist

-
-    <listeners>
-        <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener"/>
-    </listeners>


I would also remove this listener on the 2.5 to be consistent

Did that in #7432

mamazu force-pushed the phpunit-upgrade branch 2 times, most recently from 8c367cb to 3c127eb Compare March 31, 2024 14:14

mamazu changed the title ~~updating to phpunit 10 (mostly)~~ Updating to phpunit 10 Mar 31, 2024

mamazu force-pushed the phpunit-upgrade branch 4 times, most recently from d433aa5 to b612f25 Compare March 31, 2024 15:24

alexander-schranz requested changes Apr 2, 2024

View reviewed changes

alexander-schranz added the DX Affecting the end developer label Apr 2, 2024

mamazu mentioned this pull request Apr 3, 2024

Upgrade Phpunit (part 1) #7344

Merged

mamazu force-pushed the phpunit-upgrade branch from f34b5ef to 0862e3a Compare April 6, 2024 23:08

mamazu force-pushed the phpunit-upgrade branch 2 times, most recently from 456b658 to e5365b0 Compare April 9, 2024 07:12

mamazu mentioned this pull request May 9, 2024

Refactor phpunit dataprovider to be static #7415

Merged

mamazu force-pushed the phpunit-upgrade branch 5 times, most recently from f11f153 to b604859 Compare May 10, 2024 16:55

alexander-schranz reviewed May 13, 2024

View reviewed changes

phpunit.xml.dist Show resolved Hide resolved

mamazu force-pushed the phpunit-upgrade branch 6 times, most recently from 3939947 to 98a2ab4 Compare May 15, 2024 10:01

updating to phpunit 10 (mostly)

7565564

mamazu force-pushed the phpunit-upgrade branch from 98a2ab4 to 7565564 Compare May 15, 2024 10:02

alexander-schranz reviewed May 15, 2024

View reviewed changes

phpunit.xml.dist Outdated Show resolved Hide resolved

Minimizing diff

b7cff19

mamazu force-pushed the phpunit-upgrade branch from 00eebde to b7cff19 Compare May 15, 2024 11:29

mamazu added 2 commits May 15, 2024 13:56

Removing cache default directory

6396e38

Merge branch '2.6' into phpunit-upgrade

b700023

alexander-schranz requested changes May 16, 2024

View reviewed changes

This was referenced May 16, 2024

Remove SymfonyTestsListener configuration #7432

Draft

Refactor phpunit dataprovider to be static and change some test methods with stricter types #7433

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating to phpunit 10 #7339

Updating to phpunit 10 #7339

mamazu commented Mar 31, 2024 •

edited

alexander-schranz left a comment

alexander-schranz Apr 2, 2024

alexander-schranz May 16, 2024

mamazu commented Apr 7, 2024 •

edited

alexander-schranz May 15, 2024 •

edited

mamazu May 15, 2024 •

edited

alexander-schranz May 15, 2024

mamazu May 15, 2024

alexander-schranz left a comment

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024 •

edited

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

alexander-schranz May 16, 2024

mamazu May 16, 2024

		yield ['sulu_io', 'test-1', '123-123-123', true];
		yield ['sulu_io', 'test-1', '123-123-123', false];

Updating to phpunit 10 #7339

Are you sure you want to change the base?

Updating to phpunit 10 #7339

Conversation

mamazu commented Mar 31, 2024 • edited

What's in this PR?

Why?

To Do

alexander-schranz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mamazu commented Apr 7, 2024 • edited

alexander-schranz May 15, 2024 • edited

Choose a reason for hiding this comment

mamazu May 15, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexander-schranz 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

alexander-schranz May 16, 2024 • edited

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

mamazu commented Mar 31, 2024 •

edited

mamazu commented Apr 7, 2024 •

edited

alexander-schranz May 15, 2024 •

edited

mamazu May 15, 2024 •

edited

alexander-schranz May 16, 2024 •

edited