Add aspire testing instructions

Author: rbev

docs/test-ghcr-tag-aspire/AppHost.cs

@@ -0,0 +1,51 @@
+#:sdk Aspire.AppHost.Sdk@13.4.0
+#:package Particular.Aspire.Hosting.ServicePlatform@1.0.0-alpha.4
+#:package Aspire.Hosting.RabbitMQ@13.4.0
+
+using Aspire.Hosting;
+using Particular.Aspire.Hosting.ServicePlatform.Transport;
+
+var builder = DistributedApplication.CreateBuilder(args);
+
+var transportUserName = builder.AddParameter("transportUserName", "guest", secret: true);
+var transportPassword = builder.AddParameter("transportPassword", "guest", secret: true);
+
+var transport = builder.AddRabbitMQ("transport", transportUserName, transportPassword)
+    .WithManagementPlugin(15672)
+    .WithUrlForEndpoint("management", url => url.DisplayText = "RabbitMQ Management");
+
+builder
+    .AddParticularPlatform("particular")
+    .WithTransportRabbitMQ(RabbitMqRouting.QuorumConventionalRouting, transport)
+    .AddDefaultComponents();
+
+//using positional param for now since there's only one
+if (args.Length > 1)
+{
+    UsePrereleaseImage(builder, args[1]);
+} else {
+    Console.WriteLine("No arguments provided, defaulting to published 'latest' images'");
+}
+
+var app = builder.Build();
+
+await app.RunAsync();
+
+static void UsePrereleaseImage(IDistributedApplicationBuilder builder, string tag)
+{
+    Console.WriteLine($"Using prerelease image tag: {tag}");
+    foreach (var c in builder.Resources.OfType<ContainerResource>())
+    {
+        if (!c.TryGetLastAnnotation<ContainerImageAnnotation>(out var image))
+        {
+            continue;
+        }
+
+        if (image.Image.StartsWith("particular/servicecontrol"))
+        {
+            builder
+                .CreateResourceBuilder(c)
+                .WithImage($"ghcr.io/{image.Image}", tag);
+        }
+    }
+}

docs/test-ghcr-tag-aspire/aspire.config.json

@@ -0,0 +1,5 @@
+{
+  "appHost": {
+    "path": "AppHost.cs"
+  }
+}

docs/testing.md

@@ -63,3 +63,31 @@ Containers built by a PR and stored on GitHub Container Registry can be tested l
     * [Monitoring API](http://localhost:33633)
     * [ServicePulse (latest from Docker Hub)](http://localhost:9090)
 6. Tear down services using `docker compose down`.
+
+
+## Container tests using Aspire
+
+The https://github.com/Particular/Particular.Aspire.Hosting.ServicePlatform package integrates servicecontrol with the Aspire hosting platform. This package configures environment variables to attach the platform. There is a single file apphost in [`testghcr-tag-aspire`](/docs/testghcr-tag-aspire) to start up serviceconrol from a prerelease container image.
+
+Containers built by a PR and stored on GitHub Container Registry can be tested locally:
+
+1. Make sure you have the [Aspire CLI installed](https://aspire.dev/get-started/install-cli/).
+2. [Authenticate to the GitHub Container Registry using a personal access token](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
+    - Create a [classic token](https://github.com/settings/tokens). Select the scope for `read:packages`
+    - Copy the newly created token text.
+    - Run the following command in a terminal:
+       ```shell
+       docker login ghcr.io
+       ```
+      you will be prompted for a username (your particular.net email) and a password (the token)
+    - ensure that you get a successful login message.
+    - Use `docker logout ghcr.io` once the following steps are complete and consider removing the token from github if its no longer needed.
+4. Run `aspire run docs/test-ghcr-tag-aspire/AppHost.cs -- [tag]` to start the application, where [tag] is the PR-based tag (in the form `pr-####`) to test. If no tag is provided, it will default to the `latest` tag.
+5. Once running you can open the dashboard from the link in the terminal, this dashboard will provide the assigned ports for each service.
+    * RabbitMQ Management (Login: `guest`/`guest`)
+    * RavenDB
+    * ServiceControl API
+    * Audit API
+    * Monitoring API
+    * ServicePulse (latest from Docker Hub)
+6. Aspire will automatically tear down the application when you exit the CLI process.