(cake-contribGH-214) Add possibility to overwrite context parameters …

…and state
pascalberger · Aug 9, 2021 · 8574940 · 8574940
1 parent 1588a57
commit 8574940
Show file tree

Hide file tree

Showing 25 changed files with 332 additions and 159 deletions.
diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/AppVeyorBuildServer.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/AppVeyorBuildServer.cs
@@ -15,7 +15,7 @@ internal class AppVeyorBuildServer : BaseBuildServer
     {
         /// <inheritdoc />
         public override Uri DetermineRepositoryRemoteUrl(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -32,7 +32,7 @@ internal class AppVeyorBuildServer : BaseBuildServer
 
         /// <inheritdoc />
         public override string DetermineCommitId(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -41,15 +41,15 @@ internal class AppVeyorBuildServer : BaseBuildServer
         }
 
         /// <inheritdoc />
-        public override bool DetermineIfPullRequest(IssuesContext context)
+        public override bool DetermineIfPullRequest(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
             return context.AppVeyor().Environment.PullRequest.IsPullRequest;
         }
 
         /// <inheritdoc />
-        public override int? DeterminePullRequestId(IssuesContext context)
+        public override int? DeterminePullRequestId(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -58,7 +58,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void ReportIssuesToBuildServer(
-            IssuesContext context)
+            IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -70,7 +70,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void CreateSummaryIssuesReport(
-            IssuesContext context,
+            IIssuesContext context,
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "")
         {
             context.NotNull(nameof(context));
@@ -79,7 +79,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
         }
 
         /// <inheritdoc />
-        public override void PublishIssuesArtifacts(IssuesContext context)
+        public override void PublishIssuesArtifacts(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 

diff --git a/...Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/AzureDevOpsBuildServer.cs b/...Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/AzureDevOpsBuildServer.cs
@@ -18,7 +18,7 @@ internal class AzureDevOpsBuildServer : BaseBuildServer
     {
         /// <inheritdoc />
         public override Uri DetermineRepositoryRemoteUrl(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -28,7 +28,7 @@ internal class AzureDevOpsBuildServer : BaseBuildServer
 
         /// <inheritdoc />
         public override string DetermineCommitId(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -37,7 +37,7 @@ internal class AzureDevOpsBuildServer : BaseBuildServer
         }
 
         /// <inheritdoc />
-        public override bool DetermineIfPullRequest(IssuesContext context)
+        public override bool DetermineIfPullRequest(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -46,7 +46,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
         }
 
         /// <inheritdoc />
-        public override int? DeterminePullRequestId(IssuesContext context)
+        public override int? DeterminePullRequestId(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -62,7 +62,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void ReportIssuesToBuildServer(
-            IssuesContext context)
+            IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -80,7 +80,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void CreateSummaryIssuesReport(
-            IssuesContext context,
+            IIssuesContext context,
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "")
         {
             context.NotNull(nameof(context));
@@ -116,7 +116,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
         }
 
         /// <inheritdoc />
-        public override void PublishIssuesArtifacts(IssuesContext context)
+        public override void PublishIssuesArtifacts(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 

diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/BaseBuildServer.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/BaseBuildServer.cs
@@ -11,7 +11,7 @@ internal abstract class BaseBuildServer : IIssuesBuildServer
     {
         /// <inheritdoc />
         public virtual Uri DetermineRepositoryRemoteUrl(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -22,7 +22,7 @@ internal abstract class BaseBuildServer : IIssuesBuildServer
 
         /// <inheritdoc />
         public virtual string DetermineCommitId(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -32,15 +32,15 @@ internal abstract class BaseBuildServer : IIssuesBuildServer
         }
 
         /// <inheritdoc />
-        public virtual bool DetermineIfPullRequest(IssuesContext context)
+        public virtual bool DetermineIfPullRequest(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
             return false;
         }
 
         /// <inheritdoc />
-        public virtual int? DeterminePullRequestId(IssuesContext context)
+        public virtual int? DeterminePullRequestId(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -49,15 +49,15 @@ public virtual bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public abstract void ReportIssuesToBuildServer(
-            IssuesContext context);
+            IIssuesContext context);
 
         /// <inheritdoc />
         public abstract void CreateSummaryIssuesReport(
-            IssuesContext context,
+            IIssuesContext context,
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "");
 
         /// <inheritdoc />
         public abstract void PublishIssuesArtifacts(
-            IssuesContext context);
+            IIssuesContext context);
     }
 }
diff --git a/...osting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/GitHubActionsBuildServer.cs b/...osting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/GitHubActionsBuildServer.cs
@@ -14,7 +14,7 @@ internal class GitHubActionsBuildServer : BaseBuildServer
     {
         /// <inheritdoc />
         public override Uri DetermineRepositoryRemoteUrl(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -24,7 +24,7 @@ internal class GitHubActionsBuildServer : BaseBuildServer
 
         /// <inheritdoc />
         public override string DetermineCommitId(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory)
         {
             context.NotNull(nameof(context));
@@ -33,15 +33,15 @@ internal class GitHubActionsBuildServer : BaseBuildServer
         }
 
         /// <inheritdoc />
-        public override bool DetermineIfPullRequest(IssuesContext context)
+        public override bool DetermineIfPullRequest(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
             return context.GitHubActions().Environment.PullRequest.IsPullRequest;
         }
 
         /// <inheritdoc />
-        public override int? DeterminePullRequestId(IssuesContext context)
+        public override int? DeterminePullRequestId(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -51,7 +51,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void ReportIssuesToBuildServer(
-            IssuesContext context)
+            IIssuesContext context)
         {
             context.NotNull(nameof(context));
 
@@ -63,7 +63,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
 
         /// <inheritdoc />
         public override void CreateSummaryIssuesReport(
-            IssuesContext context,
+            IIssuesContext context,
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "")
         {
             context.NotNull(nameof(context));
@@ -72,7 +72,7 @@ public override bool DetermineIfPullRequest(IssuesContext context)
         }
 
         /// <inheritdoc />
-        public override void PublishIssuesArtifacts(IssuesContext context)
+        public override void PublishIssuesArtifacts(IIssuesContext context)
         {
             context.NotNull(nameof(context));
 

diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/IIssuesBuildServer.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/BuildServers/IIssuesBuildServer.cs
@@ -15,7 +15,7 @@ public interface IIssuesBuildServer
         /// <param name="repositoryRootDirectory">The root directory of the repository.</param>
         /// <returns>The remote URL of the repository.</returns>
         Uri DetermineRepositoryRemoteUrl(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory);
 
         /// <summary>
@@ -25,44 +25,44 @@ public interface IIssuesBuildServer
         /// <param name="repositoryRootDirectory">The root directory of the repository.</param>
         /// <returns>The SHA ID of the current commit.</returns>
         string DetermineCommitId(
-            IssuesContext context,
+            IIssuesContext context,
             DirectoryPath repositoryRootDirectory);
 
         /// <summary>
         /// Determines whether the build is for a pull request.
         /// </summary>
         /// <param name="context">The Cake context.</param>
         /// <returns>A value indicating whether the build is for a pull request.</returns>
-        bool DetermineIfPullRequest(IssuesContext context);
+        bool DetermineIfPullRequest(IIssuesContext context);
 
         /// <summary>
         /// Determines ID of the pull request.
         /// </summary>
         /// <param name="context">The Cake context.</param>
         /// <returns>ID of the pull request.</returns>
-        int? DeterminePullRequestId(IssuesContext context);
+        int? DeterminePullRequestId(IIssuesContext context);
 
         /// <summary>
         /// Reports issues to the build server.
         /// </summary>
         /// <param name="context">The Cake context.</param>
         void ReportIssuesToBuildServer(
-            IssuesContext context);
+            IIssuesContext context);
 
         /// <summary>
         /// Creates a summary report of the issues.
         /// </summary>
         /// <param name="context">The Cake context.</param>
         /// <param name="sourceFilePath">Path of the file.</param>
         void CreateSummaryIssuesReport(
-            IssuesContext context,
+            IIssuesContext context,
             [System.Runtime.CompilerServices.CallerFilePath] string sourceFilePath = "");
 
         /// <summary>
         /// Publishes issues report as artifact to the build system.
         /// </summary>
         /// <param name="context">The Cake context.</param>
         void PublishIssuesArtifacts(
-            IssuesContext context);
+            IIssuesContext context);
     }
 }
diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/IIssuesContext.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/IIssuesContext.cs
@@ -0,0 +1,18 @@
+namespace Cake.Frosting.Issues.Recipe
+{
+    /// <summary>
+    /// Description of parameters and state for the build run.
+    /// </summary>
+    public interface IIssuesContext : IFrostingContext
+    {
+        /// <summary>
+        /// Gets input parameters.
+        /// </summary>
+        IIssuesParameters Parameters { get; }
+
+        /// <summary>
+        /// Gets the mutable state of the build run.
+        /// </summary>
+        IIssuesState State { get; }
+    }
+}
diff --git a/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/IssuesContext.cs b/Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe/Context/IssuesContext.cs
@@ -1,21 +1,13 @@
-using Cake.Core;
+using Cake.Core; 
 
 namespace Cake.Frosting.Issues.Recipe
 {
     /// <summary>
     /// Parameters and state for the build run.
     /// </summary>
-    public class IssuesContext : FrostingContext
+    public class IssuesContext : IssuesContext<IssuesParameters, IssuesState>
     {
-        /// <summary>
-        /// Input parameters.
-        /// </summary>
-        public IssuesParameters Parameters { get; }
-
-        /// <summary>
-        /// Mutable state of the build run.
-        /// </summary>
-        public IssuesState State { get; }
+        private readonly RepositoryInfoProviderType repositoryInfoProviderType;
 
         /// <summary>
         /// Creates a new instance of the <see cref="IssuesContext"/> class.
@@ -27,8 +19,19 @@ public class IssuesContext : FrostingContext
             RepositoryInfoProviderType repositoryInfoProviderType)
             : base(context)
         {
-            this.Parameters = new IssuesParameters();
-            this.State = new IssuesState(this, repositoryInfoProviderType);
+            this.repositoryInfoProviderType = repositoryInfoProviderType;
+        }
+
+        /// <inheritdoc />
+        protected override IssuesParameters CreateIssuesParameters()
+        {
+            return new IssuesParameters();
+        }
+
+        /// <inheritdoc />
+        protected override IssuesState CreateIssuesState()
+        {
+            return new IssuesState(this, this.repositoryInfoProviderType);
         }
     }
-}
+}