PhpUnit 10 Compatibility Part 3 (Last) (#3530)

* PhpUnit 10 Compatibility Part 3 (Last)

Final changes for PhpUnit 10, including enabling it for testing. This finishes the work of PR #3523 and PR #3526.

The major remaining problem with PhpUnit 10 is that earlier releases converted notices and warnings to exceptions, and 10 does not. Not having the information provided by the messages seems risky to me. Fortunately, it appears that you can add an error handler to the test bootstrap for 10 and make it act like earlier versions; I have done so. In order to demonstrate the effectiveness of this handler, a new otherwise unused class Helper/Handler and tests for that class are added.

As part of the testing of this change, it became apparent that the fopen in OLE::getStream attempts to create a dynamic property $context in Shared/OLE/ChainedBlockStream, and that action is deprecated in Php8.2. Adding the property to the class eliminates that problem. No executable code is added, and this is the only change to source code.

There also seems to have been a change in assertXmlStringEqualsXmlString in PhpUnit 10. The only test which uses that method is Chart/Issue589Test, and both the places which use that method could just as easily and effectively use assertSame. They are changed to do so.

* Remove Phpunit Verbose Option

Not supported in PhpUnit 10. I'm not at all sure that this is the correct solution for this problem.

* Try Changing Phpunit Command for Different Php Releases

Not sure how to test this locally. We'll see if it works on github.

* Another main.yml attempt

We shall see.

* Eliminate One Test

Not sure why testDeprecated is not working in Github; it works locally. Disable it for now and continue to research.

* Show Incomplete and Other Messages in PhpUnit 10

6 new command line args to replace the 1 they got rid of.

* Restore Disabled Test

Deprecated messages are suppressed by default setting for error_reporting. Switch that to E_ALL in bootstrap and restore original test.

* Add Deprecation Tests for PhpUnit 9-

Default configuration option caused deprecation messages to be suppressed. Change the option.

.github/workflows/main.yml

@@ -57,11 +57,18 @@ jobs:
       - name: Setup problem matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-      - name: "Run PHPUnit tests (Experimental: ${{ matrix.experimental }})"
+      - name: "Run PHPUnit tests 1 (Experimental: ${{ matrix.experimental }})"
         env:
           FAILURE_ACTION: "${{ matrix.experimental == true }}"
+        if: ${{ matrix.php-version == '7.4' || matrix.php-version == '8.0' }}
         run: vendor/bin/phpunit --verbose || $FAILURE_ACTION
 
+      - name: "Run PHPUnit tests 2 (Experimental: ${{ matrix.experimental }})"
+        env:
+          FAILURE_ACTION: "${{ matrix.experimental == true }}"
+        if: ${{ matrix.php-version == '8.1' || matrix.php-version == '8.2' || matrix.php-version == 'nightly' }}
+        run: vendor/bin/phpunit -c phpunit10.xml.dist --display-incomplete --display-skipped --display-deprecations --display-errors --display-notices --display-warnings || $FAILURE_ACTION
+
   php-cs-fixer:
     runs-on: ubuntu-latest
     steps:

composer.json

@@ -92,7 +92,7 @@
         "phpcompatibility/php-compatibility": "^9.3",
         "phpstan/phpstan": "^1.1",
         "phpstan/phpstan-phpunit": "^1.0",
-        "phpunit/phpunit": "^8.5 || ^9.0",
+        "phpunit/phpunit": "^8.5 || ^9.0 || ^10.0",
         "squizlabs/php_codesniffer": "^3.7",
         "tecnickcom/tcpdf": "^6.5"
     },

phpunit.xml.dist

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="./tests/bootstrap.php" backupGlobals="true" colors="true" cacheResultFile="/tmp/.phpspreadsheet.phpunit.result.cache">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="./tests/bootstrap.php" backupGlobals="true" colors="true" cacheResultFile="/tmp/.phpspreadsheet.phpunit.result.cache" convertDeprecationsToExceptions="true">
   <coverage>
     <include>
       <directory suffix=".php">./src</directory>
@@ -7,6 +7,7 @@
   </coverage>
   <php>
     <ini name="memory_limit" value="2048M"/>
+    <ini name="error_reporting" value="E_ALL"/>
   </php>
   <testsuite name="PhpSpreadsheet Unit Test Suite">
     <directory>./tests/PhpSpreadsheetTests</directory>

phpunit10.xml.dist

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" bootstrap="./tests/bootstrap.php" backupGlobals="true" colors="true" cacheResultFile="/tmp/.phpspreadsheet.phpunit.result.cache">
+  <coverage/>
+  <php>
+    <ini name="memory_limit" value="2048M"/>
+  </php>
+  <testsuite name="PhpSpreadsheet Unit Test Suite">
+    <directory>./tests/PhpSpreadsheetTests</directory>
+  </testsuite>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
+</phpunit>

src/PhpSpreadsheet/Helper/Handler.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheet\Helper;
+
+class Handler
+{
+    /** @var string */
+    private static $invalidHex = 'Y';
+
+    // A bunch of methods to show that we continue
+    // to capture messages even using PhpUnit 10.
+    public static function suppressed(): bool
+    {
+        return @trigger_error('hello');
+    }
+
+    public static function deprecated(): string
+    {
+        return (string) hexdec(self::$invalidHex);
+    }
+
+    public static function notice(string $value): void
+    {
+        date_default_timezone_set($value);
+    }
+
+    public static function warning(): bool
+    {
+        return file_get_contents(__FILE__ . 'noexist') !== false;
+    }
+
+    public static function userDeprecated(): bool
+    {
+        return trigger_error('hello', E_USER_DEPRECATED);
+    }
+
+    public static function userNotice(): bool
+    {
+        return trigger_error('userNotice', E_USER_NOTICE);
+    }
+
+    public static function userWarning(): bool
+    {
+        return trigger_error('userWarning', E_USER_WARNING);
+    }
+}

src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php

@@ -6,6 +6,9 @@ use PhpOffice\PhpSpreadsheet\Shared\OLE;
 
 class ChainedBlockStream
 {
+    /** @var mixed */
+    public $context;
+
     /**
      * The OLE container of the file that is being read.
      *

tests/PhpSpreadsheetTests/Chart/Issue589Test.php

@@ -108,7 +108,7 @@ class Issue589Test extends TestCase
                     if ($actualXml === false) {
                         self::fail('Failure saving the spPr element as xml string!');
                     } else {
-                        self::assertXmlStringEqualsXmlString('<c:spPr><a:ln><a:solidFill><a:srgbClr val="98B954"/></a:solidFill></a:ln></c:spPr>', $actualXml);
+                        self::assertSame('<c:spPr><a:ln><a:solidFill><a:srgbClr val="98B954"/></a:solidFill></a:ln></c:spPr>', $actualXml);
                     }
                 }
             }
@@ -153,7 +153,7 @@ class Issue589Test extends TestCase
                     if ($actualXml === false) {
                         self::fail('Failure saving the spPr element as xml string!');
                     } else {
-                        self::assertXmlStringEqualsXmlString('<c:spPr><a:ln/></c:spPr>', $actualXml);
+                        self::assertSame('<c:spPr><a:ln/></c:spPr>', $actualXml);
                     }
                 }
             }

tests/PhpSpreadsheetTests/Helper/HandlerTest.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Helper;
+
+use PhpOffice\PhpSpreadsheet\Helper\Handler;
+use PHPUnit\Framework\TestCase;
+use Throwable;
+
+class HandlerTest extends TestCase
+{
+    public function testSuppressed(): void
+    {
+        self::assertTrue(Handler::suppressed());
+    }
+
+    public function testDeprecated(): void
+    {
+        try {
+            Handler::deprecated();
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('Invalid characters', $e->getMessage());
+        }
+    }
+
+    public function testNotice(): void
+    {
+        try {
+            Handler::notice('invalidtz');
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('Timezone', $e->getMessage());
+        }
+    }
+
+    public function testWarning(): void
+    {
+        try {
+            Handler::warning();
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('ailed to open stream', $e->getMessage());
+        }
+    }
+
+    public function testUserDeprecated(): void
+    {
+        try {
+            Handler::userDeprecated();
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('hello', $e->getMessage());
+        }
+    }
+
+    public function testUserNotice(): void
+    {
+        try {
+            Handler::userNotice();
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('userNotice', $e->getMessage());
+        }
+    }
+
+    public function testUserWarning(): void
+    {
+        try {
+            Handler::userWarning();
+            self::fail('Expected error/exception did not happen');
+        } catch (Throwable $e) {
+            self::assertStringContainsString('userWarning', $e->getMessage());
+        }
+    }
+}

tests/bootstrap.php

@@ -4,3 +4,35 @@ setlocale(LC_ALL, 'en_US.utf8');
 
 // PHP 5.3 Compat
 //date_default_timezone_set('Europe/London');
+
+function phpunit10ErrorHandler(int $errno, string $errstr, string $filename, int $lineno): bool
+{
+    $x = error_reporting() & $errno;
+    if (
+        in_array(
+            $errno,
+            [
+                E_DEPRECATED,
+                E_WARNING,
+                E_NOTICE,
+                E_USER_DEPRECATED,
+                E_USER_NOTICE,
+                E_USER_WARNING,
+            ],
+            true
+        )
+    ) {
+        if (0 === $x) {
+            return true; // message suppressed - stop error handling
+        }
+
+        throw new \Exception("$errstr $filename $lineno");
+    }
+
+    return false; // continue error handling
+}
+
+if (!method_exists(\PHPUnit\Framework\TestCase::class, 'setOutputCallback')) {
+    ini_set('error_reporting', E_ALL);
+    set_error_handler('phpunit10ErrorHandler');
+}