chore: align with sdk deprecation; add ci (#80)

Co-authored-by: Danielss89 <[email protected]>
Co-authored-by: Abdul Malik Ikhsan <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: Run tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: ['8.1', '8.2', '8.3', '8.4']
+    name: Run tests on PHP ${{ matrix.php-versions }}
+
+    steps:
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: json
+
+      - uses: actions/checkout@v4
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run test suite
+        run: make test

.gitignore

@@ -2,3 +2,4 @@ vendor/
 composer.phar
 composer.lock
 phpunit.xml
+.phpunit.result.cache

composer.json

@@ -15,17 +15,16 @@
         "sqs"
     ],
     "require": {
-        "php": "^5.6 || ^7.0",
-        "aws/aws-sdk-php": "3.*",
+        "php": ">=8.1",
+        "aws/aws-sdk-php": "^3.338.0",
         "laminas/laminas-filter": "^2.9.0",
-        "laminas/laminas-servicemanager": "^2.7.0 || ^3.0",
+        "laminas/laminas-servicemanager": "^3.0 || ^4.0",
         "laminas/laminas-session": "^2.7.0",
         "laminas/laminas-view": "^2.8"
     },
     "require-dev": {
-        "phpunit/phpunit": "5.*",
-        "laminas/laminas-modulemanager": "2.7.*",
-        "squizlabs/php_codesniffer": "~2.3"
+        "phpunit/phpunit": "^8.5 || ^9.5",
+        "laminas/laminas-modulemanager": "^2.11"
     },
     "autoload": {
         "psr-4": {

src/Session/SaveHandler/DynamoDb.php

@@ -35,6 +35,7 @@ public function __construct(SessionHandler $sessionHandler)
      *
      * @return bool Whether or not the operation succeeded
      */
+    #[\ReturnTypeWillChange]
     public function open($savePath, $name)
     {
         return $this->sessionHandler->open($savePath, $name);
@@ -47,6 +48,7 @@ public function open($savePath, $name)
      *
      * @return bool Whether or not the operation succeeded
      */
+    #[\ReturnTypeWillChange]
     public function close()
     {
         return $this->sessionHandler->close();
@@ -61,6 +63,7 @@ public function close()
      *
      * @return string Session data
      */
+    #[\ReturnTypeWillChange]
     public function read($id)
     {
         return $this->sessionHandler->read($id);
@@ -76,6 +79,7 @@ public function read($id)
      *
      * @return bool Whether or not the operation succeeded
      */
+    #[\ReturnTypeWillChange]
     public function write($id, $data)
     {
         return $this->sessionHandler->write($id, $data);
@@ -90,6 +94,7 @@ public function write($id, $data)
      *
      * @return bool Whether or not the operation succeeded
      */
+    #[\ReturnTypeWillChange]
     public function destroy($id)
     {
         return $this->sessionHandler->destroy($id);
@@ -104,6 +109,7 @@ public function destroy($id)
      *
      * @return bool Whether or not the operation succeeded
      */
+    #[\ReturnTypeWillChange]
     public function gc($maxlifetime)
     {
         return $this->sessionHandler->gc($maxlifetime);

tests/Factory/AwsFactoryTest.php

@@ -6,11 +6,12 @@
 use Aws\Sdk as AwsSdk;
 use AwsModule\Module;
 use Laminas\ServiceManager\ServiceLocatorInterface;
+use PHPUnit\Framework\TestCase;
 
 /**
  * AWS Module test cases
  */
-class AwsFactoryTest extends \PHPUnit_Framework_TestCase
+class AwsFactoryTest extends TestCase
 {
     public function testCanFetchAwsFromServiceManager()
     {
@@ -34,7 +35,7 @@ public function testProvidesVersionInformationForSdkUserAgent()
 
 
         $this->assertArrayHasKey('ua_append', $args);
-        $this->assertInternalType('array', $args['ua_append']);
+        $this->assertIsArray($args['ua_append']);
         $this->assertNotEmpty($args['ua_append']);
         $this->assertNotEmpty(array_filter($args['ua_append'], function ($ua) {
             return false !== strpos($ua, Module::VERSION);

tests/Factory/DynamoDbSessionSaveHandlerFactoryTest.php

@@ -2,15 +2,18 @@
 
 namespace AwsModule\Tests\Factory;
 
+use Aws\DynamoDb\Exception\DynamoDbException;
 use AwsModule\Factory\DynamoDbSessionSaveHandlerFactory;
 use Aws\Sdk as AwsSdk;
 use AwsModule\Session\SaveHandler\DynamoDb as DynamoDbSaveHandler;
+use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
 use Laminas\ServiceManager\ServiceLocatorInterface;
+use PHPUnit\Framework\TestCase;
 
 /**
  * DynamoDB-backed session save handler tests
  */
-class DynamoDbSessionSaveHandlerFactoryTest extends \PHPUnit_Framework_TestCase
+class DynamoDbSessionSaveHandlerFactoryTest extends TestCase
 {
     public function testCanFetchSaveHandlerFromServiceManager()
     {
@@ -31,8 +34,15 @@ public function testCanFetchSaveHandlerFromServiceManager()
         $awsSdk = new AwsSdk($config['aws']);
 
         $serviceLocator = $this->createMock(ServiceLocatorInterface::class);
-        $serviceLocator->expects($this->at(0))->method('get')->with('Config')->willReturn($config);
-        $serviceLocator->expects($this->at(1))->method('get')->with(AwsSdk::class)->willReturn($awsSdk);
+        $serviceLocator->method('get')
+            ->withConsecutive(
+                ['Config'],
+                [AwsSdk::class]
+            )
+            ->willReturnOnConsecutiveCalls(
+                $config,
+                $awsSdk
+            );
 
 
         $saveHandlerFactory = new DynamoDbSessionSaveHandlerFactory();
@@ -43,11 +53,9 @@ public function testCanFetchSaveHandlerFromServiceManager()
         $this->assertInstanceOf(DynamoDbSaveHandler::class, $saveHandler);
     }
 
-    /**
-     * @expectedException \Laminas\ServiceManager\Exception\ServiceNotCreatedException
-     */
     public function testExceptionThrownWhenSaveHandlerConfigurationDoesNotExist()
     {
+        $this->expectException(ServiceNotCreatedException::class);
         $serviceLocator = $this->createMock(ServiceLocatorInterface::class);
         $serviceLocator->expects($this->once())->method('get')->with('Config')->willReturn([]);
 

tests/Filter/File/S3RenameUploadTest.php

@@ -5,16 +5,17 @@
 use AwsModule\Filter\Exception\MissingBucketException;
 use AwsModule\Filter\File\S3RenameUpload;
 use Aws\S3\S3Client;
+use PHPUnit\Framework\TestCase;
 use ReflectionMethod;
 
-class S3RenameUploadTest extends \PHPUnit_Framework_TestCase
+class S3RenameUploadTest extends TestCase
 {
     /**
      * @var S3RenameUpload
      */
     protected $filter;
 
-    public function setUp()
+    public function setUp(): void
     {
         $s3Client = new S3Client([
             'credentials' => [
@@ -46,7 +47,7 @@ public function testBucketNameIsTrimmedWhenSet()
 
     public function testThrowExceptionIfNoBucketIsSet()
     {
-        $this->setExpectedException(MissingBucketException::class);
+        $this->expectException(MissingBucketException::class);
         $this->filter->filter(['tmp_name' => 'foo', 'name' => 'foo']);
     }
 

tests/Session/SaveHandler/DynamoDbTest.php

@@ -4,8 +4,9 @@
 
 use Aws\DynamoDb\SessionHandler;
 use AwsModule\Session\SaveHandler\DynamoDb as DynamoDbSaveHandler;
+use PHPUnit\Framework\TestCase;
 
-class DynamoDbTest extends \PHPUnit_Framework_TestCase
+class DynamoDbTest extends TestCase
 {
     /**
      * @var SessionHandler
@@ -17,7 +18,7 @@ class DynamoDbTest extends \PHPUnit_Framework_TestCase
      */
     protected $saveHandler;
 
-    public function setUp()
+    public function setUp(): void
     {
         parent::setUp();
 

tests/View/Helper/CloudFrontLinkTest.php

@@ -3,9 +3,11 @@
 namespace AwsModule\Tests\View\Helper;
 
 use Aws\CloudFront\CloudFrontClient;
+use AwsModule\View\Exception\InvalidDomainNameException;
 use AwsModule\View\Helper\CloudFrontLink;
+use PHPUnit\Framework\TestCase;
 
-class CloudFrontLinkTest extends \PHPUnit_Framework_TestCase
+class CloudFrontLinkTest extends TestCase
 {
     /**
      * @var CloudFrontClient
@@ -17,7 +19,7 @@ class CloudFrontLinkTest extends \PHPUnit_Framework_TestCase
      */
     protected $viewHelper;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->cloudFrontClient = new CloudFrontClient([
             'credentials' => [
@@ -71,11 +73,9 @@ public function testCanUseCustomHostname()
         $this->assertEquals('https://123abc.example.com/my-object', $link);
     }
 
-    /**
-     * @expectedException \AwsModule\View\Exception\InvalidDomainNameException
-     */
     public function testFailsWhenDomainIsInvalid()
     {
+        $this->expectException(InvalidDomainNameException::class);
         $this->viewHelper->setDefaultDomain('');
         $link = $this->viewHelper->__invoke('my-object');
     }
@@ -102,7 +102,7 @@ public function testGenerateSignedLink()
 
         $this->viewHelper->setHostname('example.com');
         $link = $this->viewHelper->__invoke('my-object', '123abc', time() + 600, 'kpid', $pemFile);
-        $this->assertRegExp(
+        $this->assertMatchesRegularExpression(
             '#^https\:\/\/123abc\.example\.com\/my-object\?Expires\=(.*)\&Signature\=(.*)\&Key-Pair-Id\=kpid$#',
             $link
         );

tests/View/Helper/S3LinkTest.php

@@ -3,9 +3,11 @@
 namespace AwsModule\Tests\View\Helper;
 
 use Aws\S3\S3Client;
+use AwsModule\View\Exception\InvalidDomainNameException;
 use AwsModule\View\Helper\S3Link;
+use PHPUnit\Framework\TestCase;
 
-class S3LinkTest extends \PHPUnit_Framework_TestCase
+class S3LinkTest extends TestCase
 {
     /**
      * @var S3Client
@@ -17,7 +19,7 @@ class S3LinkTest extends \PHPUnit_Framework_TestCase
      */
     protected $viewHelper;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->s3Client = new S3Client([
             'credentials' => [
@@ -70,11 +72,9 @@ public function testCreatesUrlsForRegionalBuckets()
         $this->assertEquals('https://my-bucket.s3.sa-east-1.amazonaws.com/my-object', $link);
     }
 
-    /**
-     * @expectedException \AwsModule\View\Exception\InvalidDomainNameException
-     */
     public function testFailsWhenNoBucketSpecified()
     {
+        $this->expectException(InvalidDomainNameException::class);
         $link = $this->viewHelper->__invoke('my-object');
     }
 
@@ -96,8 +96,8 @@ public function testGenerateSignedLink()
         $url = $viewHelper->__invoke('my-object', 'my-bucket', $expires);
 
         $this->assertStringStartsWith('https://my-bucket.s3.sa-east-1.amazonaws.com/my-object?', $url);
-        $this->assertContains('X-Amz-Security-Token=999', $url);
-        $this->assertContains('X-Amz-Content-Sha256=', $url);
-        $this->assertContains('X-Amz-Expires=', $url);
+        $this->assertStringContainsString('X-Amz-Security-Token=999', $url);
+        $this->assertStringContainsString('X-Amz-Content-Sha256=', $url);
+        $this->assertStringContainsString('X-Amz-Expires=', $url);
     }
 }