1.0.3.15

* Respect start timeout setting and expose exception from server startup

* Dispose running servers properly on error happening

* Addressed comments from Stef

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.0.3.15 (05 April 2018)
+
+ - [#117](https://github.com/WireMock-Net/WireMock.Net/pull/117) - Respect start timeout setting and expose exception from server startup contributed by Evan Liang ([evanlwj](https://github.com/evanlwj))
+
+Commits: 2d2a2dd6fc...4f294baff2
+
+
 # 1.0.3.14 (01 April 2018)
 
  - [#114](https://github.com/WireMock-Net/WireMock.Net/issues/114) - Feature: Add PathSegments in Transform +feature

GitReleaseNotes.txt

@@ -1,5 +1,5 @@
 https://github.com/GitTools/GitReleaseNotes
 
-GitReleaseNotes.exe . /OutputFile CHANGELOG.md /Version 1.0.3.14
+GitReleaseNotes.exe . /OutputFile CHANGELOG.md /Version 1.0.3.15
 
 GitReleaseNotes.exe . /OutputFile CHANGELOG.md /allTags

src/WireMock.Net.StandAlone/WireMock.Net.StandAlone.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Description>Lightweight StandAlone Http Mocking Server for .Net.</Description>
     <AssemblyTitle>WireMock.Net.StandAlone</AssemblyTitle>
-    <Version>1.0.3.14</Version>
+    <Version>1.0.3.15</Version>
     <Authors>Stef Heyenrath</Authors>
     <TargetFrameworks>net452;net46;netstandard1.3;netstandard2.0</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

src/WireMock.Net/Owin/AspNetCoreSelfHost.cs

@@ -9,6 +9,7 @@ using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using WireMock.Http;
 using WireMock.HttpsCertificate;
+using WireMock.Logging;
 using WireMock.Validation;
 
 namespace WireMock.Owin
@@ -18,6 +19,8 @@ namespace WireMock.Owin
         private readonly CancellationTokenSource _cts = new CancellationTokenSource();
         private readonly WireMockMiddlewareOptions _options;
         private readonly string[] _urls;
+        private readonly IWireMockLogger _logger;
+        private Exception _runningException;
 
         private IWebHost _host;
 
@@ -27,11 +30,15 @@ namespace WireMock.Owin
 
         public List<int> Ports { get; } = new List<int>();
 
+        public Exception RunningException => _runningException;
+
         public AspNetCoreSelfHost([NotNull] WireMockMiddlewareOptions options, [NotNull] params string[] uriPrefixes)
         {
             Check.NotNull(options, nameof(options));
             Check.NotNullOrEmpty(uriPrefixes, nameof(uriPrefixes));
 
+            _logger = options.Logger ?? new WireMockConsoleLogger();
+
             foreach (string uriPrefix in uriPrefixes)
             {
                 Urls.Add(uriPrefix);
@@ -89,20 +96,34 @@ namespace WireMock.Owin
 
             IsStarted = true;
 
-#if NETSTANDARD1_3
-            Console.WriteLine("WireMock.Net server using netstandard1.3");
             return Task.Run(() =>
             {
-                _host.Run(_cts.Token);
+                StartServers();
             }, _cts.Token);
-#else
-            System.Console.WriteLine("WireMock.Net server using netstandard2.0");
+        }
 
-            return Task.Run(() =>
+        private void StartServers()
+        {
+            try
             {
+                IsStarted = true;
+#if NETSTANDARD1_3
+                _logger.Info("WireMock.Net server using netstandard1.3");
+                _host.Run(_cts.Token);
+#else
+                _logger.Info("WireMock.Net server using netstandard2.0");
                 _host.Run();
-            }, _cts.Token);
 #endif
+            }
+            catch (Exception e)
+            {
+                _runningException = e;
+                _logger.Error(e.ToString());
+            }
+            finally
+            {
+                IsStarted = false;
+            }
         }
 
         public Task StopAsync()

src/WireMock.Net/Owin/IOwinSelfHost.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using System;
 
 namespace WireMock.Owin
 {
@@ -16,19 +17,18 @@ namespace WireMock.Owin
         /// <summary>
         /// Gets the urls.
         /// </summary>
-        /// <value>
-        /// The urls.
-        /// </value>
         List<string> Urls { get; }
 
         /// <summary>
         /// Gets the ports.
         /// </summary>
-        /// <value>
-        /// The ports.
-        /// </value>
         List<int> Ports { get; }
 
+        /// <summary>
+        /// The exception occurred when the host is running
+        /// </summary>
+        Exception RunningException { get; }
+
         Task StartAsync();
 
         Task StopAsync();

src/WireMock.Net/Owin/OwinRequestMapper.cs

@@ -1,8 +1,6 @@
 using System;
 using System.Collections.Generic;
-// using System.IO;
 using System.Linq;
-// using System.Text;
 using System.Threading.Tasks;
 using WireMock.Util;
 #if !NETSTANDARD

src/WireMock.Net/Owin/OwinSelfHost.cs

@@ -1,13 +1,14 @@
 #if !NETSTANDARD
+using JetBrains.Annotations;
+using Microsoft.Owin.Hosting;
+using Owin;
 using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using JetBrains.Annotations;
-using WireMock.Validation;
-using Owin;
-using Microsoft.Owin.Hosting;
 using WireMock.Http;
+using WireMock.Logging;
+using WireMock.Validation;
 
 namespace WireMock.Owin
 {
@@ -15,12 +16,16 @@ namespace WireMock.Owin
     {
         private readonly WireMockMiddlewareOptions _options;
         private readonly CancellationTokenSource _cts = new CancellationTokenSource();
+        private readonly IWireMockLogger _logger;
+        private Exception _runningException;
 
         public OwinSelfHost([NotNull] WireMockMiddlewareOptions options, [NotNull] params string[] uriPrefixes)
         {
             Check.NotNull(options, nameof(options));
             Check.NotNullOrEmpty(uriPrefixes, nameof(uriPrefixes));
 
+            _logger = options.Logger ?? new WireMockConsoleLogger();
+
             foreach (string uriPrefix in uriPrefixes)
             {
                 Urls.Add(uriPrefix);
@@ -38,6 +43,8 @@ namespace WireMock.Owin
 
         public List<int> Ports { get; } = new List<int>();
 
+        public Exception RunningException => _runningException;
+
         [PublicAPI]
         public Task StartAsync()
         {
@@ -58,37 +65,46 @@ namespace WireMock.Owin
         private void StartServers()
         {
 #if NET46
-            Console.WriteLine("WireMock.Net server using .net 4.6.x or higher");
+            _logger.Info("WireMock.Net server using .net 4.6.x or higher");
 #else
-            Console.WriteLine("WireMock.Net server using .net 4.5.x or higher");
+            _logger.Info("WireMock.Net server using .net 4.5.x or higher");
 #endif
-
-            Action<IAppBuilder> startup = app =>
-            {
-                app.Use<GlobalExceptionMiddleware>(_options);
-                _options.PreWireMockMiddlewareInit?.Invoke(app);
-                app.Use<WireMockMiddleware>(_options);
-                _options.PostWireMockMiddlewareInit?.Invoke(app);
-            };
-
             var servers = new List<IDisposable>();
-            foreach (var url in Urls)
+
+            try
             {
-                servers.Add(WebApp.Start(url, startup));
+                Action<IAppBuilder> startup = app =>
+                {
+                    app.Use<GlobalExceptionMiddleware>(_options);
+                    _options.PreWireMockMiddlewareInit?.Invoke(app);
+                    app.Use<WireMockMiddleware>(_options);
+                    _options.PostWireMockMiddlewareInit?.Invoke(app);
+                };
+
+                foreach (var url in Urls)
+                {
+                    servers.Add(WebApp.Start(url, startup));
+                }
+
+                IsStarted = true;
+
+                // WaitHandle is signaled when the token is cancelled,
+                // which will be more efficent than Thread.Sleep in while loop
+                _cts.Token.WaitHandle.WaitOne();
             }
-
-            IsStarted = true;
-
-            while (!_cts.IsCancellationRequested)
+            catch (Exception e)
             {
-                Thread.Sleep(30000);
+                // Expose exception of starting host, otherwise it's hard to be troubleshooting if keeping quiet
+                // For example, WebApp.Start will fail with System.MissingMemberException if Microsoft.Owin.Host.HttpListener.dll is being located
+                // https://stackoverflow.com/questions/25090211/owin-httplistener-not-located/31369857
+                _runningException = e;
+                _logger.Error(e.ToString());
             }
-
-            IsStarted = false;
-
-            foreach (var server in servers)
+            finally
             {
-                server.Dispose();
+                IsStarted = false;
+                // Dispose all servers in finally block to make sure clean up allocated resource on error happening
+                servers.ForEach(s => s.Dispose());
             }
         }
     }

src/WireMock.Net/Server/FluentMockServer.cs

@@ -1,20 +1,20 @@
+using JetBrains.Annotations;
+using Newtonsoft.Json;
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
-using System.Threading.Tasks;
-using JetBrains.Annotations;
-using Newtonsoft.Json;
+using System.Threading;
 using WireMock.Http;
 using WireMock.Logging;
 using WireMock.Matchers;
 using WireMock.Matchers.Request;
+using WireMock.Owin;
 using WireMock.RequestBuilders;
+using WireMock.ResponseProviders;
 using WireMock.Settings;
 using WireMock.Validation;
-using WireMock.Owin;
-using WireMock.ResponseProviders;
 
 namespace WireMock.Server
 {
@@ -32,7 +32,7 @@ namespace WireMock.Server
         /// Gets a value indicating whether this server is started.
         /// </summary>
         [PublicAPI]
-        public bool IsStarted { get; }
+        public bool IsStarted => _httpServer != null && _httpServer.IsStarted;
 
         /// <summary>
         /// Gets the ports.
@@ -186,10 +186,23 @@ namespace WireMock.Server
 
             _httpServer.StartAsync();
 
-            // Fix for 'Bug: Server not listening after Start() returns (on macOS)'
-            Task.Delay(ServerStartDelay).Wait();
-
-            IsStarted = _httpServer.IsStarted;
+            using (var ctsStartTimeout = new CancellationTokenSource(settings.StartTimeout))
+            {
+                while (!_httpServer.IsStarted)
+                {
+                    // Throw out exception if service start fails
+                    if (_httpServer.RunningException != null)
+                    {
+                        throw new Exception($"Service start failed with error: {_httpServer.RunningException.Message}", _httpServer.RunningException);
+                    }
+                    // Respect start timeout setting by throwing TimeoutException
+                    if (ctsStartTimeout.IsCancellationRequested)
+                    {
+                        throw new TimeoutException($"Service start timed out after {TimeSpan.FromMilliseconds(settings.StartTimeout)}");
+                    }
+                    ctsStartTimeout.Token.WaitHandle.WaitOne(ServerStartDelay);
+                }
+            }
 
             if (settings.AllowPartialMapping == true)
             {

src/WireMock.Net/WireMock.Net.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Description>Lightweight Http Mocking Server for .Net, inspired by WireMock from the Java landscape.</Description>
     <AssemblyTitle>WireMock.Net</AssemblyTitle>
-    <Version>1.0.3.14</Version>
+    <Version>1.0.3.15</Version>
     <Authors>Stef Heyenrath</Authors>
     <TargetFrameworks>net452;net46;netstandard1.3;netstandard2.0</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>