[#187] Updated to PHPUnit 11 and moved to attributes in tests.

AlexSkrypnyk · May 16, 2024 · 6a8b6c7 · 6a8b6c7
1 parent 1d6c291
commit 6a8b6c7
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 43 deletions.
diff --git a/composer.json b/composer.json
@@ -29,7 +29,7 @@
         "opis/closure": "^3.6",
         "phpmd/phpmd": "^2.13",
         "phpstan/phpstan": "^1.10",
-        "phpunit/phpunit": "^10",
+        "phpunit/phpunit": "^11",
         "rector/rector": "^1.0.0"
     },
     "minimum-stability": "stable",
@@ -67,14 +67,14 @@
             "box compile"
         ],
         "lint": [
-            "cp php-script php-script.php && phpcs && rm php-script.php",
+            "cp php-script php-script.php && phpcs; rm php-script.php",
             "phpmd --exclude vendor,vendor-bin,node_modules . text phpmd.xml",
             "phpstan",
             "rector --clear-cache --dry-run"
         ],
         "lint-fix": [
             "rector --clear-cache",
-            "cp php-script php-script.php && phpcbf && rm php-script.php"
+            "cp php-script php-script.php && phpcbf; rm php-script.php"
         ],
         "test": "phpunit --no-coverage",
         "test-coverage": "phpunit"

diff --git a/phpunit.xml b/phpunit.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.1/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheDirectory=".phpunit.cache"
          executionOrder="depends,defects"
@@ -11,15 +11,16 @@
          failOnWarning="true"
          displayDetailsOnTestsThatTriggerWarnings="true"
          displayDetailsOnTestsThatTriggerErrors="true"
-         displayDetailsOnTestsThatTriggerNotices="true"
->
+         displayDetailsOnTestsThatTriggerNotices="true">
     <testsuites>
         <testsuite name="default">
             <directory>tests/phpunit</directory>
         </testsuite>
     </testsuites>
 
-    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+    <source restrictNotices="true"
+            restrictWarnings="true"
+            ignoreIndirectDeprecations="true">
         <include>
             <!-- #;< PHP_COMMAND -->
             <directory>src</directory>
@@ -28,7 +29,6 @@
             <file>php-script</file>
             <!-- #;> !PHP_COMMAND -->
         </include>
-
         <exclude>
             <directory>tests</directory>
         </exclude>

diff --git a/phpunit.xml.bak b/phpunit.xml.bak
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         executionOrder="depends,defects"
+         requireCoverageMetadata="true"
+         beStrictAboutCoverageMetadata="false"
+         beStrictAboutOutputDuringTests="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+>
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests/phpunit</directory>
+        </testsuite>
+    </testsuites>
+
+    <source restrictDeprecations="true" restrictNotices="true" restrictWarnings="true">
+        <include>
+            <!-- #;< PHP_COMMAND -->
+            <directory>src</directory>
+            <!-- #;> PHP_COMMAND -->
+            <!-- #;< !PHP_COMMAND -->
+            <file>php-script</file>
+            <!-- #;> !PHP_COMMAND -->
+        </include>
+
+        <exclude>
+            <directory>tests</directory>
+        </exclude>
+    </source>
+
+    <coverage includeUncoveredFiles="true"
+              pathCoverage="false"
+              ignoreDeprecatedCodeUnits="true"
+              disableCodeCoverageIgnore="false">
+        <report>
+            <html outputDirectory=".coverage-html" lowUpperBound="50" highLowerBound="90"/>
+            <cobertura outputFile="cobertura.xml"/>
+        </report>
+    </coverage>
+</phpunit>
diff --git a/tests/phpunit/Functional/ExampleScriptFunctionalTest.php b/tests/phpunit/Functional/ExampleScriptFunctionalTest.php
@@ -4,19 +4,22 @@
 
 namespace YourNamespace\App\Tests\Functional;
 
+use PHPUnit\Framework\Attributes\CoversFunction;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Group;
+use PHPUnit\Framework\Attributes\RunInSeparateProcess;
+
 /**
  * Class ExampleScriptFunctionalTest.
  *
  * Functional tests for php-script.
  */
+#[CoversFunction('main')]
+#[Group('scripts')]
 class ExampleScriptFunctionalTest extends ScriptFunctionalTestCase {
 
-  /**
-   * @covers ::main
-   * @dataProvider dataProviderMain
-   * @runInSeparateProcess
-   * @group script
-   */
+  #[DataProvider('dataProviderMain')]
+  #[RunInSeparateProcess]
   public function testMain(array|string $args, int $expected_code, string $expected_output): void {
     $result = $this->runScript($args);
     $this->assertEquals($expected_code, $result['code']);

diff --git a/tests/phpunit/Unit/Command/JokeCommandTest.php b/tests/phpunit/Unit/Command/JokeCommandTest.php
@@ -4,27 +4,24 @@
 
 namespace YourNamespace\App\Tests\Unit\Command;
 
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Group;
 use Symfony\Component\Console\Command\Command;
 use YourNamespace\App\Command\JokeCommand;
 
 /**
  * Class JokeCommandTest.
  *
  * This is a unit test for the JokeCommand class.
- *
- * @coversDefaultClass \YourNamespace\App\Command\JokeCommand
  */
+#[CoversMethod(JokeCommand::class, 'execute')]
+#[CoversMethod(JokeCommand::class, 'configure')]
+#[CoversMethod(JokeCommand::class, 'getJoke')]
+#[Group('command')]
 class JokeCommandTest extends CommandTestCase {
 
-  /**
-   * Test the execute method.
-   *
-   * @covers ::execute
-   * @covers ::configure
-   * @covers ::getJoke
-   * @dataProvider dataProviderExecute
-   * @group command
-   */
+  #[DataProvider('dataProviderExecute')]
   public function testExecute(string $content, int $expected_code, array|string $expected_output = []): void {
     /** @var \YourNamespace\App\Command\JokeCommand $mock */
     $mock = $this->prepareMock(JokeCommand::class, [

diff --git a/tests/phpunit/Unit/Command/SayHelloCommandTest.php b/tests/phpunit/Unit/Command/SayHelloCommandTest.php
@@ -4,24 +4,20 @@
 
 namespace YourNamespace\App\Tests\Unit\Command;
 
+use PHPUnit\Framework\Attributes\CoversMethod;
+use PHPUnit\Framework\Attributes\Group;
 use YourNamespace\App\Command\SayHelloCommand;
 
 /**
  * Class SayHelloCommandTest.
  *
  * This is a unit test for the SayHelloCommand class.
- *
- * @coversDefaultClass \YourNamespace\App\Command\SayHelloCommand
  */
+#[CoversMethod(SayHelloCommand::class, 'execute')]
+#[CoversMethod(SayHelloCommand::class, 'configure')]
+#[Group('command')]
 class SayHelloCommandTest extends CommandTestCase {
 
-  /**
-   * Test the execute method.
-   *
-   * @covers ::execute
-   * @covers ::configure
-   * @group command
-   */
   public function testExecute(): void {
     $output = $this->runExecute(SayHelloCommand::class);
     $this->assertArrayContainsString('Hello, Symfony console!', $output);

diff --git a/tests/phpunit/Unit/ExampleScriptUnitTest.php b/tests/phpunit/Unit/ExampleScriptUnitTest.php
@@ -4,22 +4,22 @@
 
 namespace YourNamespace\App\Tests\Unit;
 
+use PHPUnit\Framework\Attributes\CoversFunction;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Group;
+
 /**
  * Class ExampleScriptUnitTest.
  *
  * Unit tests for php-script.
- *
- * @group scripts
  */
+#[CoversFunction('main')]
+#[CoversFunction('print_help')]
+#[CoversFunction('verbose')]
+#[Group('scripts')]
 class ExampleScriptUnitTest extends ScriptUnitTestCase {
 
-  /**
-   * @covers ::main
-   * @covers ::print_help
-   * @covers ::verbose
-   * @dataProvider dataProviderMain
-   * @group script
-   */
+  #[DataProvider('dataProviderMain')]
   public function testMain(string|array $args = [], array|string $expected_output = [], string|null $expected_exception_message = NULL): void {
     if ($expected_exception_message) {
       $this->expectException(\Exception::class);