Add player connection port parsing tests (#1139)

Author: Jamie Brynes

workers/unity/Packages/io.improbable.gdk.core/Tests/Editmode/Utility/PlayerConnectionPortTests.cs

@@ -0,0 +1,44 @@
+using System;
+using NUnit.Framework;
+
+namespace Improbable.Gdk.Core.EditmodeTests
+{
+    [TestFixture]
+    public class PlayerConnectionPortTests
+    {
+        private const string CorrectTemplate = "PlayerConnection initialized network socket : 0.0.0.0 {0}";
+
+        [Test]
+        public void ExtractPlayerConnectionPort_throws_exception_if_no_match()
+        {
+            var noPortHere = "There isn't a port here.\nYou really shouldn't even bother looking.";
+            Assert.Throws<Exception>(() => WorkerConnector.ExtractPlayerConnectionPort(noPortHere));
+        }
+
+        [Test]
+        public void ExtractPlayerConnectionPort_finds_port_regardless_of_position_in_file()
+        {
+            const string validPort = "5555";
+
+            // First start with a single line.
+            var exampleFile = string.Format(CorrectTemplate, validPort);
+            Assert.AreEqual(ushort.Parse(validPort), WorkerConnector.ExtractPlayerConnectionPort(exampleFile));
+
+            // Put something in front.
+            exampleFile = $"Something in front!\n{exampleFile}";
+            Assert.AreEqual(ushort.Parse(validPort), WorkerConnector.ExtractPlayerConnectionPort(exampleFile));
+
+            // Put something behind.
+            exampleFile = $"{exampleFile}\nSomething behind!";
+            Assert.AreEqual(ushort.Parse(validPort), WorkerConnector.ExtractPlayerConnectionPort(exampleFile));
+        }
+
+        [TestCase("0", typeof(Exception))]
+        [TestCase("70000", typeof(OverflowException))]
+        public void ExtractPlayerConnectionPort_throws_exception_if_invalid_port(string port, Type exceptionType)
+        {
+            var file = string.Format(CorrectTemplate, port);
+            Assert.Throws(exceptionType, () => WorkerConnector.ExtractPlayerConnectionPort(file));
+        }
+    }
+}

workers/unity/Packages/io.improbable.gdk.core/Tests/Editmode/Utility/PlayerConnectionPortTests.cs.meta

@@ -253,7 +253,7 @@ private void RemoveFromPlayerLoop()
             }
         }
 
-        private ushort GetPlayerConnectionPort()
+        private static ushort GetPlayerConnectionPort()
         {
             var companyName = Application.companyName;
             var productName = Application.productName;
@@ -287,19 +287,30 @@ private ushort GetPlayerConnectionPort()
             using (var readStream = new StreamReader(stream))
             {
                 var logContents = readStream.ReadToEnd();
+                return ExtractPlayerConnectionPort(logContents);
+            }
+        }
 
-                const string portRegex =
-                    "PlayerConnection initialized network socket : [0-9]\\.[0-9]\\.[0-9]\\.[0-9] ([0-9]*)";
+        internal static ushort ExtractPlayerConnectionPort(string fileContents)
+        {
+            const string portRegex =
+                "PlayerConnection initialized network socket : 0\\.0\\.0\\.0 ([0-9]+)";
 
-                var regex = new Regex(portRegex, RegexOptions.Compiled);
+            var regex = new Regex(portRegex, RegexOptions.Compiled);
 
-                if (!regex.IsMatch(logContents))
-                {
-                    throw new Exception("Could not find PlayerConnection port in logfile");
-                }
+            if (!regex.IsMatch(fileContents))
+            {
+                throw new Exception("Could not find PlayerConnection port in logfile");
+            }
+
+            var port = ushort.Parse(regex.Match(fileContents).Groups[1].Value);
 
-                return ushort.Parse(regex.Match(logContents).Groups[1].Value);
+            if (port == 0)
+            {
+                throw new Exception("PlayerConnection port cannot be 0.");
             }
+
+            return port;
         }
     }
 }