PHP 8.0, 8.1, PHPUnit 9 support + automated check for php compatibility

.changes/nextrelease/php8

@@ -0,0 +1,7 @@
+[
+    {
+        "type": "enhancement",
+        "category": "",
+        "description": "Add support for php 8.0 and 8.1"
+    }
+]

.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       #for each of the following versions of PHP, with and without --prefer-lowest
       matrix:
-        php-versions: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4']
+        php-versions: ['5.5', '5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
         composer-options: ['', '--prefer-lowest']
     #set the name for each job
     name: PHP ${{ matrix.php-versions }} ${{ matrix.composer-options }}
@@ -42,28 +42,32 @@ jobs:
     - name: Validate composer.json and composer.lock
       run: composer validate
 
-    #downgrade to supported php unit and remove incompatible xdebug file if it exists
+    #remove incompatible xdebug file if it exists
     - if: ${{ matrix.php-versions == '5.5' }}
-      name: PHP 5.5 specific setup
+      name: PHP 5.5
       run: |
         sudo rm -f /etc/php5/cli/conf.d/20-xdebug.ini
-        composer require --dev --ignore-platform-reqs phpunit/phpunit "4.8.36"
-
-    #downgrade to supported php unit
-    - if: ${{ matrix.php-versions <= '7.1'  && matrix.php-versions > 5.5}}
-      name: PHP 5.6-7.1 specific setup
-      run: composer require --dev --ignore-platform-reqs phpunit/phpunit "^5.7.11"
 
     #get dependencies
     - name: Install dependencies
       run: composer update ${{ matrix.composer-options }} --no-interaction --prefer-source
 
+    #php 8.x requirements
+    - if: ${{ matrix.php-versions >= '8.0' && matrix.composer-options != '' }}
+      name: PHP 8.x
+      run: composer require --dev phpunit/phpunit "^9.5" --no-interaction --prefer-source --with-all-dependencies
+
+    #php 8.1 requirements
+    - if: ${{ matrix.php-versions >= '8.1' && matrix.composer-options != '' }}
+      name: PHP 8.1
+      run: composer require --dev guzzlehttp/guzzle "^7.3" --no-interaction --prefer-source --with-all-dependencies
+
     #run tests
     - name: Run test suite
       run: make test
 
     #static analysis
-    - if: ${{ matrix.php-versions >= '7.1' && matrix.php-versions <= 7.4 && matrix.composer-options == '' }}
+    - if: ${{ matrix.php-versions >= '7.1' && matrix.php-versions < '8.0' && matrix.composer-options == '' }}
       name: Static analysis
       run: |
         composer require --dev nette/neon "^3.0"
@@ -79,6 +83,6 @@ jobs:
         make package
 
     #generate code coverage
-    - if: ${{ matrix.php-versions == '7.1' && matrix.composer-options == '' }}
+    - if: ${{ (matrix.php-versions == '7.1' || matrix.php-versions == '8.0') && matrix.composer-options == '' }}
       name: Code coverage
       run: bash <(curl -s https://codecov.io/bash)

.gitignore

@@ -8,6 +8,7 @@ test_services.json
 /Makefile
 .idea
 .php_cs.cache
+.phpunit.result.cache
 atlassian-ide-plugin.xml
 aws-sdk-php.iml
 .DS_Store

composer.json

@@ -32,7 +32,7 @@
         "ext-dom": "*",
         "ext-pcntl": "*",
         "ext-sockets": "*",
-        "phpunit/phpunit": "^4.8.35 || ^5.6.3",
+        "phpunit/phpunit": "^4.8.35 || ^5.6.3 || ^9.5",
         "behat/behat": "~3.0",
         "doctrine/cache": "~1.4",
         "aws/aws-php-sns-message-validator": "~1.0",
@@ -41,7 +41,9 @@
         "psr/cache": "^1.0",
         "psr/simple-cache": "^1.0",
         "paragonie/random_compat": ">= 2",
-        "sebastian/comparator": "^1.2.3"
+        "sebastian/comparator": "^1.2.3 || ^4.0",
+        "yoast/phpunit-polyfills": "^1.0",
+        "dms/phpunit-arraysubset-asserts": "^0.4.0"
     },
     "suggest": {
         "ext-openssl": "Allows working with CloudFront private distributions and verifying received SNS messages",

phpunit.xml.dist

@@ -1,33 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="./tests/bootstrap.php"
-         colors="true">
-
-    <php>
-        <!-- Specify the path to your CloudFront private key -->
-        <server name="CF_PRIVATE_KEY" value="changeme" />
-        <!-- Specify the CloudFront key pair ID to use when testing -->
-        <server name="CF_KEY_PAIR_ID" value="change_me" />
-    </php>
-
-    <testsuites>
-        <testsuite name="unit">
-            <directory suffix="Test.php">tests/</directory>
-            <exclude>tests/Integ</exclude>
-        </testsuite>
-        <testsuite name="integ">
-            <directory suffix="Test.php">tests/Integ</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src</directory>
-            <exclude>
-                <directory>src/data</directory>
-            </exclude>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="coverage-clover" target="clover.xml"/>
-    </logging>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./tests/bootstrap.php" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+    <exclude>
+      <directory>src/data</directory>
+    </exclude>
+    <report>
+      <clover outputFile="clover.xml"/>
+    </report>
+  </coverage>
+  <testsuites>
+    <testsuite name="unit">
+      <directory suffix="Test.php">tests/</directory>
+      <exclude>tests/Integ</exclude>
+    </testsuite>
+    <testsuite name="integ">
+      <directory suffix="Test.php">tests/Integ</directory>
+    </testsuite>
+  </testsuites>
+  <logging/>
 </phpunit>

src/Api/Parser/AbstractRestParser.php

@@ -160,7 +160,7 @@ private function extractHeaders(
         // Check if the headers are prefixed by a location name
         $result[$name] = [];
         $prefix = $shape['locationName'];
-        $prefixLen = strlen($prefix);
+        $prefixLen = $prefix !== null ? strlen($prefix) : 0;
 
         foreach ($response->getHeaders() as $k => $values) {
             if (!$prefixLen) {

src/Api/Serializer/JsonBody.php

@@ -28,8 +28,17 @@ public function __construct(Service $api)
      */
     public static function getContentType(Service $service)
     {
-        return 'application/x-amz-json-'
-            . number_format($service->getMetadata('jsonVersion'), 1);
+        if ($service->getMetadata('protocol') === 'rest-json') {
+            return 'application/json';
+        }
+
+        $jsonVersion = $service->getMetadata('jsonVersion');
+        if (empty($jsonVersion)) {
+            throw new \InvalidArgumentException('invalid json');
+        } else {
+            return 'application/x-amz-json-'
+                . @number_format($service->getMetadata('jsonVersion'), 1);
+        }
     }
 
     /**

src/Api/Serializer/RestJsonSerializer.php

@@ -27,7 +27,7 @@ public function __construct(
         JsonBody $jsonFormatter = null
     ) {
         parent::__construct($api, $endpoint);
-        $this->contentType = 'application/json';
+        $this->contentType = JsonBody::getContentType($api);
         $this->jsonFormatter = $jsonFormatter ?: new JsonBody($api);
     }
 

src/Arn/ArnParser.php

@@ -23,7 +23,7 @@ class ArnParser
      */
     public static function isArn($string)
     {
-        return strpos($string, 'arn:') === 0;
+        return $string !== null && strpos($string, 'arn:') === 0;
     }
 
     /**

src/CloudFront/Signer.php

@@ -34,11 +34,15 @@ public function __construct($keyPairId, $privateKey, $passphrase = "")
         if (!$this->pkHandle = openssl_pkey_get_private($privateKey, $passphrase)) {
             if (!file_exists($privateKey)) {
                 throw new \InvalidArgumentException("PK file not found: $privateKey");
-            } else {
-                $this->pkHandle = openssl_pkey_get_private("file://$privateKey", $passphrase);
-                if (!$this->pkHandle) {
-                    throw new \InvalidArgumentException(openssl_error_string());
+            }
+
+            $this->pkHandle = openssl_pkey_get_private("file://$privateKey", $passphrase);
+            if (!$this->pkHandle) {
+                $errorMessages = [];
+                while(($newMessage = openssl_error_string()) !== false){
+                    $errorMessages[] = $newMessage;
                 }
+                throw new \InvalidArgumentException(implode("\n",$errorMessages));
             }
         }
     }

src/MockHandler.php

@@ -37,7 +37,7 @@ public function __construct(
         $this->onRejected = $onRejected;
 
         if ($resultOrQueue) {
-            call_user_func_array([$this, 'append'], $resultOrQueue);
+            call_user_func_array([$this, 'append'], array_values($resultOrQueue));
         }
     }
 

src/S3/S3Client.php

@@ -429,6 +429,9 @@ public function __construct(array $args)
      */
     public static function isBucketDnsCompatible($bucket)
     {
+        if (!is_string($bucket)) {
+            return false;
+        }
         $bucketLen = strlen($bucket);
 
         return ($bucketLen >= 3 && $bucketLen <= 63) &&

tests/AbstractConfigurationProviderTest.php

@@ -6,7 +6,7 @@
 use Aws\Result;
 use Aws\ResultInterface;
 use GuzzleHttp\Promise;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * @covers \Aws\AbstractConfigurationProvider
@@ -65,11 +65,9 @@ public function testChainsConfiguration()
         $this->assertSame($expected, $result);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testChainThrowsExceptionOnEmptyArgs()
     {
+        $this->expectException(\InvalidArgumentException::class);
         call_user_func([$this->provider, 'chain']);
     }
 

tests/Api/ApiProviderTest.php

@@ -3,7 +3,7 @@
 
 use Aws\Api\ApiProvider;
 use Aws\Exception\UnresolvedApiException;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * @covers Aws\Api\ApiProvider
@@ -30,7 +30,7 @@ public function testCanResolveProvider()
         $this->assertEquals($result, ApiProvider::resolve($p, 't', 's', 'v'));
 
         $p = function ($a, $b, $c) {return null;};
-        $this->setExpectedException(UnresolvedApiException::class);
+        $this->expectException(UnresolvedApiException::class);
         ApiProvider::resolve($p, 't', 's', 'v');
     }
 
@@ -53,7 +53,7 @@ public function testCanGetServiceVersions()
     public function testCanGetDefaultProvider()
     {
         $p = ApiProvider::defaultProvider();
-        $this->assertArrayHasKey('s3', $this->readAttribute($p, 'manifest'));
+        $this->assertArrayHasKey('s3', $this->getPropertyValue($p, 'manifest'));
     }
 
     public function testManifestProviderReturnsNullForMissingService()
@@ -66,15 +66,13 @@ public function testManifestProviderCanLoadData()
     {
         $p = $this->getTestApiProvider();
         $data = $p('api', 'dynamodb', 'latest');
-        $this->assertInternalType('array', $data);
+        $this->assertIsArray($data);
         $this->assertArrayHasKey('foo', $data);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
     public function testFilesystemProviderEnsuresDirectoryIsValid()
     {
+        $this->expectException(\InvalidArgumentException::class);
         ApiProvider::filesystem('/path/to/invalid/dir');
     }
 
@@ -116,21 +114,21 @@ public function testReturnsWaiterConfigsForLatestCompatibleVersion()
 
     public function testThrowsOnBadType()
     {
-        $this->setExpectedException(UnresolvedApiException::class);
+        $this->expectException(UnresolvedApiException::class);
         $p = $this->getTestApiProvider();
         ApiProvider::resolve($p, 'foo', 's3', 'latest');
     }
 
     public function testThrowsOnBadService()
     {
-        $this->setExpectedException(UnresolvedApiException::class);
+        $this->expectException(UnresolvedApiException::class);
         $p = $this->getTestApiProvider();
         ApiProvider::resolve($p, 'api', '', 'latest');
     }
 
     public function testThrowsOnBadVersion()
     {
-        $this->setExpectedException(UnresolvedApiException::class);
+        $this->expectException(UnresolvedApiException::class);
         $p = $this->getTestApiProvider();
         ApiProvider::resolve($p, 'api', 'dynamodb', 'derp');
     }

tests/Api/ErrorParser/XmlErrorParserTest.php

@@ -3,14 +3,16 @@
 
 use Aws\Api\ErrorParser\XmlErrorParser;
 use Aws\Test\TestServiceTrait;
+use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
 use GuzzleHttp\Psr7;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * @covers Aws\Api\ErrorParser\XmlErrorParser
  */
 class XmlErrorParserTest extends TestCase
 {
+    use ArraySubsetAsserts;
     use TestServiceTrait;
 
     /**

tests/Api/ListShapeTest.php

@@ -3,7 +3,7 @@
 
 use Aws\Api\ShapeMap;
 use Aws\Api\ListShape;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * @covers \Aws\Api\ListShape
@@ -23,11 +23,9 @@ public function testReturnsMember()
         $this->assertSame('string', $m->getType());
     }
 
-    /**
-     * @expectedException \RuntimeException
-     */
     public function testFailsWhenMemberIsMissing()
     {
+        $this->expectException(\RuntimeException::class);
         (new ListShape([], new ShapeMap([])))->getMember();
     }
 }

tests/Api/MapShapeTest.php

@@ -3,7 +3,7 @@
 
 use Aws\Api\ShapeMap;
 use Aws\Api\MapShape;
-use PHPUnit\Framework\TestCase;
+use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * @covers \Aws\Api\MapShape
@@ -19,11 +19,9 @@ public function testReturnsValue()
         $this->assertSame($v, $s->getValue());
     }
 
-    /**
-     * @expectedException \RuntimeException
-     */
     public function testFailsWhenValueIsMissing()
     {
+        $this->expectException(\RuntimeException::class);
         (new MapShape([], new ShapeMap([])))->getValue();
     }