Create WireMock.Net.ProtoBuf project (#1350)

* Create WireMock.Net.ProtoBuf project

* ok

* Update Directory.Build.props

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

src/WireMock.Net.Shared/ResponseBuilders/BodyDestinationFormat.cs

@@ -0,0 +1,29 @@
+// Copyright © WireMock.Net
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// Defines the BodyDestinationFormat
+/// </summary>
+public static class BodyDestinationFormat
+{
+    /// <summary>
+    /// Same as source (no conversion)
+    /// </summary>
+    public const string SameAsSource = "SameAsSource";
+
+    /// <summary>
+    /// Convert to string
+    /// </summary>
+    public const string String = "String";
+
+    /// <summary>
+    /// Convert to bytes
+    /// </summary>
+    public const string Bytes = "Bytes";
+
+    /// <summary>
+    /// Convert to Json object
+    /// </summary>
+    public const string Json = "Json";
+}

src/WireMock.Net.Shared/ResponseBuilders/IBodyResponseBuilder.cs

@@ -0,0 +1,119 @@
+// Copyright © WireMock.Net
+
+using System;
+using System.Text;
+using System.Threading.Tasks;
+using JsonConverter.Abstractions;
+using WireMock.Models;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The BodyResponseBuilder interface.
+/// </summary>
+public interface IBodyResponseBuilder : IFaultResponseBuilder
+{
+    /// <summary>
+    /// WithBody : Create a ... response based on a string.
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(string body, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBody : Create a ... response based on a callback function.
+    /// </summary>
+    /// <param name="bodyFactory">The delegate to build the body.</param>
+    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(Func<IRequestMessage, string> bodyFactory, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBody : Create a ... response based on an async callback function.
+    /// </summary>
+    /// <param name="bodyFactory">The async delegate to build the body.</param>
+    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(Func<IRequestMessage, Task<string>> bodyFactory, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBody : Create a ... response based on an async callback function.
+    /// </summary>
+    /// <param name="bodyFactory">The async delegate to build the body.</param>
+    /// <param name="timeout">The timeout to wait on new items in the queue. Default value is <c>1</c> hour.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithSseBody(Func<IRequestMessage, IBlockingQueue<string?>, Task> bodyFactory, TimeSpan? timeout = null);
+
+    /// <summary>
+    /// WithBody : Create a ... response based on a bytearray.
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(byte[] body, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBody : Create a string response based on a object (which will be converted to a JSON string).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <param name="indented">Define whether child objects to be indented according to the Newtonsoft.Json.JsonTextWriter.Indentation and Newtonsoft.Json.JsonTextWriter.IndentChar settings.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBodyAsJson(object body, Encoding? encoding = null, bool? indented = null);
+
+    /// <summary>
+    /// WithBody : Create a string response based on a object (which will be converted to a JSON string).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="indented">Define whether child objects to be indented according to the Newtonsoft.Json.JsonTextWriter.Indentation and Newtonsoft.Json.JsonTextWriter.IndentChar settings.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBodyAsJson(object body, bool indented);
+
+    /// <summary>
+    /// WithBodyAsJson : Create a ... response based on a callback function.
+    /// </summary>
+    /// <param name="bodyFactory">The delegate to build the body.</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBodyAsJson(Func<IRequestMessage, object> bodyFactory, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBodyAsJson : Create a ... response based on an async callback function.
+    /// </summary>
+    /// <param name="bodyFactory">The async delegate to build the body.</param>
+    /// <param name="encoding">The body encoding.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBodyAsJson(Func<IRequestMessage, Task<object>> bodyFactory, Encoding? encoding = null);
+
+    /// <summary>
+    /// WithBodyFromFile : Create a ... response based on a File.
+    /// </summary>
+    /// <param name="filename">The filename.</param>
+    /// <param name="cache">Defines if this file is cached in memory or retrieved from disk every time the response is created.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBodyFromFile(string filename, bool cache = true);
+
+    /// <summary>
+    /// WithBody : Create a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="jsonConverter">The <see cref="IJsonConverter"/>.</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(object body, IJsonConverter jsonConverter, JsonConverterOptions? options = null);
+
+    /// <summary>
+    /// WithBody : Create a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
+    /// </summary>
+    /// <param name="body">The body.</param>
+    /// <param name="encoding">The body encoding, can be <c>null</c>.</param>
+    /// <param name="jsonConverter">The <see cref="IJsonConverter"/>.</param>
+    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithBody(object body, Encoding? encoding, IJsonConverter jsonConverter, JsonConverterOptions? options = null);
+}

src/WireMock.Net.Shared/ResponseBuilders/ICallbackResponseBuilder.cs

@@ -0,0 +1,28 @@
+// Copyright © WireMock.Net
+
+using System;
+using System.Threading.Tasks;
+using JetBrains.Annotations;
+using WireMock.ResponseProviders;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The CallbackResponseBuilder interface.
+/// </summary>
+public interface ICallbackResponseBuilder : IResponseProvider
+{
+    /// <summary>
+    /// The callback builder
+    /// </summary>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    [PublicAPI]
+    IResponseBuilder WithCallback(Func<IRequestMessage, IResponseMessage> callbackHandler);
+
+    /// <summary>
+    /// The async callback builder
+    /// </summary>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    [PublicAPI]
+    IResponseBuilder WithCallback(Func<IRequestMessage, Task<IResponseMessage>> callbackHandler);
+}

src/WireMock.Net.Shared/ResponseBuilders/IDelayResponseBuilder.cs

@@ -0,0 +1,33 @@
+// Copyright © WireMock.Net
+
+using System;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The DelayResponseBuilder interface.
+/// </summary>
+public interface IDelayResponseBuilder : ICallbackResponseBuilder
+{
+    /// <summary>
+    /// The delay defined as a <see cref="TimeSpan"/>.
+    /// </summary>
+    /// <param name="delay">The TimeSpan to delay.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithDelay(TimeSpan delay);
+
+    /// <summary>
+    /// The delay defined as milliseconds.
+    /// </summary>
+    /// <param name="milliseconds">The milliseconds to delay.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithDelay(int milliseconds);
+
+    /// <summary>
+    /// Introduce random delay
+    /// </summary>
+    /// <param name="minimumMilliseconds">Minimum milliseconds to delay</param>
+    /// <param name="maximumMilliseconds">Maximum milliseconds to delay</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithRandomDelay(int minimumMilliseconds = 0, int maximumMilliseconds = 60_000);
+}

src/WireMock.Net.Shared/ResponseBuilders/IFaultRequestBuilder.cs

@@ -0,0 +1,19 @@
+// Copyright © WireMock.Net
+
+using JetBrains.Annotations;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The FaultRequestBuilder interface.
+/// </summary>
+public interface IFaultResponseBuilder : ITransformResponseBuilder
+{
+    /// <summary>
+    /// WithBody : Create a fault response.
+    /// </summary>
+    /// <param name="faultType">The FaultType.</param>
+    /// <param name="percentage">The percentage when this fault should occur. When null, it's always a fault.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithFault(FaultType faultType, double? percentage = null);
+}

src/WireMock.Net.Shared/ResponseBuilders/IHeadersResponseBuilder.cs

@@ -0,0 +1,70 @@
+// Copyright © WireMock.Net
+
+using System.Collections.Generic;
+using WireMock.Types;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The HeadersResponseBuilder interface.
+/// </summary>
+public interface IHeadersResponseBuilder : IBodyResponseBuilder
+{
+    /// <summary>
+    /// The WithHeader.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="values">The values.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithHeader(string name, params string[] values);
+
+    /// <summary>
+    /// The WithHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithHeaders(IDictionary<string, string> headers);
+
+    /// <summary>
+    /// The WithHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithHeaders(IDictionary<string, string[]> headers);
+
+    /// <summary>
+    /// The WithHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithHeaders(IDictionary<string, WireMockList<string>> headers);
+
+    /// <summary>
+    /// The WithTrailingHeader.
+    /// </summary>
+    /// <param name="name">The name.</param>
+    /// <param name="values">The values.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithTrailingHeader(string name, params string[] values);
+
+    /// <summary>
+    /// The WithTrailingHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithTrailingHeaders(IDictionary<string, string> headers);
+
+    /// <summary>
+    /// The WithTrailingHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithTrailingHeaders(IDictionary<string, string[]> headers);
+
+    /// <summary>
+    /// The WithTrailingHeaders.
+    /// </summary>
+    /// <param name="headers">The headers.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithTrailingHeaders(IDictionary<string, WireMockList<string>> headers);
+}

src/WireMock.Net.Shared/ResponseBuilders/IProxyResponseBuilder.cs

@@ -0,0 +1,35 @@
+// Copyright © WireMock.Net
+
+using System.Security.Cryptography.X509Certificates;
+using WireMock.Settings;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The ProxyResponseBuilder interface.
+/// </summary>
+public interface IProxyResponseBuilder : IStatusCodeResponseBuilder
+{
+    /// <summary>
+    /// WithProxy URL using Client X509Certificate2.
+    /// </summary>
+    /// <param name="proxyUrl">The proxy url.</param>
+    /// <param name="clientX509Certificate2ThumbprintOrSubjectName">The X509Certificate2 file to use for client authentication.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithProxy(string proxyUrl, string? clientX509Certificate2ThumbprintOrSubjectName = null);
+
+    /// <summary>
+    /// WithProxy using <see cref="ProxyAndRecordSettings"/>.
+    /// </summary>
+    /// <param name="settings">The ProxyAndRecordSettings.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithProxy(ProxyAndRecordSettings settings);
+
+    /// <summary>
+    /// WithProxy using <see cref="X509Certificate2"/>.
+    /// </summary>
+    /// <param name="proxyUrl">The proxy url.</param>
+    /// <param name="certificate">The X509Certificate2.</param>
+    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithProxy(string proxyUrl, X509Certificate2 certificate);
+}

src/WireMock.Net.Shared/ResponseBuilders/IResponseBuilder.cs

@@ -0,0 +1,19 @@
+// Copyright © WireMock.Net
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The ResponseBuilder interface.
+/// </summary>
+public interface IResponseBuilder : IProxyResponseBuilder
+{
+    /// <summary>
+    /// The link back to the mapping.
+    /// </summary>
+    IMapping Mapping { get; }
+
+    /// <summary>
+    /// Gets the response message.
+    /// </summary>
+    IResponseMessage ResponseMessage { get; }
+}

src/WireMock.Net.Shared/ResponseBuilders/IStatusCodeResponseBuilder.cs

@@ -0,0 +1,48 @@
+// Copyright © WireMock.Net
+
+using System.Net;
+using WireMock.Settings;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The StatusCodeResponseBuilder interface.
+/// </summary>
+public interface IStatusCodeResponseBuilder : IHeadersResponseBuilder
+{
+    /// <summary>
+    /// The with status code.
+    /// By default all status codes are allowed, to change this behaviour, see <inheritdoc cref="WireMockServerSettings.AllowOnlyDefinedHttpStatusCodeInResponse"/>.
+    /// </summary>
+    /// <param name="code">The code.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithStatusCode(int code);
+
+    /// <summary>
+    /// The with status code.
+    /// By default all status codes are allowed, to change this behaviour, see <inheritdoc cref="WireMockServerSettings.AllowOnlyDefinedHttpStatusCodeInResponse"/>.
+    /// </summary>
+    /// <param name="code">The code.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithStatusCode(string code);
+
+    /// <summary>
+    /// The with status code.
+    /// By default all status codes are allowed, to change this behaviour, see <inheritdoc cref="WireMockServerSettings.AllowOnlyDefinedHttpStatusCodeInResponse"/>.
+    /// </summary>
+    /// <param name="code">The code.</param>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithStatusCode(HttpStatusCode code);
+
+    /// <summary>
+    /// The with Success status code (200).
+    /// </summary>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithSuccess();
+
+    /// <summary>
+    /// The with NotFound status code (404).
+    /// </summary>
+    /// <returns>The <see cref="IResponseBuilder"/>.</returns>
+    IResponseBuilder WithNotFound();
+}

src/WireMock.Net.Shared/ResponseBuilders/ITransformResponseBuilder.cs

@@ -0,0 +1,35 @@
+// Copyright © WireMock.Net
+
+using WireMock.Types;
+
+namespace WireMock.ResponseBuilders;
+
+/// <summary>
+/// The TransformResponseBuilder interface.
+/// </summary>
+public interface ITransformResponseBuilder : IDelayResponseBuilder
+{
+    /// <summary>
+    /// Use the Handlebars.Net ResponseMessage transformer.
+    /// </summary>
+    /// <returns>
+    /// The <see cref="IResponseBuilder"/>.
+    /// </returns>
+    IResponseBuilder WithTransformer(bool transformContentFromBodyAsFile);
+
+    /// <summary>
+    /// Use the Handlebars.Net ResponseMessage transformer.
+    /// </summary>
+    /// <returns>
+    /// The <see cref="IResponseBuilder"/>.
+    /// </returns>
+    IResponseBuilder WithTransformer(ReplaceNodeOptions options);
+
+    /// <summary>
+    /// Use a specific ResponseMessage transformer.
+    /// </summary>
+    /// <returns>
+    /// The <see cref="IResponseBuilder"/>.
+    /// </returns>
+    IResponseBuilder WithTransformer(TransformerType transformerType = TransformerType.Handlebars, bool transformContentFromBodyAsFile = false, ReplaceNodeOptions options = ReplaceNodeOptions.EvaluateAndTryToConvert);
+}