Add PHP 8.2 support and PHPUnit 10 (#319)

* allow running tests via composer script * Update all dev-dependencies * fix covers warnings * set all dataProvider as static * Improve github Actions, update services, add tests with PHP 8.2 * Run tests with phpunit 10.2, replace deprecated withConsecutive() * catch and tests warnings thrown by SimpleXMLElement * Create composer command to create HTML code-coverage report * Update CHANGELOG.md
kbsali · Sep 14, 2023 · 006e065 · 006e065
1 parent a2e59e7
commit 006e065
Show file tree

Hide file tree

Showing 18 changed files with 158 additions and 208 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,11 +14,11 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: ['ubuntu-latest']
-        php-versions: ['7.4', '8.0', '8.1']
+        php-versions: ['7.4', '8.0', '8.1', '8.2']
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
@@ -32,21 +32,10 @@ jobs:
           extensions: mbstring, xml, ctype, iconv, intl, pdo_sqlite
           coverage: xdebug
 
-      - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
-
-      - name: Cache composer dependencies
-        uses: actions/cache@v3
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          # Use composer.json for key, if composer.lock is not committed.
-          # key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: ${{ runner.os }}-composer-
-
-      - name: Install Composer dependencies
-        run: composer install --no-progress --prefer-dist --optimize-autoloader
+      # Install composer dependencies and handle caching in one go.
+      # @link https://github.com/marketplace/actions/install-composer-dependencies
+      - name: "Install Composer dependencies"
+        uses: "ramsey/composer-install@v2"
 
       - name: Run tests
         run: vendor/bin/phpunit --coverage-text

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 .php-cs-fixer.cache
-.phpunit.result.cache
+.phpunit.cache
 composer.lock
 composer.phar
-coverage.clover
 phpunit.xml
 vendor
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/kbsali/php-redmine-api/compare/v2.2.0...v2.x)
 
+### Added
+
+- Added support for PHP 8.2
+
 ### Deprecated
 
 - `Redmine\Api\AbstractApi::attachCustomFieldXML()` is deprecated
@@ -37,6 +41,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Added support for PHP 8.1
 - New interface `Redmine\Exception` that is implemented by every library-related exception
 - New exception `Redmine\Exception\ClientException` for client related exceptions
 - New exception `Redmine\Exception\InvalidApiNameException` if an invalid API instance is requested

diff --git a/composer.json b/composer.json
@@ -24,10 +24,10 @@
         "psr/http-factory": "^1.0"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "3.11.0",
-        "phpunit/phpunit": "9.5.10",
-        "guzzlehttp/psr7": "2.1.0",
-        "php-mock/php-mock-phpunit": "2.6.0"
+        "friendsofphp/php-cs-fixer": "^3",
+        "phpunit/phpunit": "^9 || 10.2.*",
+        "guzzlehttp/psr7": "^2",
+        "php-mock/php-mock-phpunit": "^2.6"
     },
     "autoload": {
         "psr-4": {
@@ -38,5 +38,9 @@
         "psr-4": {
             "Redmine\\Tests\\": "tests/"
         }
+    },
+    "scripts": {
+        "coverage": "phpunit --coverage-html=\".phpunit.cache/code-coverage\"",
+        "test": "phpunit"
     }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,13 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" bootstrap="vendor/autoload.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory suffix=".php">src/Redmine/</directory>
-    </include>
-    <report>
-      <clover outputFile="coverage.clover"/>
-    </report>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheDirectory=".phpunit.cache"
+         colors="true"
+         beStrictAboutCoverageMetadata="false"
+         beStrictAboutOutputDuringTests="true"
+         displayDetailsOnIncompleteTests="true"
+         displayDetailsOnSkippedTests="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+>
+  <coverage />
   <testsuites>
     <testsuite name="all">
       <directory suffix="Test.php">tests/Unit/</directory>
@@ -20,4 +26,9 @@
     </exclude>
   </groups>
   <logging/>
+  <source>
+    <include>
+      <directory suffix=".php">src/Redmine/</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/src/Redmine/Serializer/XmlSerializer.php b/src/Redmine/Serializer/XmlSerializer.php
@@ -2,6 +2,7 @@
 
 namespace Redmine\Serializer;
 
+use JsonException;
 use Redmine\Exception\SerializerException;
 use SimpleXMLElement;
 use Throwable;
@@ -64,14 +65,26 @@ private function deserialize(string $encoded): void
     {
         $this->encoded = $encoded;
 
+        $prevSetting = libxml_use_internal_errors(true);
+
         try {
             $this->deserialized = new SimpleXMLElement($encoded);
         } catch (Throwable $e) {
+            $errors = [];
+
+            foreach (libxml_get_errors() as $error) {
+                $errors[] = $error->message;
+            }
+
+            libxml_clear_errors();
+
             throw new SerializerException(
-                'Catched error "' . $e->getMessage() . '" while decoding XML: ' . $encoded,
+                'Catched errors: "' . implode('", "', $errors) . '" while decoding XML: ' . $encoded,
                 $e->getCode(),
                 $e
             );
+        } finally {
+            libxml_use_internal_errors($prevSetting);
         }
 
         $this->normalize($this->deserialized);
@@ -94,14 +107,26 @@ private function denormalize(array $normalized): void
 
         $rootElementName = array_key_first($this->normalized);
 
+        $prevSetting = libxml_use_internal_errors(true);
+
         try {
             $this->deserialized = $this->createXmlElement($rootElementName, $this->normalized[$rootElementName]);
         } catch (Throwable $e) {
+            $errors = [];
+
+            foreach (libxml_get_errors() as $error) {
+                $errors[] = $error->message;
+            }
+
+            libxml_clear_errors();
+
             throw new SerializerException(
-                'Could not create XML from array: ' . $e->getMessage(),
+                'Could not create XML from array: "' . implode('", "', $errors) . '"',
                 $e->getCode(),
                 $e
             );
+        } finally {
+            libxml_use_internal_errors($prevSetting);
         }
 
         $this->encoded = $this->deserialized->asXml();

diff --git a/tests/Integration/Psr18ClientRequestGenerationTest.php b/tests/Integration/Psr18ClientRequestGenerationTest.php
@@ -107,7 +107,7 @@ public function createStreamFromResource($resource): StreamInterface
         $client->$method($path, $data);
     }
 
-    public function createdGetRequestsData()
+    public static function createdGetRequestsData(): array
     {
         return [
             [

diff --git a/tests/Unit/Api/AbstractApiTest.php b/tests/Unit/Api/AbstractApiTest.php
@@ -30,7 +30,7 @@ public function testIsNotNullReturnsCorrectBoolean(bool $expected, $value)
         $this->assertSame($expected, $method->invoke($api, $value));
     }
 
-    public function getIsNotNullReturnsCorrectBooleanData()
+    public static function getIsNotNullReturnsCorrectBooleanData(): array
     {
         return [
             [false, null],
@@ -67,7 +67,7 @@ public function testLastCallFailedReturnsCorrectBoolean($statusCode, $expectedBo
         $this->assertSame($expectedBoolean, $api->lastCallFailed());
     }
 
-    public function getLastCallFailedData()
+    public static function getLastCallFailedData(): array
     {
         return [
             [100, true],
@@ -161,7 +161,7 @@ public function testJsonDecodingFromGetMethod($response, $decode, $expected)
         }
     }
 
-    public function getJsonDecodingFromGetMethodData()
+    public static function getJsonDecodingFromGetMethodData(): array
     {
         return [
             ['{"foo_bar": 12345}', null, ['foo_bar' => 12345]], // test decode by default
@@ -217,7 +217,7 @@ public function testXmlDecodingFromRequestMethods($methodName, $response, $decod
         }
     }
 
-    public function getXmlDecodingFromGetMethodData()
+    public static function getXmlDecodingFromGetMethodData(): array
     {
         return [
             ['get', '<?xml version="1.0"?><issue/>', null, '<?xml version="1.0"?><issue/>'], // test decode by default

diff --git a/tests/Unit/Api/AttachmentTest.php b/tests/Unit/Api/AttachmentTest.php
@@ -44,7 +44,7 @@ public function testLastCallFailedTrue($responseCode, $hasFailed)
      *
      * @return array[]
      */
-    public function responseCodeProvider()
+    public static function responseCodeProvider(): array
     {
         return [
             [199, true],

diff --git a/tests/Unit/Api/IssueTest.php b/tests/Unit/Api/IssueTest.php
@@ -13,7 +13,7 @@
  */
 class IssueTest extends TestCase
 {
-    public function getPriorityConstantsData()
+    public static function getPriorityConstantsData(): array
     {
         return [
             [1, Issue::PRIO_LOW],
@@ -475,7 +475,6 @@ public function testCreateCleansParameters()
      * Test create() and buildXML().
      *
      * @covers ::create
-     * @covers ::buildXML
      * @covers ::attachCustomFieldXML
      * @test
      */
@@ -719,7 +718,6 @@ public function testAddNoteToIssue()
     /**
      * Test buildXML().
      *
-     * @covers ::buildXML
      * @test
      */
     public function testBuildXmlWithCustomFields()
@@ -760,7 +758,6 @@ public function testBuildXmlWithCustomFields()
     /**
      * Test buildXML().
      *
-     * @covers ::buildXML
      * @test
      */
     public function testBuildXmlWithWatchers()
@@ -796,7 +793,6 @@ public function testBuildXmlWithWatchers()
     /**
      * Test buildXML().
      *
-     * @covers ::buildXML
      * @test
      */
     public function testBuildXmlWithUploads()
@@ -857,7 +853,6 @@ public function testBuildXmlWithUploads()
     /**
      * Test buildXML().
      *
-     * @covers ::buildXML
      * @test
      */
     public function testBuildXmlWithWatcherAndUploadAndCustomFieldAndStandard()

diff --git a/tests/Unit/Api/MembershipTest.php b/tests/Unit/Api/MembershipTest.php
@@ -220,7 +220,6 @@ public function testCreateCallsPost()
      * Test create().
      *
      * @covers ::create
-     * @covers ::buildXML
      * @test
      */
     public function testCreateBuildsXml()

diff --git a/tests/Unit/Api/UserTest.php b/tests/Unit/Api/UserTest.php
@@ -323,7 +323,7 @@ public function testCreateThrowsExceptionIfValueIsMissingInParameters($parameter
      *
      * @return array[]
      */
-    public function incompleteCreateParameterProvider()
+    public static function incompleteCreateParameterProvider(): array
     {
         return [
             // Missing Login

diff --git a/tests/Unit/Api/VersionTest.php b/tests/Unit/Api/VersionTest.php
@@ -909,7 +909,7 @@ public function testUpdateThrowsExceptionWithInvalidSharing($sharingValue)
      *
      * @return array[]
      */
-    public function validSharingProvider()
+    public static function validSharingProvider(): array
     {
         return [
             ['none', '<sharing>none</sharing>'],
@@ -925,7 +925,7 @@ public function validSharingProvider()
      *
      * @return array[]
      */
-    public function validEmptySharingProvider()
+    public static function validEmptySharingProvider(): array
     {
         return [
             [null],
@@ -939,7 +939,7 @@ public function validEmptySharingProvider()
      *
      * @return array[]
      */
-    public function invalidSharingProvider()
+    public static function invalidSharingProvider(): array
     {
         return [
             ['all'],