Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 3.02 KB

README.md

File metadata and controls

54 lines (34 loc) · 3.02 KB
Raw

NServiceBus.AmazonSQS

NServiceBus.AmazonSQS is the Amazon SQS transport for NServiceBus.

It is part of the Particular Service Platform, which includes NServiceBus and tools to build, monitor, and debug distributed systems.

See the Amazon SQS Transport documentation to learn more.

Running tests locally

The solution contains the NServiceBus Acceptance Test suite and the NServiceBus Transport Test suite.

To run the tests, the Access Key ID and Secret Access Key of an AWS IAM account need to be set in environment variables on the machine running the tests. Full details on how to set this up can be found in the Amazon SQS Transport documentation.

NSERVICEBUS_AMAZONSQS_S3BUCKET enables offloading large messages to S3. This is disabled by default. When enabled, the bucket should not have encryption enabled. For further details review the documentation on configuration options.

AWS Permissions

In addition to the permissions required to run the transport, running the tests also requires:

  • sns:ListSubscriptionsByTopic
  • sns:CreateTopic
  • sns:Subscribe
  • sns:Publish
  • sqs:DeleteQueue
  • sns:DeleteTopic
  • s3:DeleteBucket
  • sqs:DeleteQueue
  • sns:DeleteTopic

Queue Names in Acceptance Tests

The names of queues used by the acceptance tests take the following form:

AT<unique-prefix>-<pre-truncated-queue-name>

Where

  • AT stands for "Acceptance Test"
  • unique-prefix is an identifier that uniquely identifies a single test run so that parallel test runs do not conflict.
  • pre-truncated-queue-name is the name of the queue, "pre-truncated" (characters are removed from the beginning) so that the entire queue name is 80 characters or less.

This scheme accomplishes the following goals:

  • Test runs are idempotent - each test run uses its own set of queues
  • Queues for a given test run are easily searchable by prefix in the SQS portal
  • The discriminator and qualifier at the end of the queue name are not interfered with
  • Queue names fit the 80 character limit imposed by SQS

Cleanup scheduled task

This repo has a GitHub action that deletes stale AWS objects created when the tests run. It takes care of deleting S3 buckets older than 24 hours with the cli- prefix in the name. The same GitHub action code can be updated to delete any other AWS object created by the tests that fail to be deleted during the tests cleanup phase.

The cleanup workflow requires the same permissions as running the tests.