Add support for multiple webhooks (#615)

WireMock.Net Solution.sln.DotSettings

@@ -16,4 +16,6 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Raml/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=randomizer/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Stef/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Webhook/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=Webhooks/@EntryIndexedValue">True</s:Boolean>
 </wpf:ResourceDictionary>

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

@@ -57,5 +57,10 @@ namespace WireMock.Admin.Mappings
         /// The Webhook.
         /// </summary>
         public WebhookModel Webhook { get; set; }
+
+        /// <summary>
+        /// The Webhooks.
+        /// </summary>
+        public WebhookModel[] Webhooks { get; set; }
     }
 }

src/WireMock.Net/IMapping.cs

@@ -95,9 +95,9 @@ namespace WireMock
         bool LogMapping { get; }
 
         /// <summary>
-        /// The Webhook.
+        /// The Webhooks.
         /// </summary>
-        IWebhook Webhook { get; }
+        IWebhook[] Webhooks { get; }
 
         /// <summary>
         /// ProvideResponseAsync

src/WireMock.Net/Mapping.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Threading.Tasks;
 using JetBrains.Annotations;
-using WireMock.Admin.Mappings;
 using WireMock.Matchers.Request;
 using WireMock.Models;
 using WireMock.ResponseProviders;
@@ -56,8 +55,8 @@ namespace WireMock
         /// <inheritdoc cref="IMapping.LogMapping" />
         public bool LogMapping => !(Provider is DynamicResponseProvider || Provider is DynamicAsyncResponseProvider);
 
-        /// <inheritdoc cref="IMapping.Webhook" />
+        /// <inheritdoc cref="IMapping.Webhooks" />
-        public IWebhook Webhook { get; }
+        public IWebhook[] Webhooks { get; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Mapping"/> class.
@@ -73,7 +72,7 @@ namespace WireMock
         /// <param name="executionConditionState">State in which the current mapping can occur. [Optional]</param>
         /// <param name="nextState">The next state which will occur after the current mapping execution. [Optional]</param>
         /// <param name="stateTimes">Only when the current state is executed this number, the next state which will occur. [Optional]</param>
-        /// <param name="webhook">The Webhook. [Optional]</param>
+        /// <param name="webhooks">The Webhooks. [Optional]</param>
         public Mapping(
             Guid guid,
             [CanBeNull] string title,
@@ -86,7 +85,7 @@ namespace WireMock
             [CanBeNull] string executionConditionState,
             [CanBeNull] string nextState,
             [CanBeNull] int? stateTimes,
-            [CanBeNull] IWebhook webhook)
+            [CanBeNull] IWebhook[] webhooks)
         {
             Guid = guid;
             Title = title;
@@ -99,7 +98,7 @@ namespace WireMock
             ExecutionConditionState = executionConditionState;
             NextState = nextState;
             StateTimes = stateTimes;
-            Webhook = webhook;
+            Webhooks = webhooks;
         }
 
         /// <inheritdoc cref="IMapping.ProvideResponseAsync" />

src/WireMock.Net/Models/Webhook.cs

@@ -1,8 +1,4 @@
-using System.Collections.Generic;
+namespace WireMock.Models
-using JetBrains.Annotations;
-using WireMock.Types;
-
-namespace WireMock.Models
 {
     /// <summary>
     /// Webhook

src/WireMock.Net/Owin/WireMockMiddleware.cs

@@ -156,9 +156,9 @@ namespace WireMock.Owin
                     UpdateScenarioState(targetMapping);
                 }
 
-                if (!targetMapping.IsAdminInterface && targetMapping.Webhook != null)
+                if (!targetMapping.IsAdminInterface && targetMapping.Webhooks?.Length > 0)
                 {
-                    await SendToWebhookAsync(targetMapping, request, response).ConfigureAwait(false);
+                    await SendToWebhooksAsync(targetMapping, request, response).ConfigureAwait(false);
                 }
             }
             catch (Exception ex)
@@ -191,18 +191,21 @@ namespace WireMock.Owin
             await CompletedTask;
         }
 
-        private async Task SendToWebhookAsync(IMapping mapping, RequestMessage request, ResponseMessage response)
+        private async Task SendToWebhooksAsync(IMapping mapping, RequestMessage request, ResponseMessage response)
         {
-            var httpClientForWebhook = HttpClientBuilder.Build(mapping.Settings.WebhookSettings ?? new WebhookSettings());
+            for (int index = 0; index < mapping.Webhooks.Length; index++)
-            var webhookSender = new WebhookSender(mapping.Settings);
+            {
+                var httpClientForWebhook = HttpClientBuilder.Build(mapping.Settings.WebhookSettings ?? new WebhookSettings());
+                var webhookSender = new WebhookSender(mapping.Settings);
 
-            try
+                try
-            {
+                {
-                await webhookSender.SendAsync(httpClientForWebhook, mapping.Webhook.Request, request, response).ConfigureAwait(false);
+                    await webhookSender.SendAsync(httpClientForWebhook, mapping.Webhooks[index].Request, request, response).ConfigureAwait(false);
-            }
+                }
-            catch (Exception ex)
+                catch (Exception ex)
-            {
+                {
-                _options.Logger.Error($"Sending message to Webhook Mapping '{mapping.Guid}' failed. Exception: {ex}");
+                    _options.Logger.Error($"Sending message to Webhook [{index}] from Mapping '{mapping.Guid}' failed. Exception: {ex}");
+                }
             }
         }
 

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -84,10 +84,18 @@ namespace WireMock.Serialization
                 Response = new ResponseModel
                 {
                     Delay = (int?)response.Delay?.TotalMilliseconds
-                },
+                }
-                Webhook = WebhookMapper.Map(mapping.Webhook)
             };
 
+            if (mapping.Webhooks?.Length == 1)
+            {
+                mappingModel.Webhook = WebhookMapper.Map(mapping.Webhooks[0]);
+            }
+            else if (mapping.Webhooks?.Length > 1)
+            {
+                mappingModel.Webhooks = mapping.Webhooks.Select(WebhookMapper.Map).ToArray();
+            }
+
             if (bodyMatcher?.Matchers != null)
             {
                 mappingModel.Request.Body = new BodyModel();

src/WireMock.Net/Server/IRespondWithAProvider.cs

@@ -103,14 +103,14 @@ namespace WireMock.Server
         IRespondWithAProvider WillSetStateTo(int state, int? times = 1);
 
         /// <summary>
-        /// Add a Webbook to call after the response has been generated.
+        /// Add (multiple) Webhook(s) to call after the response has been generated.
         /// </summary>
-        /// <param name="webhook">The Webhook</param>
+        /// <param name="webhooks">The Webhooks</param>
         /// <returns>The <see cref="IRespondWithAProvider"/>.</returns>
-        IRespondWithAProvider WithWebhook(IWebhook webhook);
+        IRespondWithAProvider WithWebhook(params IWebhook[] webhooks);
 
         /// <summary>
-        /// Add a Webbook to call after the response has been generated.
+        /// Add a Webhook to call after the response has been generated.
         /// </summary>
         /// <param name="url">The Webhook Url</param>
         /// <param name="method">The method to use. [optional]</param>
@@ -129,7 +129,7 @@ namespace WireMock.Server
         );
 
         /// <summary>
-        /// Add a Webbook to call after the response has been generated.
+        /// Add a Webhook to call after the response has been generated.
         /// </summary>
         /// <param name="url">The Webhook Url</param>
         /// <param name="method">The method to use. [optional]</param>

src/WireMock.Net/Server/RespondWithAProvider.cs

@@ -9,6 +9,7 @@ using WireMock.ResponseProviders;
 using WireMock.Settings;
 using WireMock.Types;
 using WireMock.Util;
+using WireMock.Validation;
 
 namespace WireMock.Server
 {
@@ -31,7 +32,7 @@ namespace WireMock.Server
 
         public Guid Guid { get; private set; } = Guid.NewGuid();
 
-        public IWebhook Webhook { get; private set; }
+        public IWebhook[] Webhooks { get; private set; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="RespondWithAProvider"/> class.
@@ -54,7 +55,7 @@ namespace WireMock.Server
         /// <param name="provider">The provider.</param>
         public void RespondWith(IResponseProvider provider)
         {
-            _registrationCallback(new Mapping(Guid, _title, _path, _settings, _requestMatcher, provider, _priority, _scenario, _executionConditionState, _nextState, _timesInSameState, Webhook), _saveToFile);
+            _registrationCallback(new Mapping(Guid, _title, _path, _settings, _requestMatcher, provider, _priority, _scenario, _executionConditionState, _nextState, _timesInSameState, Webhooks), _saveToFile);
         }
 
         /// <see cref="IRespondWithAProvider.WithGuid(string)"/>
@@ -148,15 +149,17 @@ namespace WireMock.Server
             return WillSetStateTo(state.ToString(), times);
         }
 
-        /// <see cref="IRespondWithAProvider.WithWebhook(IWebhook)"/>
+        /// <see cref="IRespondWithAProvider.WithWebhook(IWebhook[])"/>
-        public IRespondWithAProvider WithWebhook(IWebhook webhook)
+        public IRespondWithAProvider WithWebhook(params IWebhook[] webhooks)
         {
-            Webhook = webhook;
+            Check.HasNoNulls(webhooks, nameof(webhooks));
+
+            Webhooks = webhooks;
 
             return this;
         }
 
-        /// <see cref="IRespondWithAProvider.WithWebhook(string,string, IDictionary{string, WireMockList{string}}, string, bool, TransformerType)"/>
+        /// <see cref="IRespondWithAProvider.WithWebhook(string, string, IDictionary{string, WireMockList{string}}, string, bool, TransformerType)"/>
         public IRespondWithAProvider WithWebhook(
             [NotNull] string url,
             [CanBeNull] string method = "post",
@@ -165,11 +168,11 @@ namespace WireMock.Server
             bool useTransformer = true,
             TransformerType transformerType = TransformerType.Handlebars)
         {
-            Webhook = InitWebhook(url, method, headers, useTransformer, transformerType);
+            Webhooks = new[] { InitWebhook(url, method, headers, useTransformer, transformerType) };
 
             if (body != null)
             {
-                Webhook.Request.BodyData = new BodyData
+                Webhooks[0].Request.BodyData = new BodyData
                 {
                     BodyAsString = body,
                     DetectedBodyType = BodyType.String,
@@ -189,11 +192,11 @@ namespace WireMock.Server
             bool useTransformer = true,
             TransformerType transformerType = TransformerType.Handlebars)
         {
-            Webhook = InitWebhook(url, method, headers, useTransformer, transformerType);
+            Webhooks = new[] { InitWebhook(url, method, headers, useTransformer, transformerType) };
 
             if (body != null)
             {
-                Webhook.Request.BodyData = new BodyData
+                Webhooks[0].Request.BodyData = new BodyData
                 {
                     BodyAsJson = body,
                     DetectedBodyType = BodyType.Json,

src/WireMock.Net/Server/WireMockServer.Admin.cs

@@ -470,10 +470,15 @@ namespace WireMock.Server
                 respondProvider = respondProvider.WillSetStateTo(mappingModel.SetStateTo);
             }
 
-            if (mappingModel.Webhook?.Request != null)
+            if (mappingModel.Webhook != null)
             {
                 respondProvider = respondProvider.WithWebhook(WebhookMapper.Map(mappingModel.Webhook));
             }
+            else if (mappingModel.Webhooks?.Length > 1)
+            {
+                var webhooks = mappingModel.Webhooks.Select(WebhookMapper.Map).ToArray();
+                respondProvider = respondProvider.WithWebhook(webhooks);
+            }
 
             respondProvider.RespondWith(responseBuilder);
 

test/WireMock.Net.Tests/Serialization/MappingConverterTests.cs

@@ -24,31 +24,34 @@ namespace WireMock.Net.Tests.Serialization
         }
 
         [Fact]
-        public void ToMappingModel()
+        public void ToMappingModel_With_SingleWebHook()
         {
             // Assign
             var request = Request.Create();
             var response = Response.Create();
-            var webhook = new Webhook
+            var webhooks = new IWebhook[]
             {
-                Request = new WebhookRequest
+                new Webhook
                 {
-                    Url = "https://test.com",
+                    Request = new WebhookRequest
-                    Headers = new Dictionary<string, WireMockList<string>>
                     {
-                        { "Single", new WireMockList<string>("x") },
+                        Url = "https://test.com",
-                        { "Multi", new WireMockList<string>("a", "b") }
+                        Headers = new Dictionary<string, WireMockList<string>>
-                    },
+                        {
-                    Method = "post",
+                            { "Single", new WireMockList<string>("x") },
-                    BodyData = new BodyData
+                            { "Multi", new WireMockList<string>("a", "b") }
-                    {
+                        },
-                        BodyAsString = "b",
+                        Method = "post",
-                        DetectedBodyType = BodyType.String,
+                        BodyData = new BodyData
-                        DetectedBodyTypeFromContentType = BodyType.String
+                        {
+                            BodyAsString = "b",
+                            DetectedBodyType = BodyType.String,
+                            DetectedBodyTypeFromContentType = BodyType.String
+                        }
                     }
                 }
             };
-            var mapping = new Mapping(Guid.NewGuid(), "", null, _settings, request, response, 0, null, null, null, null, webhook);
+            var mapping = new Mapping(Guid.NewGuid(), "", null, _settings, request, response, 0, null, null, null, null, webhooks);
 
             // Act
             var model = _sut.ToMappingModel(mapping);
@@ -61,6 +64,8 @@ namespace WireMock.Net.Tests.Serialization
             model.Response.UseTransformer.Should().BeNull();
             model.Response.Headers.Should().BeNull();
 
+            model.Webhooks.Should().BeNull();
+
             model.Webhook.Request.Method.Should().Be("post");
             model.Webhook.Request.Url.Should().Be("https://test.com");
             model.Webhook.Request.Headers.Should().HaveCount(2);
@@ -68,6 +73,80 @@ namespace WireMock.Net.Tests.Serialization
             model.Webhook.Request.BodyAsJson.Should().BeNull();
         }
 
+        [Fact]
+        public void ToMappingModel_With_MultipleWebHooks()
+        {
+            // Assign
+            var request = Request.Create();
+            var response = Response.Create();
+            var webhooks = new IWebhook[]
+            {
+                new Webhook
+                {
+                    Request = new WebhookRequest
+                    {
+                        Url = "https://test1.com",
+                        Headers = new Dictionary<string, WireMockList<string>>
+                        {
+                            { "One", new WireMockList<string>("x") }
+                        },
+                        Method = "post",
+                        BodyData = new BodyData
+                        {
+                            BodyAsString = "1",
+                            DetectedBodyType = BodyType.String,
+                            DetectedBodyTypeFromContentType = BodyType.String
+                        }
+                    }
+                },
+
+                new Webhook
+                {
+                    Request = new WebhookRequest
+                    {
+                        Url = "https://test2.com",
+                        Headers = new Dictionary<string, WireMockList<string>>
+                        {
+                            { "First", new WireMockList<string>("x") },
+                            { "Second", new WireMockList<string>("a", "b") }
+                        },
+                        Method = "post",
+                        BodyData = new BodyData
+                        {
+                            BodyAsString = "2",
+                            DetectedBodyType = BodyType.String,
+                            DetectedBodyTypeFromContentType = BodyType.String
+                        }
+                    }
+                }
+            };
+            var mapping = new Mapping(Guid.NewGuid(), "", null, _settings, request, response, 0, null, null, null, null, webhooks
+);
+
+            // Act
+            var model = _sut.ToMappingModel(mapping);
+
+            // Assert
+            model.Should().NotBeNull();
+            model.Priority.Should().BeNull();
+
+            model.Response.BodyAsJsonIndented.Should().BeNull();
+            model.Response.UseTransformer.Should().BeNull();
+            model.Response.Headers.Should().BeNull();
+
+            model.Webhook.Should().BeNull();
+
+            model.Webhooks[0].Request.Method.Should().Be("post");
+            model.Webhooks[0].Request.Url.Should().Be("https://test1.com");
+            model.Webhooks[0].Request.Headers.Should().HaveCount(1);
+            model.Webhooks[0].Request.Body.Should().Be("1");
+
+            model.Webhooks[1].Request.Method.Should().Be("post");
+            model.Webhooks[1].Request.Url.Should().Be("https://test2.com");
+            model.Webhooks[1].Request.Headers.Should().HaveCount(2);
+            model.Webhooks[1].Request.Body.Should().Be("2");
+        }
+
         [Fact]
         public void ToMappingModel_WithPriority_ReturnsPriority()
         {

test/WireMock.Net.Tests/WireMockServer.WebhookTests.cs

@@ -16,6 +16,74 @@ namespace WireMock.Net.Tests
 {
     public class WireMockServerWebhookTests
     {
+        [Fact]
+        public async Task WireMockServer_WithWebhooks_Should_Send_Message_To_Webhooks()
+        {
+            // Assign
+            var serverReceivingTheWebhook1 = WireMockServer.Start();
+            serverReceivingTheWebhook1.Given(Request.Create().UsingPost()).RespondWith(Response.Create().WithStatusCode(200));
+
+            var serverReceivingTheWebhook2 = WireMockServer.Start();
+            serverReceivingTheWebhook2.Given(Request.Create().UsingPost()).RespondWith(Response.Create().WithStatusCode(200));
+
+            var webhook1 = new Webhook
+            {
+                Request = new WebhookRequest
+                {
+                    Url = serverReceivingTheWebhook1.Urls[0],
+                    Method = "post",
+                    BodyData = new BodyData
+                    {
+                        BodyAsString = "1",
+                        DetectedBodyType = BodyType.String,
+                        DetectedBodyTypeFromContentType = BodyType.String
+                    }
+                }
+            };
+
+            var webhook2 = new Webhook
+            {
+                Request = new WebhookRequest
+                {
+                    Url = serverReceivingTheWebhook2.Urls[0],
+                    Method = "post",
+                    BodyData = new BodyData
+                    {
+                        BodyAsString = "2",
+                        DetectedBodyType = BodyType.String,
+                        DetectedBodyTypeFromContentType = BodyType.String
+                    }
+                }
+            };
+
+            // Act
+            var server = WireMockServer.Start();
+            server.Given(Request.Create().UsingPost())
+                .WithWebhook(webhook1, webhook2)
+                .RespondWith(Response.Create().WithBody("a-response"));
+
+            var request = new HttpRequestMessage
+            {
+                Method = HttpMethod.Post,
+                RequestUri = new Uri($"{server.Urls[0]}/TST"),
+                Content = new StringContent("test")
+            };
+
+            // Assert
+            var response = await new HttpClient().SendAsync(request);
+            string content = await response.Content.ReadAsStringAsync();
+
+            response.StatusCode.Should().Be(HttpStatusCode.OK);
+            content.Should().Be("a-response");
+
+            serverReceivingTheWebhook1.LogEntries.Should().HaveCount(1);
+            serverReceivingTheWebhook2.LogEntries.Should().HaveCount(1);
+
+            server.Dispose();
+            serverReceivingTheWebhook1.Dispose();
+            serverReceivingTheWebhook2.Dispose();
+        }
+
         [Fact]
         public async Task WireMockServer_WithWebhook_Should_Send_Message_To_Webhook()
         {