fix regex

Author: devjoes

GithubRunnerRegistration/.gitignore

@@ -1,15 +1,18 @@
 using GithubRunnerRegistration.Models;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text;
 using System.Threading.Tasks;
 
 // For more information on enabling Web API for empty projects, visit https://go.microsoft.com/fwlink/?LinkID=397860
 
 namespace GithubRunnerRegistration.Api.Controllers
 {
+    [Produces("application/json")]
     [Route("api/[controller]")]
     [ApiController]
     public class RegisterController : ControllerBase
@@ -20,21 +23,45 @@ public RegisterController(ILogger<RegisterController> logger)
         {
             this.logger = logger;
         }
+
+
+        /// <summary>
+        /// Registers runners against the provided repo and returns the data required to associate each runner with the repo.
+        /// The data returned can be used as the data property of a secret which is then referenced by ScaledActionRunner.RunnerSecrets
+        /// The secret will then be mnoounted by a pod and used to register with Github
+        /// </summary>
+        /// <param name="request"></param>
+        /// <returns>A map of secret names to secret data</returns>
+        /// <response code="201">Request passed validation and runner(s) have been registered</response>
+        /// <response code="202">Request passed validation but no runners were created because dryRun was specified, dummy information has been returned</response>
+        /// <response code="400">Supplied request is invalid</response>  
         [HttpPost]
-        public async Task<ActionResult> Post([FromBody] RegistrationRequest request)
+        [ProducesResponseType(StatusCodes.Status201Created)]
+        [ProducesResponseType(StatusCodes.Status202Accepted)]
+        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        public async Task<ActionResult<Dictionary<string,RunnerRegistrationSecretData>>> Post([FromBody] RegistrationRequest request)
         {
             try
             {
-                var runners = new Dictionary<string, Dictionary<string, string>>();
+                var runners = new Dictionary<string, RunnerRegistrationSecretData>();
                 var register = new Register(request);
                 await register.Setup();
+                var identifier = new StringBuilder();
+                identifier.AppendFormat ("runners://{0}/{1}", request.Owner, request.Repository);
                 foreach (var name in request.RunnerNames)
                 {
                     this.logger.LogInformation("Adding runner {name} to {Owner}/{Repository}", name, request.Owner, request.Repository);
-                    var creds = await register.AddRunner(name);
+                    var creds = await register.AddRunner(name, request.DryRun);
                     runners.Add(name, creds);
+                    identifier.AppendFormat("/{0}", creds.Id);
+                }
+                // This is essentially a registration request ID
+                var idUri = new Uri(identifier.ToString());
+                if (request.DryRun)
+                {
+                    return this.Accepted(idUri, runners);
                 }
-                return this.Ok(runners);
+                return this.Created(idUri,runners);
             }
             catch (InvalidOperationException ex)
             {

GithubRunnerRegistration/GithubRunnerRegistration.Api/Controllers/RegisterController.cs

@@ -1,18 +1,21 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
-  <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
-    <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
-  </PropertyGroup>
+	<PropertyGroup>
+		<TargetFramework>netcoreapp3.1</TargetFramework>
+		<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
+	</PropertyGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.10.9" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.2" />
-  </ItemGroup>
-
-  <ItemGroup>
-    <ProjectReference Include="..\GithubRunnerRegistration\GithubRunnerRegistration.csproj" />
-  </ItemGroup>
+	<ItemGroup>
+		<PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.10.9" />
+		<PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.2" />
+	</ItemGroup>
 
+	<ItemGroup>
+		<ProjectReference Include="..\GithubRunnerRegistration\GithubRunnerRegistration.csproj" />
+	</ItemGroup>
+	<PropertyGroup>
+		<GenerateDocumentationFile>true</GenerateDocumentationFile>
+		<NoWarn>$(NoWarn);1591</NoWarn>
+	</PropertyGroup>
 
 </Project>

GithubRunnerRegistration/GithubRunnerRegistration.Api/GithubRunnerRegistration.Api.csproj

@@ -7,7 +7,9 @@
 using Microsoft.Extensions.Logging;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
+using System.Reflection;
 using System.Threading.Tasks;
 
 namespace GithubRunnerRegistration
@@ -25,7 +27,21 @@ public Startup(IConfiguration configuration)
         public void ConfigureServices(IServiceCollection services)
         {
             services.AddControllers();
-            services.AddSwaggerGen();
+            services.AddSwaggerGen(c =>
+            {
+                c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
+                {
+                    Title = "Github runner registration service",
+                    Version = "v1",
+                    Description = "Registers runners against a repo and returns the data required to associate each runner with the repo."
+                });
+                var apiXmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+                var xmlFile = $"{nameof(GithubRunnerRegistration)}.xml";
+
+                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, apiXmlFile));
+                c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFile));
+
+            });
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
@@ -49,6 +65,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             {
                 endpoints.MapControllers();
             });
+            
         }
     }
 }

GithubRunnerRegistration/GithubRunnerRegistration.Api/Startup.cs

@@ -10,7 +10,7 @@ namespace GithubRunnerRegistration.Tests
     public class GetCredentialsTest
     {
         const string runner = "runner content";
-        const string credentials = "credentials content";
+        const string credentials = "{\"data\":{\"clientId\":\"213aa528-e449-4fc8-8b51-2f4bcd76d560\"}}";
         // This is just a random RSA params object and is not sensitive
         const string credentialsRsaParams = "{\"RSAParameters\":{},\"d\":\"hXdVeIRBXrT8GgOF9N5rB0PGhEgH0x9Nm0bzhCbL3YvWxuium+q2Sc8wy9xwBflknLCGD9j5uCyOiD9uxfh3q5Im6sESV/VgetRuGqjNGhSaAnobX6KBVEwYtWnWzV14u0os1F6P0Nkij5cnAOHe1y7LuibdvVkcmqsGudZcUYUlmNitqknWAoEoxtNpu5BjvbC/8MuOZ488NJJBDuZSg75yJsY6KSk/wMXWVWthQ+IiJQqZhi15iJefrlpW5aCmqtbkY2KGKBij+CjvSdMPFrfiKCDZv8PxlzcIIaD9T9pM0p89Ti78p4jBlMsN3dpWjXIQvE3QMnegUeILrxx+RQ==\",\"dp\":\"B3D+bJdztNWoIAfCw8Q/UlsANmCkP7E6XhGydpAtOKN9UhJeK4E9NRRIs6p0glaRR6nsGN4KkM3Yl61ROr8Kn89IsUCZXyXbLnXOmi4BcMrSqssguDQfVlE3NLXOtTYDDv6pDdY2ZMSpThl4edMUydlF7F6bmDaFjMZoEk1SpL0=\",\"dq\":\"AbhSl9H9SVjYzTwg6fLqzB3GCdeC1KTtIM2Uokj/VxjWXIbAxFRG4uSCx3ddoCyRex6WV8nqYSpvsyCoX76+jzomYPdns5SL9kgB2BgIYPKRszUoY8PcNDpPHAPj1PlmzZFpNzsE++kmon54kyavwb47Nuo1A2KnSkw359T+pDU=\",\"exponent\":\"AQAB\",\"inverseQ\":\"kBH3mldmzKxoEdNsMHSPCXenFQySm1hyv3DimLwlDTGX835qp6+FPdFVZK8o2d86kN9xwe/iX+mDe0yK2vCHskgscJlMcGvP0+IgTDDW4ctkmHlD/X2lcJKUif96pmr10bpMm9ayN6Hc4BJFo9YTHtqfZ+Xfc950qPp9GfMtLYs=\",\"modulus\":\"omMMkenoxhTbvMvPsjrYsvWE+VDPMPi8mKgpOr+ngf9AKMGD1fldxsakuxtq1g4qZM768yFMsGPf/XsfHNIwEXXVhn6RSuUu22n0Y8fmHxSraceYXPOCi0mBC64HHZr6jWeCB5KiL2g8iGiNDti6Tsv3xeDU8ACA6LmCz37CB68VUsxXaQQLbGXo8+3qcQ53D5FwLafGSk4yl7gucF5SThvIDxOMsoE65TOxyhEMqiAnGTCU50XJURPj1GBXCzW17CjDmsQ64QKOlNm9EJzmMFo6ttPoOxZRb8usJps0nzPcq2IVhihCnX+udlAttkmo0fdFHKhEKzFbgSvX0vVMWQ==\",\"p\":\"yVtPBKM6ljwjRR1Bsa3h1YsohbE3NaOgX/r7lpTMt5EDVgFLPkyZt9xAQkoBxmce42CVHghlWQqBiPmK5MI0ujrSLxD6Q/zdJzZw4kHqT4M4MM+J+HqPlYPcRC0tWKabsYrkXBdHIe9OuDUfACoh6+yHC0KV91hWmQu3WtYIQDs=\",\"q\":\"znRs1/NkBqBr4I2qs/b4+5Q71ZdKJ0VJBBVNxMAPDEYTZNwI8mxoouHWuq0N2aTg6Ja46K2PCrKTBNsx43Rr01JV21PFYpPyUoF3I5Nx7MCJvdLM24u1Bd3uVc1KfFvLAQm+qObILCLzpJ76MkqBm6hNbmF9du9wCSWav7gEUHs=\"}";
 
@@ -26,12 +26,12 @@ public async Task ShouldParseCredentials()
                 File.WriteAllText(Path.Combine(tmp, ".credentials_rsaparams"), credentialsRsaParams);
                 var getCreds = new GetCredentials();
                 var creds = await getCreds.GetCredentialsFromPath(tmp);
-                Assert.Equal(5, creds.Count);
-                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(credentialsRsaParams)), creds[".credentials_rsaparams"]);
-                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(runner)), creds[".runner"]);
-                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(credentials)), creds[".credentials"]);
-                Assert.NotNull(creds["private.pem"]);
-                Assert.NotNull(creds["public.pem"]);
+                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(credentialsRsaParams)), creds.CredentialsRsaParams);
+                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(runner)), creds.Runner);
+                Assert.Equal(Convert.ToBase64String(Encoding.UTF8.GetBytes(credentials)), creds.Credentials);
+                Assert.Equal("213aa528-e449-4fc8-8b51-2f4bcd76d560", creds.Id.ToString());
+                Assert.NotNull(creds.PrivatePem);
+                Assert.NotNull(creds.PublicPem);
             }
             finally
             {

GithubRunnerRegistration/GithubRunnerRegistration.Tests/GetCredentialsTest.cs

@@ -20,7 +20,7 @@ public class RegisterTest
 
 
         [Fact]
-        public async Task ShouldErrorIfRequestLabelsContainsInvalidChars()
+        public void ShouldErrorIfRequestLabelsContainsInvalidChars()
         {
             Assert.Throws<InvalidOperationException>(() => new Register(new RegistrationRequest { AdminPat = Pat, Labels = new string[] { "foo\"" }, Owner = Owner, Repository = Repo }, "a"));
         }
@@ -30,7 +30,7 @@ public async Task ShouldErrorIfRequestLabelsContainsInvalidChars()
         public async Task ShouldErrorIfNameContainsInvalidChars()
         {
             var register = new Register(new RegistrationRequest { AdminPat = Pat, Labels = new string[] { }, Owner = Owner, Repository = Repo }, "a");
-            await Assert.ThrowsAsync<InvalidOperationException>(async () => await register.AddRunner("foo\""));
+            await Assert.ThrowsAsync<InvalidOperationException>(async () => await register.AddRunner("foo\"", false));
         }
 
         [Fact]
@@ -82,13 +82,13 @@ public async Task ShouldCopyAndExecuteBinary()
             var binary = Path.Combine(tmp, binaryName);
             File.WriteAllText(binary, "this isn't actually executable");
 
-            var request = new RegistrationRequest { AdminPat = Pat, Labels = new string[] {"foo" }, Owner = Owner, Repository = Repo };
+            var request = new RegistrationRequest { AdminPat = Pat, Labels = new string[] { "foo" }, Owner = Owner, Repository = Repo };
             var register = new Register(request, binary);
             register.RunnerRegistrationToken = "RunnerRegistrationToken";
             var secretGenerator = new Mock<IGetCredentials>();
             string credsDir = Path.Combine(Path.GetTempPath(), name);
-            string runnerWd = Path.Combine(credsDir, "runner");            
-            secretGenerator.Setup(g => g.GetCredentialsFromPath(credsDir)).Returns(Task.FromResult(new Dictionary<string, string>{ { "foo", "bar" } })).Verifiable();
+            string runnerWd = Path.Combine(credsDir, "runner");
+            secretGenerator.Setup(g => g.GetCredentialsFromPath(credsDir)).Returns(Task.FromResult(new RunnerRegistrationSecretData { Credentials = "foo" })).Verifiable();
             void mockRun(ProcessStartInfo startInfo)
             {
                 Assert.Equal("dotnet", startInfo.FileName);
@@ -97,12 +97,36 @@ void mockRun(ProcessStartInfo startInfo)
                 Assert.True(File.Exists(Path.Combine(runnerWd, binaryName)));
                 Assert.Equal($"{binaryName} configure --name \"{name}\" --token {register.RunnerRegistrationToken} --url \"https://github.com/{Owner}/{Repo}\" --labels \"foo\" --replace --unattended", startInfo.Arguments);
             }
-            var creds = await register.RegisterRunner(name, secretGenerator.Object, mockRun);
-            Assert.Equal("bar", creds["foo"]);
+            var creds = await register.RegisterRunner(name, secretGenerator.Object, false, mockRun);
+            Assert.Equal("foo", creds.Credentials);
             Assert.False(Directory.Exists(runnerWd));
             secretGenerator.Verify();
             Directory.Delete(tmp, true);
         }
 
+
+        [Fact]
+        public async Task ShouldNotExecuteBinaryOnDryRun()
+        {
+            const string binaryName = "binary";
+            const string name = "foobar";
+            var tmp = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString());
+            Directory.CreateDirectory(tmp);
+            var binary = Path.Combine(tmp, binaryName);
+            File.WriteAllText(binary, "this isn't actually executable");
+
+            var request = new RegistrationRequest { AdminPat = Pat, Labels = new string[] { "foo" }, Owner = Owner, Repository = Repo };
+            var register = new Register(request, binary);
+            register.RunnerRegistrationToken = "RunnerRegistrationToken";
+            var secretGenerator = new Mock<IGetCredentials>();
+            string credsDir = Path.Combine(Path.GetTempPath(), name);
+            string runnerWd = Path.Combine(credsDir, "runner");
+            var creds = await register.RegisterRunner(name, secretGenerator.Object, true, _=>throw new Exception("boom"));
+            Assert.False(Directory.Exists(runnerWd));
+            secretGenerator.Verify(sg => sg.GetCredentialsFromPath(It.IsAny<string>()), Times.Never);
+            Assert.NotEqual(default, creds.Id);
+            Directory.Delete(tmp, true);
+        }
+
     }
 }