feat: add Symfony-7 support & deprecates old PHPvs

We have done the following changes: - Add support for symfony 7 - Deprecates PHP versions below than 7.2.5 - Add support for phpunit 9 - Refactor code for making the current implementation compatible with the new versions that we are starting to support for the different used packages.
aws · Jan 18, 2024 · 8dc7b47 · 8dc7b47
1 parent 73495ac
commit 8dc7b47
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 69 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -13,8 +13,8 @@ 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: [ '7.2.5', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2' ]
+        composer-options: [ '', '--prefer-lowest' ]
     #set the name for each job
     name: PHP ${{ matrix.php-versions }}
     steps:
@@ -35,4 +35,14 @@ jobs:
 
       #run tests
       - name: Run test suite
-        run: vendor/bin/phpunit
+        run: vendor/bin/phpunit
+
+      #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.4.5" --no-interaction --prefer-source --with-all-dependencies
diff --git a/composer.json b/composer.json
@@ -12,16 +12,16 @@
         }
     ],
     "require": {
-        "php": ">=5.5",
+        "php": ">=7.2.5",
         "aws/aws-sdk-php": "^3.2.6",
-        "symfony/config": "~2.3|~3.0|~4.0|~5.0|~6.0",
-        "symfony/dependency-injection": "~2.3|~3.0|~4.0|~5.0|~6.0",
-        "symfony/http-kernel": "~2.3|~3.0|~4.0|~5.0|~6.0"
+        "symfony/config": "~4.0|~5.0|~6.0|~7.0",
+        "symfony/dependency-injection": "~4.0|~5.0|~6.0|~7.0",
+        "symfony/http-kernel": "~4.0|~5.0|~6.0|~7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^4.8.35|^5.6.3|^6.0.0",
-        "symfony/framework-bundle": "~2.3|~3.0|~4.0|~5.0|~6.0",
-        "symfony/yaml": "~2.3|~3.0|~4.0|~5.0|~6.0"
+        "phpunit/phpunit": "^5.6.3 || ^8.5 || ^9.5",
+        "symfony/framework-bundle": "~4.0|~5.0|~6.0|~7.0",
+        "symfony/yaml": "~4.0|~5.0|~6.0|~7.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/DependencyInjection/AwsExtension.php b/src/DependencyInjection/AwsExtension.php
@@ -15,7 +15,10 @@
 
 class AwsExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    /**
+     * @throws \Exception
+     */
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $loader = new YamlFileLoader(
             $container,
@@ -44,7 +47,7 @@ public function load(array $configs, ContainerBuilder $container)
     }
 
 
-    private function createServiceDefinition($name)
+    private function createServiceDefinition($name): Definition
     {
         $clientClass = "Aws\\{$name}\\{$name}Client";
         $serviceDefinition = new Definition(
@@ -53,21 +56,13 @@ class_exists($clientClass) ? $clientClass : AwsClient::class
 
         $serviceDefinition->setLazy(true);
 
-        // Handle Symfony >= 2.6
-        if (method_exists($serviceDefinition, 'setFactory')) {
-            return $serviceDefinition->setFactory([
-                new Reference('aws_sdk'),
-                'createClient',
-            ])->setArguments([$name]);
-        }
-
-        return $serviceDefinition
-                ->setFactoryService('aws_sdk')
-                ->setFactoryMethod('createClient')
-                ->setArguments([$name]);
+        return $serviceDefinition->setFactory([
+            new Reference('aws_sdk'),
+            'createClient',
+        ])->setArguments([$name]);
     }
 
-    private function inflateServicesInConfig(array &$config)
+    private function inflateServicesInConfig(array &$config): void
     {
         array_walk($config, function (&$value) {
             if (is_array($value)) {

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -8,7 +8,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         // Maintain backwars compatibility, only merge when AWS_MERGE_CONFIG is set
         $mergeConfig = $this->shouldMergeConfig();
@@ -18,25 +18,13 @@ public function getConfigTreeBuilder()
             $treeType = 'array';
         }
 
-        // Most recent versions of TreeBuilder have a constructor
-        if (\method_exists(TreeBuilder::class, '__construct')) {
-            $treeBuilder = new TreeBuilder('aws', $treeType);
-        } else { // which is not the case for older versions
-            $treeBuilder = new TreeBuilder;
-            $treeBuilder->root('aws', $treeType);
-        }
-
+        $treeBuilder = new TreeBuilder('aws', $treeType);
         // If not AWS_MERGE_CONFIG, return empty, variable TreeBuilder
         if (!$mergeConfig) {
             return $treeBuilder;
         }
 
-        if (method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->getRootNode();
-        } else {
-            $rootNode = $treeBuilder->root('aws', $treeType);
-        }
-
+        $rootNode = $treeBuilder->getRootNode();
         // Define TreeBuilder to allow config validation and merging
         $rootNode
             ->ignoreExtraKeys(false)
@@ -70,8 +58,7 @@ public function getConfigTreeBuilder()
                 ->variableNode('ua_append')->end()
                 ->variableNode('validate')->end()
                 ->scalarNode('version')->end()
-            ->end()
-        ;
+            ->end();
 
         //Setup config trees for each of the services
         foreach (array_column(Aws\manifest(), 'namespace') as $awsService) {
@@ -111,14 +98,13 @@ public function getConfigTreeBuilder()
                             ->scalarNode('version')->end()
                         ->end()
                     ->end()
-                ->end()
-            ;
+                ->end();
         }
 
         return $treeBuilder;
     }
 
-    protected function shouldMergeConfig()
+    protected function shouldMergeConfig(): ?string
     {
         # works with symfony/dotenv
         if (isset($_ENV['AWS_MERGE_CONFIG'])) {

diff --git a/tests/DependencyInjection/AwsExtensionTest.php b/tests/DependencyInjection/AwsExtensionTest.php
@@ -10,6 +10,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
 class AwsExtensionTest extends TestCase
@@ -24,7 +25,7 @@ class AwsExtensionTest extends TestCase
      */
     protected $container;
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->kernel = new AppKernel('test', true);
         $this->kernel->boot();
@@ -38,9 +39,9 @@ public function setUp()
     public function sdk_config_should_be_passed_directly_to_the_constructor_and_resolved_by_the_sdk()
     {
         $config           = $this->kernel->getTestConfig()['aws'];
-        $s3Region         = isset($config['S3']['region']) ? $config['S3']['region'] : $config['region'];
-        $lambdaRegion     = isset($config['Lambda']['region']) ? $config['Lambda']['region'] : $config['region'];
-        $codeDeployRegion = isset($config['CodeDeploy']['region']) ? $config['CodeDeploy']['region'] : $config['region'];
+        $s3Region         = $config['S3']['region'] ?? $config['region'];
+        $lambdaRegion     = $config['Lambda']['region'] ?? $config['region'];
+        $codeDeployRegion = $config['CodeDeploy']['region'] ?? $config['region'];
 
         $testService = $this->container->get('test_service');
 
@@ -76,13 +77,16 @@ public function extension_should_escape_strings_that_begin_with_at_sign()
             'secret' => '@@secret'
         ]];
         $container = $this->getMockBuilder(ContainerBuilder::class)
-            ->setMethods(['getDefinition', 'replaceArgument'])
+            ->onlyMethods(['getDefinition'])
+            ->getMock();
+        $definition = $this->getMockBuilder(Definition::class)
+            ->onlyMethods(['replaceArgument'])
             ->getMock();
         $container->expects($this->once())
             ->method('getDefinition')
             ->with('aws_sdk')
-            ->willReturnSelf();
-        $container->expects($this->once())
+            ->willReturn($definition);
+        $definition->expects($this->once())
             ->method('replaceArgument')
             ->with(0, $this->callback(function ($arg) {
                 return is_array($arg)
@@ -104,13 +108,16 @@ public function extension_should_expand_service_references()
         $extension = new AwsExtension;
         $config = ['credentials' => '@aws_sdk'];
         $container = $this->getMockBuilder(ContainerBuilder::class)
-            ->setMethods(['getDefinition', 'replaceArgument'])
+            ->onlyMethods(['getDefinition'])
+            ->getMock();
+        $definition = $this->getMockBuilder(Definition::class)
+            ->onlyMethods(['replaceArgument'])
             ->getMock();
         $container->expects($this->once())
             ->method('getDefinition')
             ->with('aws_sdk')
-            ->willReturnSelf();
-        $container->expects($this->once())
+            ->willReturn($definition);
+        $definition->expects($this->once())
             ->method('replaceArgument')
             ->with(0, $this->callback(function ($arg) {
                 return is_array($arg)
@@ -137,7 +144,6 @@ public function extension_should_validate_and_merge_configs()
             'stats' => [
                 'http' => true
             ],
-            'retries' => 5,
             'endpoint' => 'http://localhost:8000',
             'endpoint_discovery' => [
                 'enabled' => true,
@@ -181,13 +187,16 @@ public function extension_should_validate_and_merge_configs()
             'validate' => true,
         ];
         $container = $this->getMockBuilder(ContainerBuilder::class)
-            ->setMethods(['getDefinition', 'replaceArgument'])
+            ->onlyMethods(['getDefinition'])
+            ->getMock();
+        $definition = $this->getMockBuilder(Definition::class)
+            ->onlyMethods(['replaceArgument'])
             ->getMock();
         $container->expects($this->once())
             ->method('getDefinition')
             ->with('aws_sdk')
-            ->willReturnSelf();
-        $container->expects($this->once())
+            ->willReturn($definition);
+        $definition->expects($this->once())
             ->method('replaceArgument')
             ->with(0, $this->callback(function ($arg) {
                 return is_array($arg)
@@ -230,9 +239,8 @@ public function extension_should_error_merging_unknown_config_options()
             'foo' => 'baz'
         ];
         $container = $this->getMockBuilder(ContainerBuilder::class)
-            ->setMethods(['getDefinition', 'replaceArgument'])
+            ->onlyMethods(['getDefinition'])
             ->getMock();
-
         try {
             $extension->load([$config, $configDev], $container);
             $this->fail('Should have thrown an Error or RuntimeException');

diff --git a/tests/DependencyInjection/ConfigurationTest.php b/tests/DependencyInjection/ConfigurationTest.php
@@ -10,7 +10,7 @@
 
 class ConfigurationTest extends TestCase
 {
-    public function setUp()
+    public function setUp(): void
     {
         (new Filesystem)
             ->remove(implode(DIRECTORY_SEPARATOR, [

diff --git a/tests/fixtures/AppKernel.php b/tests/fixtures/AppKernel.php
@@ -16,15 +16,15 @@ public function __construct($env, $debug, $extension = 'yml')
         parent::__construct($env, $debug);
     }
 
-    public function registerBundles()
+    public function registerBundles(): iterable
     {
         return [
             new FrameworkBundle(),
             new AwsBundle(),
         ];
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load($this->getTestConfigFile($this->extension));
     }
@@ -35,7 +35,7 @@ public function getTestConfig()
     }
 
 
-    private function getTestConfigFile($extension)
+    private function getTestConfigFile($extension): string
     {
         return __DIR__ . '/config.' . $extension;
     }

diff --git a/tests/fixtures/TestService.php b/tests/fixtures/TestService.php
@@ -35,31 +35,31 @@ public function __construct(
     /**
      * @return S3Client
      */
-    public function getS3Client()
+    public function getS3Client(): S3Client
     {
         return $this->s3Client;
     }
 
     /**
      * @return LambdaClient
      */
-    public function getLambdaClient()
+    public function getLambdaClient(): LambdaClient
     {
         return $this->lambdaClient;
     }
 
     /**
      * @return CodeDeployClient
      */
-    public function getCodeDeployClient()
+    public function getCodeDeployClient(): CodeDeployClient
     {
         return $this->codeDeployClient;
     }
 
     /**
      * @return array
      */
-    public function getClients()
+    public function getClients(): array
     {
         return [
             $this->s3Client,