Aspire: Add WithProtoDefinition to support proto definition at server level (#1383)

* Add property UseHttp2 to WireMockServerArguments

* .

* additionalUrls

* ok?

* WireMockServerArguments

* fx

* AddProtoDefinition

* ...

* FIX

* Always add the lifecycle hook to support dynamic mappings and proto definitions

src/WireMock.Net.Abstractions/Admin/Mappings/StatusModel.cs

@@ -24,4 +24,13 @@ public class StatusModel
     /// The error message.
     /// </summary>
     public string? Error { get; set; }
+
+    /// <summary>
+    /// Returns a string that represents the current status model, including its unique identifier, status, and error information.
+    /// </summary>
+    /// <returns>A string containing the values of the Guid, Status, and Error properties formatted for display.</returns>
+    public override string ToString()
+    {
+        return $"StatusModel [Guid={Guid}, Status={Status}, Error={Error}]";
+    }
 }

src/WireMock.Net.Aspire/WireMock.Net.Aspire.csproj

@@ -30,7 +30,10 @@
     </ItemGroup>
 
     <ItemGroup>
-        <Compile Include="..\WireMock.Net.Minimal\Util\EnhancedFileSystemWatcher.cs" Link="Utils\EnhancedFileSystemWatcher.cs" />
+        <Compile Include="..\WireMock.Net.Minimal\Util\EnhancedFileSystemWatcher.cs" Link="Util\EnhancedFileSystemWatcher.cs" />
+        <Compile Include="..\WireMock.Net.Minimal\Constants\WireMockConstants.cs" Link="Constants\WireMockConstants.cs" />
+        <Compile Include="..\WireMock.Net.Shared\Constants\RegexConstants.cs" Link="Constants\RegexConstants.cs" />
+        <Compile Include="..\WireMock.Net.Minimal\Util\PortUtils.cs" Link="Util\PortUtils.cs" />
     </ItemGroup>
 
     <PropertyGroup Condition="'$(Configuration)' == 'Debug - Sonar'">

src/WireMock.Net.Aspire/WireMockMappingState.cs

@@ -4,7 +4,9 @@ namespace WireMock.Net.Aspire;
 
 internal enum WireMockMappingState
 {
-    NoMappings,
-    NotSubmitted,
-    Submitted,
-}
+    NoMappings = 0,
+
+    NotSubmitted = 1,
+
+    Submitted = 2
+}

src/WireMock.Net.Aspire/WireMockServerArguments.cs

@@ -1,7 +1,9 @@
 // Copyright © WireMock.Net
 
 using System.Diagnostics.CodeAnalysis;
+using Stef.Validation;
 using WireMock.Client.Builders;
+using WireMock.Util;
 
 // ReSharper disable once CheckNamespace
 namespace Aspire.Hosting;
@@ -21,10 +23,15 @@ public class WireMockServerArguments
     private const string DefaultLogger = "WireMockConsoleLogger";
 
     /// <summary>
-    /// The HTTP port where WireMock.Net is listening.
+    /// The HTTP ports where WireMock.Net is listening on.
     /// If not defined, .NET Aspire automatically assigns a random port.
     /// </summary>
-    public int? HttpPort { get; set; }
+    public List<int> HttpPorts { get; set; } = [];
+
+    /// <summary>
+    /// Additional Urls on which WireMock listens.
+    /// </summary>
+    public List<string> AdditionalUrls { get; set; } = [];
 
     /// <summary>
     /// The admin username.
@@ -67,6 +74,42 @@ public class WireMockServerArguments
     /// </summary>
     public Func<AdminApiMappingBuilder, CancellationToken, Task>? ApiMappingBuilder { get; set; }
 
+    /// <summary>
+    /// Grpc ProtoDefinitions.
+    /// </summary>
+    public Dictionary<string, string[]> ProtoDefinitions { get; set; } = [];
+
+    /// <summary>
+    /// Add an additional Urls on which WireMock should listen.
+    /// </summary>
+    /// <param name="additionalUrls">The additional urls which the WireMock Server should listen on.</param>
+    public void WithAdditionalUrls(params string[] additionalUrls)
+    {
+        foreach (var url in additionalUrls)
+        {
+            if (!PortUtils.TryExtract(Guard.NotNullOrEmpty(url), out _, out _, out _, out _, out var port))
+            {
+                throw new ArgumentException($"The URL '{url}' is not valid.");
+            }
+
+            AdditionalUrls.Add(Guard.NotNullOrWhiteSpace(url));
+            HttpPorts.Add(port);
+        }
+    }
+
+    /// <summary>
+    /// Add a Grpc ProtoDefinition at server-level.
+    /// </summary>
+    /// <param name="id">Unique identifier for the ProtoDefinition.</param>
+    /// <param name="protoDefinitions">The ProtoDefinition as text.</param>
+    public void WithProtoDefinition(string id, params string[] protoDefinitions)
+    {
+        Guard.NotNullOrWhiteSpace(id);
+        Guard.NotNullOrEmpty(protoDefinitions);
+
+        ProtoDefinitions[id] = protoDefinitions;
+    }
+
     /// <summary>
     /// Converts the current instance's properties to an array of command-line arguments for starting the WireMock.Net server.
     /// </summary>
@@ -95,6 +138,11 @@ public class WireMockServerArguments
             Add(args, "--WatchStaticMappingsInSubdirectories", "true");
         }
 
+        if (AdditionalUrls.Count > 0)
+        {
+            Add(args, "--Urls", $"http://*:{HttpContainerPort} {string.Join(' ', AdditionalUrls)}");
+        }
+
         return args
             .SelectMany(k => new[] { k.Key, k.Value })
             .ToArray();

src/WireMock.Net.Aspire/WireMockServerBuilderExtensions.cs

@@ -8,6 +8,7 @@ using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Stef.Validation;
 using WireMock.Client.Builders;
 using WireMock.Net.Aspire;
+using WireMock.Util;
 
 // ReSharper disable once CheckNamespace
 namespace Aspire.Hosting;
@@ -34,9 +35,31 @@ public static class WireMockServerBuilderExtensions
         Guard.NotNullOrWhiteSpace(name);
         Guard.Condition(port, p => p is null or > 0 and <= ushort.MaxValue);
 
-        return builder.AddWireMock(name, callback =>
+        return builder.AddWireMock(name, serverArguments =>
         {
-            callback.HttpPort = port;
+            if (port != null)
+            {
+                serverArguments.HttpPorts = [port.Value];
+            }
+        });
+    }
+
+    /// <summary>
+    /// Adds a WireMock.Net Server resource to the application model.
+    /// </summary>
+    /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
+    /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
+    /// <param name="additionalUrls">The additional urls which the WireMock Server should listen on.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
+    public static IResourceBuilder<WireMockServerResource> AddWireMock(this IDistributedApplicationBuilder builder, string name, params string[] additionalUrls)
+    {
+        Guard.NotNull(builder);
+        Guard.NotNullOrWhiteSpace(name);
+        Guard.NotNull(additionalUrls);
+
+        return builder.AddWireMock(name, serverArguments =>
+        {
+            serverArguments.WithAdditionalUrls(additionalUrls);
         });
     }
 
@@ -67,10 +90,37 @@ public static class WireMockServerBuilderExtensions
             .AddResource(wireMockContainerResource)
             .WithImage(DefaultLinuxImage)
             .WithEnvironment(ctx => ctx.EnvironmentVariables.Add("DOTNET_USE_POLLING_FILE_WATCHER", "1")) // https://khalidabuhakmeh.com/aspnet-docker-gotchas-and-workarounds#configuration-reloads-and-filesystemwatcher
-            .WithHttpEndpoint(port: arguments.HttpPort, targetPort: WireMockServerArguments.HttpContainerPort)
             .WithHealthCheck(healthCheckKey)
             .WithWireMockInspectorCommand();
 
+        if (arguments.HttpPorts.Count == 0)
+        {
+            resourceBuilder = resourceBuilder.WithHttpEndpoint(port: null, targetPort: WireMockServerArguments.HttpContainerPort);
+        }
+        else if (arguments.HttpPorts.Count == 1)
+        {
+            resourceBuilder = resourceBuilder.WithHttpEndpoint(port: arguments.HttpPorts[0], targetPort: WireMockServerArguments.HttpContainerPort);
+        }
+        else
+        {
+            // Required for the default admin endpoint and health checks
+            resourceBuilder = resourceBuilder.WithHttpEndpoint(port: null, targetPort: WireMockServerArguments.HttpContainerPort);
+
+            var anyIsHttp2 = false;
+            foreach (var url in arguments.AdditionalUrls)
+            {
+                PortUtils.TryExtract(url, out _, out var isHttp2, out var scheme, out _, out var httpPort);
+                anyIsHttp2 |= isHttp2;
+
+                resourceBuilder = resourceBuilder.WithEndpoint(port: httpPort, targetPort: httpPort, scheme: scheme, name: $"{scheme}-{httpPort}");
+            }
+
+            if (anyIsHttp2)
+            {
+                resourceBuilder = resourceBuilder.AsHttp2Service();
+            }
+        }
+
         if (!string.IsNullOrEmpty(arguments.MappingsPath))
         {
             resourceBuilder = resourceBuilder.WithBindMount(arguments.MappingsPath, DefaultLinuxMappingsPath);
@@ -84,6 +134,9 @@ public static class WireMockServerBuilderExtensions
             }
         });
 
+        // Always add the lifecycle hook to support dynamic mappings and proto definitions
+        resourceBuilder.ApplicationBuilder.Services.TryAddLifecycleHook<WireMockServerLifecycleHook>();
+
         return resourceBuilder;
     }
 
@@ -94,7 +147,10 @@ public static class WireMockServerBuilderExtensions
     /// <param name="name">The name of the resource. This name will be used as the connection string name when referenced in a dependency.</param>
     /// <param name="callback">A callback that allows for setting the <see cref="WireMockServerArguments"/>.</param>
     /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
-    public static IResourceBuilder<WireMockServerResource> AddWireMock(this IDistributedApplicationBuilder builder, string name, Action<WireMockServerArguments> callback)
+    public static IResourceBuilder<WireMockServerResource> AddWireMock(
+        this IDistributedApplicationBuilder builder,
+        string name,
+        Action<WireMockServerArguments> callback)
     {
         Guard.NotNull(builder);
         Guard.NotNullOrWhiteSpace(name);
@@ -165,7 +221,7 @@ public static class WireMockServerBuilderExtensions
     /// </summary>
     /// <param name="wiremock">The <see cref="IResourceBuilder{WireMockServerResource}"/>.</param>
     /// <param name="configure">Delegate that will be invoked to configure the WireMock.Net resource.</param>
-    /// <returns></returns>
+    /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
     public static IResourceBuilder<WireMockServerResource> WithApiMappingBuilder(this IResourceBuilder<WireMockServerResource> wiremock, Func<AdminApiMappingBuilder, Task> configure)
     {
         return wiremock.WithApiMappingBuilder((adminApiMappingBuilder, _) => configure.Invoke(adminApiMappingBuilder));
@@ -176,18 +232,31 @@ public static class WireMockServerBuilderExtensions
     /// </summary>
     /// <param name="wiremock">The <see cref="IResourceBuilder{WireMockServerResource}"/>.</param>
     /// <param name="configure">Delegate that will be invoked to configure the WireMock.Net resource.</param>
-    /// <returns></returns>
+    /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
     public static IResourceBuilder<WireMockServerResource> WithApiMappingBuilder(this IResourceBuilder<WireMockServerResource> wiremock, Func<AdminApiMappingBuilder, CancellationToken, Task> configure)
     {
         Guard.NotNull(wiremock);
 
-        wiremock.ApplicationBuilder.Services.TryAddLifecycleHook<WireMockServerLifecycleHook>();
         wiremock.Resource.Arguments.ApiMappingBuilder = configure;
         wiremock.Resource.ApiMappingState = WireMockMappingState.NotSubmitted;
 
         return wiremock;
     }
 
+    /// <summary>
+    /// Add a Grpc ProtoDefinition at server-level.
+    /// </summary>
+    /// <param name="wiremock">The <see cref="IResourceBuilder{WireMockServerResource}"/>.</param>
+    /// <param name="id">Unique identifier for the ProtoDefinition.</param>
+    /// <param name="protoDefinitions">The ProtoDefinition as text.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
+    public static IResourceBuilder<WireMockServerResource> WithProtoDefinition(this IResourceBuilder<WireMockServerResource> wiremock, string id, params string[] protoDefinitions)
+    {
+        Guard.NotNull(wiremock).Resource.Arguments.WithProtoDefinition(id, protoDefinitions);
+
+        return wiremock;
+    }
+
     /// <summary>
     /// Enables the WireMockInspect, a cross-platform UI app that facilitates WireMock troubleshooting.
     /// This requires installation of the WireMockInspector tool.
@@ -195,11 +264,11 @@ public static class WireMockServerBuilderExtensions
     /// dotnet tool install WireMockInspector --global --no-cache --ignore-failed-sources
     /// </code>
     /// </summary>
-    /// <param name="builder">The <see cref="IResourceBuilder{WireMockNetResource}"/>.</param>
-    /// <returns></returns>
-    public static IResourceBuilder<WireMockServerResource> WithWireMockInspectorCommand(this IResourceBuilder<WireMockServerResource> builder)
+    /// <param name="wiremock">The <see cref="IResourceBuilder{WireMockNetResource}"/>.</param>
+    /// <returns>A reference to the <see cref="IResourceBuilder{WireMockServerResource}"/>.</returns>
+    public static IResourceBuilder<WireMockServerResource> WithWireMockInspectorCommand(this IResourceBuilder<WireMockServerResource> wiremock)
     {
-        Guard.NotNull(builder);
+        Guard.NotNull(wiremock);
 
         CommandOptions commandOptions = new()
         {
@@ -209,13 +278,13 @@ public static class WireMockServerBuilderExtensions
             IconVariant = IconVariant.Filled
         };
 
-        builder.WithCommand(
+        wiremock.WithCommand(
             name: "wiremock-inspector",
             displayName: "WireMock Inspector",
-            executeCommand: _ => OnRunOpenInspectorCommandAsync(builder),
+            executeCommand: _ => OnRunOpenInspectorCommandAsync(wiremock),
             commandOptions: commandOptions);
 
-        return builder;
+        return wiremock;
     }
 
     private static Task<ExecuteCommandResult> OnRunOpenInspectorCommandAsync(IResourceBuilder<WireMockServerResource> builder)

src/WireMock.Net.Aspire/WireMockServerLifecycleHook.cs

@@ -1,5 +1,6 @@
 // Copyright © WireMock.Net
 
+using System.Diagnostics;
 using Aspire.Hosting.ApplicationModel;
 using Aspire.Hosting.Lifecycle;
 using Microsoft.Extensions.Logging;
@@ -28,10 +29,12 @@ internal class WireMockServerLifecycleHook(ILoggerFactory loggerFactory) : IDist
                 wireMockServerResource.SetLogger(loggerFactory.CreateLogger<WireMockServerResource>());
 
                 var endpoint = wireMockServerResource.GetEndpoint();
-                System.Diagnostics.Debug.Assert(endpoint.IsAllocated);
+                Debug.Assert(endpoint.IsAllocated);
 
                 await wireMockServerResource.WaitForHealthAsync(_linkedCts.Token);
 
+                await wireMockServerResource.CallAddProtoDefinitionsAsync(_linkedCts.Token);
+
                 await wireMockServerResource.CallApiMappingBuilderActionAsync(_linkedCts.Token);
 
                 wireMockServerResource.StartWatchingStaticMappings(_linkedCts.Token);

src/WireMock.Net.Aspire/WireMockServerResource.cs

@@ -70,6 +70,34 @@ public class WireMockServerResource : ContainerResource, IResourceWithServiceDis
         ApiMappingState = WireMockMappingState.Submitted;
     }
 
+    internal async Task CallAddProtoDefinitionsAsync(CancellationToken cancellationToken)
+    {
+        _logger?.LogInformation("Calling AdminApi to add GRPC ProtoDefinition at server level to WireMock.Net");
+
+        foreach (var (id, protoDefinitions) in Arguments.ProtoDefinitions)
+        {
+            _logger?.LogInformation("Adding ProtoDefinition {Id}", id);
+            foreach (var protoDefinition in protoDefinitions)
+            {
+                try
+                {
+                    var status = await AdminApi.Value.AddProtoDefinitionAsync(id, protoDefinition, cancellationToken);
+                    _logger?.LogInformation("ProtoDefinition '{Id}' added with status: {Status}.", id, status.Status);
+                }
+                catch (Exception ex)
+                {
+                    _logger?.LogWarning(ex, "Error adding ProtoDefinition '{Id}'.", id);
+                }
+            }
+        }
+
+        // Force a reload of static mappings when ProtoDefinitions are added at server-level to fix #1382
+        if (Arguments.ProtoDefinitions.Count > 0)
+        {
+            await ReloadStaticMappingsAsync(default);
+        }
+    }
+
     internal void StartWatchingStaticMappings(CancellationToken cancellationToken)
     {
         if (!Arguments.WatchStaticMappings || string.IsNullOrEmpty(Arguments.MappingsPath))
@@ -113,10 +141,17 @@ public class WireMockServerResource : ContainerResource, IResourceWithServiceDis
 
     private async void FileCreatedChangedOrDeleted(object sender, FileSystemEventArgs args)
     {
-        _logger?.LogInformation("MappingFile created, changed or deleted: '{0}'. Triggering ReloadStaticMappings.", args.FullPath);
+        _logger?.LogInformation("MappingFile created, changed or deleted: '{FullPath}'. Triggering ReloadStaticMappings.", args.FullPath);
+
+        await ReloadStaticMappingsAsync(default);
+    }
+
+    private async Task ReloadStaticMappingsAsync(CancellationToken cancellationToken)
+    {
         try
         {
-            await AdminApi.Value.ReloadStaticMappingsAsync();
+            var status = await AdminApi.Value.ReloadStaticMappingsAsync(cancellationToken);
+            _logger?.LogInformation("ReloadStaticMappings called with status: {Status}.", status);
         }
         catch (Exception ex)
         {

src/WireMock.Net.Minimal/Settings/SimpleSettingsParser.cs

@@ -55,7 +55,7 @@ internal class SimpleSettingsParser
         // Now also parse environment
         if (environment != null)
         {
-            foreach (string key in environment.Keys)
+            foreach (var key in environment.Keys.OfType<string>())
             {
                 if (key.StartsWith(Prefix, StringComparison.OrdinalIgnoreCase) && environment.TryGetStringValue(key, out var value))
                 {

src/WireMock.Net.Minimal/Settings/WireMockServerSettingsParser.cs

@@ -153,7 +153,7 @@ public static class WireMockServerSettingsParser
         }
         else if (settings.HostingScheme is null)
         {
-            settings.Urls = parser.GetValues("Urls", ["http://*:9091/"]);
+            settings.Urls = parser.GetValues(nameof(WireMockServerSettings.Urls), defaultValue: ["http://*:9091/"]);
         }
     }
 

src/WireMock.Net.Minimal/Util/PortUtils.cs

@@ -84,22 +84,22 @@ internal static class PortUtils
     }
 
     /// <summary>
-    /// Extract the isHttps, isHttp2, protocol, host and port from a URL.
+    /// Extract the isHttps, isHttp2, scheme, host and port from a URL.
     /// </summary>
-    public static bool TryExtract(string url, out bool isHttps, out bool isHttp2, [NotNullWhen(true)] out string? protocol, [NotNullWhen(true)] out string? host, out int port)
+    public static bool TryExtract(string url, out bool isHttps, out bool isHttp2, [NotNullWhen(true)] out string? scheme, [NotNullWhen(true)] out string? host, out int port)
     {
         isHttps = false;
         isHttp2 = false;
-        protocol = null;
+        scheme = null;
         host = null;
         port = 0;
 
         var match = UrlDetailsRegex.Match(url);
         if (match.Success)
         {
-            protocol = match.Groups["proto"].Value;
-            isHttps = protocol.StartsWith("https", StringComparison.OrdinalIgnoreCase) || protocol.StartsWith("grpcs", StringComparison.OrdinalIgnoreCase);
-            isHttp2 = protocol.StartsWith("grpc", StringComparison.OrdinalIgnoreCase);
+            scheme = match.Groups["proto"].Value;
+            isHttps = scheme.StartsWith("https", StringComparison.OrdinalIgnoreCase) || scheme.StartsWith("grpcs", StringComparison.OrdinalIgnoreCase);
+            isHttp2 = scheme.StartsWith("grpc", StringComparison.OrdinalIgnoreCase);
             host = match.Groups["host"].Value;
 
             return int.TryParse(match.Groups["port"].Value, out port);

src/WireMock.Net.Testcontainers/WireMockContainer.cs

@@ -156,7 +156,8 @@ public sealed class WireMockContainer : DockerContainer
 
         try
         {
-            await _adminApi.ReloadStaticMappingsAsync(cancellationToken);
+            var result = await _adminApi.ReloadStaticMappingsAsync(cancellationToken);
+            Logger.LogInformation("ReloadStaticMappings result: {Result}", result);
         }
         catch (Exception ex)
         {
@@ -231,7 +232,8 @@ public sealed class WireMockContainer : DockerContainer
             {
                 try
                 {
-                    await _adminApi!.AddProtoDefinitionAsync(kvp.Key, protoDefinition);
+                    var result = await _adminApi!.AddProtoDefinitionAsync(kvp.Key, protoDefinition);
+                    Logger.LogInformation("AddProtoDefinition '{Id}' result: {Result}", kvp.Key, result);
                 }
                 catch (Exception ex)
                 {
@@ -239,6 +241,12 @@ public sealed class WireMockContainer : DockerContainer
                 }
             }
         }
+
+        // Force a reload of static mappings when ProtoDefinitions are added at server-level to fix #1382
+        if (_configuration.ProtoDefinitions.Count > 0)
+        {
+            await ReloadStaticMappingsAsync();
+        }
     }
 
     private async void FileCreatedChangedOrDeleted(object sender, FileSystemEventArgs args)
@@ -246,6 +254,7 @@ public sealed class WireMockContainer : DockerContainer
         try
         {
             await ReloadStaticMappingsAsync(args.FullPath);
+            Logger.LogInformation("ReloadStaticMappings triggered from file change: '{FullPath}'.", args.FullPath);
         }
         catch (Exception ex)
         {

src/WireMock.Net.Testcontainers/WireMockContainerBuilder.cs

@@ -112,6 +112,7 @@ public sealed class WireMockContainerBuilder : ContainerBuilder<WireMockContaine
     {
         DockerResourceConfiguration.WithWatchStaticMappings(includeSubDirectories);
         return
+            WithCommand("--ReadStaticMappings true").
             WithCommand("--WatchStaticMappings true").
             WithCommand("--WatchStaticMappingsInSubdirectories", includeSubDirectories);
     }
@@ -129,9 +130,7 @@ public sealed class WireMockContainerBuilder : ContainerBuilder<WireMockContaine
 
         DockerResourceConfiguration.WithStaticMappingsPath(path);
 
-        return
-            WithReadStaticMappings().
-            WithCommand("--WatchStaticMappingsInSubdirectories", includeSubDirectories);
+        return WithWatchStaticMappings(includeSubDirectories);
     }
 
     /// <summary>