Create dotnet-wiremock tool (#542)

* dotnet tool

* .

* c

* x

* ### As a dotnet tool

* help

* v

README.md

@@ -59,9 +59,13 @@ WireMock.Net can be used in several ways:
 You can use your favorite test framework and use WireMock within your tests, see
 [Wiki : UnitTesting](https://github.com/StefH/WireMock.Net/wiki/Using-WireMock-in-UnitTests).
 
+### As a dotnet tool
+It's simple to install WireMock.Net as (global) dotnet tool, see [Wiki : Standalone Process](https://github.com/StefH/WireMock.Net/wiki/WireMock-as-dotnet-tool).
+
 ### As standalone process / console application
 This is quite straight forward to launch a mock server within a console application, see [Wiki : Standalone Process](https://github.com/StefH/WireMock.Net/wiki/WireMock-as-a-standalone-process).
 
+
 ### As a Windows Service
 You can also run WireMock.Net as a Windows Service, follow this [WireMock-as-a-Windows-Service](https://github.com/WireMock-Net/WireMock.Net/wiki/WireMock-as-a-Windows-Service).
 

WireMock.Net Solution.sln

@@ -71,7 +71,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.WebApplication
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.WebApplication.NETCore3", "examples\WireMock.Net.WebApplication.NETCore3\WireMock.Net.WebApplication.NETCore3.csproj", "{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WireMock.Net.Console.NETCoreApp3WithCertificate", "examples\WireMock.Net.Console.NETCoreApp3WithCertificate\WireMock.Net.Console.NETCoreApp3WithCertificate.csproj", "{925E421A-1B3F-4202-B48F-734743573A4B}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Console.NETCoreApp3WithCertificate", "examples\WireMock.Net.Console.NETCoreApp3WithCertificate\WireMock.Net.Console.NETCoreApp3WithCertificate.csproj", "{925E421A-1B3F-4202-B48F-734743573A4B}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "dotnet-WireMock", "src\dotnet-WireMock.Net\dotnet-WireMock.csproj", "{40BF24B5-12E6-4610-9489-138798632E28}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -179,6 +181,10 @@ Global
 		{925E421A-1B3F-4202-B48F-734743573A4B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{925E421A-1B3F-4202-B48F-734743573A4B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{925E421A-1B3F-4202-B48F-734743573A4B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{40BF24B5-12E6-4610-9489-138798632E28}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{40BF24B5-12E6-4610-9489-138798632E28}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{40BF24B5-12E6-4610-9489-138798632E28}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{40BF24B5-12E6-4610-9489-138798632E28}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -209,6 +215,7 @@ Global
 		{6F38CB3A-6DA1-408A-AECD-E434523C2838} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{925E421A-1B3F-4202-B48F-734743573A4B} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
+		{40BF24B5-12E6-4610-9489-138798632E28} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

examples/WireMock.Net.StandAlone.NETCoreApp/Program.cs

@@ -23,7 +23,11 @@ namespace WireMock.Net.StandAlone.NETCoreApp
         {
             XmlConfigurator.Configure(LogRepository, new FileInfo("log4net.config"));
 
-            var settings = WireMockServerSettingsParser.ParseArguments(args, new WireMockLog4NetLogger());
+            if (WireMockServerSettingsParser.TryParseArguments(args, out var settings, new WireMockLog4NetLogger()))
+            {
+                return;
+            }
+            
             settings.Logger.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
 
             _server = WireMockServer.Start(settings);

examples/WireMock.Net.StandAlone.Net452/Program.cs

@@ -13,13 +13,15 @@ namespace WireMock.Net.StandAlone.Net452
         {
             XmlConfigurator.Configure(new FileInfo("log4net.config"));
 
-            var settings = WireMockServerSettingsParser.ParseArguments(args);
+            if (WireMockServerSettingsParser.TryParseArguments(args, out var settings))
-            settings.Logger.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
+            {
+                settings.Logger.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
 
-            WireMockServer.Start(settings);
+                WireMockServer.Start(settings);
 
-            Console.WriteLine("Press any key to stop the server");
+                Console.WriteLine("Press any key to stop the server");
-            Console.ReadKey();
+                Console.ReadKey();
+            }
         }
     }
 }

examples/WireMock.Net.StandAlone.Net461/Program.cs

@@ -9,13 +9,15 @@ namespace WireMock.Net.StandAlone.Net461
     {
         static void Main(string[] args)
         {
-            var settings = WireMockServerSettingsParser.ParseArguments(args);
+            if (WireMockServerSettingsParser.TryParseArguments(args, out var settings))
-            settings.Logger.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
+            {
+                settings.Logger.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
 
-            WireMockServer.Start(settings);
+                WireMockServer.Start(settings);
 
-            Console.WriteLine("Press any key to stop the server");
+                Console.WriteLine("Press any key to stop the server");
-            Console.ReadKey();
+                Console.ReadKey();
+            }
         }
     }
 }

src/WireMock.Net.Abstractions/WireMock.Net.Abstractions.csproj

@@ -21,6 +21,7 @@
     <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
     <!--<DelaySign>true</DelaySign>-->
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">

src/WireMock.Net.FluentAssertions/WireMock.Net.FluentAssertions.csproj

@@ -21,6 +21,7 @@
 		<AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
 		<!--<DelaySign>true</DelaySign>-->
 		<PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
 	<PropertyGroup Condition=" '$(Configuration)' == 'Release' ">

src/WireMock.Net.OpenApiParser/WireMock.Net.OpenApiParser.csproj

@@ -11,6 +11,7 @@
 		<SignAssembly>true</SignAssembly>
 		<AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
 		<PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="'$(Configuration)' == 'Release'">

src/WireMock.Net.RestClient/WireMock.Net.RestClient.csproj

@@ -21,6 +21,7 @@
     <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
     <!--<DelaySign>true</DelaySign>-->
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
   </PropertyGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">

src/WireMock.Net.StandAlone/StandAloneApp.cs

@@ -1,5 +1,5 @@
-using JetBrains.Annotations;
+using System.Linq;
-using System.Linq;
+using JetBrains.Annotations;
 using WireMock.Logging;
 using WireMock.Server;
 using WireMock.Settings;
@@ -38,11 +38,37 @@ namespace WireMock.Net.StandAlone
         {
             Check.NotNull(args, nameof(args));
 
-            var settings = WireMockServerSettingsParser.ParseArguments(args, logger);
+            if (WireMockServerSettingsParser.TryParseArguments(args, out var settings, logger))
+            {
+                settings.Logger?.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
 
-            settings.Logger?.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
+                return Start(settings);
+            }
 
-            return Start(settings);
+            return null;
+        }
+
+        /// <summary>
+        /// Try to start WireMock.Net standalone Server based on the commandline arguments.
+        /// </summary>
+        /// <param name="args">The commandline arguments</param>
+        /// <param name="logger">The logger</param>
+        /// <param name="server">The WireMockServer</param>
+        [PublicAPI]
+        public static bool TryStart([NotNull] string[] args, out WireMockServer server, [CanBeNull] IWireMockLogger logger = null)
+        {
+            Check.NotNull(args, nameof(args));
+
+            if (WireMockServerSettingsParser.TryParseArguments(args, out var settings, logger))
+            {
+                settings.Logger?.Debug("WireMock.Net server arguments [{0}]", string.Join(", ", args.Select(a => $"'{a}'")));
+
+                server = Start(settings);
+                return true;
+            }
+
+            server = null;
+            return false;
         }
     }
 }

src/WireMock.Net/Settings/SimpleCommandLineParser.cs

@@ -9,7 +9,7 @@ namespace WireMock.Settings
     {
         private const string Sigil = "--";
 
-        private IDictionary<string, string[]> Arguments { get; } = new Dictionary<string, string[]>();
+        private IDictionary<string, string[]> Arguments { get; } = new Dictionary<string, string[]>(StringComparer.OrdinalIgnoreCase);
 
         public void Parse(string[] arguments)
         {
@@ -70,6 +70,11 @@ namespace WireMock.Settings
             }, defaultValue);
         }
 
+        public bool GetBoolSwitchValue(string name)
+        {
+            return Contains(name);
+        }
+
         public int? GetIntValue(string name, int? defaultValue = null)
         {
             return GetValue(name, values =>

src/WireMock.Net/Settings/WireMockServerSettingsParser.cs

@@ -14,15 +14,23 @@ namespace WireMock.Settings
         /// </summary>
         /// <param name="args">The commandline arguments</param>
         /// <param name="logger">The logger (optional, can be null)</param>
+        /// <param name="settings">The parsed settings</param>
         [PublicAPI]
-        public static IWireMockServerSettings ParseArguments([NotNull] string[] args, [CanBeNull] IWireMockLogger logger = null)
+        public static bool TryParseArguments([NotNull] string[] args, out IWireMockServerSettings settings, [CanBeNull] IWireMockLogger logger = null)
         {
             Check.HasNoNulls(args, nameof(args));
 
             var parser = new SimpleCommandLineParser();
             parser.Parse(args);
 
-            var settings = new WireMockServerSettings
+            if (parser.GetBoolSwitchValue("help"))
+            {
+                logger.Info("See https://github.com/WireMock-Net/WireMock.Net/wiki/WireMock-commandline-parameters for details on all commandline options.");
+                settings = null;
+                return false;
+            }
+
+            settings = new WireMockServerSettings
             {
                 StartAdminInterface = parser.GetBoolValue("StartAdminInterface", true),
                 ReadStaticMappings = parser.GetBoolValue("ReadStaticMappings"),
@@ -100,7 +108,7 @@ namespace WireMock.Settings
                 settings.CertificateSettings = certificateSettings;
             }
 
-            return settings;
+            return true;
         }
     }
 }

src/dotnet-WireMock.Net/Program.cs

@@ -0,0 +1,58 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using WireMock.Net.StandAlone;
+using WireMock.Server;
+
+namespace WireMock
+{
+    public class Program
+    {
+        private static int SleepTime = 30000;
+        private static readonly ILogger Logger = LoggerFactory.Create(o =>
+        {
+            o.SetMinimumLevel(LogLevel.Debug);
+            o.AddSimpleConsole(options =>
+            {
+                options.IncludeScopes = true;
+                options.SingleLine = false;
+                options.TimestampFormat = "yyyy-MM-ddTHH:mm:ss ";
+            });
+        }).CreateLogger(string.Empty);
+
+        private static WireMockServer Server;
+
+        static async Task Main(string[] args)
+        {
+            if (!StandAloneApp.TryStart(args, out Server, new WireMockLogger(Logger)))
+            {
+                return;
+            }
+
+            Logger.LogInformation("Press Ctrl+C to shut down");
+
+            Console.CancelKeyPress += (s, e) =>
+            {
+                Stop("CancelKeyPress");
+            };
+
+            System.Runtime.Loader.AssemblyLoadContext.Default.Unloading += ctx =>
+            {
+                Stop("AssemblyLoadContext.Default.Unloading");
+            };
+
+            while (true)
+            {
+                Logger.LogInformation("WireMock.Net server running : {IsStarted}", Server.IsStarted);
+                await Task.Delay(SleepTime);
+            }
+        }
+
+        private static void Stop(string why)
+        {
+            Logger.LogInformation("WireMock.Net server stopping because '{why}'", why);
+            Server.Stop();
+            Logger.LogInformation("WireMock.Net server stopped");
+        }
+    }
+}

src/dotnet-WireMock.Net/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "dotnet-WireMock.Net": {
+      "commandName": "Project",
+      "commandLineArgs": ""
+    }
+  }
+}

src/dotnet-WireMock.Net/WireMockLogger.cs

@@ -0,0 +1,61 @@
+using System;
+using System.Text.Json;
+using Microsoft.Extensions.Logging;
+using WireMock.Admin.Requests;
+using WireMock.Logging;
+
+namespace WireMock
+{
+    public class WireMockLogger : IWireMockLogger
+    {
+        private readonly JsonSerializerOptions options = new JsonSerializerOptions
+        {
+            WriteIndented = true
+        };
+
+        private readonly ILogger _logger;
+
+        public WireMockLogger(ILogger logger)
+        {
+            _logger = logger;
+        }
+
+        /// <see cref="IWireMockLogger.Debug"/>
+        public void Debug(string formatString, params object[] args)
+        {
+            _logger.LogDebug(formatString, args);
+        }
+
+        /// <see cref="IWireMockLogger.Info"/>
+        public void Info(string formatString, params object[] args)
+        {
+            _logger.LogInformation(formatString, args);
+        }
+
+        /// <see cref="IWireMockLogger.Warn"/>
+        public void Warn(string formatString, params object[] args)
+        {
+            _logger.LogWarning(formatString, args);
+        }
+
+        /// <see cref="IWireMockLogger.Error(string, object[])"/>
+        public void Error(string formatString, params object[] args)
+        {
+            _logger.LogError(formatString, args);
+        }
+
+        /// <see cref="IWireMockLogger.Error(string, Exception)"/>
+        public void Error(string formatString, Exception exception)
+        {
+            _logger.LogError(formatString, exception);
+        }
+
+        /// <see cref="IWireMockLogger.DebugRequestResponse"/>
+        public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
+        {
+            string message = JsonSerializer.Serialize(logEntryModel, options);
+
+            _logger.LogDebug("Admin[{IsAdmin}] {Message}", isAdminRequest, message);
+        }
+    }
+}

src/dotnet-WireMock.Net/dotnet-WireMock.csproj

@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net5</TargetFramework>
+    <PackAsTool>true</PackAsTool>
+    <ToolCommandName>dotnet-wiremock</ToolCommandName>
+    <Description>A dotnet commandline tool for WireMock.Net (A Lightweight Http Mocking Server for .NET)</Description>
+    <PackageTags>tdd;mock;http;wiremock;test;server;unittest;dotnet;tool;dotnet-tool</PackageTags>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <Authors>Stef Heyenrath</Authors>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)' == 'Release'">
+    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="5.0.0" />
+    <PackageReference Include="System.Text.Json" Version="5.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\WireMock.Net.StandAlone\WireMock.Net.StandAlone.csproj" />
+  </ItemGroup>
+
+</Project>