TcpCustomServerProtocolSetup and TcpBinaryServerProtocolSetup shouldn…

…'t return 0.0.0.0 as a discoverable host, zyanfx#71.

source/Zyan.Communication/Protocols/ServerProtocolSetup.cs

@@ -223,5 +223,45 @@ protected virtual bool IsDiscoverableUrl(string url)
 				return false;
 			}
 		}
+
+		/// <summary>
+		/// Gets the current machine IP addresses.
+		/// TODO: move this method to a helper class.
+		/// </summary>
+		internal static IPAddress[] GetIpAddresses()
+		{
+			var invalid = new[]
+			{
+				IPAddress.Loopback, IPAddress.Any,
+				IPAddress.IPv6Loopback, IPAddress.IPv6Any
+			};
+
+			return Tcp.DuplexChannel.Manager.GetAddresses()
+				.Where(ip => !invalid.Contains(ip))
+				.ToArray();
+		}
+
+		/// <summary>
+		/// Replaces the host name within the given URL.
+		/// TODO: move this method to a helper class.
+		/// </summary>
+		/// <param name="url">URL to replace the host name.</param>
+		/// <param name="hostName">New host name.</param>
+		internal static string TryReplaceHostName(string url, string hostName)
+		{
+			try
+			{
+				// use Uri class to validate the input
+				var uri = new Uri(url ?? string.Empty);
+				var builder = new UriBuilder(uri);
+				builder.Host = hostName;
+				return builder.Uri.ToString();
+			}
+			catch (UriFormatException)
+			{
+				// fail to format the given url
+				return url;
+			}
+		}
 	}
 }

source/Zyan.Communication/Protocols/Tcp/TcpBinaryServerProtocolSetup.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections;
+using System.Linq;
 using System.Net.Security;
 using System.Runtime.Remoting;
 using System.Runtime.Remoting.Channels;
@@ -207,6 +208,19 @@ public override IAuthenticationProvider AuthenticationProvider
 			}
 		}
 
+		/// <inheritdoc/>
+		public override string GetDiscoverableUrl(string zyanHostName)
+		{
+			var channel = CreateChannel() as IChannelReceiver;
+			if (channel == null)
+			{
+				return null;
+			}
+
+			var url = channel.GetUrlsForUri(zyanHostName).FirstOrDefault();
+			return TryReplaceHostName(url, GetIpAddresses().FirstOrDefault()?.ToString());
+		}
+
 		#region Versioning settings
 
 		private Versioning _versioning = Versioning.Strict;

source/Zyan.Communication/Protocols/Tcp/TcpCustomServerProtocolSetup.cs

@@ -1,5 +1,7 @@
 using System;
 using System.Collections;
+using System.Linq;
+using System.Net;
 using System.Runtime.Remoting;
 using System.Runtime.Remoting.Channels;
 using System.Runtime.Remoting.Channels.Tcp;
@@ -388,6 +390,19 @@ public override IAuthenticationProvider AuthenticationProvider
 			}
 		}
 
+		/// <inheritdoc/>
+		public override string GetDiscoverableUrl(string zyanHostName)
+		{
+			var channel = CreateChannel() as IChannelReceiver;
+			if (channel == null)
+			{
+				return null;
+			}
+
+			var url = channel.GetUrlsForUri(zyanHostName).FirstOrDefault();
+			return TryReplaceHostName(url, GetIpAddresses().FirstOrDefault()?.ToString());
+		}
+
 		#region Versioning settings
 
 		private Versioning _versioning = Versioning.Strict;

source/Zyan.Tests/ProtocolUrlTests.cs

@@ -1,5 +1,9 @@
 using System;
+using System.Configuration;
+using System.Linq;
+using System.Net;
 using Zyan.Communication;
+using Zyan.Communication.Protocols;
 using Zyan.Communication.Protocols.Http;
 using Zyan.Communication.Protocols.Ipc;
 using Zyan.Communication.Protocols.Null;
@@ -125,5 +129,42 @@ public void ZyanConnectionDoesntAcceptMalformedUrl()
 				Assert.Fail("'hello' is not a valid url for the Ipc protocol.");
 			}
 		}
+
+		[TestMethod]
+		public void GetIpAddressesDoesntReturnLoopbackOrAnyIpAddresses()
+		{
+			var addresses = ServerProtocolSetup.GetIpAddresses();
+			Assert.IsFalse(addresses.Contains(IPAddress.Any));
+			Assert.IsFalse(addresses.Contains(IPAddress.IPv6Any));
+			Assert.IsFalse(addresses.Contains(IPAddress.Loopback));
+			Assert.IsFalse(addresses.Contains(IPAddress.IPv6Loopback));
+		}
+
+		[TestMethod]
+		public void TryReplaceHostNameReplacesValidHostNamesAndDoesntThrowOnInvalidInput()
+		{
+			var url = ServerProtocolSetup.TryReplaceHostName("http://1.2.3.4/5", "newhost");
+			Assert.AreEqual("http://newhost/5", url);
+			Assert.AreEqual("unsupported", ServerProtocolSetup.TryReplaceHostName("unsupported", "example"));
+			Assert.AreEqual(null, ServerProtocolSetup.TryReplaceHostName(null, null));
+		}
+
+		[TestMethod]
+		public void TcpCustomServerChannelDoesntReturn0000AsDiscoverableUrl()
+		{
+			var proto = new TcpCustomServerProtocolSetup(12346, null);
+			var url = proto.GetDiscoverableUrl("SomeServer");
+			Assert.IsFalse(string.IsNullOrEmpty(url));
+			Assert.AreNotEqual("tcp://0.0.0.0:12346/SomeServer", url);
+		}
+
+		[TestMethod]
+		public void TcpBinaryServerChannelDoesntReturn0000AsDiscoverableUrl()
+		{
+			var proto = new TcpBinaryServerProtocolSetup(12347);
+			var url = proto.GetDiscoverableUrl("SomeServer");
+			Assert.IsFalse(string.IsNullOrEmpty(url));
+			Assert.AreNotEqual("tcp://0.0.0.0:12347/SomeServer", url);
+		}
 	}
 }