From 28d8d48803e374afacc4df358aeb2ffcc9a5bb5e Mon Sep 17 00:00:00 2001 From: Michael Fyffe <6224270+TraGicCode@users.noreply.github.com> Date: Thu, 4 Dec 2025 06:09:18 -0600 Subject: [PATCH] Update docs for rabbitmq transport along with rabbitmq config validation --- .editorconfig | 1 + .../RabbitMQTransportConfigValidator.cs | 28 ++++++ .../Factories/RawEndpointFactory.cs | 10 +- .../ManagementApiConfigValidatorTests.cs | 96 +++++++++++++++++++ .../RabbitMQTransportConfigValidatorTests.cs | 47 +++++++++ website/docs/transports/learning.md | 16 ++-- website/docs/transports/rabbitmq.md | 80 ++++++++++++++++ website/package-lock.json | 29 +----- 8 files changed, 267 insertions(+), 40 deletions(-) create mode 100644 src/BuslyCLI.Console/Config/Validators/RabbitMQTransportConfigValidator.cs create mode 100644 tests/BuslyCLI.Console.Tests/Config/Validators/ManagementApiConfigValidatorTests.cs create mode 100644 tests/BuslyCLI.Console.Tests/Config/Validators/RabbitMQTransportConfigValidatorTests.cs create mode 100644 website/docs/transports/rabbitmq.md diff --git a/.editorconfig b/.editorconfig index ceab5d72..beb5d104 100644 --- a/.editorconfig +++ b/.editorconfig @@ -26,6 +26,7 @@ indent_size = 2 [*.md] trim_trailing_whitespace = false +indent_size = 2 [*.cs] # Sort using and Import directives with System.* appearing first diff --git a/src/BuslyCLI.Console/Config/Validators/RabbitMQTransportConfigValidator.cs b/src/BuslyCLI.Console/Config/Validators/RabbitMQTransportConfigValidator.cs new file mode 100644 index 00000000..b93002a2 --- /dev/null +++ b/src/BuslyCLI.Console/Config/Validators/RabbitMQTransportConfigValidator.cs @@ -0,0 +1,28 @@ +using FluentValidation; + +namespace BuslyCLI.Config.Validators; + +public class RabbitMQTransportConfigValidator : AbstractValidator +{ + public RabbitMQTransportConfigValidator() + { + RuleFor(x => x.AmqpConnectionString) + .NotEmpty(); + + RuleFor(x => x.ManagementApi) + .SetValidator(new ManagementApiConfigValidator()); + } +} + +public class ManagementApiConfigValidator : AbstractValidator +{ + public ManagementApiConfigValidator() + { + RuleFor(x => x) + .Must(x => + (string.IsNullOrEmpty(x.UserName) && string.IsNullOrEmpty(x.Password)) // both empty + || (!string.IsNullOrEmpty(x.UserName) && !string.IsNullOrEmpty(x.Password)) // both set + ) + .WithMessage("Username and Password are mutually dependent: if one is set, the other must also be set."); + } +} \ No newline at end of file diff --git a/src/BuslyCLI.Console/Factories/RawEndpointFactory.cs b/src/BuslyCLI.Console/Factories/RawEndpointFactory.cs index d7628620..7d8ca9ae 100644 --- a/src/BuslyCLI.Console/Factories/RawEndpointFactory.cs +++ b/src/BuslyCLI.Console/Factories/RawEndpointFactory.cs @@ -43,11 +43,13 @@ private TransportDefinition CreateTransport(TransportConfig transportConfig) private RabbitMQTransport CreateRabbitMQTransport(RabbitmqTransportConfig rabbitmqTransportConfig) { - var t = new RabbitMQTransport(RoutingTopology.Conventional(QueueType.Quorum), - rabbitmqTransportConfig.AmqpConnectionString) + var t = new RabbitMQTransport(RoutingTopology.Conventional(QueueType.Quorum), rabbitmqTransportConfig.AmqpConnectionString); + + if (rabbitmqTransportConfig.ManagementApi != null) { - ManagementApiConfiguration = CreateManagementApiConfig(rabbitmqTransportConfig.ManagementApi) - }; + t.ManagementApiConfiguration = + CreateManagementApiConfig(rabbitmqTransportConfig.ManagementApi); + } return t; } diff --git a/tests/BuslyCLI.Console.Tests/Config/Validators/ManagementApiConfigValidatorTests.cs b/tests/BuslyCLI.Console.Tests/Config/Validators/ManagementApiConfigValidatorTests.cs new file mode 100644 index 00000000..6c623528 --- /dev/null +++ b/tests/BuslyCLI.Console.Tests/Config/Validators/ManagementApiConfigValidatorTests.cs @@ -0,0 +1,96 @@ +using Bogus; +using BuslyCLI.Config; +using BuslyCLI.Config.Validators; +using FluentValidation.TestHelper; + +namespace BuslyCLI.Console.Tests.Config.Validators; + +[TestFixture] +public class ManagementApiConfigValidatorTests +{ + private readonly ManagementApiConfigValidator _validator; + + public ManagementApiConfigValidatorTests() + { + _validator = new ManagementApiConfigValidator(); + } + + // [Test] + // public async Task ShouldErrorWhenAmqpConnectionStringIsNotPassed() + // { + // // Arrange + // var rabbitmqTransportConfig = new ManagementApi() + // { + // AmqpConnectionString = null + // }; + // // Act + // var result = await _validator.TestValidateAsync(rabbitmqTransportConfig); + // + // // Assert + // result.ShouldHaveValidationErrorFor(c => c.AmqpConnectionString) + // .WithErrorMessage("'Amqp Connection String' must not be empty."); + // } + + [Test] + public async Task ShouldNotErrorWhenOnlyAUrlStringIsPassed() + { + // Arrange + var managementApi = new ManagementApi() + { + Url = "http://localhost:15672" + }; + // Act + var result = await _validator.TestValidateAsync(managementApi); + + // Assert + result.ShouldNotHaveValidationErrorFor(c => c.Url); + } + + [Test] + public async Task ShouldNotErrorWhenOnlyCredentialsAreIsPassed() + { + // Arrange + var managementApi = new ManagementApi() + { + UserName = new Faker().Internet.UserName(), + Password = new Faker().Internet.Password() + }; + // Act + var result = await _validator.TestValidateAsync(managementApi); + + // Assert + result.ShouldNotHaveAnyValidationErrors(); + } + + [Test] + public async Task ShouldNotErrorWhenUrlAndCredentialsAreIsPassed() + { + // Arrange + var managementApi = new ManagementApi() + { + Url = "http://localhost:15672", + UserName = new Faker().Internet.UserName(), + Password = new Faker().Internet.Password() + }; + // Act + var result = await _validator.TestValidateAsync(managementApi); + + // Assert + result.ShouldNotHaveAnyValidationErrors(); + } + + [Test] + public async Task ShouldErrorWhenUserNameIsPassedWithoutPassword() + { + // Arrange + var managementApi = new ManagementApi() + { + UserName = new Faker().Internet.UserName() + }; + // Act + var result = await _validator.TestValidateAsync(managementApi); + + // Assert + result.ShouldHaveValidationErrors().WithErrorMessage("Username and Password are mutually dependent: if one is set, the other must also be set."); + } +} \ No newline at end of file diff --git a/tests/BuslyCLI.Console.Tests/Config/Validators/RabbitMQTransportConfigValidatorTests.cs b/tests/BuslyCLI.Console.Tests/Config/Validators/RabbitMQTransportConfigValidatorTests.cs new file mode 100644 index 00000000..532fee5a --- /dev/null +++ b/tests/BuslyCLI.Console.Tests/Config/Validators/RabbitMQTransportConfigValidatorTests.cs @@ -0,0 +1,47 @@ +using BuslyCLI.Config; +using BuslyCLI.Config.Validators; +using FluentValidation.TestHelper; + +namespace BuslyCLI.Console.Tests.Config.Validators; + +[TestFixture] +public class RabbitMQTransportConfigValidatorTests +{ + private readonly RabbitMQTransportConfigValidator _validator; + + public RabbitMQTransportConfigValidatorTests() + { + _validator = new RabbitMQTransportConfigValidator(); + } + + [Test] + public async Task ShouldErrorWhenAmqpConnectionStringIsNotPassed() + { + // Arrange + var rabbitmqTransportConfig = new RabbitmqTransportConfig() + { + AmqpConnectionString = null + }; + // Act + var result = await _validator.TestValidateAsync(rabbitmqTransportConfig); + + // Assert + result.ShouldHaveValidationErrorFor(c => c.AmqpConnectionString) + .WithErrorMessage("'Amqp Connection String' must not be empty."); + } + + [Test] + public async Task ShouldNotErrorWhenAmqpConnectionStringIsPassed() + { + // Arrange + var rabbitmqTransportConfig = new RabbitmqTransportConfig() + { + AmqpConnectionString = "amqp://localhost" + }; + // Act + var result = await _validator.TestValidateAsync(rabbitmqTransportConfig); + + // Assert + result.ShouldNotHaveValidationErrorFor(c => c.AmqpConnectionString); + } +} \ No newline at end of file diff --git a/website/docs/transports/learning.md b/website/docs/transports/learning.md index fb19c883..4ee689b1 100644 --- a/website/docs/transports/learning.md +++ b/website/docs/transports/learning.md @@ -12,20 +12,20 @@ To use the Learning Transport, define it under `transports` and reference it as current-transport: local-learning transports: - - name: local-learning - learning-transport-config: - storage-directory: C:\Source\tutorials-quickstart\.learningtransport - restrict-payload-size: true + - name: local-learning + learning-transport-config: + storage-directory: C:\Source\tutorials-quickstart\.learningtransport + restrict-payload-size: true ``` --- ## `learning-transport-config` Fields -| Field | Required | Type | Default | Description | -| ----------------------- | -------- | ------- | ------- | ----------------------------------------------------------------------------------------------------- | -| `storage-directory` | **Yes** | string | — | Absolute path where Learning Transport stores message files. Busly will not start without this value. | -| `restrict-payload-size` | No | boolean | `true` | Enforces the NServiceBus payload size limit. Set to `false` if you need to send larger payloads. | +| Field | Required | Type | Default | Description | +| ----------------------- | -------- | ------- | ------- | ------------------------------------------------------------------------------------------------ | +| `storage-directory` | **Yes** | string | — | Absolute path where Learning Transport stores message files. | +| `restrict-payload-size` | No | boolean | `true` | Enforces the NServiceBus payload size limit. Set to `false` if you need to send larger payloads. | --- diff --git a/website/docs/transports/rabbitmq.md b/website/docs/transports/rabbitmq.md new file mode 100644 index 00000000..5215c6be --- /dev/null +++ b/website/docs/transports/rabbitmq.md @@ -0,0 +1,80 @@ +# RabbitMQ + +The **RabbitMQ Transport** is used to communicate to RabbitMQ. +It is suitable for development, testing, and production environments. + +## Configuration + +To use the RabbitMQ Transport, define it under `transports` and reference it as `current-transport`. + +### Example + +```yaml +current-transport: local-rabbitmq + +transports: + - name: local-rabbitmq + rabbitmq-transport-config: + amqp-connection-string: amqp://localhost +``` + +--- + +## `rabbitmq-transport-config` Fields + +| Field | Required | Type | Default | Description | +| ------------------------ | -------- | ------ | ------- | ----------------------------------------------------------------- | +| `amqp-connection-string` | **Yes** | string | — | Full AMQP connection string used to connect to RabbitMQ. | +| `management-api` | No | object | — | Optional configuration to connect to the RabbitMQ Management API. | + +--- + +## `management-api` Fields + +| Field | Required | Type | Default | Description | +| ---------- | -------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------- | +| `url` | No | string | — | Base URL for the RabbitMQ Management API. Example: http://localhost:15672. | +| `username` | No | string | — | Username for authenticating with the Management API. If username is provided, password must also be provided. | +| `password` | No | string | — | Password for authenticating with the Management API. If password is provided, username must also be provided. | + +--- + +## Field Details + +### `amqp-connection-string` (required) + +A standard AMQP URI used to connect to RabbitMQ. + +Examples: + +```yaml +amqp-connection-string: amqp://guest:guest@localhost:5672/ +``` + +```yaml +amqp-connection-string: amqps://user:pass@rabbitmq.example.com:5671/my-vhost +``` + +### `management-api` (optional) + +Allows Busly to interact with the RabbitMQ Management API for monitoring or queue management. + +Examples: + +```yaml +management-api: + url: http://localhost:15672 +``` + +```yaml +management-api: + username: admin + password: hello123! +``` + +```yaml +management-api: + url: http://localhost:15672 + username: admin + password: hello123! +``` diff --git a/website/package-lock.json b/website/package-lock.json index 8e47e8b2..2ebda805 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -230,7 +230,6 @@ "resolved": "https://registry.npmjs.org/@algolia/client-search/-/client-search-5.41.0.tgz", "integrity": "sha512-G9I2atg1ShtFp0t7zwleP6aPS4DcZvsV4uoQOripp16aR6VJzbEnKFPLW4OFXzX7avgZSpYeBAS+Zx4FOgmpPw==", "license": "MIT", - "peer": true, "dependencies": { "@algolia/client-common": "5.41.0", "@algolia/requester-browser-xhr": "5.41.0", @@ -356,7 +355,6 @@ "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.28.5.tgz", "integrity": "sha512-e7jT4DxYvIDLk1ZHmU/m/mB19rex9sv0c2ftBtjSBv+kVM/902eh0fINUzD7UwLLNR+jU585GxUJ8/EBfAM5fw==", "license": "MIT", - "peer": true, "dependencies": { "@babel/code-frame": "^7.27.1", "@babel/generator": "^7.28.5", @@ -2146,7 +2144,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": ">=18" }, @@ -2169,7 +2166,6 @@ } ], "license": "MIT", - "peer": true, "engines": { "node": ">=18" } @@ -2279,7 +2275,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -2701,7 +2696,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -3565,7 +3559,6 @@ "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.9.2.tgz", "integrity": "sha512-C5wZsGuKTY8jEYsqdxhhFOe1ZDjH0uIYJ9T/jebHwkyxqnr4wW0jTkB72OMqNjsoQRcb0JN3PcSeTwFlVgzCZg==", "license": "MIT", - "peer": true, "dependencies": { "@docusaurus/core": "3.9.2", "@docusaurus/logger": "3.9.2", @@ -4262,7 +4255,6 @@ "resolved": "https://registry.npmjs.org/@mdx-js/react/-/react-3.1.1.tgz", "integrity": "sha512-f++rKLQgUVYDAtECQ6fn/is15GkEH9+nZPM3MS0RcxVqoTfawHvDlSCH7JbMhAM6uJ32v3eXLvLmLvjGu7PTQw==", "license": "MIT", - "peer": true, "dependencies": { "@types/mdx": "^2.0.0" }, @@ -4581,7 +4573,6 @@ "resolved": "https://registry.npmjs.org/@svgr/core/-/core-8.1.0.tgz", "integrity": "sha512-8QqtOQT5ACVlmsvKOJNEaWmRPmcojMOzCz4Hs2BGG/toAp/K38LcsMRyLp349glq5AzJbCEeimEoxaX6v/fLrA==", "license": "MIT", - "peer": true, "dependencies": { "@babel/core": "^7.21.3", "@svgr/babel-preset": "8.1.0", @@ -4953,7 +4944,6 @@ "resolved": "https://registry.npmjs.org/@types/react/-/react-19.2.2.tgz", "integrity": "sha512-6mDvHUFSjyT2B2yeNx2nUgMxh9LtOWvkhIU3uePn2I2oyNymUAX1NIsdgviM4CH+JSrp2D2hsMvJOkxY+0wNRA==", "license": "MIT", - "peer": true, "dependencies": { "csstype": "^3.0.2" } @@ -5304,7 +5294,6 @@ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.15.0.tgz", "integrity": "sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==", "license": "MIT", - "peer": true, "bin": { "acorn": "bin/acorn" }, @@ -5390,7 +5379,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -5436,7 +5424,6 @@ "resolved": "https://registry.npmjs.org/algoliasearch/-/algoliasearch-5.41.0.tgz", "integrity": "sha512-9E4b3rJmYbBkn7e3aAPt1as+VVnRhsR4qwRRgOzpeyz4PAOuwKh0HI4AN6mTrqK0S0M9fCCSTOUnuJ8gPY/tvA==", "license": "MIT", - "peer": true, "dependencies": { "@algolia/abtesting": "1.7.0", "@algolia/client-abtesting": "5.41.0", @@ -5900,7 +5887,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "baseline-browser-mapping": "^2.8.19", "caniuse-lite": "^1.0.30001751", @@ -6857,7 +6843,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -8231,7 +8216,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -12693,7 +12677,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -13209,7 +13192,6 @@ } ], "license": "MIT", - "peer": true, "dependencies": { "nanoid": "^3.3.11", "picocolors": "^1.1.1", @@ -14113,7 +14095,6 @@ "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-7.1.0.tgz", "integrity": "sha512-8sLjZwK0R+JlxlYcTuVnyT2v+htpdrjDOKuMcOVdYjt52Lh8hWRYpxBPoKx/Zg+bcjc3wx6fmQevMmUztS/ccA==", "license": "MIT", - "peer": true, "dependencies": { "cssesc": "^3.0.0", "util-deprecate": "^1.0.2" @@ -14908,7 +14889,6 @@ "resolved": "https://registry.npmjs.org/react/-/react-19.2.0.tgz", "integrity": "sha512-tmbWg6W31tQLeB5cdIBOicJDJRR2KzXsV7uSK9iNfLWQ5bIZfxuPEHp7M8wiHyHnn0DD1i7w3Zmin0FtkrwoCQ==", "license": "MIT", - "peer": true, "engines": { "node": ">=0.10.0" } @@ -14918,7 +14898,6 @@ "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-19.2.0.tgz", "integrity": "sha512-UlbRu4cAiGaIewkPyiRGJk0imDN2T3JjieT6spoL2UeSf5od4n5LB/mQ4ejmxhCFT1tYe8IvaFulzynWovsEFQ==", "license": "MIT", - "peer": true, "dependencies": { "scheduler": "^0.27.0" }, @@ -14974,7 +14953,6 @@ "resolved": "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz", "integrity": "sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==", "license": "MIT", - "peer": true, "dependencies": { "@types/react": "*" }, @@ -15003,7 +14981,6 @@ "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", "license": "MIT", - "peer": true, "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -16776,8 +16753,7 @@ "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", - "license": "0BSD", - "peer": true + "license": "0BSD" }, "node_modules/type-fest": { "version": "2.19.0", @@ -17167,7 +17143,6 @@ "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", "license": "MIT", - "peer": true, "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -17375,7 +17350,6 @@ "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.102.1.tgz", "integrity": "sha512-7h/weGm9d/ywQ6qzJ+Xy+r9n/3qgp/thalBbpOi5i223dPXKi04IBtqPN9nTd+jBc7QKfvDbaBnFipYp4sJAUQ==", "license": "MIT", - "peer": true, "dependencies": { "@types/eslint-scope": "^3.7.7", "@types/estree": "^1.0.8", @@ -17962,7 +17936,6 @@ "resolved": "https://registry.npmjs.org/zod/-/zod-4.1.12.tgz", "integrity": "sha512-JInaHOamG8pt5+Ey8kGmdcAcg3OL9reK8ltczgHTAwNhMys/6ThXHityHxVV2p3fkw/c+MAvBHFVYHFZDmjMCQ==", "license": "MIT", - "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" }