Fix tests on PHP 8

.github/workflows/tests.yml

@@ -30,6 +30,10 @@ jobs:
 
             - run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
+            - name: "Use PHPUnit 9.3+ on PHP 8"
+              run: composer require --no-update --dev phpunit/phpunit:^9.3
+              if: "matrix.php == '8.0'"
+
             - run: composer update --no-progress ${{ matrix.composer-flags }}
 
             - run: vendor/bin/phpunit --no-coverage

composer.json

@@ -32,10 +32,12 @@
         "michelf/php-markdown": "~1.4",
         "mikehaertl/php-shellcommand": "^1.4",
         "phpstan/phpstan": "^0.12",
-        "phpunit/phpunit": "^7.5",
+        "phpunit/phpunit": "^7.5 || ^8.5 || ^9.2",
         "scrutinizer/ocular": "^1.5",
         "symfony/finder": "^4.2"
     },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "conflict": {
         "scrutinizer/ocular": "1.7.*"
     },

phpunit.xml.dist

@@ -10,8 +10,11 @@
          processIsolation="false"
          stopOnFailure="false">
     <testsuites>
-        <testsuite name="league/commonmark Test Suite">
-            <directory>tests</directory>
+        <testsuite name="league/commonmark Functional Tests">
+            <directory>tests/functional</directory>
+        </testsuite>
+        <testsuite name="league/commonmark Unit Tests">
+            <directory>tests/unit</directory>
         </testsuite>
     </testsuites>
     <filter>
@@ -20,8 +23,6 @@
         </whitelist>
     </filter>
     <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
         <log type="coverage-html" target="build/coverage" />
         <log type="coverage-text" target="build/coverage.txt"/>
         <log type="coverage-clover" target="build/logs/clover.xml"/>

src/Reference/Reference.php

@@ -65,6 +65,7 @@ public function getTitle(): string
      * @return string
      *
      * @deprecated Use TextNormalizer::normalize() instead
+     * @group legacy
      */
     public static function normalizeReference(string $string): string
     {

tests/functional/AbstractSpecTest.php

@@ -24,7 +24,7 @@ abstract class AbstractSpecTest extends TestCase
      */
     protected $converter;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->converter = new CommonMarkConverter();
     }

tests/functional/BinTest.php

@@ -35,7 +35,7 @@ public function testNoArgsOrStdin()
         $this->assertEquals(1, $cmd->getExitCode());
 
         if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
-            $this->assertContains('Usage:', $cmd->getError());
+            $this->assertStringContainsString('Usage:', $cmd->getError());
         }
     }
 
@@ -49,7 +49,7 @@ public function testHelpShortFlag()
         $cmd->execute();
 
         $this->assertEquals(0, $cmd->getExitCode());
-        $this->assertContains('Usage:', $cmd->getOutput());
+        $this->assertStringContainsString('Usage:', $cmd->getOutput());
     }
 
     /**
@@ -62,7 +62,7 @@ public function testHelpOption()
         $cmd->execute();
 
         $this->assertEquals(0, $cmd->getExitCode());
-        $this->assertContains('Usage:', $cmd->getOutput());
+        $this->assertStringContainsString('Usage:', $cmd->getOutput());
     }
 
     /**
@@ -77,7 +77,7 @@ public function testUnknownOption()
         $this->assertEquals(1, $cmd->getExitCode());
 
         if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
-            $this->assertContains('Unknown option', $cmd->getError());
+            $this->assertStringContainsString('Unknown option', $cmd->getError());
         }
     }
 
@@ -92,7 +92,7 @@ public function testFileArgument()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('atx_heading.html')));
-        $this->assertContains($expectedContents, $cmd->getOutput());
+        $this->assertStringContainsString($expectedContents, $cmd->getOutput());
     }
 
     /**
@@ -109,7 +109,7 @@ public function testStdin()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('atx_heading.html')));
-        $this->assertContains($expectedContents, $cmd->getOutput());
+        $this->assertStringContainsString($expectedContents, $cmd->getOutput());
     }
 
     /**
@@ -123,7 +123,7 @@ public function testUnsafe()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('safe/unsafe_output.html')));
-        $this->assertContains($expectedContents, $cmd->getOutput());
+        $this->assertStringContainsString($expectedContents, $cmd->getOutput());
     }
 
     /**
@@ -138,7 +138,7 @@ public function testSafe()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('safe/safe_output.html')));
-        $this->assertContains($expectedContents, $cmd->getOutput());
+        $this->assertStringContainsString($expectedContents, $cmd->getOutput());
     }
 
     /**
@@ -152,7 +152,7 @@ public function testVersion()
             $cmd->execute();
 
             $this->assertEquals(0, $cmd->getExitCode());
-            $this->assertContains(CommonMarkConverter::VERSION, trim($cmd->getOutput()));
+            $this->assertStringContainsString(CommonMarkConverter::VERSION, trim($cmd->getOutput()));
         }
     }
 

tests/functional/Delimiter/DelimiterProcessingTest.php

@@ -73,11 +73,9 @@ public function testMultipleDelimitersWithDifferentLengths()
         $this->assertEquals("<p>(1)(2)both(/2)(/1)</p>\n", $c->convertToHtml('@@@both@@@'));
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testMultipleDelimitersWithSameLength()
     {
+        $this->expectException(\InvalidArgumentException::class);
         $e = Environment::createCommonMarkEnvironment();
         $e->addDelimiterProcessor(new TestDelimiterProcessor('@', 1));
         $e->addDelimiterProcessor(new TestDelimiterProcessor('@', 1));

tests/functional/EmphasisTest.php

@@ -44,7 +44,7 @@ public function testEmStrong()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('emstrong.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 
     /**
@@ -59,7 +59,7 @@ public function testEm()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('em.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 
     /**
@@ -74,7 +74,7 @@ public function testStrong()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('strong.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 
     /**
@@ -90,7 +90,7 @@ public function testNone()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('disabled.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 
     /**
@@ -105,7 +105,7 @@ public function testAsterisks()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('asterisks.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 
     /**
@@ -120,6 +120,6 @@ public function testUnderscores()
 
         $this->assertEquals(0, $cmd->getExitCode());
         $expectedContents = trim(file_get_contents($this->getPathToData('underscores.html')));
-        $this->assertContains($expectedContents, trim($cmd->getOutput()));
+        $this->assertStringContainsString($expectedContents, trim($cmd->getOutput()));
     }
 }

tests/functional/Extension/GithubFlavoredMarkdownExtensionTest.php

@@ -16,7 +16,7 @@
 
 class GithubFlavoredMarkdownExtensionTest extends AbstractSpecTest
 {
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->converter = new GithubFlavoredMarkdownConverter();
     }

tests/functional/Extension/HeadingPermalink/HeadingPermalinkExtensionTest.php

@@ -77,6 +77,9 @@ public function dataProviderForTestHeadingPermalinksWithCustomOptions()
         yield ["Test\n----", '<h2>Test<a id="custom-prefix-test" href="#test" name="test" class="custom-class" aria-hidden="true" title="Link">¶ 🦄️ &lt;3 You</a></h2>'];
     }
 
+    /**
+     * @group legacy
+     */
     public function testHeadingPermalinksWithDeprecatedInnerContents()
     {
         $environment = Environment::createCommonMarkEnvironment();

tests/functional/Extension/InlinesOnly/InlinesOnlyFunctionalTest.php

@@ -26,7 +26,7 @@ class InlinesOnlyFunctionalTest extends TestCase
      */
     protected $converter;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $environment = new Environment();
         $environment->addExtension(new InlinesOnlyExtension());

tests/functional/Extension/SmartPunct/SmartPunctFunctionalTest.php

@@ -12,7 +12,7 @@
  * file that was distributed with this source code.
  */
 
-namespace League\CommonMark\Tests\Unit\Extension\SmartPunct;
+namespace League\CommonMark\Tests\Functional\Extension\SmartPunct;
 
 use League\CommonMark\CommonMarkConverter;
 use League\CommonMark\Environment;
@@ -29,7 +29,7 @@ class SmartPunctFunctionalTest extends TestCase
      */
     protected $converter;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $environment = Environment::createCommonMarkEnvironment();
         $environment->addExtension(new SmartPunctExtension());

tests/functional/LocalDataTest.php

@@ -26,7 +26,7 @@ class LocalDataTest extends AbstractLocalDataTest
      */
     protected $converter;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->converter = new CommonMarkConverter();
     }

tests/unit/Block/Element/AbstractBlockTest.php

@@ -33,11 +33,10 @@ public function testSetParent()
         $this->assertNull($block->parent());
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testSetParentWithInvalidNode()
     {
+        $this->expectException(\InvalidArgumentException::class);
+
         $block = $this->getMockForAbstractClass(AbstractBlock::class);
 
         $inline = $this->getMockForAbstractClass(AbstractInline::class);

tests/unit/Block/Renderer/BlockQuoteRendererTest.php

@@ -29,7 +29,7 @@ class BlockQuoteRendererTest extends TestCase
      */
     protected $renderer;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->renderer = new BlockQuoteRenderer();
     }
@@ -58,15 +58,14 @@ public function testRenderBlockQuote()
 
         $this->assertTrue($result instanceof HtmlElement);
         $this->assertEquals('blockquote', $result->getTagName());
-        $this->assertContains('::blocks::', $result->getContents(true));
+        $this->assertStringContainsString('::blocks::', $result->getContents(true));
         $this->assertEquals(['id' => 'id'], $result->getAllAttributes());
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testRenderWithInvalidType()
     {
+        $this->expectException(\InvalidArgumentException::class);
+
         $inline = $this->getMockForAbstractClass(BlockElement\AbstractBlock::class);
         $fakeRenderer = new FakeHtmlRenderer();
 

tests/unit/Block/Renderer/DocumentRendererTest.php

@@ -28,7 +28,7 @@ class DocumentRendererTest extends TestCase
      */
     protected $renderer;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->renderer = new DocumentRenderer();
     }
@@ -40,7 +40,7 @@ public function testRenderEmptyDocument()
 
         $result = $this->renderer->render($block, $fakeRenderer);
 
-        $this->assertInternalType('string', $result);
+        $this->assertIsString($result);
         $this->assertEmpty($result);
     }
 
@@ -51,15 +51,14 @@ public function testRenderDocument()
 
         $result = $this->renderer->render($block, $fakeRenderer);
 
-        $this->assertInternalType('string', $result);
-        $this->assertContains('::blocks::', $result);
+        $this->assertIsString($result);
+        $this->assertStringContainsString('::blocks::', $result);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testRenderWithInvalidType()
     {
+        $this->expectException(\InvalidArgumentException::class);
+
         $inline = $this->getMockForAbstractClass(BlockElement\AbstractBlock::class);
         $fakeRenderer = new FakeHtmlRenderer();
 

tests/unit/Block/Renderer/FencedCodeRendererTest.php

@@ -31,7 +31,7 @@ class FencedCodeRendererTest extends TestCase
      */
     protected $renderer;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->renderer = new FencedCodeRenderer();
     }
@@ -59,8 +59,8 @@ public function testRenderWithLanguageSpecified()
         $code = $result->getContents(false);
         $this->assertTrue($code instanceof HtmlElement);
         $this->assertEquals('code', $code->getTagName());
-        $this->assertContains('bar language-php', $code->getAttribute('class'));
-        $this->assertContains('hello world', $code->getContents(true));
+        $this->assertStringContainsString('bar language-php', $code->getAttribute('class'));
+        $this->assertStringContainsString('hello world', $code->getContents(true));
     }
 
     public function testRenderWithoutLanguageSpecified()
@@ -87,14 +87,13 @@ public function testRenderWithoutLanguageSpecified()
         $this->assertTrue($code instanceof HtmlElement);
         $this->assertEquals('code', $code->getTagName());
         $this->assertEquals('bar', $code->getAttribute('class'));
-        $this->assertContains('hello world', $code->getContents(true));
+        $this->assertStringContainsString('hello world', $code->getContents(true));
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testRenderWithInvalidType()
     {
+        $this->expectException(\InvalidArgumentException::class);
+
         $inline = $this->getMockForAbstractClass(BlockElement\AbstractBlock::class);
         $fakeRenderer = new FakeHtmlRenderer();