Merge pull request #666 from php-enqueue/sqs-another-account

[sqs] Add ability to use another aws account per queue.

docs/transport/sqs.md

@@ -19,6 +19,7 @@ It uses internally official [aws sdk library](https://packagist.org/packages/aws
 * [Send delay message](#send-delay-message)
 * [Consume message](#consume-message)
 * [Purge queue messages](#purge-queue-messages)
+* [Queue from another AWS account](#queue-from-another-aws-account)
 
 ## Installation
 
@@ -122,4 +123,23 @@ $fooQueue = $context->createQueue('foo');
 $context->purgeQueue($fooQueue);
 ```
 
+## Queue from another AWS account
+
+SQS allows to use queues from another account. You could set it globally for all queues via option `queue_owner_aws_account_id` or 
+per queue using `SqsDestination::setQueueOwnerAWSAccountId` method.
+
+```php
+<?php
+use Enqueue\Sqs\SqsConnectionFactory;
+
+// globally for all queues
+$factory = new SqsConnectionFactory('sqs:?queue_owner_aws_account_id=awsAccountId');
+
+$context = (new SqsConnectionFactory('sqs:'))->createContext();
+
+// per queue.
+$queue = $context->createQueue('foo');
+$queue->setQueueOwnerAWSAccountId('awsAccountId');
+```
+
 [back to index](../index.md)

pkg/sqs/SqsContext.php

@@ -153,7 +153,10 @@ public function getQueueUrl(SqsDestination $destination): string
         }
 
         $arguments = ['QueueName' => $destination->getQueueName()];
-        if (false == empty($this->config['queue_owner_aws_account_id'])) {
+
+        if ($destination->getQueueOwnerAWSAccountId()) {
+            $arguments['QueueOwnerAWSAccountId'] = $destination->getQueueOwnerAWSAccountId();
+        } elseif (false == empty($this->config['queue_owner_aws_account_id'])) {
             $arguments['QueueOwnerAWSAccountId'] = $this->config['queue_owner_aws_account_id'];
         }
 

pkg/sqs/SqsDestination.php

@@ -19,6 +19,11 @@ class SqsDestination implements Topic, Queue
      */
     private $attributes;
 
+    /**
+     * @var string|null
+     */
+    private $queueOwnerAWSAccountId;
+
     /**
      * The name of the new queue.
      * The following limits apply to this name:
@@ -187,4 +192,14 @@ public function setContentBasedDeduplication(bool $enable): void
             unset($this->attributes['ContentBasedDeduplication']);
         }
     }
+
+    public function getQueueOwnerAWSAccountId(): ?string
+    {
+        return $this->queueOwnerAWSAccountId;
+    }
+
+    public function setQueueOwnerAWSAccountId(?string $queueOwnerAWSAccountId): void
+    {
+        $this->queueOwnerAWSAccountId = $queueOwnerAWSAccountId;
+    }
 }

pkg/sqs/Tests/Spec/SqsSendToAndReceiveFromQueueTest.php

@@ -4,15 +4,18 @@
 
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\RetryTrait;
 use Enqueue\Test\SqsExtension;
 use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToAndReceiveFromQueueSpec;
 
 /**
  * @group functional
+ * @retry 5
  */
 class SqsSendToAndReceiveFromQueueTest extends SendToAndReceiveFromQueueSpec
 {
+    use RetryTrait;
     use SqsExtension;
     use CreateSqsQueueTrait;
 

pkg/sqs/Tests/Spec/SqsSendToAndReceiveNoWaitFromQueueTest.php

@@ -4,15 +4,18 @@
 
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\RetryTrait;
 use Enqueue\Test\SqsExtension;
 use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToAndReceiveNoWaitFromQueueSpec;
 
 /**
  * @group functional
+ * @retry 5
  */
 class SqsSendToAndReceiveNoWaitFromQueueTest extends SendToAndReceiveNoWaitFromQueueSpec
 {
+    use RetryTrait;
     use SqsExtension;
     use CreateSqsQueueTrait;
 

pkg/sqs/Tests/Spec/SqsSendToAndReceiveNoWaitFromTopicTest.php

@@ -4,15 +4,18 @@
 
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\RetryTrait;
 use Enqueue\Test\SqsExtension;
 use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToAndReceiveNoWaitFromTopicSpec;
 
 /**
  * @group functional
+ * @retry 5
  */
 class SqsSendToAndReceiveNoWaitFromTopicTest extends SendToAndReceiveNoWaitFromTopicSpec
 {
+    use RetryTrait;
     use SqsExtension;
     use CreateSqsQueueTrait;
 

pkg/sqs/Tests/Spec/SqsSendToTopicAndReceiveFromQueueTest.php

@@ -4,15 +4,18 @@
 
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\RetryTrait;
 use Enqueue\Test\SqsExtension;
 use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToTopicAndReceiveFromQueueSpec;
 
 /**
  * @group functional
+ * @retry 5
  */
 class SqsSendToTopicAndReceiveFromQueueTest extends SendToTopicAndReceiveFromQueueSpec
 {
+    use RetryTrait;
     use SqsExtension;
     use CreateSqsQueueTrait;
 

pkg/sqs/Tests/Spec/SqsSendToTopicAndReceiveNoWaitFromQueueTest.php

@@ -4,15 +4,18 @@
 
 use Enqueue\Sqs\SqsContext;
 use Enqueue\Sqs\SqsDestination;
+use Enqueue\Test\RetryTrait;
 use Enqueue\Test\SqsExtension;
 use Interop\Queue\Context;
 use Interop\Queue\Spec\SendToTopicAndReceiveNoWaitFromQueueSpec;
 
 /**
  * @group functional
+ * @retry 5
  */
 class SqsSendToTopicAndReceiveNoWaitFromQueueTest extends SendToTopicAndReceiveNoWaitFromQueueSpec
 {
+    use RetryTrait;
     use SqsExtension;
     use CreateSqsQueueTrait;
 

pkg/sqs/Tests/SqsContextTest.php

@@ -220,7 +220,7 @@ public function testShouldAllowGetQueueUrl()
         $context->getQueueUrl(new SqsDestination('aQueueName'));
     }
 
-    public function testShouldAllowGetQueueUrlFromAnotherAWSAccount()
+    public function testShouldAllowGetQueueUrlFromAnotherAWSAccountSetGlobally()
     {
         $sqsClient = $this->createSqsClientMock();
         $sqsClient
@@ -240,6 +240,29 @@ public function testShouldAllowGetQueueUrlFromAnotherAWSAccount()
         $context->getQueueUrl(new SqsDestination('aQueueName'));
     }
 
+    public function testShouldAllowGetQueueUrlFromAnotherAWSAccountSetPerQueue()
+    {
+        $sqsClient = $this->createSqsClientMock();
+        $sqsClient
+            ->expects($this->once())
+            ->method('getQueueUrl')
+            ->with($this->identicalTo([
+                'QueueName' => 'aQueueName',
+                'QueueOwnerAWSAccountId' => 'anotherAWSAccountID',
+            ]))
+            ->willReturn(new Result(['QueueUrl' => 'theQueueUrl']))
+        ;
+
+        $context = new SqsContext($sqsClient, [
+            'queue_owner_aws_account_id' => null,
+        ]);
+
+        $queue = new SqsDestination('aQueueName');
+        $queue->setQueueOwnerAWSAccountId('anotherAWSAccountID');
+
+        $context->getQueueUrl($queue);
+    }
+
     public function testShouldThrowExceptionIfGetQueueUrlResultHasNoQueueUrlProperty()
     {
         $sqsClient = $this->createSqsClientMock();