Allow PHPUnit 9.3 (#504)

* Allow PHPUnit 9.3 * Suggest warming coverage cache
paratestphp · Aug 10, 2020 · 88e4d87 · 88e4d87
1 parent d51a2ad
commit 88e4d87
Show file tree

Hide file tree

Showing 15 changed files with 289 additions and 232 deletions.
diff --git a/.github/lint-xml-configuration/lint-xml-configuration.sh b/.github/lint-xml-configuration/lint-xml-configuration.sh
@@ -2,7 +2,9 @@
 
 set -ex
 
-xmllint --noout --schema vendor/phpunit/phpunit/phpunit.xsd phpunit.xml.dist
+phpunitXsd="vendor/phpunit/phpunit/phpunit.xsd"
+
+xmllint --noout --schema "$phpunitXsd" phpunit.xml.dist
 xmllint --noout --schema vendor/squizlabs/php_codesniffer/phpcs.xsd phpcs.xml.dist
 xmllint --noout --schema vendor/vimeo/psalm/config.xsd psalm.xml.dist
-find test/ -name "phpunit*.xml*" -not -name "phpunit-files-dirs-mix-nested.xml" -print0 | xargs -0 xmllint --noout --schema vendor/phpunit/phpunit/phpunit.xsd
+find test/ -name "phpunit*.xml*" -not -name "phpunit-files-dirs-mix-nested.xml" -print0 | xargs -0 xmllint --noout --schema "$phpunitXsd"
diff --git a/README.md b/README.md
@@ -137,6 +137,14 @@ The corresponding logfiles are placed in your `sys_get_temp_dir()`.
 See [Logging docs](docs/logging.md) for further information.
 
 ### Generating code coverage
+
+Beginning from PHPUnit 9.3.4, it is strongly advised to warm the coverage cache before running any code-coverage
+analysis, see [PHPUnit Changlog @ 9.3.4](https://github.com/sebastianbergmann/phpunit/blob/master/ChangeLog-9.3.md#934---2020-08-10):
+
+```
+vendor/bin/phpunit --warm-coverage-cache
+``` 
+
 Examples assume your tests are located under `./test/unit`.
 ````
 vendor/bin/paratest -p 1 --coverage-text test/unit

diff --git a/composer.json b/composer.json
@@ -27,18 +27,18 @@
         "ext-reflection": "*",
         "ext-simplexml": "*",
         "brianium/habitat": "^1.0",
-        "phpunit/php-code-coverage": "^8.0",
+        "phpunit/php-code-coverage": "^9.1.2",
         "phpunit/php-timer": "^5.0",
-        "phpunit/phpunit": "^9.2",
-        "symfony/console": "^4.4 || ^5.0",
-        "symfony/process": "^4.4 || ^5.0"
+        "phpunit/phpunit": "^9.3.5",
+        "symfony/console": "^4.4 || ^5.1",
+        "symfony/process": "^4.4 || ^5.1"
     },
     "require-dev": {
-        "doctrine/coding-standard": "^8.1",
-        "phpstan/phpstan": "^0.12.33",
-        "phpstan/phpstan-phpunit": "^0.12.12",
-        "squizlabs/php_codesniffer": "^3.5",
-        "vimeo/psalm": "^3.12"
+        "doctrine/coding-standard": "^8.1.0",
+        "phpstan/phpstan": "^0.12.37",
+        "phpstan/phpstan-phpunit": "^0.12.16",
+        "squizlabs/php_codesniffer": "^3.5.6",
+        "vimeo/psalm": "^3.12.2"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -14,12 +14,6 @@ parameters:
     excludes_analyse:
         - test/fixtures/*
     ignoreErrors:
-        # @see https://github.com/phpstan/phpstan-src/pull/281
-        -
-            message: "#^Strict comparison using \\=\\=\\= between int and false will always evaluate to false\\.$#"
-            count: 1
-            path: src/Runners/PHPUnit/SqliteRunner.php
-
         # Known fixtures
         -
             message: "#^Property ParaTest\\\\Runners\\\\PHPUnit\\\\ExecutableTest\\:\\:\\$process type has no value type specified in iterable type Symfony\\\\Component\\\\Process\\\\Process\\.$#"

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,33 +1,34 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="./test/bootstrap.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        bootstrap="./test/bootstrap.php"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        processIsolation="false"
+        stopOnFailure="false"
 >
-    <testsuites>
-        <testsuite name="ParaTest Unit Tests">
-            <directory>./test/Unit/</directory>
-        </testsuite>
-        <testsuite name="ParaTest Functional Tests">
-            <directory>./test/Functional/</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
-
-    <php>
-        <env name="APP_ENV" value="testing"/>
-        <env name="CACHE_DRIVER" value="array"/>
-        <env name="DB_CONNECTION" value="sqlite"/>
-        <env name="DB_DATABASE" value=":memory:"/>
-    </php>
+  <testsuites>
+    <testsuite name="ParaTest Unit Tests">
+      <directory>./test/Unit/</directory>
+    </testsuite>
+    <testsuite name="ParaTest Functional Tests">
+      <directory>./test/Functional/</directory>
+    </testsuite>
+  </testsuites>
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </coverage>
+  <php>
+    <env name="APP_ENV" value="testing"/>
+    <env name="CACHE_DRIVER" value="array"/>
+    <env name="DB_CONNECTION" value="sqlite"/>
+    <env name="DB_DATABASE" value=":memory:"/>
+  </php>
 </phpunit>
diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -13,4 +13,9 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <issueHandlers>
+      <InternalClass errorLevel="suppress" />
+      <InternalMethod errorLevel="suppress" />
+    </issueHandlers>
 </psalm>
diff --git a/src/Coverage/CoverageMerger.php b/src/Coverage/CoverageMerger.php
@@ -6,6 +6,7 @@
 
 use RuntimeException;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\ProcessedCodeCoverageData;
 use SplFileObject;
 
 use function array_map;
@@ -118,7 +119,8 @@ private function limitCoverageTests(CodeCoverage $coverage): void
             return;
         }
 
-        $coverage->setData(array_map(
+        $data          = $coverage->getData(true);
+        $newData       = array_map(
             function (array $lines) {
                 return array_map(function ($value) {
                     if (! is_array($value)) {
@@ -128,7 +130,11 @@ function (array $lines) {
                     return array_slice($value, 0, $this->test_limit);
                 }, $lines);
             },
-            $coverage->getData($raw = true)
-        ));
+            $data->lineCoverage(),
+        );
+        $processedData = new ProcessedCodeCoverageData();
+        $processedData->setLineCoverage($newData);
+
+        $coverage->setData($processedData);
     }
 }
diff --git a/src/Runners/PHPUnit/Options.php b/src/Runners/PHPUnit/Options.php
@@ -205,7 +205,7 @@ public function __construct(array $opts = [])
         $this->maxBatchSize      = (int) $opts['max-batch-size'];
         $this->filter            = $opts['filter'];
         $this->parallelSuite     = $opts['parallel-suite'];
-        $this->passthru          = $this->parsePassthru($opts['passthru-php'] ?? null);
+        $this->passthru          = $this->parsePassthru($opts['passthru'] ?? null);
         $this->passthruPhp       = $this->parsePassthru($opts['passthru-php'] ?? null);
         $this->verbose           = $opts['verbose'] ?? 0;
         $this->coverageTestLimit = $opts['coverage-test-limit'] ?? 0;

diff --git a/src/Runners/PHPUnit/Worker/BaseWorker.php b/src/Runners/PHPUnit/Worker/BaseWorker.php
@@ -157,7 +157,7 @@ public function stop(): void
     }
 
     /**
-     * @param array<string, bool|int> $status
+     * @param array<string, bool|int|string> $status
      */
     protected function setExitCode(array $status): void
     {

diff --git a/test/Functional/Coverage/CoverageReporterTest.php b/test/Functional/Coverage/CoverageReporterTest.php
@@ -107,7 +107,7 @@ public function testGenerateClover(array $coverageFiles): void
 
         static::assertFileExists($target);
 
-        $reportXml = Xml::loadFile($target);
+        $reportXml = (new Xml\Loader())->loadFile($target);
         static::assertInstanceOf('DomDocument', $reportXml, 'Incorrect clover report xml was generated');
     }
 
@@ -133,7 +133,7 @@ public function testGenerateCrap4J(array $coverageFiles): void
 
         static::assertFileExists($target);
 
-        $reportXml = Xml::loadFile($target);
+        $reportXml = (new Xml\Loader())->loadFile($target);
         static::assertInstanceOf('DomDocument', $reportXml, 'Incorrect crap4j report xml was generated');
         static::assertEquals('crap_result', $reportXml->documentElement->tagName);
     }

diff --git a/test/Unit/Coverage/CoverageMergerTest.php b/test/Unit/Coverage/CoverageMergerTest.php
@@ -7,7 +7,9 @@
 use ParaTest\Coverage\CoverageMerger;
 use ParaTest\Tests\TestBase;
 use SebastianBergmann\CodeCoverage\CodeCoverage;
+use SebastianBergmann\CodeCoverage\Driver\Driver;
 use SebastianBergmann\CodeCoverage\Filter;
+use SebastianBergmann\CodeCoverage\RawCodeCoverageData;
 
 use function assert;
 
@@ -34,20 +36,24 @@ public function testSimpleMerge(): void
         $secondFileFirstLine = 53;
 
         $filter = new Filter();
-        $filter->addFilesToWhitelist([$firstFile, $secondFile]);
-        $coverage1 = new CodeCoverage(null, $filter);
+        $filter->includeFiles([$firstFile, $secondFile]);
+
+        $data      = RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+            $firstFile => [$firstFileFirstLine => 1],
+            $secondFile => [$secondFileFirstLine => 1],
+        ]);
+        $coverage1 = new CodeCoverage(Driver::forLineCoverage($filter), $filter);
         $coverage1->append(
-            [
-                $firstFile => [$firstFileFirstLine => 1],
-                $secondFile => [$secondFileFirstLine => 1],
-            ],
+            $data,
             'Test1'
         );
-        $coverage2 = new CodeCoverage(null, $filter);
+
+        $data      = RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+            $firstFile => [$firstFileFirstLine => 1, 1 + $firstFileFirstLine => 1],
+        ]);
+        $coverage2 = new CodeCoverage(Driver::forLineCoverage($filter), $filter);
         $coverage2->append(
-            [
-                $firstFile => [$firstFileFirstLine => 1, 1 + $firstFileFirstLine => 1],
-            ],
+            $data,
             'Test2'
         );
 
@@ -60,7 +66,7 @@ public function testSimpleMerge(): void
 
         $this->assertInstanceOf(CodeCoverage::class, $coverage);
 
-        $data = $coverage->getData();
+        $data = $coverage->getData()->lineCoverage();
 
         $this->assertCount(2, $data[$firstFile][$firstFileFirstLine]);
         $this->assertEquals('Test1', $data[$firstFile][$firstFileFirstLine][0]);
@@ -86,20 +92,24 @@ public function testSimpleMergeLimited(): void
         $secondFileFirstLine = 53;
 
         $filter = new Filter();
-        $filter->addFilesToWhitelist([$firstFile, $secondFile]);
-        $coverage1 = new CodeCoverage(null, $filter);
+        $filter->includeFiles([$firstFile, $secondFile]);
+
+        $data      = RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+            $firstFile => [$firstFileFirstLine => 1],
+            $secondFile => [$secondFileFirstLine => 1],
+        ]);
+        $coverage1 = new CodeCoverage(Driver::forLineCoverage($filter), $filter);
         $coverage1->append(
-            [
-                $firstFile => [$firstFileFirstLine => 1],
-                $secondFile => [$secondFileFirstLine => 1],
-            ],
+            $data,
             'Test1'
         );
-        $coverage2 = new CodeCoverage(null, $filter);
+
+        $data      = RawCodeCoverageData::fromXdebugWithoutPathCoverage([
+            $firstFile => [$firstFileFirstLine => 1, 1 + $firstFileFirstLine => 1],
+        ]);
+        $coverage2 = new CodeCoverage(Driver::forLineCoverage($filter), $filter);
         $coverage2->append(
-            [
-                $firstFile => [$firstFileFirstLine => 1, 1 + $firstFileFirstLine => 1],
-            ],
+            $data,
             'Test2'
         );
 
@@ -111,7 +121,7 @@ public function testSimpleMergeLimited(): void
         assert($coverage instanceof CodeCoverage);
 
         $this->assertInstanceOf(CodeCoverage::class, $coverage);
-        $data = $coverage->getData();
+        $data = $coverage->getData()->lineCoverage();
 
         $this->assertCount(1, $data[$firstFile][$firstFileFirstLine]);
         $this->assertCount(1, $data[$secondFile][$secondFileFirstLine]);
-Original file line number
+Diff line change
@@ Expand Up / @@ -157,7 +157,7 @@ public function stop(): void @@
         }
         /**
-         * @param array<string, bool|int> $status
+         * @param array<string, bool|int|string> $status
          */
         protected function setExitCode(array $status): void
         {
@@ Expand Down @@