chore: phpunit 10 support (#3242)

Author: yenfryherrerafeliz

.changes/nextrelease/chore-phpunit-10-support.json

@@ -0,0 +1,7 @@
+[
+    {
+        "type": "enhancement",
+        "category": "",
+        "description": "Add support for PHPUnit v10. \n- Make data provider static functions. \n- Use class attributes instead of annotations for @dataProvider, @covers, and @doesNotPerformAssertions. \n- Remove/Replace the usage of expectDeprecation, expectDeprecationMessage, expectDeprecationMessageMatches, expectError, expectErrorMessage, expectNotice, expectNoticeMessage, expectWarning, and expectWarningMessage. \n- Migrate phpunit xml config file."
+    }
+]

.github/workflows/tests.yml

@@ -71,7 +71,7 @@ jobs:
               composer update ${{ matrix.composer-options }} --no-interaction --prefer-dist --with-all-dependencies
               composer update psr/http-message guzzlehttp/psr7 guzzlehttp/guzzle --with-all-dependencies --no-interaction
               if [[ "${{ matrix.php-versions }}" == "8.4" ]]; then
-                composer update phpunit/phpunit:^9.6.18 --with-all-dependencies --no-interaction
+                composer update phpunit/phpunit:^10.0 --with-all-dependencies --no-interaction
               fi
             else
               composer update ${{ matrix.composer-options }} --no-interaction --prefer-dist --with-all-dependencies

Makefile

@@ -24,8 +24,12 @@ clear-cache:
 	php build/aws-clear-cache.php
 
 test:
-	@AWS_ACCESS_KEY_ID=foo AWS_SECRET_ACCESS_KEY=bar AWS_SESSION_TOKEN= AWS_CSM_ENABLED=false AWS_REGION= AWS_ENDPOINT_URL= AWS_SUPPRESS_PHP_DEPRECATION_WARNING=true \
-	vendor/bin/phpunit --testsuite=unit $(TEST)
+	AWS_ACCESS_KEY_ID=foo AWS_SECRET_ACCESS_KEY=bar AWS_SESSION_TOKEN= \
+	AWS_CSM_ENABLED=false \
+	AWS_REGION= \
+	AWS_ENDPOINT_URL= \
+	AWS_SUPPRESS_PHP_DEPRECATION_WARNING=true \
+	vendor/bin/phpunit --no-coverage --testsuite=unit $(TEST)
 
 test-phar: package
 	[ -f build/artifacts/behat.phar ] || (cd build/artifacts && \

composer.json

@@ -33,7 +33,7 @@
         "ext-openssl": "*",
         "ext-dom": "*",
         "ext-sockets": "*",
-        "phpunit/phpunit": "^9.6",
+        "phpunit/phpunit": "^10.0",
         "behat/behat": "~3.0",
         "doctrine/cache": "~1.4",
         "aws/aws-php-sns-message-validator": "~1.0",
@@ -42,7 +42,7 @@
         "psr/simple-cache": "^2.0 || ^3.0",
         "sebastian/comparator": "^1.2.3 || ^4.0 || ^5.0",
         "yoast/phpunit-polyfills": "^2.0",
-        "dms/phpunit-arraysubset-asserts": "^0.4.0"
+        "dms/phpunit-arraysubset-asserts": "^v0.5.0"
     },
     "suggest": {
         "ext-openssl": "Allows working with CloudFront private distributions and verifying received SNS messages",

features/bootstrap/Aws/Test/Integ/BatchingContext.php

@@ -9,15 +9,11 @@
 use Aws\Sqs\SqsClient;
 use Behat\Behat\Hook\Scope\AfterFeatureScope;
 use Behat\Behat\Hook\Scope\BeforeFeatureScope;
-use Behat\Behat\Tester\Exception\PendingException;
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\SnippetAcceptingContext;
-use Behat\Gherkin\Node\PyStringNode;
-use Behat\Gherkin\Node\TableNode;
 use PHPUnit\Framework\Assert;
-use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
-class BatchingContext extends TestCase implements
+class BatchingContext implements
     Context,
     SnippetAcceptingContext
 {
@@ -163,15 +159,15 @@ public function itemsShouldHaveBeenWritten($itemCount)
             'TableName' => self::$resource,
         ]);
 
-        $this->assertSame((int) $itemCount, iterator_count($actualItems));
+        Assert::assertSame((int) $itemCount, iterator_count($actualItems));
     }
 
     /**
      * @Then /^the batch should have been flushed at least (\d+) times$/
      */
     public function theBatchShouldHaveBeenFlushedTimes($flushCount)
     {
-        $this->assertGreaterThanOrEqual((int) $flushCount, $this->flushCount);
+        Assert::assertGreaterThanOrEqual((int) $flushCount, $this->flushCount);
     }
 
     /**
@@ -230,6 +226,6 @@ public function messagesShouldHaveBeenDeletedFromTheQueue($messageCount)
             ? count($this->response['Successful'])
             : 0;
 
-        $this->assertSame((int) $messageCount, $failedCount + $successfulCount);
+        Assert::assertSame((int) $messageCount, $failedCount + $successfulCount);
     }
 }

features/bootstrap/Aws/Test/Integ/BlockingContext.php

@@ -4,20 +4,15 @@
 
 use Aws\AwsClient;
 use Aws\DynamoDb\Exception\DynamoDbException;
-use Behat\Behat\Hook\Scope\AfterFeatureScope;
-use Behat\Behat\Tester\Exception\PendingException;
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\SnippetAcceptingContext;
-use Behat\Gherkin\Node\PyStringNode;
-use Behat\Gherkin\Node\TableNode;
 use GuzzleHttp\Promise;
 use PHPUnit\Framework\Assert;
-use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
 /**
  * Defines application features from the specific context.
  */
-class BlockingContext extends TestCase implements Context, SnippetAcceptingContext
+class BlockingContext implements Context, SnippetAcceptingContext
 {
     use IntegUtils;
 
@@ -101,9 +96,9 @@ public function theTableNamedWillNotExist($table)
     {
         try {
             $this->theTableNamedWillExist($table);
-            $this->fail("$table exists but should not.");
+            Assert::fail("$table exists but should not.");
         } catch (DynamoDbException $e) {
-            $this->assertSame('ResourceNotFoundException', $e->getAwsErrorCode());
+            Assert::assertSame('ResourceNotFoundException', $e->getAwsErrorCode());
         }
     }
 

features/bootstrap/Aws/Test/Integ/ClientSideMonitoringContext.php

@@ -19,9 +19,8 @@
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\Assert;
-use Yoast\PHPUnitPolyfills\TestCases\TestCase;
 
-class ClientSideMonitoringContext extends TestCase
+class ClientSideMonitoringContext
     implements Context, SnippetAcceptingContext
 {
 
@@ -271,19 +270,19 @@ private function clearAndSetEnv($env)
 
     private function compareMonitoringEvents($expected, $actual)
     {
-        $this->assertSame(count($expected), count($actual));
+        Assert::assertSame(count($expected), count($actual));
         foreach ($expected as $index => $expectedEvent) {
             $actualEvent = $actual[$index];
             foreach ($expectedEvent as $key => $value) {
-                $this->assertArrayHasKey($key, $actualEvent);
+                Assert::assertArrayHasKey($key, $actualEvent);
                 $this->validateEventValue($value, $actualEvent[$key]);
             }
             $allowedFields = array_merge(
                 array_keys($expectedEvent),
                 array_keys($this->testData['defaults']['optionalEventFields'][$actualEvent['Type']])
             );
             foreach ($actualEvent as $key => $value) {
-                $this->assertTrue(in_array($key, $allowedFields));
+                Assert::assertTrue(in_array($key, $allowedFields));
                 if (in_array($key, $this->testData['defaults']['optionalEventFields'][$actualEvent['Type']])) {
                     $this->validateEventValue(
                         $this->testData['defaults']['optionalEventFields'][$actualEvent['Type']],
@@ -437,13 +436,13 @@ private function validateEventValue($expected, $actual)
     {
         switch ($expected) {
             case "ANY_INT":
-                $this->assertIsInt($actual);
+                Assert::assertIsInt($actual);
                 break;
             case "ANY_STR":
-                $this->assertIsString('string', $actual);
+                Assert::assertIsString('string', $actual);
                 break;
             default:
-                $this->assertEquals($expected, $actual);
+                Assert::assertEquals($expected, $actual);
         }
     }
 }

features/bootstrap/Aws/Test/Integ/ConcurrencyContext.php

@@ -4,26 +4,22 @@
 
 use Aws\CommandInterface;
 use Aws\CommandPool;
-use Aws\Exception\AwsException;
 use Aws\Result;
 use Aws\S3\S3Client;
 use Behat\Behat\Hook\Scope\AfterFeatureScope;
 use Behat\Behat\Hook\Scope\BeforeFeatureScope;
-use Behat\Behat\Tester\Exception\PendingException;
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\SnippetAcceptingContext;
-use Behat\Gherkin\Node\PyStringNode;
 use Behat\Gherkin\Node\TableNode;
 use GuzzleHttp\Promise;
 use GuzzleHttp\Promise\PromiseInterface;
 use JmesPath;
 use PHPUnit\Framework\Assert;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Defines application features from the specific context.
  */
-class ConcurrencyContext extends TestCase implements
+class ConcurrencyContext implements
     Context,
     SnippetAcceptingContext
 {
@@ -93,9 +89,12 @@ public function iCallTheApi($command)
      */
     public function theValueAtShouldBeA($key, $type)
     {
-        $this->assertInstanceOf(Result::class, $this->result);
+        Assert::assertInstanceOf(Result::class, $this->result);
         $methodName = 'assertIs' . ucfirst($type);
-        $this->$methodName($this->result->search($key));
+        call_user_func(
+            [Assert::class, $methodName],
+            $this->result->search($key)
+        );
     }
 
     /**
@@ -161,15 +160,15 @@ public function iSendTheCommandsAsABatchTo($service)
      */
     public function thereShouldBeResults($count)
     {
-        $this->assertCount((int) $count, $this->result);
+        Assert::assertCount((int) $count, $this->result);
     }
 
     /**
      * @Then there should be :count value at :path
      */
     public function thereShouldBeValueAt($count, $path)
     {
-        $this->assertCount((int) $count, array_unique(
+        Assert::assertCount((int) $count, array_unique(
                 JmesPath\search($path, $this->result)
         ));
     }

features/bootstrap/Aws/Test/Integ/MultipartContext.php

@@ -8,12 +8,9 @@
 use Aws\S3\MultipartCopy;
 use Aws\S3\MultipartUploader as S3MultipartUploader;
 use Aws\S3\S3Client;
-use Behat\Behat\Tester\Exception\PendingException;
 use Aws\S3\BatchDelete;
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\SnippetAcceptingContext;
-use Behat\Gherkin\Node\PyStringNode;
-use Behat\Gherkin\Node\TableNode;
 use GuzzleHttp\Psr7;
 use GuzzleHttp\Psr7\NoSeekStream;
 use PHPUnit\Framework\Assert;

features/bootstrap/Aws/Test/Integ/NativeStreamContext.php

@@ -5,18 +5,14 @@
 use Aws\S3\S3Client;
 use Behat\Behat\Hook\Scope\AfterFeatureScope;
 use Behat\Behat\Hook\Scope\BeforeFeatureScope;
-use Behat\Behat\Tester\Exception\PendingException;
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\SnippetAcceptingContext;
-use Behat\Gherkin\Node\PyStringNode;
-use Behat\Gherkin\Node\TableNode;
 use PHPUnit\Framework\Assert;
-use PHPUnit\Framework\TestCase;
 
 /**
  * Defines application features from the specific context.
  */
-class NativeStreamContext extends TestCase implements
+class NativeStreamContext implements
     Context,
     SnippetAcceptingContext
 {
@@ -108,7 +104,7 @@ public function iCallOnThePath($method, $path)
      */
     public function theCallShouldReturn($booleanString)
     {
-        $this->assertSame(
+        Assert::assertSame(
             filter_var($booleanString, FILTER_VALIDATE_BOOLEAN),
             $this->callSucceeded
         );
@@ -119,7 +115,7 @@ public function theCallShouldReturn($booleanString)
      */
     public function iHaveAFileAtWithTheContent($path, $contents)
     {
-        $this->assertGreaterThan(
+        Assert::assertGreaterThan(
             0,
             file_put_contents($this->getS3Path($path), $contents)
         );
@@ -130,15 +126,15 @@ public function iHaveAFileAtWithTheContent($path, $contents)
      */
     public function iHaveAFileAtWithNoContent($path)
     {
-        $this->assertSame(0, file_put_contents($this->getS3Path($path), ''));
+        Assert::assertSame(0, file_put_contents($this->getS3Path($path), ''));
     }
 
     /**
      * @Then the file at :arg1 should contain :arg2
      */
     public function theFileAtShouldContain($key, $contents)
     {
-        $this->assertStringEqualsFile($this->getS3Path($key), $contents);
+        Assert::assertStringEqualsFile($this->getS3Path($key), $contents);
     }
 
     /**
@@ -154,23 +150,23 @@ public function iHaveAReadHandleOnTheFileAt($key)
      */
     public function readingBytesShouldReturn($byteCount, $expected)
     {
-        $this->assertSame($expected, fread($this->handle, $byteCount));
+        Assert::assertSame($expected, fread($this->handle, $byteCount));
     }
 
     /**
      * @Then /^calling fstat should report a size of (\d+)$/
      */
     public function callingFstatShouldReportASizeOf($size)
     {
-        $this->assertSame((int) $size, fstat($this->handle)['size']);
+        Assert::assertSame((int) $size, fstat($this->handle)['size']);
     }
 
     /**
      * @Then scanning the directory at :dir should return a list with one member named :file
      */
     public function scanningTheDirectoryAtShouldReturnAListWithOneMemberNamed($dir, $file)
     {
-        $this->assertSame([$file], scandir($this->getS3Path($dir)));
+        Assert::assertSame([$file], scandir($this->getS3Path($dir)));
     }
 
     private function getS3Path($path)