(GH-3946) Add ISetupContext to Frosting lifetime

* fixes #3946
cake-build · Oct 29, 2022 · a14dc69 · a14dc69
1 parent bd4ad10
commit a14dc69
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 28 deletions.
diff --git a/src/Cake.Frosting.Tests/Fakes/FakeLifetime.cs b/src/Cake.Frosting.Tests/Fakes/FakeLifetime.cs
@@ -11,7 +11,7 @@ public sealed class FakeLifetime : FrostingLifetime
         public int SetupCount { get; set; }
         public int TeardownCount { get; set; }
 
-        public override void Setup(ICakeContext context)
+        public override void Setup(ICakeContext context, ISetupContext info)
         {
             SetupCount++;
         }

diff --git a/src/Cake.Frosting/FrostingLifetime.cs b/src/Cake.Frosting/FrostingLifetime.cs
@@ -28,7 +28,8 @@ public abstract class FrostingLifetime<TContext> : IFrostingLifetime
         /// If setup fails, no tasks will be executed but teardown will be performed.
         /// </summary>
         /// <param name="context">The context.</param>
-        public abstract void Setup(TContext context);
+        /// <param name="info">The setup information.</param>
+        public abstract void Setup(TContext context, ISetupContext info);
 
         /// <summary>
         /// This method is executed after all tasks have been run.
@@ -38,29 +39,20 @@ public abstract class FrostingLifetime<TContext> : IFrostingLifetime
         /// <param name="info">The teardown information.</param>
         public abstract void Teardown(TContext context, ITeardownContext info);
 
-        /// <inheritdoc/>
-        void IFrostingSetup.Setup(ICakeContext context)
+        /// <inheritdoc cref="IFrostingSetup" />
+        void IFrostingSetup.Setup(ICakeContext context, ISetupContext info)
         {
-            if (context is null)
-            {
-                throw new ArgumentNullException(nameof(context));
-            }
+            ArgumentNullException.ThrowIfNull(context);
+            ArgumentNullException.ThrowIfNull(info);
 
-            Setup((TContext)context);
+            Setup((TContext)context, info);
         }
 
         /// <inheritdoc/>
         void IFrostingTeardown.Teardown(ICakeContext context, ITeardownContext info)
         {
-            if (context is null)
-            {
-                throw new ArgumentNullException(nameof(context));
-            }
-
-            if (info is null)
-            {
-                throw new ArgumentNullException(nameof(info));
-            }
+            ArgumentNullException.ThrowIfNull(context);
+            ArgumentNullException.ThrowIfNull(info);
 
             Teardown((TContext)context, info);
         }

diff --git a/src/Cake.Frosting/FrostingSetup.cs b/src/Cake.Frosting/FrostingSetup.cs
@@ -27,16 +27,16 @@ public abstract class FrostingSetup<TContext> : IFrostingSetup
         /// If setup fails, no tasks will be executed but teardown will be performed.
         /// </summary>
         /// <param name="context">The context.</param>
-        public abstract void Setup(TContext context);
+        /// <param name="info">The setup infortation.</param>
+        public abstract void Setup(TContext context, ISetupContext info);
 
-        void IFrostingSetup.Setup(ICakeContext context)
+        /// <inheritdoc cref="IFrostingSetup"/>
+        void IFrostingSetup.Setup(ICakeContext context, ISetupContext info)
         {
-            if (context is null)
-            {
-                throw new ArgumentNullException(nameof(context));
-            }
+            ArgumentNullException.ThrowIfNull(context);
+            ArgumentNullException.ThrowIfNull(info);
 
-            Setup((TContext)context);
+            Setup((TContext)context, info);
         }
     }
 }
diff --git a/src/Cake.Frosting/IFrostingLifetime.cs b/src/Cake.Frosting/IFrostingLifetime.cs
@@ -16,7 +16,8 @@ public interface IFrostingSetup
         /// If setup fails, no tasks will be executed but teardown will be performed.
         /// </summary>
         /// <param name="context">The context.</param>
-        void Setup(ICakeContext context);
+        /// <param name="info">The setup information.</param>
+        void Setup(ICakeContext context, ISetupContext info);
     }
 
     /// <summary>

diff --git a/src/Cake.Frosting/Internal/FrostingEngine.cs b/src/Cake.Frosting/Internal/FrostingEngine.cs
@@ -80,7 +80,7 @@ private void ConfigureLifetime()
             if (_setup != null)
             {
                 _log.Debug("Registering setup: {0}", _setup.GetType().Name);
-                _engine.RegisterSetupAction(info => _setup.Setup(_context));
+                _engine.RegisterSetupAction(info => _setup.Setup(_context, info));
             }
 
             if (_teardown != null)

diff --git a/tests/integration/Cake.Frosting/build/Lifetime.cs b/tests/integration/Cake.Frosting/build/Lifetime.cs
@@ -4,7 +4,7 @@
 
 public sealed class Lifetime : FrostingLifetime<Context>
 {
-    public override void Setup(Context context)
+    public override void Setup(Context context, ISetupContext info)
     {
         context.Information("Setting things up...");
     }