Update docs for amazon-sqs transport along with config validation

Author: TraGicCode

src/BuslyCLI.Console/Config/Validators/AmazonsqsTransportConfigValidator.cs

@@ -0,0 +1,15 @@
+using FluentValidation;
+
+namespace BuslyCLI.Config.Validators;
+
+public class AmazonsqsTransportConfigValidator : AbstractValidator<AmazonsqsTransportConfig>
+{
+    public AmazonsqsTransportConfigValidator()
+    {
+        RuleFor(x => x.RegionName)
+            .NotEmpty();
+
+        RuleFor(x => x.ServiceUrl)
+            .NotEmpty();
+    }
+}

src/BuslyCLI.Console/Config/Validators/TransportConfigValidator.cs

@@ -16,6 +16,7 @@ public TransportConfigValidator()
                 v.Add(new LearningTransportConfigValidator());
                 v.Add(new RabbitMQTransportConfigValidator());
                 v.Add(new AzureServiceBusTransportConfigValidator());
+                v.Add(new AmazonsqsTransportConfigValidator());
             });
 
         // RuleFor(x => x.LearningTransportConfig)

tests/BuslyCLI.Console.Tests/Config/Validators/AmazonsqsTransportConfigValidatorTests.cs

@@ -0,0 +1,80 @@
+using BuslyCLI.Config;
+using BuslyCLI.Config.Validators;
+using FluentValidation.TestHelper;
+
+namespace BuslyCLI.Console.Tests.Config.Validators;
+
+[TestFixture]
+public class AmazonsqsTransportConfigValidatorTests
+{
+    private readonly AmazonsqsTransportConfigValidator _validator;
+
+    public AmazonsqsTransportConfigValidatorTests()
+    {
+        _validator = new AmazonsqsTransportConfigValidator();
+    }
+
+    [Test]
+    public async Task ShouldErrorWhenRegionNameIsNotPassed()
+    {
+        // Arrange
+        var amazonsqsTransportConfig = new AmazonsqsTransportConfig
+        {
+            RegionName = null
+        };
+
+        // Act
+        var result = await _validator.TestValidateAsync(amazonsqsTransportConfig);
+
+        // Assert
+        result.ShouldHaveValidationErrorFor(c => c.RegionName)
+            .WithErrorMessage("'Region Name' must not be empty.");
+    }
+
+    [Test]
+    public async Task ShouldNotErrorWhenRegionNameIsPassed()
+    {
+        // Arrange
+        var amazonsqsTransportConfig = new AmazonsqsTransportConfig
+        {
+            RegionName = "us-east-1"
+        };
+        // Act
+        var result = await _validator.TestValidateAsync(amazonsqsTransportConfig);
+
+        // Assert
+        result.ShouldNotHaveValidationErrorFor(c => c.RegionName);
+    }
+
+    [Test]
+    public async Task ShouldErrorWhenServiceUrlIsNotPassed()
+    {
+        // Arrange
+        var amazonsqsTransportConfig = new AmazonsqsTransportConfig
+        {
+            RegionName = null
+        };
+
+        // Act
+        var result = await _validator.TestValidateAsync(amazonsqsTransportConfig);
+
+        // Assert
+        result.ShouldHaveValidationErrorFor(c => c.ServiceUrl)
+            .WithErrorMessage("'Service Url' must not be empty.");
+    }
+
+    [Test]
+    public async Task ShouldNotErrorWhenServiceUrlIsPassed()
+    {
+        // Arrange
+        var amazonsqsTransportConfig = new AmazonsqsTransportConfig
+        {
+            ServiceUrl = "us-east-1"
+        };
+        // Act
+        var result = await _validator.TestValidateAsync(amazonsqsTransportConfig);
+
+        // Assert
+        result.ShouldNotHaveValidationErrorFor(c => c.ServiceUrl);
+    }
+}

website/docs/transports/amazon-sqs.md

@@ -0,0 +1,59 @@
+# Amazon SQS
+
+The **Amazon SQS Transport** is used to communicate to Amazon SQS.
+
+## Configuration
+
+To use the Amazon SQS Transport, define it under `transports` and reference it as `current-transport`.
+
+### Example
+
+```yaml
+current-transport: local-stack-amazon-sqs
+
+transports:
+  - name: local-stack-amazon-sqs
+    amazonsqs-transport-config:
+      service-url: http://127.0.0.1:32813/
+      region-name: us-east-1
+```
+
+:::info
+
+The Amazon SQS transport implementation currently works only with the LocalStack emulator.
+Pull requests to improve functionality or add support for live AWS SQS are welcome and much appreciated!
+
+:::
+
+---
+
+## `amazonsqs-transport-config` Fields
+
+| Field         | Required | Type   | Default | Description                     |
+| ------------- | -------- | ------ | ------- | ------------------------------- |
+| `service-url` | **Yes**  | string | —       | The Service Url for Amazon SQS. |
+| `region-name` | **Yes**  | string | —       | The region (EX: us-east-1).     |
+
+---
+
+## Field Details
+
+### `service-url` (required)
+
+The Service Url for Amazon SQS.
+
+Examples:
+
+```yaml
+service-url: http://127.0.0.1:32813/
+```
+
+### `region-name` (optional)
+
+Allows Busly to interact with the RabbitMQ Management API for monitoring or queue management.
+
+Examples:
+
+```yaml
+region-name: us-east-1
+```