Update runner to handle Dotcom/runner-admin based registration flow (#2487)

src/Runner.Common/ConfigurationStore.cs

@@ -50,6 +50,9 @@ namespace GitHub.Runner.Common
         [DataMember(EmitDefaultValue = false)]
         public string MonitorSocketAddress { get; set; }
 
+        [DataMember(EmitDefaultValue = false)]
+        public bool UseV2Flow { get; set; }
+
         [IgnoreDataMember]
         public bool IsHostedServer
         {

src/Runner.Common/RunnerDotcomServer.cs

@@ -0,0 +1,237 @@
+using GitHub.DistributedTask.WebApi;
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using GitHub.Services.WebApi;
+using GitHub.Services.Common;
+using GitHub.Runner.Sdk;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Linq;
+
+namespace GitHub.Runner.Common
+{
+    [ServiceLocator(Default = typeof(RunnerDotcomServer))]
+    public interface IRunnerDotcomServer : IRunnerService
+    {
+        Task<List<TaskAgent>> GetRunnersAsync(int runnerGroupId, string githubUrl, string githubToken, string agentName);
+
+        Task<TaskAgent> AddRunnerAsync(int runnerGroupId, TaskAgent agent, string githubUrl, string githubToken);
+        Task<List<TaskAgentPool>> GetRunnerGroupsAsync(string githubUrl, string githubToken);
+
+        string GetGitHubRequestId(HttpResponseHeaders headers);
+    }
+
+    public enum RequestType
+    {
+        Get,
+        Post,
+        Patch,
+        Delete
+    }
+
+    public class RunnerDotcomServer : RunnerService, IRunnerDotcomServer
+    {
+        private ITerminal _term;
+
+        public override void Initialize(IHostContext hostContext)
+        {
+            base.Initialize(hostContext);
+            _term = hostContext.GetService<ITerminal>();
+        }
+
+
+        public async Task<List<TaskAgent>> GetRunnersAsync(int runnerGroupId, string githubUrl, string githubToken, string agentName = null)
+        {
+            var githubApiUrl = "";
+            var gitHubUrlBuilder = new UriBuilder(githubUrl);
+            var path = gitHubUrlBuilder.Path.Split('/', '\\', StringSplitOptions.RemoveEmptyEntries);
+            if (path.Length == 1)
+            {
+                // org runner
+                if (UrlUtil.IsHostedServer(gitHubUrlBuilder))
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://api.{gitHubUrlBuilder.Host}/orgs/{path[0]}/actions/runner-groups/{runnerGroupId}/runners";
+                }
+                else
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://{gitHubUrlBuilder.Host}/api/v3/orgs/{path[0]}/actions/runner-groups/{runnerGroupId}/runners";
+                }
+            }
+            else if (path.Length == 2)
+            {
+                // repo or enterprise runner.
+                if (!string.Equals(path[0], "enterprises", StringComparison.OrdinalIgnoreCase))
+                {
+                    return null;
+                }
+
+                if (UrlUtil.IsHostedServer(gitHubUrlBuilder))
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://api.{gitHubUrlBuilder.Host}/{path[0]}/{path[1]}/actions/runner-groups/{runnerGroupId}/runners";
+                }
+                else
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://{gitHubUrlBuilder.Host}/api/v3/{path[0]}/{path[1]}/actions/runner-groups/{runnerGroupId}/runners";
+                }
+            }
+            else
+            {
+                throw new ArgumentException($"'{githubUrl}' should point to an org or enterprise.");
+            }
+
+            var runnersList = await RetryRequest<ListRunnersResponse>(githubApiUrl, githubToken, RequestType.Get, 3, "Failed to get agents pools");
+            var agents = runnersList.ToTaskAgents();
+
+            if (string.IsNullOrEmpty(agentName))
+            {
+                return agents;
+            }
+
+            return agents.Where(x => string.Equals(x.Name, agentName, StringComparison.OrdinalIgnoreCase)).ToList();
+        }
+
+        public async Task<List<TaskAgentPool>> GetRunnerGroupsAsync(string githubUrl, string githubToken)
+        {
+            var githubApiUrl = "";
+            var gitHubUrlBuilder = new UriBuilder(githubUrl);
+            var path = gitHubUrlBuilder.Path.Split('/', '\\', StringSplitOptions.RemoveEmptyEntries);
+            if (path.Length == 1)
+            {
+                // org runner
+                if (UrlUtil.IsHostedServer(gitHubUrlBuilder))
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://api.{gitHubUrlBuilder.Host}/orgs/{path[0]}/actions/runner-groups";
+                }
+                else
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://{gitHubUrlBuilder.Host}/api/v3/orgs/{path[0]}/actions/runner-groups";
+                }
+            }
+            else if (path.Length == 2)
+            {
+                // repo or enterprise runner.
+                if (!string.Equals(path[0], "enterprises", StringComparison.OrdinalIgnoreCase))
+                {
+                    return null;
+                }
+
+                if (UrlUtil.IsHostedServer(gitHubUrlBuilder))
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://api.{gitHubUrlBuilder.Host}/{path[0]}/{path[1]}/actions/runner-groups";
+                }
+                else
+                {
+                    githubApiUrl = $"{gitHubUrlBuilder.Scheme}://{gitHubUrlBuilder.Host}/api/v3/{path[0]}/{path[1]}/actions/runner-groups";
+                }
+            }
+            else
+            {
+                throw new ArgumentException($"'{githubUrl}' should point to an org or enterprise.");
+            }
+
+            var agentPools = await RetryRequest<RunnerGroupList>(githubApiUrl, githubToken, RequestType.Get, 3, "Failed to get agents pools");
+
+            return agentPools?.ToAgentPoolList();
+        }
+
+        public async Task<TaskAgent> AddRunnerAsync(int runnerGroupId, TaskAgent agent, string githubUrl, string githubToken)
+        {
+            var gitHubUrlBuilder = new UriBuilder(githubUrl);
+            var path = gitHubUrlBuilder.Path.Split('/', '\\', StringSplitOptions.RemoveEmptyEntries);
+            string githubApiUrl;
+            if (UrlUtil.IsHostedServer(gitHubUrlBuilder))
+            {
+                githubApiUrl = $"{gitHubUrlBuilder.Scheme}://api.{gitHubUrlBuilder.Host}/actions/runners/register";
+            }
+            else
+            {
+                githubApiUrl = $"{gitHubUrlBuilder.Scheme}://{gitHubUrlBuilder.Host}/api/v3/actions/runners/register";
+            }
+
+            var bodyObject = new Dictionary<string, Object>()
+                    {
+                        {"url", githubUrl},
+                        {"group_id", runnerGroupId},
+                        {"name", agent.Name},
+                        {"version", agent.Version},
+                        {"updates_disabled", agent.DisableUpdate},
+                        {"ephemeral", agent.Ephemeral},
+                        {"labels", agent.Labels},
+                    };
+
+            var body = new StringContent(StringUtil.ConvertToJson(bodyObject), null, "application/json");
+            var responseAgent = await RetryRequest<TaskAgent>(githubApiUrl, githubToken, RequestType.Post, 3, "Failed to add agent", body);
+            agent.Id = responseAgent.Id;
+            return agent;
+        }
+
+        private async Task<T> RetryRequest<T>(string githubApiUrl, string githubToken, RequestType requestType, int maxRetryAttemptsCount = 5, string errorMessage = null, StringContent body = null)
+        {
+            int retry = 0;
+            while (true)
+            {
+                retry++;
+                using (var httpClientHandler = HostContext.CreateHttpClientHandler())
+                using (var httpClient = new HttpClient(httpClientHandler))
+                {
+                    httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("RemoteAuth", githubToken);
+                    httpClient.DefaultRequestHeaders.UserAgent.AddRange(HostContext.UserAgents);
+
+                    var responseStatus = System.Net.HttpStatusCode.OK;
+                    try
+                    {
+                        HttpResponseMessage response = null;
+                        if (requestType == RequestType.Get)
+                        {
+                            response = await httpClient.GetAsync(githubApiUrl);
+                        }
+                        else
+                        {
+                            response = await httpClient.PostAsync(githubApiUrl, body);
+                        }
+
+                        if (response != null)
+                        {
+                            responseStatus = response.StatusCode;
+                            var githubRequestId = GetGitHubRequestId(response.Headers);
+
+                            if (response.IsSuccessStatusCode)
+                            {
+                                Trace.Info($"Http response code: {response.StatusCode} from '{requestType.ToString()} {githubApiUrl}' ({githubRequestId})");
+                                var jsonResponse = await response.Content.ReadAsStringAsync();
+                                return StringUtil.ConvertFromJson<T>(jsonResponse);
+                            }
+                            else
+                            {
+                                _term.WriteError($"Http response code: {response.StatusCode} from '{requestType.ToString()} {githubApiUrl}' (Request Id: {githubRequestId})");
+                                var errorResponse = await response.Content.ReadAsStringAsync();
+                                _term.WriteError(errorResponse);
+                                response.EnsureSuccessStatusCode();
+                            }
+                        }
+
+                    }
+                    catch (Exception ex) when (retry < maxRetryAttemptsCount && responseStatus != System.Net.HttpStatusCode.NotFound)
+                    {
+                        Trace.Error($"{errorMessage} -- Atempt: {retry}");
+                        Trace.Error(ex);
+                    }
+                }
+                var backOff = BackoffTimerHelper.GetRandomBackoff(TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(5));
+                Trace.Info($"Retrying in {backOff.Seconds} seconds");
+                await Task.Delay(backOff);
+            }
+        }
+
+        public string GetGitHubRequestId(HttpResponseHeaders headers)
+        {
+            if (headers.TryGetValues("x-github-request-id", out var headerValues))
+            {
+                return headerValues.FirstOrDefault();
+            }
+            return string.Empty;
+        }
+    }
+}

src/Runner.Listener/Configuration/ConfigurationManager.cs

@@ -31,12 +31,14 @@ namespace GitHub.Runner.Listener.Configuration
     {
         private IConfigurationStore _store;
         private IRunnerServer _runnerServer;
+        private IRunnerDotcomServer _dotcomServer;
         private ITerminal _term;
 
         public override void Initialize(IHostContext hostContext)
         {
             base.Initialize(hostContext);
             _runnerServer = HostContext.GetService<IRunnerServer>();
+            _dotcomServer = HostContext.GetService<IRunnerDotcomServer>();
             Trace.Verbose("Creating _store");
             _store = hostContext.GetService<IConfigurationStore>();
             Trace.Verbose("store created");
@@ -113,6 +115,7 @@ namespace GitHub.Runner.Listener.Configuration
             ICredentialProvider credProvider = null;
             VssCredentials creds = null;
             _term.WriteSection("Authentication");
+            string registerToken = string.Empty;
             while (true)
             {
                 // When testing against a dev deployment of Actions Service, set this environment variable
@@ -130,9 +133,11 @@ namespace GitHub.Runner.Listener.Configuration
                 else
                 {
                     runnerSettings.GitHubUrl = inputUrl;
-                    var registerToken = await GetRunnerTokenAsync(command, inputUrl, "registration");
+                    registerToken = await GetRunnerTokenAsync(command, inputUrl, "registration");
                     GitHubAuthResult authResult = await GetTenantCredential(inputUrl, registerToken, Constants.RunnerEvent.Register);
                     runnerSettings.ServerUrl = authResult.TenantUrl;
+                    runnerSettings.UseV2Flow = authResult.UseV2Flow;
+                    _term.WriteLine($"Using V2 flow: {runnerSettings.UseV2Flow}");
                     creds = authResult.ToVssCredentials();
                     Trace.Info("cred retrieved via GitHub auth");
                 }
@@ -186,9 +191,17 @@ namespace GitHub.Runner.Listener.Configuration
             // If we have more than one runner group available, allow the user to specify which one to be added into
             string poolName = null;
             TaskAgentPool agentPool = null;
-            List<TaskAgentPool> agentPools = await _runnerServer.GetAgentPoolsAsync();
-            TaskAgentPool defaultPool = agentPools?.Where(x => x.IsInternal).FirstOrDefault();
+            List<TaskAgentPool> agentPools;
+            if (runnerSettings.UseV2Flow)
+            {
+                agentPools = await _dotcomServer.GetRunnerGroupsAsync(runnerSettings.GitHubUrl, registerToken);
+            }
+            else
+            {
+                agentPools = await _runnerServer.GetAgentPoolsAsync();
+            }
 
+            TaskAgentPool defaultPool = agentPools?.Where(x => x.IsInternal).FirstOrDefault();
             if (agentPools?.Where(x => !x.IsHosted).Count() > 0)
             {
                 poolName = command.GetRunnerGroupName(defaultPool?.Name);
@@ -226,8 +239,16 @@ namespace GitHub.Runner.Listener.Configuration
 
                 var userLabels = command.GetLabels();
                 _term.WriteLine();
+                List<TaskAgent> agents;
+                if (runnerSettings.UseV2Flow)
+                {
+                    agents = await _dotcomServer.GetRunnersAsync(runnerSettings.PoolId, runnerSettings.GitHubUrl, registerToken, runnerSettings.AgentName);
+                }
+                else
+                {
+                    agents = await _runnerServer.GetAgentsAsync(runnerSettings.PoolId, runnerSettings.AgentName);
+                }
 
-                var agents = await _runnerServer.GetAgentsAsync(runnerSettings.PoolId, runnerSettings.AgentName);
                 Trace.Verbose("Returns {0} agents", agents.Count);
                 agent = agents.FirstOrDefault();
                 if (agent != null)
@@ -274,7 +295,15 @@ namespace GitHub.Runner.Listener.Configuration
 
                     try
                     {
-                        agent = await _runnerServer.AddAgentAsync(runnerSettings.PoolId, agent);
+                        if (runnerSettings.UseV2Flow)
+                        {
+                            agent = await _dotcomServer.AddRunnerAsync(runnerSettings.PoolId, agent, runnerSettings.GitHubUrl, registerToken);
+                        }
+                        else
+                        {
+                            agent = await _runnerServer.AddAgentAsync(runnerSettings.PoolId, agent);
+                        }
+
                         if (command.DisableUpdate &&
                             command.DisableUpdate != agent.DisableUpdate)
                         {
@@ -652,7 +681,7 @@ namespace GitHub.Runner.Listener.Configuration
                     {
                         var response = await httpClient.PostAsync(githubApiUrl, new StringContent(string.Empty));
                         responseStatus = response.StatusCode;
-                        var githubRequestId = GetGitHubRequestId(response.Headers);
+                        var githubRequestId = _dotcomServer.GetGitHubRequestId(response.Headers);
 
                         if (response.IsSuccessStatusCode)
                         {
@@ -715,7 +744,7 @@ namespace GitHub.Runner.Listener.Configuration
                     {
                         var response = await httpClient.PostAsync(githubApiUrl, new StringContent(StringUtil.ConvertToJson(bodyObject), null, "application/json"));
                         responseStatus = response.StatusCode;
-                        var githubRequestId = GetGitHubRequestId(response.Headers);
+                        var githubRequestId = _dotcomServer.GetGitHubRequestId(response.Headers);
 
                         if (response.IsSuccessStatusCode)
                         {
@@ -744,14 +773,5 @@ namespace GitHub.Runner.Listener.Configuration
             }
             return null;
         }
-
-        private string GetGitHubRequestId(HttpResponseHeaders headers)
-        {
-            if (headers.TryGetValues("x-github-request-id", out var headerValues))
-            {
-                return headerValues.FirstOrDefault();
-            }
-            return string.Empty;
-        }
     }
 }

src/Runner.Listener/Configuration/CredentialManager.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Runtime.Serialization;
 using GitHub.Runner.Common;
@@ -20,8 +20,8 @@ namespace GitHub.Runner.Listener.Configuration
     {
         public static readonly Dictionary<string, Type> CredentialTypes = new(StringComparer.OrdinalIgnoreCase)
         {
-            { Constants.Configuration.OAuth, typeof(OAuthCredential)},
-            { Constants.Configuration.OAuthAccessToken, typeof(OAuthAccessTokenCredential)},
+            { Constants.Configuration.OAuth, typeof(OAuthCredential) },
+            { Constants.Configuration.OAuthAccessToken, typeof(OAuthAccessTokenCredential) },
         };
 
         public ICredentialProvider GetCredentialProvider(string credType)
@@ -93,6 +93,9 @@ namespace GitHub.Runner.Listener.Configuration
         [DataMember(Name = "token")]
         public string Token { get; set; }
 
+        [DataMember(Name = "use_v2_flow")]
+        public bool UseV2Flow { get; set; }
+
         public VssCredentials ToVssCredentials()
         {
             ArgUtil.NotNullOrEmpty(TokenSchema, nameof(TokenSchema));

src/Sdk/DTWebApi/WebApi/ListRunnersResponse.cs

@@ -0,0 +1,50 @@
+using GitHub.Services.WebApi;
+using System;
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+using Newtonsoft.Json;
+using System.Linq;
+
+namespace GitHub.DistributedTask.WebApi
+{
+
+    public class ListRunnersResponse
+    {
+        public ListRunnersResponse()
+        {
+        }
+
+        public ListRunnersResponse(ListRunnersResponse responseToBeCloned)
+        {
+            this.TotalCount = responseToBeCloned.TotalCount;
+            this.Runners = responseToBeCloned.Runners;
+        }
+
+        [JsonProperty("total_count")]
+        public int TotalCount
+        {
+            get;
+            set;
+        }
+
+        [JsonProperty("runners")]
+        public List<Runner> Runners
+        {
+            get;
+            set;
+        }
+
+        public ListRunnersResponse Clone()
+        {
+            return new ListRunnersResponse(this);
+        }
+
+        public List<TaskAgent> ToTaskAgents()
+        {
+            List<TaskAgent> taskAgents = new List<TaskAgent>();
+
+            return Runners.Select(runner => new TaskAgent() { Name = runner.Name }).ToList();
+        }
+    }
+
+}

src/Sdk/DTWebApi/WebApi/Runner.cs

@@ -0,0 +1,18 @@
+using Newtonsoft.Json;
+
+namespace GitHub.DistributedTask.WebApi
+{
+    public class Runner
+    {
+        /// <summary>
+        /// Name of the agent
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name
+        {
+            get;
+            internal set;
+        }
+
+    }
+}

src/Sdk/DTWebApi/WebApi/RunnerGroup.cs

@@ -0,0 +1,98 @@
+using GitHub.Services.WebApi;
+using System;
+using System.Runtime.Serialization;
+using System.ComponentModel;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using System.Linq;
+
+namespace GitHub.DistributedTask.WebApi
+{
+    /// <summary>
+    /// An organization-level grouping of runners.
+    /// </summary>
+    [DataContract]
+    public class RunnerGroup
+    {
+        internal RunnerGroup()
+        {
+        }
+
+        public RunnerGroup(String name)
+        {
+            this.Name = name;
+        }
+
+        private RunnerGroup(RunnerGroup poolToBeCloned)
+        {
+            this.Id = poolToBeCloned.Id;
+            this.IsHosted = poolToBeCloned.IsHosted;
+            this.Name = poolToBeCloned.Name;
+            this.IsDefault = poolToBeCloned.IsDefault;
+        }
+
+        [DataMember(EmitDefaultValue = false)]
+        [JsonProperty("id")]
+        public Int32 Id
+        {
+            get;
+            set;
+        }
+
+        [DataMember(EmitDefaultValue = false)]
+        [JsonProperty("name")]
+        public String Name
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether or not this pool is internal and can't be modified by users
+        /// </summary>
+        [DataMember]
+        [JsonProperty("default")]
+        public bool IsDefault
+        {
+            get;
+            set;
+        }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether or not this pool is managed by the service.
+        /// </summary>
+        [DataMember]
+        [JsonProperty("is_hosted")]
+        public Boolean IsHosted
+        {
+            get;
+            set;
+        }
+    }
+
+    public class RunnerGroupList
+    {
+        public RunnerGroupList()
+        {
+            this.RunnerGroups = new List<RunnerGroup>();
+        }
+
+        public List<TaskAgentPool> ToAgentPoolList()
+        {
+            var agentPools = this.RunnerGroups.Select(x => new TaskAgentPool(x.Name)
+            {
+                Id = x.Id,
+                IsHosted = x.IsHosted,
+                IsInternal = x.IsDefault
+            }).ToList();
+
+            return agentPools;
+        }
+
+        [JsonProperty("runner_groups")]
+        public List<RunnerGroup> RunnerGroups { get; set; }
+
+        [JsonProperty("total_count")]
+        public int Count { get; set; }
+    }
+}

src/Test/L0/Listener/Configuration/ConfigurationManagerL0.cs

@@ -19,6 +19,7 @@ namespace GitHub.Runner.Common.Tests.Listener.Configuration
     public class ConfigurationManagerL0
     {
         private Mock<IRunnerServer> _runnerServer;
+        private Mock<IRunnerDotcomServer> _dotcomServer;
         private Mock<ILocationServer> _locationServer;
         private Mock<ICredentialManager> _credMgr;
         private Mock<IPromptManager> _promptManager;
@@ -55,6 +56,7 @@ namespace GitHub.Runner.Common.Tests.Listener.Configuration
             _store = new Mock<IConfigurationStore>();
             _extnMgr = new Mock<IExtensionManager>();
             _rsaKeyManager = new Mock<IRSAKeyManager>();
+            _dotcomServer = new Mock<IRunnerDotcomServer>();
 
 #if OS_WINDOWS
             _serviceControlManager = new Mock<IWindowsServiceControlManager>();
@@ -106,6 +108,10 @@ namespace GitHub.Runner.Common.Tests.Listener.Configuration
             _runnerServer.Setup(x => x.AddAgentAsync(It.IsAny<int>(), It.IsAny<TaskAgent>())).Returns(Task.FromResult(expectedAgent));
             _runnerServer.Setup(x => x.ReplaceAgentAsync(It.IsAny<int>(), It.IsAny<TaskAgent>())).Returns(Task.FromResult(expectedAgent));
 
+            _dotcomServer.Setup(x => x.GetRunnersAsync(It.IsAny<int>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>())).Returns(Task.FromResult(expectedAgents));
+            _dotcomServer.Setup(x => x.GetRunnerGroupsAsync(It.IsAny<string>(), It.IsAny<string>())).Returns(Task.FromResult(expectedPools));
+            _dotcomServer.Setup(x => x.AddRunnerAsync(It.IsAny<int>(), It.IsAny<TaskAgent>(), It.IsAny<string>(), It.IsAny<string>())).Returns(Task.FromResult(expectedAgent));
+
             rsa = new RSACryptoServiceProvider(2048);
 
             _rsaKeyManager.Setup(x => x.CreateKey()).Returns(rsa);
@@ -119,6 +125,7 @@ namespace GitHub.Runner.Common.Tests.Listener.Configuration
             tc.SetSingleton<IConfigurationStore>(_store.Object);
             tc.SetSingleton<IExtensionManager>(_extnMgr.Object);
             tc.SetSingleton<IRunnerServer>(_runnerServer.Object);
+            tc.SetSingleton<IRunnerDotcomServer>(_dotcomServer.Object);
             tc.SetSingleton<ILocationServer>(_locationServer.Object);
 
 #if OS_WINDOWS