Merge pull request #960 from thephpleague/phpunit-10

PHPUnit 10 & 11

Author: colinodell

.gitignore

@@ -1,6 +1,7 @@
 /.idea/
 /.phpcs-cache
 /.phpunit.result.cache
+/.phpunit.cache
 /build/
 /docs/_site/
 composer.lock

composer.json

@@ -40,7 +40,7 @@
         "michelf/php-markdown": "^1.4 || ^2.0",
         "nyholm/psr7": "^1.5",
         "phpstan/phpstan": "^1.8.2",
-        "phpunit/phpunit": "^9.5.21",
+        "phpunit/phpunit": "^9.5.21 || ^10.5.9 || ^11.0.0",
         "scrutinizer/ocular": "^1.8.1",
         "symfony/finder": "^5.3 | ^6.0 || ^7.0",
         "symfony/yaml": "^2.3 | ^3.0 | ^4.0 | ^5.0 | ^6.0 || ^7.0",

phpunit.xml.dist

@@ -2,15 +2,12 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          bootstrap="vendor/autoload.php"
          backupGlobals="false"
-         backupStaticAttributes="false"
+         backupStaticProperties="false"
          colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+         cacheDirectory=".phpunit.cache"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd">
     <coverage>
         <include>
             <directory suffix=".php">src/</directory>

tests/functional/AbstractLocalDataTest.php renamed to tests/functional/AbstractLocalDataTestCase.php

@@ -26,7 +26,7 @@
  * This is particularly useful for testing minor variations allowed by the spec
  * or small regressions not tested by the spec.
  */
-abstract class AbstractLocalDataTest extends TestCase
+abstract class AbstractLocalDataTestCase extends TestCase
 {
     /**
      * @param array<string, mixed> $config
@@ -36,7 +36,7 @@ abstract protected function createConverter(array $config = []): ConverterInterf
     /**
      * @return iterable<array{string, string, array<string, mixed>, string}>
      */
-    abstract public function dataProvider(): iterable;
+    abstract public static function dataProvider(): iterable;
 
     /**
      * @dataProvider dataProvider
@@ -61,7 +61,7 @@ public function testWithLocalData(string $markdown, string $html, array $config,
     /**
      * @return iterable<array{string, string, array<string, mixed>, string}>
      */
-    protected function loadTests(string $dir, string $pattern = '*', string $inputFormat = '.md', string $outputFormat = '.html'): iterable
+    final protected static function loadTests(string $dir, string $pattern = '*', string $inputFormat = '.md', string $outputFormat = '.html'): iterable
     {
         $finder = new Finder();
         $finder->files()

tests/functional/AbstractSpecTest.php renamed to tests/functional/AbstractSpecTestCase.php

@@ -18,10 +18,9 @@
 
 use League\CommonMark\CommonMarkConverter;
 use League\CommonMark\MarkdownConverter;
-use League\CommonMark\Util\SpecReader;
 use PHPUnit\Framework\TestCase;
 
-abstract class AbstractSpecTest extends TestCase
+abstract class AbstractSpecTestCase extends TestCase
 {
     protected MarkdownConverter $converter;
 
@@ -33,35 +32,25 @@ protected function setUp(): void
     /**
      * @dataProvider dataProvider
      *
-     * @param string $markdown Markdown to parse
-     * @param string $html     Expected result
+     * @param string $input  Markdown to parse
+     * @param string $output Expected result
      */
-    public function testSpecExample(string $markdown, string $html): void
+    public function testSpecExample(string $input, string $output, string $type = '', string $section = '', int $number = -1): void
     {
-        $actualResult = (string) $this->converter->convert($markdown);
+        $actualResult = (string) $this->converter->convert($input);
 
         $failureMessage  = 'Unexpected result:';
-        $failureMessage .= "\n=== markdown ===============\n" . $this->showSpaces($markdown);
-        $failureMessage .= "\n=== expected ===============\n" . $this->showSpaces($html);
+        $failureMessage .= "\n=== markdown ===============\n" . $this->showSpaces($input);
+        $failureMessage .= "\n=== expected ===============\n" . $this->showSpaces($output);
         $failureMessage .= "\n=== got ====================\n" . $this->showSpaces($actualResult);
 
-        $this->assertEquals($html, $actualResult, $failureMessage);
+        $this->assertEquals($output, $actualResult, $failureMessage);
     }
 
-    public function dataProvider(): \Generator
-    {
-        yield from $this->loadSpecExamples();
-    }
-
-    protected function loadSpecExamples(): \Generator
-    {
-        yield from SpecReader::readFile($this->getFileName());
-    }
+    abstract public static function dataProvider(): \Generator;
 
     private function showSpaces(string $str): string
     {
         return \strtr($str, ["\t" => '→', ' ' => '␣']);
     }
-
-    abstract protected function getFileName(): string;
 }

tests/functional/CMarkRegressionTest.php

@@ -16,30 +16,24 @@
 
 namespace League\CommonMark\Tests\Functional;
 
+use League\CommonMark\Util\SpecReader;
+
 /**
  * Tests the parser against the CommonMark spec
  */
-final class CMarkRegressionTest extends AbstractSpecTest
+final class CMarkRegressionTest extends AbstractSpecTestCase
 {
-    protected function getFileName(): string
+    public static function dataProvider(): \Generator
     {
-        return __DIR__ . '/../../vendor/commonmark/cmark/test/regression.txt';
-    }
-
-    /**
-     * @deprecated
-     *
-     * We can't currently render spec example 13 exactly how the upstream library does. We'll likely need to overhaul
-     * our rendering approach in order to fix that, so we'll use this temporary workaround for now.
-     */
-    public function dataProvider(): \Generator
-    {
-        foreach (parent::dataProvider() as $example) {
+        $tests = SpecReader::readFile(__DIR__ . '/../../vendor/commonmark/cmark/test/regression.txt');
+        foreach ($tests as $example) {
+            // We can't currently render spec example 13 exactly how the upstream library does. We'll likely need to overhaul
+            // our rendering approach in order to fix that, so we'll use this temporary workaround for now.
             if ($example['number'] === 13) {
-                yield \str_replace('</script></li>', "</script>\n</li>", $example);
-            } else {
-                yield $example;
+                $example['output'] = \str_replace('</script></li>', "</script>\n</li>", $example['output']);
             }
+
+            yield $example;
         }
     }
 }

tests/functional/CommonMarkJSRegressionTest.php

@@ -16,30 +16,24 @@
 
 namespace League\CommonMark\Tests\Functional;
 
+use League\CommonMark\Util\SpecReader;
+
 /**
  * Tests the parser against the CommonMark spec
  */
-final class CommonMarkJSRegressionTest extends AbstractSpecTest
+final class CommonMarkJSRegressionTest extends AbstractSpecTestCase
 {
-    protected function getFileName(): string
+    public static function dataProvider(): \Generator
     {
-        return __DIR__ . '/../../vendor/commonmark/commonmark.js/test/regression.txt';
-    }
-
-    /**
-     * @deprecated
-     *
-     * We can't currently render spec example 18 exactly how the upstream library does. We'll likely need to overhaul
-     * our rendering approach in order to fix that, so we'll use this temporary workaround for now.
-     */
-    public function dataProvider(): \Generator
-    {
-        foreach (parent::dataProvider() as $example) {
+        $tests = SpecReader::readFile(__DIR__ . '/../../vendor/commonmark/commonmark.js/test/regression.txt');
+        foreach ($tests as $example) {
+            // We can't currently render spec example 18 exactly how the upstream library does. We'll likely need to overhaul
+            // our rendering approach in order to fix that, so we'll use this temporary workaround for now.
             if ($example['number'] === 18) {
-                yield \str_replace('</script></li>', "</script>\n</li>", $example);
-            } else {
-                yield $example;
+                $example['output'] = \str_replace('</script></li>', "</script>\n</li>", $example['output']);
             }
+
+            yield $example;
         }
     }
 }

tests/functional/Delimiter/DelimiterProcessingTest.php

@@ -55,7 +55,7 @@ public function testAsymmetricDelimiterProcessing(string $input, string $expecte
     /**
      * @return iterable<array<string>>
      */
-    public function asymmetricDelimiterDataProvider(): iterable
+    public static function asymmetricDelimiterDataProvider(): iterable
     {
         yield ['{foo} bar', "<p>FOO bar</p>\n"];
         yield ['f{oo ba}r', "<p>fOO BAr</p>\n"];

tests/functional/Extension/Attributes/LocalDataTest.php

@@ -20,12 +20,12 @@
 use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
 use League\CommonMark\Extension\GithubFlavoredMarkdownExtension;
 use League\CommonMark\MarkdownConverter;
-use League\CommonMark\Tests\Functional\AbstractLocalDataTest;
+use League\CommonMark\Tests\Functional\AbstractLocalDataTestCase;
 
 /**
  * @internal
  */
-final class LocalDataTest extends AbstractLocalDataTest
+final class LocalDataTest extends AbstractLocalDataTestCase
 {
     /**
      * @param array<string, mixed> $config
@@ -43,8 +43,8 @@ protected function createConverter(array $config = []): ConverterInterface
     /**
      * {@inheritDoc}
      */
-    public function dataProvider(): iterable
+    public static function dataProvider(): iterable
     {
-        yield from $this->loadTests(__DIR__ . '/data');
+        yield from self::loadTests(__DIR__ . '/data');
     }
 }

tests/functional/Extension/Autolink/AutolinkXmlTest.php

@@ -17,10 +17,10 @@
 use League\CommonMark\Environment\Environment;
 use League\CommonMark\Extension\Autolink\AutolinkExtension;
 use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
-use League\CommonMark\Tests\Functional\AbstractLocalDataTest;
+use League\CommonMark\Tests\Functional\AbstractLocalDataTestCase;
 use League\CommonMark\Xml\MarkdownToXmlConverter;
 
-final class AutolinkXmlTest extends AbstractLocalDataTest
+final class AutolinkXmlTest extends AbstractLocalDataTestCase
 {
     /**
      * @param array<string, mixed> $config
@@ -37,8 +37,8 @@ protected function createConverter(array $config = []): ConverterInterface
     /**
      * {@inheritDoc}
      */
-    public function dataProvider(): iterable
+    public static function dataProvider(): iterable
     {
-        yield from $this->loadTests(__DIR__ . '/xml', '*', '.md', '.xml');
+        yield from self::loadTests(__DIR__ . '/xml', '*', '.md', '.xml');
     }
 }