Skip to content
This repository was archived by the owner on Dec 18, 2018. It is now read-only.

Commit 2c94884

Browse files
author
Cesar Blum Silveira
committed
Include address in error message when address already in use (#1086).
1 parent f1f6644 commit 2c94884

File tree

2 files changed

+74
-22
lines changed

2 files changed

+74
-22
lines changed

‎src/Microsoft.AspNetCore.Server.Kestrel/KestrelServer.cs

+26-20
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
using System;
55
using System.Collections.Generic;
6+
using System.IO;
67
using System.Linq;
78
using System.Reflection;
89
using Microsoft.AspNetCore.Hosting;
@@ -109,8 +110,19 @@ public void Start<TContext>(IHttpApplication<TContext> application)
109110

110111
if (!parsedAddress.Host.Equals("localhost", StringComparison.OrdinalIgnoreCase))
111112
{
112-
_disposables.Push(engine.CreateServer(
113-
parsedAddress));
113+
try
114+
{
115+
_disposables.Push(engine.CreateServer(parsedAddress));
116+
}
117+
catch (AggregateException ex)
118+
{
119+
if ((ex.InnerException as UvException)?.StatusCode == Constants.EADDRINUSE)
120+
{
121+
throw new IOException($"Failed to bind to address {parsedAddress}: address already in use.", ex);
122+
}
123+
124+
throw;
125+
}
114126
}
115127
else
116128
{
@@ -120,24 +132,22 @@ public void Start<TContext>(IHttpApplication<TContext> application)
120132
}
121133

122134
var ipv4Address = parsedAddress.WithHost("127.0.0.1");
123-
var exceptions = new List<UvException>();
135+
var exceptions = new List<Exception>();
124136

125137
try
126138
{
127139
_disposables.Push(engine.CreateServer(ipv4Address));
128140
}
129-
catch (AggregateException ex)
141+
catch (AggregateException ex) when (ex.InnerException is UvException)
130142
{
131-
var uvException = ex.InnerException as UvException;
132-
133-
if (uvException != null && uvException.StatusCode != Constants.EADDRINUSE)
143+
if ((ex.InnerException as UvException).StatusCode == Constants.EADDRINUSE)
134144
{
135-
_logger.LogWarning(0, ex, $"Unable to bind to {parsedAddress.ToString()} on the IPv4 loopback interface.");
136-
exceptions.Add(uvException);
145+
throw new IOException($"Failed to bind to address {parsedAddress.ToString()} on the IPv4 loopback interface: port already in use.", ex);
137146
}
138147
else
139148
{
140-
throw;
149+
_logger.LogWarning(0, ex, $"Unable to bind to {parsedAddress.ToString()} on the IPv4 loopback interface.");
150+
exceptions.Add(ex.InnerException);
141151
}
142152
}
143153

@@ -147,26 +157,22 @@ public void Start<TContext>(IHttpApplication<TContext> application)
147157
{
148158
_disposables.Push(engine.CreateServer(ipv6Address));
149159
}
150-
catch (AggregateException ex)
160+
catch (AggregateException ex) when (ex.InnerException is UvException)
151161
{
152-
var uvException = ex.InnerException as UvException;
153-
154-
if (uvException != null && uvException.StatusCode != Constants.EADDRINUSE)
162+
if ((ex.InnerException as UvException).StatusCode == Constants.EADDRINUSE)
155163
{
156-
_logger.LogWarning(0, ex, $"Unable to bind to {parsedAddress.ToString()} on the IPv6 loopback interface.");
157-
exceptions.Add(uvException);
164+
throw new IOException($"Failed to bind to address {parsedAddress.ToString()} on the IPv6 loopback interface: port already in use.", ex);
158165
}
159166
else
160167
{
161-
throw;
168+
_logger.LogWarning(0, ex, $"Unable to bind to {parsedAddress.ToString()} on the IPv6 loopback interface.");
169+
exceptions.Add(ex.InnerException);
162170
}
163171
}
164172

165173
if (exceptions.Count == 2)
166174
{
167-
var ex = new AggregateException(exceptions);
168-
_logger.LogError(0, ex, $"Unable to bind to {parsedAddress.ToString()} on any loopback interface.");
169-
throw ex;
175+
throw new IOException($"Failed to bind to address {parsedAddress.ToString()}.", new AggregateException(exceptions));
170176
}
171177
}
172178

‎test/Microsoft.AspNetCore.Server.Kestrel.FunctionalTests/AddressRegistrationTests.cs

+48-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
using System;
55
using System.Collections.Generic;
6+
using System.IO;
67
using System.Linq;
78
using System.Net;
89
using System.Net.NetworkInformation;
@@ -97,6 +98,49 @@ private async Task RegisterAddresses_Success(string addressInput, Func<IServerAd
9798
}
9899
}
99100

101+
[Fact]
102+
public void ThrowsWhenBindingToIPv4AddressInUse()
103+
{
104+
using (var socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp))
105+
{
106+
var port = GetNextPort();
107+
socket.Bind(new IPEndPoint(IPAddress.Loopback, port));
108+
109+
var hostBuilder = new WebHostBuilder()
110+
.UseKestrel()
111+
.UseUrls($"http://127.0.0.1:{port}")
112+
.Configure(ConfigureEchoAddress);
113+
114+
using (var host = hostBuilder.Build())
115+
{
116+
var exception = Assert.Throws<IOException>(() => host.Start());
117+
Assert.Equal($"Failed to bind to address http://127.0.0.1:{port}: address already in use.", exception.Message);
118+
}
119+
}
120+
}
121+
122+
[ConditionalFact]
123+
[IPv6SupportedCondition]
124+
public void ThrowsWhenBindingToIPv6AddressInUse()
125+
{
126+
using (var socket = new Socket(AddressFamily.InterNetworkV6, SocketType.Stream, ProtocolType.Tcp))
127+
{
128+
var port = GetNextPort();
129+
socket.Bind(new IPEndPoint(IPAddress.IPv6Loopback, port));
130+
131+
var hostBuilder = new WebHostBuilder()
132+
.UseKestrel()
133+
.UseUrls($"http://[::1]:{port}")
134+
.Configure(ConfigureEchoAddress);
135+
136+
using (var host = hostBuilder.Build())
137+
{
138+
var exception = Assert.Throws<IOException>(() => host.Start());
139+
Assert.Equal($"Failed to bind to address http://[::1]:{port}: address already in use.", exception.Message);
140+
}
141+
}
142+
}
143+
100144
[Fact]
101145
public void ThrowsWhenBindingLocalhostToIPv4AddressInUse()
102146
{
@@ -138,8 +182,10 @@ private void ThrowsWhenBindingLocalhostToAddressInUse(AddressFamily addressFamil
138182

139183
using (var host = hostBuilder.Build())
140184
{
141-
var exception = Assert.Throws<AggregateException>(() => host.Start());
142-
Assert.Contains(exception.InnerExceptions, ex => ex is UvException);
185+
var exception = Assert.Throws<IOException>(() => host.Start());
186+
Assert.Equal(
187+
$"Failed to bind to address http://localhost:{port} on the {(addressFamily == AddressFamily.InterNetwork ? "IPv4" : "IPv6")} loopback interface: port already in use.",
188+
exception.Message);
143189
}
144190
}
145191
}

0 commit comments

Comments
 (0)