Implement new runner service name convention (#193)

* Limit service name to 80 characters
* Add L0 tests
* New service name convention
* Make RepoOrOrgName a computed property
* Add service name sanitizing logic with L0 test

src/Test/L0/ServiceControlManagerL0.cs

@@ -0,0 +1,175 @@
+using System;
+using System.Runtime.CompilerServices;
+using GitHub.Runner.Common;
+using GitHub.Runner.Listener.Configuration;
+using Xunit;
+
+namespace GitHub.Runner.Common.Tests
+{
+    public sealed class ServiceControlManagerL0
+    {
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Service")]
+        public void CalculateServiceName()
+        {
+            RunnerSettings settings = new RunnerSettings();
+
+            settings.AgentName = "thisiskindofalongrunnername1";
+            settings.ServerUrl = "https://example.githubusercontent.com/12345678901234567890123456789012345678901234567890";
+            settings.GitHubUrl = "https://github.com/myorganizationexample/myrepoexample";
+
+            string serviceNamePattern = "actions.runner.{0}.{1}";
+            string serviceDisplayNamePattern = "GitHub Actions Runner ({0}.{1})";
+
+            using (TestHostContext hc = CreateTestContext())
+            {
+                ServiceControlManager scm = new ServiceControlManager();
+
+                scm.Initialize(hc);
+                scm.CalculateServiceName(
+                    settings,
+                    serviceNamePattern,
+                    serviceDisplayNamePattern,
+                    out string serviceName,
+                    out string serviceDisplayName);
+
+                var serviceNameParts = serviceName.Split('.');
+
+                // Verify name is 79 characters
+                Assert.Equal(79, serviceName.Length);
+
+                // Verify nothing has been shortened out
+                Assert.Equal("actions", serviceNameParts[0]);
+                Assert.Equal("runner", serviceNameParts[1]);
+                Assert.Equal("myorganizationexample-myrepoexample", serviceNameParts[2]); // '/' has been replaced with '-'
+                Assert.Equal("thisiskindofalongrunnername1", serviceNameParts[3]);
+            }
+        }
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Service")]
+        public void CalculateServiceName80Chars()
+        {
+            RunnerSettings settings = new RunnerSettings();
+
+            settings.AgentName = "thisiskindofalongrunnername12";
+            settings.ServerUrl = "https://example.githubusercontent.com/12345678901234567890123456789012345678901234567890";
+            settings.GitHubUrl = "https://github.com/myorganizationexample/myrepoexample";
+
+            string serviceNamePattern = "actions.runner.{0}.{1}";
+            string serviceDisplayNamePattern = "GitHub Actions Runner ({0}.{1})";
+
+            using (TestHostContext hc = CreateTestContext())
+            {
+                ServiceControlManager scm = new ServiceControlManager();
+
+                scm.Initialize(hc);
+                scm.CalculateServiceName(
+                    settings,
+                    serviceNamePattern,
+                    serviceDisplayNamePattern,
+                    out string serviceName,
+                    out string serviceDisplayName);
+
+                // Verify name is still equal to 80 characters
+                Assert.Equal(80, serviceName.Length);
+
+                var serviceNameParts = serviceName.Split('.');
+
+                // Verify nothing has been shortened out
+                Assert.Equal("actions", serviceNameParts[0]);
+                Assert.Equal("runner", serviceNameParts[1]);
+                Assert.Equal("myorganizationexample-myrepoexample", serviceNameParts[2]); // '/' has been replaced with '-'
+                Assert.Equal("thisiskindofalongrunnername12", serviceNameParts[3]);
+            }
+        }
+
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Service")]
+        public void CalculateServiceNameLimitsServiceNameTo80Chars()
+        {
+            RunnerSettings settings = new RunnerSettings();
+
+            settings.AgentName = "thisisareallyreallylongbutstillvalidagentname";
+            settings.ServerUrl = "https://example.githubusercontent.com/12345678901234567890123456789012345678901234567890";
+            settings.GitHubUrl = "https://github.com/myreallylongorganizationexample/myreallylongrepoexample";
+
+            string serviceNamePattern = "actions.runner.{0}.{1}";
+            string serviceDisplayNamePattern = "GitHub Actions Runner ({0}.{1})";
+
+            using (TestHostContext hc = CreateTestContext())
+            {
+                ServiceControlManager scm = new ServiceControlManager();
+
+                scm.Initialize(hc);
+                scm.CalculateServiceName(
+                    settings,
+                    serviceNamePattern,
+                    serviceDisplayNamePattern,
+                    out string serviceName,
+                    out string serviceDisplayName);
+
+                // Verify name has been shortened to 80 characters
+                Assert.Equal(80, serviceName.Length);
+
+                var serviceNameParts = serviceName.Split('.');
+
+                // Verify that each component has been shortened to a sensible length
+                Assert.Equal("actions", serviceNameParts[0]); // Never shortened
+                Assert.Equal("runner", serviceNameParts[1]); // Never shortened
+                Assert.Equal("myreallylongorganizationexample-myreallylongr", serviceNameParts[2]); // First 45 chars, '/' has been replaced with '-'
+                Assert.Equal("thisisareallyreally", serviceNameParts[3]); // Remainder of unused chars
+            }
+        }
+
+        // Special 'defensive' test that verifies we can gracefully handle creating service names
+        // in case GitHub.com changes its org/repo naming convention in the future,
+        // and some of these characters may be invalid for service names
+        // Not meant to test character set exhaustively -- it's just here to exercise the sanitizing logic
+        [Fact]
+        [Trait("Level", "L0")]
+        [Trait("Category", "Service")]
+        public void CalculateServiceNameSanitizeOutOfRangeChars()
+        {
+            RunnerSettings settings = new RunnerSettings();
+
+            settings.AgentName = "name";
+            settings.ServerUrl = "https://example.githubusercontent.com/12345678901234567890123456789012345678901234567890";
+            settings.GitHubUrl = "https://github.com/org!@$*+[]()/repo!@$*+[]()";
+
+            string serviceNamePattern = "actions.runner.{0}.{1}";
+            string serviceDisplayNamePattern = "GitHub Actions Runner ({0}.{1})";
+
+            using (TestHostContext hc = CreateTestContext())
+            {
+                ServiceControlManager scm = new ServiceControlManager();
+
+                scm.Initialize(hc);
+                scm.CalculateServiceName(
+                    settings,
+                    serviceNamePattern,
+                    serviceDisplayNamePattern,
+                    out string serviceName,
+                    out string serviceDisplayName);
+
+                var serviceNameParts = serviceName.Split('.');
+
+                // Verify service name parts are sanitized correctly
+                Assert.Equal("actions", serviceNameParts[0]);
+                Assert.Equal("runner", serviceNameParts[1]);
+                Assert.Equal("org----------repo---------", serviceNameParts[2]); // Chars replaced with '-'
+                Assert.Equal("name", serviceNameParts[3]);
+            }
+        }
+
+        private TestHostContext CreateTestContext([CallerMemberName] string testName = "")
+        {
+            TestHostContext hc = new TestHostContext(this, testName);
+
+            return hc;
+        }
+    }
+}