Fixes failing tests; reorganized test files (PHPUnit 10.x related) (#583

) * Fixes failing tests; reorganized test files (PHPUnit 10.x related) Since version 10, PHPUnit complains about: 1) Your XML configuration validates against a deprecated schema. Migrate your XML configuration using "--migrate-configuration"! 2) Class AltAutoloadTest cannot be found in D:\a\pdfparser\pdfparser\tests\AltAutoloadTest.php 3) Class Tests\Smalot\PdfParser\Performance\Test\AbstractPerformanceTest cannot be found in D:\a\pdfparser\pdfparser\tests\Performance\Test\AbstractPerformanceTest.php 4) Class Tests\Smalot\PdfParser\Performance\Test\DocumentDictionaryCacheTest cannot be found in D:\a\pdfparser\pdfparser\tests\Performance\Test\DocumentDictionaryCacheTest.php The first one is easy to solve. But the other 3 are confusing, because PHPUnit 9 did not complain at all. Reason for these warnings is that since PHPUnit v10, it doesn't like abstract Test classes or files (containing Test in the name), which contain no class at all. Source: sebastianbergmann/phpunit#4979 To mitigate these warnings and to make maintenance easier in the future, I reorganized our test files and put them in different folders. PHPUnit tests are separated from our other tests. * fixed alt autoloading * reverted name change for AbstractPerformanceTest * migrated Windows-related PHPUnit config file * dev-tools: restrict PHPUnit version in composer.json * Update dev-tools/composer.json Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com> --------- Co-authored-by: Jérémy Benoist <j0k3r@users.noreply.github.com>
smalot · Mar 10, 2023 · 3ef8bc5 · 3ef8bc5
1 parent 70433d1
commit 3ef8bc5
Show file tree

Hide file tree

Showing 38 changed files with 104 additions and 132 deletions.
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -165,7 +165,7 @@ jobs:
           coverage: "none"
 
       - name: "Test alt-autoload"
-        run: "php tests/AltAutoloadTest.php"
+        run: "php tests/AltAutoloading/AltAutoloadCheck.php"
 
   phpunit-lowest:
     name: "PHPUnit lowest deps (PHP ${{ matrix.php }})"

diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,5 @@
 debug*
 composer.lock
 /.php-cs-fixer.cache
+/.phpunit.cache
 /.phpunit.result.cache
diff --git a/composer.json b/composer.json
@@ -27,7 +27,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\Smalot\\PdfParser\\": "tests/"
+            "PerformanceTests\\": "tests/Performance/",
+            "PHPUnitTests\\": "tests/PHPUnit/"
         }
     },
     "config": {

diff --git a/dev-tools/composer.json b/dev-tools/composer.json
@@ -4,6 +4,6 @@
         "friendsofphp/php-cs-fixer": "^3",
         "phpstan/phpstan": "^1",
         "phpstan/phpstan-phpunit": "^1",
-        "phpunit/phpunit": ">=7.5"
+        "phpunit/phpunit": ">=7.5 <11.0"
     }
 }
diff --git a/phpunit-windows.xml b/phpunit-windows.xml
@@ -1,36 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!-- Only use this when running in Windows environment! -->
-
 <!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.1/phpunit.xsd"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor\autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         verbose="true"
->
-    <php>
-        <ini name="error_reporting" value="-1" />
-        <ini name="zend.enable_gc" value="0"/>
-        <ini name="error_reporting" value="-1"/>
-        <ini name="intl.error_level" value="0"/>
-        <ini name="display_errors" value="On"/>
-    </php>
-
-    <testsuites>
-        <testsuite name="all">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" backupGlobals="false" bootstrap="vendor\autoload.php" colors="true" processIsolation="false" stopOnFailure="false" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage>
+    <include>
+      <directory>src</directory>
+    </include>
+  </coverage>
+  <php>
+    <ini name="error_reporting" value="-1"/>
+    <ini name="zend.enable_gc" value="0"/>
+    <ini name="error_reporting" value="-1"/>
+    <ini name="intl.error_level" value="0"/>
+    <ini name="display_errors" value="On"/>
+  </php>
+  <testsuites>
+    <testsuite name="all">
+      <directory>tests/PHPUnit</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,35 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.1/phpunit.xsd"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         verbose="true"
->
-    <php>
-        <ini name="error_reporting" value="-1" />
-        <ini name="zend.enable_gc" value="0"/>
-        <ini name="error_reporting" value="-1"/>
-        <ini name="intl.error_level" value="0"/>
-        <ini name="display_errors" value="On"/>
-    </php>
-
-    <testsuites>
-        <testsuite name="all">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory>src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" backupGlobals="false" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <coverage>
+    <include>
+      <directory>src</directory>
+    </include>
+  </coverage>
+  <php>
+    <ini name="error_reporting" value="-1"/>
+    <ini name="zend.enable_gc" value="0"/>
+    <ini name="error_reporting" value="-1"/>
+    <ini name="intl.error_level" value="0"/>
+    <ini name="display_errors" value="On"/>
+  </php>
+  <testsuites>
+    <testsuite name="all">
+      <directory>tests/PHPUnit</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/tests/AltAutoloadTest.php → tests/AltAutoloading/AltAutoloadCheck.php b/tests/AltAutoloadTest.php → tests/AltAutoloading/AltAutoloadCheck.php
@@ -28,11 +28,11 @@
  *  along with this program.
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
-require __DIR__.'/../alt_autoload.php-dist';
+require __DIR__.'/../../alt_autoload.php-dist';
 
 $parser = new Smalot\PdfParser\Parser();
 
-$filename = __DIR__.'/../samples/InternationalChars.pdf';
+$filename = __DIR__.'/../../samples/InternationalChars.pdf';
 $document = $parser->parseFile($filename);
 
 $needle = 'Лорем ипсум долор сит амет, еу сед либрис долорем инцоррупте.';

diff --git a/tests/Integration/ConfigTest.php → tests/PHPUnit/Integration/ConfigTest.php b/tests/Integration/ConfigTest.php → tests/PHPUnit/Integration/ConfigTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration;
+namespace PHPUnitTests\Integration;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Config;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ConfigTest extends TestCase
 {

diff --git a/tests/Integration/DocumentTest.php → tests/PHPUnit/Integration/DocumentTest.php b/tests/Integration/DocumentTest.php → tests/PHPUnit/Integration/DocumentTest.php
@@ -33,15 +33,15 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration;
+namespace PHPUnitTests\Integration;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Document;
 use Smalot\PdfParser\Header;
 use Smalot\PdfParser\Page;
 use Smalot\PdfParser\Pages;
 use Smalot\PdfParser\Parser;
 use Smalot\PdfParser\PDFObject;
-use Tests\Smalot\PdfParser\TestCase;
 
 class DocumentTest extends TestCase
 {

diff --git a/.../Integration/Element/ElementArrayTest.php → .../Integration/Element/ElementArrayTest.php b/.../Integration/Element/ElementArrayTest.php → .../Integration/Element/ElementArrayTest.php
@@ -33,14 +33,14 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Document;
 use Smalot\PdfParser\Element\ElementArray;
 use Smalot\PdfParser\Element\ElementNumeric;
 use Smalot\PdfParser\Header;
 use Smalot\PdfParser\Page;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementArrayTest extends TestCase
 {

diff --git a/...ntegration/Element/ElementBooleanTest.php → ...ntegration/Element/ElementBooleanTest.php b/...ntegration/Element/ElementBooleanTest.php → ...ntegration/Element/ElementBooleanTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementBoolean;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementBooleanTest extends TestCase
 {

diff --git a/...s/Integration/Element/ElementDateTest.php → ...t/Integration/Element/ElementDateTest.php b/...s/Integration/Element/ElementDateTest.php → ...t/Integration/Element/ElementDateTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementDate;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementDateTest extends TestCase
 {

diff --git a/...s/Integration/Element/ElementHexaTest.php → ...t/Integration/Element/ElementHexaTest.php b/...s/Integration/Element/ElementHexaTest.php → ...t/Integration/Element/ElementHexaTest.php
@@ -33,12 +33,12 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementDate;
 use Smalot\PdfParser\Element\ElementHexa;
 use Smalot\PdfParser\Element\ElementString;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementHexaTest extends TestCase
 {

diff --git a/...ntegration/Element/ElementMissingTest.php → ...ntegration/Element/ElementMissingTest.php b/...ntegration/Element/ElementMissingTest.php → ...ntegration/Element/ElementMissingTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementMissing;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementMissingTest extends TestCase
 {

diff --git a/...s/Integration/Element/ElementNameTest.php → ...t/Integration/Element/ElementNameTest.php b/...s/Integration/Element/ElementNameTest.php → ...t/Integration/Element/ElementNameTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementName;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementNameTest extends TestCase
 {

diff --git a/...s/Integration/Element/ElementNullTest.php → ...t/Integration/Element/ElementNullTest.php b/...s/Integration/Element/ElementNullTest.php → ...t/Integration/Element/ElementNullTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementNull;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementNullTest extends TestCase
 {

diff --git a/...ntegration/Element/ElementNumericTest.php → ...ntegration/Element/ElementNumericTest.php b/...ntegration/Element/ElementNumericTest.php → ...ntegration/Element/ElementNumericTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementNumeric;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementNumericTest extends TestCase
 {

diff --git a/...Integration/Element/ElementStringTest.php → ...Integration/Element/ElementStringTest.php b/...Integration/Element/ElementStringTest.php → ...Integration/Element/ElementStringTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementString;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementStringTest extends TestCase
 {

diff --git a/...Integration/Element/ElementStructTest.php → ...Integration/Element/ElementStructTest.php b/...Integration/Element/ElementStructTest.php → ...Integration/Element/ElementStructTest.php
@@ -33,11 +33,11 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementStruct;
 use Smalot\PdfParser\Header;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementStructTest extends TestCase
 {

diff --git a/...s/Integration/Element/ElementXRefTest.php → ...t/Integration/Element/ElementXRefTest.php b/...s/Integration/Element/ElementXRefTest.php → ...t/Integration/Element/ElementXRefTest.php
@@ -33,10 +33,10 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration\Element;
+namespace PHPUnitTests\Integration\Element;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element\ElementXRef;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementXRefTest extends TestCase
 {

diff --git a/tests/Integration/ElementTest.php → tests/PHPUnit/Integration/ElementTest.php b/tests/Integration/ElementTest.php → tests/PHPUnit/Integration/ElementTest.php
@@ -33,8 +33,9 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration;
+namespace PHPUnitTests\Integration;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Element;
 use Smalot\PdfParser\Element\ElementArray;
 use Smalot\PdfParser\Element\ElementBoolean;
@@ -45,7 +46,6 @@
 use Smalot\PdfParser\Element\ElementString;
 use Smalot\PdfParser\Element\ElementXRef;
 use Smalot\PdfParser\Header;
-use Tests\Smalot\PdfParser\TestCase;
 
 class ElementTest extends TestCase
 {

diff --git a/tests/Integration/EncodingTest.php → tests/PHPUnit/Integration/EncodingTest.php b/tests/Integration/EncodingTest.php → tests/PHPUnit/Integration/EncodingTest.php
@@ -33,16 +33,16 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration;
+namespace PHPUnitTests\Integration;
 
 use Exception;
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Document;
 use Smalot\PdfParser\Element;
 use Smalot\PdfParser\Encoding;
 use Smalot\PdfParser\Encoding\StandardEncoding;
 use Smalot\PdfParser\Exception\EncodingNotFoundException;
 use Smalot\PdfParser\Header;
-use Tests\Smalot\PdfParser\TestCase;
 
 class EncodingTest extends TestCase
 {

diff --git a/tests/Integration/FontTest.php → tests/PHPUnit/Integration/FontTest.php b/tests/Integration/FontTest.php → tests/PHPUnit/Integration/FontTest.php
@@ -33,16 +33,16 @@
  *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
  */
 
-namespace Tests\Smalot\PdfParser\Integration;
+namespace PHPUnitTests\Integration;
 
+use PHPUnitTests\TestCase;
 use Smalot\PdfParser\Config;
 use Smalot\PdfParser\Document;
 use Smalot\PdfParser\Element;
 use Smalot\PdfParser\Encoding;
 use Smalot\PdfParser\Font;
 use Smalot\PdfParser\Header;
 use Smalot\PdfParser\PDFObject;
-use Tests\Smalot\PdfParser\TestCase;
 
 class FontTest extends TestCase
 {