feat: Add support for synchronous plugin interactions

Author: max-lancaster

src/PactNet.Abstractions/ISynchronousPluginPactBuilder.cs

@@ -0,0 +1,8 @@
+using System;
+
+namespace PactNet;
+
+public interface ISynchronousPluginPactBuilderV4 : IPactBuilder, IDisposable
+{
+    ISynchronousPluginRequestBuilderV4 UponReceiving(string description);
+}

src/PactNet.Abstractions/ISynchronousPluginRequestBuilder.cs

@@ -0,0 +1,28 @@
+using System.Collections.Generic;
+
+namespace PactNet;
+
+public interface ISynchronousPluginRequestBuilderV4
+{
+    /// <summary>
+    /// Add a provider state
+    /// </summary>
+    /// <param name="description">Provider state description</param>
+    /// <returns>Fluent builder</returns>
+    ISynchronousPluginRequestBuilderV4 Given(string description);
+
+    /// <summary>
+    /// Add a provider state with a parameter to the interaction
+    /// </summary>
+    /// <param name="description">Provider state description</param>
+    /// <param name="name">Parameter name</param>
+    /// <param name="value">Parameter value</param>
+    ISynchronousPluginRequestBuilderV4 Given(string description, string name, string value);
+
+    /// <summary>
+    /// Add plugin interaction content
+    /// </summary>
+    /// <param name="contentType">Content type</param>
+    /// <param name="content">A dictionary containing the plugin content.</param>
+    ISynchronousPluginRequestBuilderV4 WithContent(string contentType, Dictionary<string, object> content);
+}

src/PactNet/Drivers/IPactDriver.cs

@@ -1,11 +1,12 @@
 using PactNet.Drivers.Http;
 using PactNet.Drivers.Message;
+using PactNet.Drivers.Plugins;
 using PactNet.Interop;
 
 namespace PactNet.Drivers
 {
     /// <summary>
-    /// Driver for creating a new pact and 
+    /// Driver for creating a new pact and
     /// </summary>
     internal interface IPactDriver
     {
@@ -32,5 +33,16 @@ internal interface IPactDriver
         /// </summary>
         /// <returns>Logs</returns>
         string DriverLogs();
+
+        /// <summary>
+        /// Create a new plugin pact
+        /// </summary>
+        /// <param name="consumerName">Consumer name</param>
+        /// <param name="providerName">Provider name</param>
+        /// <param name="pluginName">Plugin name</param>
+        /// <param name="pluginVersion">Plugin version</param>
+        /// <param name="version">Specification version</param>
+        /// <returns>Plugin pact driver</returns>
+        IPluginPactDriver NewPluginPact(string consumerName, string providerName, string pluginName, string pluginVersion, PactSpecification version);
     }
 }

src/PactNet/Drivers/Plugins/IPluginInteractionDriver.cs

@@ -1,4 +1,6 @@
-namespace PactNet.Drivers.Plugins
+using System.Collections.Generic;
+
+namespace PactNet.Drivers.Plugins
 {
     /// <summary>
     /// Driver for plugin interactions
@@ -9,7 +11,7 @@ internal interface IPluginInteractionDriver : IProviderStateDriver
         /// Add a plugin interaction content
         /// </summary>
         /// <param name="contentType">Content type</param>
-        /// <param name="content">Content</param>
-        void WithContent(string contentType, string content);
+        /// <param name="content">A dictionary containing the plugin content.</param>
+        void WithContent(string contentType, Dictionary<string, object> content);
     }
 }

src/PactNet/Drivers/Plugins/IPluginPactDriver.cs

@@ -1,9 +1,11 @@
-namespace PactNet.Drivers.Plugins
+using System;
+
+namespace PactNet.Drivers.Plugins
 {
     /// <summary>
     /// Driver for plugin-based pacts
     /// </summary>
-    internal interface IPluginPactDriver : ICompletedPactDriver
+    internal interface IPluginPactDriver : ICompletedPactDriver, IDisposable
     {
         /// <summary>
         /// Create a new sync interaction on the current pact

src/PactNet/Drivers/Plugins/PluginInteractionDriver.cs

@@ -1,4 +1,6 @@
-using PactNet.Exceptions;
+using System.Collections.Generic;
+using System.Text.Json;
+using PactNet.Exceptions;
 using PactNet.Interop;
 
 namespace PactNet.Drivers.Plugins
@@ -36,13 +38,13 @@ public void GivenWithParam(string description, string name, string value)
             => NativeInterop.GivenWithParam(this.interaction, description, name, value).CheckInteropSuccess();
 
         /// <summary>
-        /// Add a plugin interaction content
+        /// Add plugin interaction content
         /// </summary>
         /// <param name="contentType">Content type</param>
-        /// <param name="content">Content</param>
-        public void WithContent(string contentType, string content)
+        /// <param name="content">A dictionary containing the plugin content.</param>
+        public void WithContent(string contentType, Dictionary<string, object> content)
         {
-            uint code = NativeInterop.InteractionContents(this.interaction, InteractionPart.Request, contentType, content);
+            uint code = NativeInterop.InteractionContents(this.interaction, InteractionPart.Request, contentType,  JsonSerializer.Serialize(content));
 
             if (code != 0)
             {

src/PactNet/Drivers/Plugins/PluginPactDriver.cs

@@ -1,11 +1,12 @@
-using PactNet.Interop;
+using System;
+using PactNet.Interop;
 
 namespace PactNet.Drivers.Plugins
 {
     /// <summary>
     /// Driver for plugin-based pacts
     /// </summary>
-    internal class PluginPactDriver : AbstractPactDriver, IPluginPactDriver
+    internal class PluginPactDriver : AbstractPactDriver, IPluginPactDriver, IDisposable
     {
         /// <summary>
         /// Initialize a new instance of the <see cref="PluginPactDriver"/> class.
@@ -25,5 +26,31 @@ public IPluginInteractionDriver NewSyncInteraction(string description)
             InteractionHandle interaction = NativeInterop.NewSyncMessageInteraction(this.pact, description);
             return new PluginInteractionDriver(interaction);
         }
+
+
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        public void Dispose()
+        {
+            this.ReleaseUnmanagedResources();
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
+        /// </summary>
+        ~PluginPactDriver()
+        {
+            this.ReleaseUnmanagedResources();
+        }
+
+        /// <summary>
+        /// Release unmanaged resources
+        /// </summary>
+        private void ReleaseUnmanagedResources()
+        {
+            NativeInterop.CleanupPlugins(pact);
+        }
     }
 }

src/PactNet/PactExtensions.cs

@@ -1,6 +1,7 @@
 using PactNet.Drivers;
 using PactNet.Drivers.Http;
 using PactNet.Drivers.Message;
+using PactNet.Drivers.Plugins;
 using PactNet.Interop;
 using PactNet.Models;
 
@@ -23,7 +24,8 @@ public static class PactExtensions
         /// It is advised that the port is not specified whenever possible to allow PactNet to allocate a port dynamically
         /// and ensure there are no port clashes
         /// </remarks>
-        public static IPactBuilderV2 WithHttpInteractions(this IPactV2 pact, int? port = null, IPAddress host = IPAddress.Loopback)
+        public static IPactBuilderV2 WithHttpInteractions(this IPactV2 pact, int? port = null,
+            IPAddress host = IPAddress.Loopback)
         {
             pact.Config.LogLevel.LogToBuffer();
 
@@ -46,7 +48,8 @@ public static IPactBuilderV2 WithHttpInteractions(this IPactV2 pact, int? port =
         /// It is advised that the port is not specified whenever possible to allow PactNet to allocate a port dynamically
         /// and ensure there are no port clashes
         /// </remarks>
-        public static IPactBuilderV3 WithHttpInteractions(this IPactV3 pact, int? port = null, IPAddress host = IPAddress.Loopback)
+        public static IPactBuilderV3 WithHttpInteractions(this IPactV3 pact, int? port = null,
+            IPAddress host = IPAddress.Loopback)
         {
             pact.Config.LogLevel.LogToBuffer();
 
@@ -69,7 +72,8 @@ public static IPactBuilderV3 WithHttpInteractions(this IPactV3 pact, int? port =
         /// It is advised that the port is not specified whenever possible to allow PactNet to allocate a port dynamically
         /// and ensure there are no port clashes
         /// </remarks>
-        public static IPactBuilderV4 WithHttpInteractions(this IPactV4 pact, int? port = null, IPAddress host = IPAddress.Loopback)
+        public static IPactBuilderV4 WithHttpInteractions(this IPactV4 pact, int? port = null,
+            IPAddress host = IPAddress.Loopback)
         {
             pact.Config.LogLevel.LogToBuffer();
 
@@ -111,5 +115,26 @@ public static IMessagePactBuilderV4 WithMessageInteractions(this IPactV4 pact)
             var builder = new MessagePactBuilder(messagePact, pact.Config, PactSpecification.V4);
             return builder;
         }
+
+        /// <summary>
+        /// Establish a new pact with synchronous plugin interactions.
+        /// </summary>
+        /// <param name="pact"></param>
+        /// <param name="pluginName">Plugin name</param>
+        /// <param name="pluginVersion">Plugin version</param>
+        /// <param name="transport">The transport to use (i.e. http, https, grpc). Must be a valid UTF-8 NULL-terminated string, or NULL or empty, in which case http will be used.</param>
+        /// <param name="port">Port for the mock server. If null, one will be assigned automatically</param>
+        /// <param name="host">Host for the mock server</param>
+        /// <returns></returns>
+        public static ISynchronousPluginPactBuilderV4 WithSynchronousPluginInteractions(this IPactV4 pact,
+            string pluginName, string pluginVersion, string transport = null, int? port = null,
+            IPAddress host = IPAddress.Loopback)
+        {
+            pact.Config.LogLevel.LogToBuffer();
+            IPactDriver driver = new PactDriver();
+            var pluginDriver = driver.NewPluginPact(pact.Consumer, pact.Provider, pluginName, pluginVersion,
+                PactSpecification.V4);
+            return new SynchronousPluginPactBuilder(pluginDriver, pact.Config, port, host, transport);
+        }
     }
 }

src/PactNet/SynchronousPluginPactBuilder.cs

@@ -0,0 +1,20 @@
+using PactNet.Drivers.Plugins;
+using PactNet.Models;
+
+namespace PactNet;
+
+internal class SynchronousPluginPactBuilder(
+    IPluginPactDriver pact,
+    PactConfig config,
+    int? port,
+    IPAddress host,
+    string transport = null)
+    : AbstractPactBuilder(pact, config, port, host, transport), ISynchronousPluginPactBuilderV4
+{
+    public ISynchronousPluginRequestBuilderV4 UponReceiving(string description)
+    {
+        return new SynchronousPluginRequestBuilder(pact.NewSyncInteraction(description));
+    }
+
+    public void Dispose() => pact?.Dispose();
+}

src/PactNet/SynchronousPluginRequestBuilder.cs

@@ -0,0 +1,43 @@
+using System.Collections.Generic;
+using PactNet.Drivers.Plugins;
+
+namespace PactNet;
+
+internal class SynchronousPluginRequestBuilder(IPluginInteractionDriver interactionDriver)
+    : ISynchronousPluginRequestBuilderV4
+{
+
+    /// <summary>
+    /// Add a provider state
+    /// </summary>
+    /// <param name="description">Provider state description</param>
+    /// <returns>Fluent builder</returns>
+    public ISynchronousPluginRequestBuilderV4 Given(string description)
+    {
+        interactionDriver.Given(description);
+        return this;
+    }
+
+    /// <summary>
+    /// Add a provider state with a parameter to the interaction
+    /// </summary>
+    /// <param name="description">Provider state description</param>
+    /// <param name="name">Parameter name</param>
+    /// <param name="value">Parameter value</param>
+    public ISynchronousPluginRequestBuilderV4 Given(string description, string name, string value)
+    {
+        interactionDriver.GivenWithParam(description, name, value);
+        return this;
+    }
+
+    /// <summary>
+    /// Add plugin interaction content
+    /// </summary>
+    /// <param name="contentType">Content type</param>
+    /// <param name="content">A dictionary containing the plugin content.</param>
+    public ISynchronousPluginRequestBuilderV4 WithContent(string contentType, Dictionary<string, object> content)
+    {
+        interactionDriver.WithContent(contentType, content);
+        return this;
+    }
+}