Adds new endpoints for creating Runbook Runs

OctopusDeploy · Jun 22, 2020 · a6878a6 · a6878a6
1 parent ccd18c2
commit a6878a6
Show file tree

Hide file tree

Showing 3 changed files with 76 additions and 2 deletions.
diff --git a/source/Octopus.Client/Model/RunbookRunParameters.cs b/source/Octopus.Client/Model/RunbookRunParameters.cs
@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Octopus.Client.Model
+{
+    public class RunbookRunParameters
+    {
+        /// <summary>
+        /// Parameter class for marshalling params between OctopusCLI and Octopus Server
+        /// This class is used to facilitate backwards compatibility while extending /runbooks/{id}/run"
+        /// </summary>
+        public RunbookRunParameters()
+        {
+            FormValues = new Dictionary<string, string>();
+            SpecificMachineIds = new string[0];
+            ExcludedMachineIds = new string[0];
+            EnvironmentIds = new string[0];
+            TenantTagNames = new string[0];
+            TenantIds = new string[0];
+            SkipActions = new string[0];
+        }
+
+        public bool UseDefaultSnapshot { get; set; } = true;
+
+        public string RunbookId { get; set; }
+        public string ProjectId { get; set; }
+        public string RunbookSnapshotNameOrId { get; set; }
+        public string EnvironmentId { get; set; }
+        public string[] EnvironmentIds { get; set; }
+        public bool ForcePackageDownload { get; set; }
+        public bool? UseGuidedFailure { get; set; }
+        public string[] SpecificMachineIds { get; set; }
+        public string[] ExcludedMachineIds { get; set; }
+        public string TenantId { get; set; }
+        public string[] TenantIds { get; set; }
+        public string[] TenantTagNames { get; set; }
+        public string[] SkipActions { get; set; }
+        public DateTimeOffset? QueueTime { get; set; }
+        public DateTimeOffset? QueueTimeExpiry { get; set; }
+        public Dictionary<string, string> FormValues { get; set; }
+
+        public static RunbookRunParameters MapFrom(RunbookRunResource runbookRun)
+        {
+            return new RunbookRunParameters
+            {
+                UseDefaultSnapshot = true,
+                RunbookId = runbookRun.RunbookId,
+                ProjectId = runbookRun.ProjectId,
+                EnvironmentId = runbookRun.EnvironmentId,
+                ForcePackageDownload = runbookRun.ForcePackageDownload,
+                UseGuidedFailure = runbookRun.UseGuidedFailure,
+                SpecificMachineIds = runbookRun.SpecificMachineIds.ToArray(),
+                ExcludedMachineIds = runbookRun.ExcludedMachineIds.ToArray(),
+                TenantId = runbookRun.TenantId,
+                SkipActions = runbookRun.SkipActions.ToArray(),
+                QueueTime = runbookRun.QueueTime,
+                QueueTimeExpiry = runbookRun.QueueTimeExpiry,
+                FormValues = runbookRun.FormValues
+            };
+        }
+    }
+}
diff --git a/source/Octopus.Client/Repositories/Async/RunbookRepository.cs b/source/Octopus.Client/Repositories/Async/RunbookRepository.cs
@@ -47,6 +47,11 @@ public Task<RunbookRunPreviewResource> GetPreview(DeploymentPromotionTarget prom
         }
 
         public Task<RunbookRunResource> Run(RunbookResource runbook, RunbookRunResource runbookRun)
+        {
+            return Run(runbook, RunbookRunParameters.MapFrom(runbookRun));
+        }
+
+        public Task<RunbookRunResource> Run(RunbookResource runbook, RunbookRunParameters runbookRun)
         {
             return Client.Post<object, RunbookRunResource>(runbook.Link("CreateRunbookRun"), runbookRun);
         }

diff --git a/source/Octopus.Client/Repositories/RunbookRepository.cs b/source/Octopus.Client/Repositories/RunbookRepository.cs
@@ -1,3 +1,4 @@
+using System.Linq;
 using Octopus.Client.Editors;
 using Octopus.Client.Model;
 
@@ -12,7 +13,7 @@ public interface IRunbookRepository : IFindByName<RunbookResource>, IGet<Runbook
         RunbookRunPreviewResource GetPreview(DeploymentPromotionTarget promotionTarget);
         RunbookRunResource Run(RunbookResource runbook, RunbookRunResource runbookRun);
     }
-    
+
     class RunbookRepository : BasicRepository<RunbookResource>, IRunbookRepository
     {
         public RunbookRepository(IOctopusRepository repository)
@@ -44,10 +45,15 @@ public RunbookRunPreviewResource GetPreview(DeploymentPromotionTarget promotionT
         {
             return Client.Get<RunbookRunPreviewResource>(promotionTarget.Link("RunbookRunPreview"));
         }
+public RunbookRunResource Run(RunbookResource runbook, RunbookRunResource runbookRun)
+        {
+            return Run(runbook, RunbookRunParameters.MapFrom(runbookRun));
+        }
 
-        public RunbookRunResource Run(RunbookResource runbook, RunbookRunResource runbookRun)
+        public RunbookRunResource Run(RunbookResource runbook, RunbookRunParameters runbookRun)
         {
             return Client.Post<object, RunbookRunResource>(runbook.Link("CreateRunbookRun"), runbookRun);
         }
+
     }
 }