Add support for storage queue subscribers (#211)

* Add support for storage queue subscribers
* Remove Newtonsoft.Json
* Support topic level auth
* Improve test coverage
* Add seq to docker compose file
* Remove Mediatr dependency

Author: pm7y

AGENTS.md

@@ -16,14 +16,13 @@ services:
       - ASPNETCORE_Kestrel__Certificates__Default__Path=/aegs/azureEventGridSimulator.pfx
       - ASPNETCORE_Kestrel__Certificates__Default__Password=Y0urSup3rCrypt1cPa55w0rd!
 
-      # you could also define topics/subscribers via via a configfile
+      # topics, subscribers, and logging config
       - AEGS_ConfigFile=/aegs/appsettings.docker.json
 
-      # logging configuration
-      - AEGS_Serilog__MinimumLevel__Default=Verbose
-
     depends_on:
       - servicebus-emulator
+      - azurite
+      - seq
 
     networks:
       - aegs-network
@@ -32,6 +31,37 @@ services:
       context: .
       dockerfile: ./Dockerfile
 
+  # Seq - Structured Log Server
+  # See: https://docs.datalust.co/docs/getting-started-with-docker
+  seq:
+    container_name: seq
+    image: datalust/seq:latest
+    ports:
+      - "5341:5341"   # Ingestion API
+      - "8081:80"     # Web UI
+    environment:
+      - ACCEPT_EULA=Y
+      - SEQ_FIRSTRUN_NOAUTHENTICATION=true
+    networks:
+      aegs-network:
+        aliases:
+          - seq
+
+  # Azurite - Azure Storage Emulator
+  # See: https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite
+  azurite:
+    container_name: azurite
+    image: mcr.microsoft.com/azure-storage/azurite:latest
+    ports:
+      - "10000:10000"   # Blob service
+      - "10001:10001"   # Queue service
+      - "10002:10002"   # Table service
+    command: "azurite --blobHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0"
+    networks:
+      aegs-network:
+        aliases:
+          - azurite
+
   # Azure Service Bus Emulator
   # See: https://learn.microsoft.com/en-us/azure/service-bus-messaging/test-locally-with-service-bus-emulator
   servicebus-emulator:

DOCKER.md

@@ -1,4 +1,22 @@
 {
+  "Serilog": {
+    "Using": [
+      "Serilog.Sinks.Console",
+      "Serilog.Sinks.Seq"
+    ],
+    "MinimumLevel": {
+      "Default": "Verbose"
+    },
+    "WriteTo": [
+      { "Name": "Console" },
+      {
+        "Name": "Seq",
+        "Args": {
+          "serverUrl": "http://seq:5341"
+        }
+      }
+    ]
+  },
   "topics": [
     {
       "name": "ExampleTopic",
@@ -43,6 +61,13 @@
               }
             }
           }
+        ],
+        "storageQueue": [
+          {
+            "name": "StorageQueueSubscription",
+            "connectionString": "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;QueueEndpoint=http://azurite:10001/devstoreaccount1;",
+            "queueName": "eventgrid-events"
+          }
         ]
       }
     }

docker-compose.yml

@@ -16,15 +16,10 @@ namespace AzureEventGridSimulator.Tests.ActualSimulatorTests;
 /// </summary>
 [Collection(nameof(ActualSimulatorFixtureCollection))]
 [Trait("Category", "integration-actual")]
-public class AzureMessagingEventGridTest
+public class AzureMessagingEventGridTest(ActualSimulatorFixture actualSimulatorFixture)
 {
     // ReSharper disable once NotAccessedField.Local
-    private readonly ActualSimulatorFixture _actualSimulatorFixture;
-
-    public AzureMessagingEventGridTest(ActualSimulatorFixture actualSimulatorFixture)
-    {
-        _actualSimulatorFixture = actualSimulatorFixture;
-    }
+    private readonly ActualSimulatorFixture _actualSimulatorFixture = actualSimulatorFixture;
 
     [Fact]
     public async Task GivenValidEvent_WhenUriContainsNonStandardPort_ThenItShouldBeAccepted()

docker/appsettings.docker.json

@@ -7,7 +7,7 @@
   <ItemGroup>
     <PackageReference Include="Azure.Messaging.EventGrid" />
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" />
-    <PackageReference Include="Newtonsoft.Json" />
+    <PackageReference Include="NSubstitute" />
     <PackageReference Include="Shouldly" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
     <PackageReference Include="xunit" />

src/AzureEventGridSimulator.Tests/ActualSimulatorTests/AzureMessagingEventGridTest.cs

@@ -2,11 +2,11 @@
 using System.Net;
 using System.Net.Http;
 using System.Text;
+using System.Text.Json;
 using System.Threading.Tasks;
 using Azure.Messaging.EventGrid;
 using AzureEventGridSimulator.Domain;
 using Microsoft.AspNetCore.Mvc.Testing;
-using Newtonsoft.Json;
 using Shouldly;
 using Xunit;
 
@@ -18,20 +18,14 @@ namespace AzureEventGridSimulator.Tests.IntegrationTests;
 /// Note: this is a WIP.
 /// </summary>
 [Trait("Category", "integration")]
-public class BasicTests : IClassFixture<IntegrationContextFixture>
+public class BasicTests(IntegrationContextFixture factory)
+    : IClassFixture<IntegrationContextFixture>
 {
-    private readonly IntegrationContextFixture _factory;
-
-    public BasicTests(IntegrationContextFixture factory)
-    {
-        _factory = factory;
-    }
-
     [Fact]
     public async Task GivenAValidEvent_WhenPublished_ThenItShouldBeAccepted()
     {
         // Arrange
-        var client = _factory.CreateClient(
+        var client = factory.CreateClient(
             new WebApplicationFactoryClientOptions
             {
                 BaseAddress = new Uri("https://localhost:60101"),
@@ -45,7 +39,10 @@ public async Task GivenAValidEvent_WhenPublished_ThenItShouldBeAccepted()
         );
 
         var testEvent = new EventGridEvent("subject", "eventType", "1.0", new { Blah = 1 });
-        var json = JsonConvert.SerializeObject(new[] { testEvent }, Formatting.Indented);
+        var json = JsonSerializer.Serialize(
+            new[] { testEvent },
+            new JsonSerializerOptions { WriteIndented = true }
+        );
 
         // Act
         var jsonContent = new StringContent(json, Encoding.UTF8, "application/json");
@@ -60,7 +57,7 @@ public async Task GivenAValidEvent_WhenPublished_ThenItShouldBeAccepted()
     public async Task GivenAHealthRequest_ThenItShouldRespondWithOk()
     {
         // Arrange
-        var client = _factory.CreateClient(
+        var client = factory.CreateClient(
             new WebApplicationFactoryClientOptions
             {
                 BaseAddress = new Uri("https://localhost:60101"),

src/AzureEventGridSimulator.Tests/AzureEventGridSimulator.Tests.csproj

@@ -1,6 +1,6 @@
+using System.Text.Json;
 using AzureEventGridSimulator.Domain.Entities;
 using AzureEventGridSimulator.Domain.Services;
-using Newtonsoft.Json.Linq;
 using Shouldly;
 using Xunit;
 
@@ -26,13 +26,14 @@ public void GivenCloudEvent_WhenSerialized_ThenJsonContainsAllRequiredFields()
         var json = _formatter.Serialize(simulatorEvent);
 
         // Azure Event Grid sends events "in an array that has a single event"
-        var array = JArray.Parse(json);
-        array.Count.ShouldBe(1);
+        using var doc = JsonDocument.Parse(json);
+        var array = doc.RootElement;
+        array.GetArrayLength().ShouldBe(1);
         var parsed = array[0];
-        parsed["specversion"]?.ToString().ShouldBe("1.0");
-        parsed["type"]?.ToString().ShouldBe("com.example.test");
-        parsed["source"]?.ToString().ShouldBe("/test/source");
-        parsed["id"]?.ToString().ShouldBe("test-id-123");
+        parsed.GetProperty("specversion").GetString().ShouldBe("1.0");
+        parsed.GetProperty("type").GetString().ShouldBe("com.example.test");
+        parsed.GetProperty("source").GetString().ShouldBe("/test/source");
+        parsed.GetProperty("id").GetString().ShouldBe("test-id-123");
     }
 
     [Fact]
@@ -52,12 +53,13 @@ public void GivenCloudEventWithOptionalFields_WhenSerialized_ThenJsonContainsOpt
         var simulatorEvent = SimulatorEvent.FromCloudEvent(cloudEvent);
         var json = _formatter.Serialize(simulatorEvent);
 
-        var array = JArray.Parse(json);
-        array.Count.ShouldBe(1);
+        using var doc = JsonDocument.Parse(json);
+        var array = doc.RootElement;
+        array.GetArrayLength().ShouldBe(1);
         var parsed = array[0];
-        parsed["subject"]?.ToString().ShouldBe("/test/subject");
-        parsed["time"].ShouldNotBeNull(); // Time format may vary by locale
-        parsed["data"].ShouldNotBeNull();
+        parsed.GetProperty("subject").GetString().ShouldBe("/test/subject");
+        parsed.TryGetProperty("time", out _).ShouldBeTrue(); // Time format may vary by locale
+        parsed.TryGetProperty("data", out _).ShouldBeTrue();
     }
 
     [Fact]
@@ -76,15 +78,16 @@ public void GivenEventGridEvent_WhenSerializedAsCloudEvent_ThenConvertedCorrectl
         var simulatorEvent = SimulatorEvent.FromEventGridEvent(eventGridEvent);
         var json = _formatter.Serialize(simulatorEvent);
 
-        var array = JArray.Parse(json);
-        array.Count.ShouldBe(1);
+        using var doc = JsonDocument.Parse(json);
+        var array = doc.RootElement;
+        array.GetArrayLength().ShouldBe(1);
         var parsed = array[0];
-        parsed["specversion"]?.ToString().ShouldBe("1.0");
-        parsed["type"]?.ToString().ShouldBe("Test.Event.Type");
-        parsed["source"]?.ToString().ShouldBe("/test/topic");
-        parsed["id"]?.ToString().ShouldBe("event-123");
-        parsed["subject"]?.ToString().ShouldBe("/test/subject");
-        parsed["time"].ShouldNotBeNull(); // Time format may vary by locale
+        parsed.GetProperty("specversion").GetString().ShouldBe("1.0");
+        parsed.GetProperty("type").GetString().ShouldBe("Test.Event.Type");
+        parsed.GetProperty("source").GetString().ShouldBe("/test/topic");
+        parsed.GetProperty("id").GetString().ShouldBe("event-123");
+        parsed.GetProperty("subject").GetString().ShouldBe("/test/subject");
+        parsed.TryGetProperty("time", out _).ShouldBeTrue(); // Time format may vary by locale
     }
 
     [Fact]