Merge pull request #353 from gitis/issue-352_allow_custom_aws_endpoin…

…t_configuration Added endpoint configuration and updated the tests
php-enqueue · Feb 5, 2018 · 1060a06 · 1060a06
2 parents f8991bc + 7ce0092
commit 1060a06
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/pkg/sqs/SqsConnectionFactory.php b/pkg/sqs/SqsConnectionFactory.php
@@ -26,6 +26,7 @@ class SqsConnectionFactory implements PsrConnectionFactory
      *   'retries' => 3,            - (int, default=int(3)) Configures the maximum number of allowed retries for a client (pass 0 to disable retries).
      *   'version' => '2012-11-05', - (string, required) The version of the webservice to utilize
      *   'lazy' => true,            - Enable lazy connection (boolean)
+     *   'endpoint' => null         - (string, default=null) The full URI of the webservice. This is only required when connecting to a custom endpoint e.g. localstack
      * ].
      *
      * or
@@ -93,6 +94,10 @@ private function establishConnection()
             'region' => $this->config['region'],
         ];
 
+        if (isset($this->config['endpoint'])) {
+            $config['endpoint'] = $this->config['endpoint'];
+        }
+
         if ($this->config['key'] && $this->config['secret']) {
             $config['credentials'] = [
                 'key' => $this->config['key'],
@@ -151,6 +156,7 @@ private function defaultConfig()
             'retries' => 3,
             'version' => '2012-11-05',
             'lazy' => true,
+            'endpoint' => null,
         ];
     }
 }
diff --git a/pkg/sqs/Tests/SqsConnectionFactoryConfigTest.php b/pkg/sqs/Tests/SqsConnectionFactoryConfigTest.php
@@ -62,6 +62,7 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => true,
+                'endpoint' => null,
             ],
         ];
 
@@ -75,6 +76,7 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => true,
+                'endpoint' => null,
             ],
         ];
 
@@ -88,6 +90,7 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => true,
+                'endpoint' => null,
             ],
         ];
 
@@ -101,6 +104,7 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => false,
+                'endpoint' => null,
             ],
         ];
 
@@ -114,6 +118,7 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => false,
+                'endpoint' => null,
             ],
         ];
 
@@ -127,6 +132,27 @@ public static function provideConfigs()
                 'retries' => 3,
                 'version' => '2012-11-05',
                 'lazy' => false,
+                'endpoint' => null,
+            ],
+        ];
+
+        yield [
+            [
+                'key' => 'theKey',
+                'secret' => 'theSecret',
+                'token' => 'theToken',
+                'lazy' => false,
+                'endpoint' => 'http://localstack:1111',
+            ],
+            [
+                'key' => 'theKey',
+                'secret' => 'theSecret',
+                'token' => 'theToken',
+                'region' => null,
+                'retries' => 3,
+                'version' => '2012-11-05',
+                'lazy' => false,
+                'endpoint' => 'http://localstack:1111',
             ],
         ];
     }

diff --git a/pkg/sqs/Tests/SqsConnectionFactoryTest.php b/pkg/sqs/Tests/SqsConnectionFactoryTest.php
@@ -28,6 +28,7 @@ public function testCouldBeConstructedWithEmptyConfiguration()
             'region' => null,
             'retries' => 3,
             'version' => '2012-11-05',
+            'endpoint' => null,
         ], 'config', $factory);
     }
 
@@ -43,6 +44,7 @@ public function testCouldBeConstructedWithCustomConfiguration()
             'region' => null,
             'retries' => 3,
             'version' => '2012-11-05',
+            'endpoint' => null,
         ], 'config', $factory);
     }