[sqs] Use a queue created in another AWS account.

pkg/sqs/SqsConnectionFactory.php

@@ -23,14 +23,15 @@ class SqsConnectionFactory implements ConnectionFactory
 
     /**
      * $config = [
-     *   'key' => null              - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
-     *   'secret' => null,          - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
-     *   'token' => null,           - AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
-     *   'region' => null,          - (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
-     *   '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
+     *   'key' => null                AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
+     *   'secret' => null,            AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
+     *   'token' => null,             AWS credentials. If no credentials are provided, the SDK will attempt to load them from the environment.
+     *   'region' => null,            (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
+     *   '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
+     *   'queue_owner_aws_account_id' The AWS account ID of the account that created the queue.
      * ].
      *
      * or
@@ -74,10 +75,10 @@ public function createContext(): Context
         if ($this->config['lazy']) {
             return new SqsContext(function () {
                 return $this->establishConnection();
-            });
+            }, $this->config);
         }
 
-        return new SqsContext($this->establishConnection());
+        return new SqsContext($this->establishConnection(), $this->config);
     }
 
     private function establishConnection(): SqsClient
@@ -132,6 +133,7 @@ private function parseDsn(string $dsn): array
             'version' => $dsn->getString('version'),
             'lazy' => $dsn->getBool('lazy'),
             'endpoint' => $dsn->getString('endpoint'),
+            'queue_owner_aws_account_id' => $dsn->getString('queue_owner_aws_account_id'),
         ]), function ($value) { return null !== $value; });
     }
 
@@ -146,6 +148,7 @@ private function defaultConfig(): array
             'version' => '2012-11-05',
             'lazy' => true,
             'endpoint' => null,
+            'queue_owner_aws_account_id' => null,
         ];
     }
 }

pkg/sqs/SqsContext.php

@@ -34,12 +34,14 @@ class SqsContext implements Context
      */
     private $queueUrls;
 
+    private $config;
+
     /**
      * Callable must return instance of SqsClient once called.
      *
      * @param SqsClient|callable $client
      */
-    public function __construct($client)
+    public function __construct($client, array $config)
     {
         if ($client instanceof SqsClient) {
             $this->client = $client;
@@ -52,6 +54,8 @@ public function __construct($client)
                 SqsClient::class
             ));
         }
+
+        $this->config = $config;
     }
 
     /**
@@ -148,15 +152,18 @@ public function getQueueUrl(SqsDestination $destination): string
             return $this->queueUrls[$destination->getQueueName()];
         }
 
-        $result = $this->getClient()->getQueueUrl([
-            'QueueName' => $destination->getQueueName(),
-        ]);
+        $arguments = ['QueueName' => $destination->getQueueName()];
+        if (false == empty($this->config['queue_owner_aws_account_id'])) {
+            $arguments['QueueOwnerAWSAccountId'] = $this->config['queue_owner_aws_account_id'];
+        }
+
+        $result = $this->getClient()->getQueueUrl($arguments);
 
         if (false == $result->hasKey('QueueUrl')) {
             throw new \RuntimeException(sprintf('QueueUrl cannot be resolved. queueName: "%s"', $destination->getQueueName()));
         }
 
-        return $this->queueUrls[$destination->getQueueName()] = $result->get('QueueUrl');
+        return $this->queueUrls[$destination->getQueueName()] = (string) $result->get('QueueUrl');
     }
 
     public function declareQueue(SqsDestination $dest): void

pkg/sqs/Tests/Spec/CreateSqsQueueTrait.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Enqueue\Sqs\Tests\Spec;
+
+use Enqueue\Sqs\SqsContext;
+use Enqueue\Sqs\SqsDestination;
+
+trait CreateSqsQueueTrait
+{
+    private $queue;
+
+    protected function createSqsQueue(SqsContext $context, string $queueName): SqsDestination
+    {
+        $queueName = $queueName.time();
+
+        $this->queue = $context->createQueue($queueName);
+        $context->declareQueue($this->queue);
+
+        return $this->queue;
+    }
+}

pkg/sqs/Tests/Spec/SqsSendAndReceiveDelayedMessageFromQueueTest.php

@@ -17,17 +17,13 @@ class SqsSendAndReceiveDelayedMessageFromQueueTest extends SendAndReceiveDelayed
 {
     use RetryTrait;
     use SqsExtension;
+    use CreateSqsQueueTrait;
 
     /**
      * @var SqsContext
      */
     private $context;
 
-    /**
-     * @var SqsDestination
-     */
-    private $queue;
-
     protected function tearDown()
     {
         parent::tearDown();
@@ -37,26 +33,13 @@ protected function tearDown()
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function createContext()
+    protected function createContext(): SqsContext
     {
         return $this->context = $this->buildSqsContext();
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @param SqsContext $context
-     */
-    protected function createQueue(Context $context, $queueName)
+    protected function createQueue(Context $context, $queueName): SqsDestination
     {
-        $queueName = $queueName.time();
-
-        $this->queue = $context->createQueue($queueName);
-        $context->declareQueue($this->queue);
-
-        return $this->queue;
+        return $this->createSqsQueue($context, $queueName);
     }
 }

pkg/sqs/Tests/Spec/SqsSendToAndReceiveFromQueueTest.php

@@ -14,17 +14,13 @@
 class SqsSendToAndReceiveFromQueueTest extends SendToAndReceiveFromQueueSpec
 {
     use SqsExtension;
+    use CreateSqsQueueTrait;
 
     /**
      * @var SqsContext
      */
     private $context;
 
-    /**
-     * @var SqsDestination
-     */
-    private $queue;
-
     protected function tearDown()
     {
         parent::tearDown();
@@ -34,26 +30,13 @@ protected function tearDown()
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function createContext()
+    protected function createContext(): SqsContext
     {
         return $this->context = $this->buildSqsContext();
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @param SqsContext $context
-     */
-    protected function createQueue(Context $context, $queueName)
+    protected function createQueue(Context $context, $queueName): SqsDestination
     {
-        $queueName = $queueName.time();
-
-        $this->queue = $context->createQueue($queueName);
-        $context->declareQueue($this->queue);
-
-        return $this->queue;
+        return $this->createSqsQueue($context, $queueName);
     }
 }

pkg/sqs/Tests/Spec/SqsSendToAndReceiveFromTopicTest.php

@@ -17,17 +17,13 @@ class SqsSendToAndReceiveFromTopicTest extends SendToAndReceiveFromTopicSpec
 {
     use SqsExtension;
     use RetryTrait;
+    use CreateSqsQueueTrait;
 
     /**
      * @var SqsContext
      */
     private $context;
 
-    /**
-     * @var SqsDestination
-     */
-    private $queue;
-
     protected function tearDown()
     {
         parent::tearDown();
@@ -37,26 +33,13 @@ protected function tearDown()
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function createContext()
+    protected function createContext(): SqsContext
     {
         return $this->context = $this->buildSqsContext();
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @param SqsContext $context
-     */
-    protected function createTopic(Context $context, $topicName)
+    protected function createTopic(Context $context, $queueName): SqsDestination
     {
-        $topicName = $topicName.time();
-
-        $this->queue = $context->createTopic($topicName);
-        $context->declareQueue($this->queue);
-
-        return $this->queue;
+        return $this->createSqsQueue($context, $queueName);
     }
 }

pkg/sqs/Tests/Spec/SqsSendToAndReceiveNoWaitFromQueueTest.php

@@ -2,23 +2,41 @@
 
 namespace Enqueue\Sqs\Tests\Spec;
 
+use Enqueue\Sqs\SqsContext;
+use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\SqsExtension;
+use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToAndReceiveNoWaitFromQueueSpec;
 
 /**
  * @group functional
  */
 class SqsSendToAndReceiveNoWaitFromQueueTest extends SendToAndReceiveNoWaitFromQueueSpec
 {
-    public function test()
-    {
-        $this->markTestSkipped('The test is fragile. This is how SQS.');
-    }
+    use SqsExtension;
+    use CreateSqsQueueTrait;
 
     /**
-     * {@inheritdoc}
+     * @var SqsContext
      */
-    protected function createContext()
+    private $context;
+
+    protected function tearDown()
+    {
+        parent::tearDown();
+
+        if ($this->context && $this->queue) {
+            $this->context->deleteQueue($this->queue);
+        }
+    }
+
+    protected function createContext(): SqsContext
+    {
+        return $this->context = $this->buildSqsContext();
+    }
+
+    protected function createQueue(Context $context, $queueName): SqsDestination
     {
-        throw new \LogicException('Should not be ever called');
+        return $this->createSqsQueue($context, $queueName);
     }
 }

pkg/sqs/Tests/Spec/SqsSendToAndReceiveNoWaitFromTopicTest.php

@@ -2,23 +2,41 @@
 
 namespace Enqueue\Sqs\Tests\Spec;
 
+use Enqueue\Sqs\SqsContext;
+use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\SqsExtension;
+use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToAndReceiveNoWaitFromTopicSpec;
 
 /**
  * @group functional
  */
 class SqsSendToAndReceiveNoWaitFromTopicTest extends SendToAndReceiveNoWaitFromTopicSpec
 {
-    public function test()
-    {
-        $this->markTestSkipped('The test is fragile. This is how SQS.');
-    }
+    use SqsExtension;
+    use CreateSqsQueueTrait;
 
     /**
-     * {@inheritdoc}
+     * @var SqsContext
      */
-    protected function createContext()
+    private $context;
+
+    protected function tearDown()
+    {
+        parent::tearDown();
+
+        if ($this->context && $this->queue) {
+            $this->context->deleteQueue($this->queue);
+        }
+    }
+
+    protected function createContext(): SqsContext
+    {
+        return $this->context = $this->buildSqsContext();
+    }
+
+    protected function createTopic(Context $context, $queueName): SqsDestination
     {
-        throw new \LogicException('Should not be ever called');
+        return $this->createSqsQueue($context, $queueName);
     }
 }