Skip to content

Commit

Permalink
(cake-buildGH-4000) Remove obsolete CakeEngine events
Browse files Browse the repository at this point in the history
* Setup
* Teardown
* TaskSetup
* TaskTeardown
* fixes cake-build#4000
  • Loading branch information
devlead committed Oct 20, 2022
1 parent a7fa100 commit 9d0f5ca
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 188 deletions.
16 changes: 8 additions & 8 deletions src/Cake.Core.Tests/Unit/CakeEngineTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1613,11 +1613,11 @@ public async Task Should_Invoke_All_Handlers()
var settings = new ExecutionSettings().SetTarget("A");
var engine = fixture.CreateEngine();
engine.RegisterTask("A");
engine.Setup += (sender, args) =>
engine.BeforeSetup += (sender, args) =>
{
list.Add("HANDLER_1");
};
engine.Setup += (sender, args) =>
engine.BeforeSetup += (sender, args) =>
{
list.Add("HANDLER_2");
};
Expand All @@ -1642,7 +1642,7 @@ public async Task Should_Raise_The_Setup_Event_Only_Once()
engine.RegisterTask("A");
engine.RegisterTask("B").IsDependentOn("A");
engine.RegisterTask("C").IsDependentOn("B");
engine.Setup += (sender, args) =>
engine.BeforeSetup += (sender, args) =>
{
list.Add("SETUP_EVENT");
};
Expand Down Expand Up @@ -1731,15 +1731,15 @@ public async Task Should_Raise_Task_Setup_Event_After_Setup_Event()
var settings = new ExecutionSettings().SetTarget("A");
var engine = fixture.CreateEngine();
engine.RegisterTask("A");
engine.Setup += (sender, args) =>
engine.BeforeSetup += (sender, args) =>
{
list.Add("SETUP_EVENT");
};
engine.TaskSetup += (sender, args) =>
engine.BeforeTaskSetup += (sender, args) =>
{
list.Add("TASK_SETUP_EVENT_1");
};
engine.TaskSetup += (sender, args) =>
engine.BeforeTaskSetup += (sender, args) =>
{
list.Add("TASK_SETUP_EVENT_2");
};
Expand Down Expand Up @@ -1767,7 +1767,7 @@ public async Task Should_Raise_Task_Setup_Event_For_All_Tasks()
var engine = fixture.CreateEngine();
engine.RegisterTask("A");
engine.RegisterTask("B").IsDependentOn("A");
engine.TaskSetup += (sender, args) =>
engine.BeforeTaskSetup += (sender, args) =>
{
list.Add("TASK_SETUP_EVENT_" + args.TaskSetupContext.Task.Name);
};
Expand Down Expand Up @@ -1857,7 +1857,7 @@ public async Task Should_Raise_Task_Teardown_Event_After_Task_Setup_Event()
var settings = new ExecutionSettings().SetTarget("A");
var engine = fixture.CreateEngine();
engine.RegisterTask("A");
engine.TaskSetup += (sender, args) =>
engine.BeforeTaskSetup += (sender, args) =>
{
list.Add("TASK_SETUP_EVENT");
};
Expand Down
33 changes: 1 addition & 32 deletions src/Cake.Core/CakeEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,44 +26,24 @@ public sealed class CakeEngine : ICakeEngine
/// <inheritdoc/>
public IReadOnlyList<ICakeTaskInfo> Tasks => _tasks;

/// <inheritdoc/>
#pragma warning disable 618
public event EventHandler<SetupEventArgs> Setup;
#pragma warning restore 618

/// <inheritdoc/>
public event EventHandler<BeforeSetupEventArgs> BeforeSetup;

/// <inheritdoc/>
public event EventHandler<AfterSetupEventArgs> AfterSetup;

/// <inheritdoc/>
#pragma warning disable 618
public event EventHandler<TeardownEventArgs> Teardown;
#pragma warning restore 618

/// <inheritdoc/>
public event EventHandler<BeforeTeardownEventArgs> BeforeTeardown;

/// <inheritdoc/>
public event EventHandler<AfterTeardownEventArgs> AfterTeardown;

/// <inheritdoc/>
#pragma warning disable 618
public event EventHandler<TaskSetupEventArgs> TaskSetup;
#pragma warning restore 618

/// <inheritdoc/>
public event EventHandler<BeforeTaskSetupEventArgs> BeforeTaskSetup;

/// <inheritdoc/>
public event EventHandler<AfterTaskSetupEventArgs> AfterTaskSetup;

/// <inheritdoc/>
#pragma warning disable 618
public event EventHandler<TaskTeardownEventArgs> TaskTeardown;
#pragma warning restore 618

/// <inheritdoc/>
public event EventHandler<BeforeTaskTeardownEventArgs> BeforeTaskTeardown;

Expand Down Expand Up @@ -265,9 +245,6 @@ private void PerformSetup(IExecutionStrategy strategy, ICakeContext context, Cak
stopWatch.Restart();

PublishEvent(BeforeSetup, new BeforeSetupEventArgs(context));
#pragma warning disable 618
PublishEvent(Setup, new SetupEventArgs(context));
#pragma warning restore 618

try
{
Expand Down Expand Up @@ -377,9 +354,7 @@ private void PerformTaskSetup(ICakeContext context, IExecutionStrategy strategy,
{
var taskSetupContext = new TaskSetupContext(context, task);
PublishEvent(BeforeTaskSetup, new BeforeTaskSetupEventArgs(taskSetupContext));
#pragma warning disable 618
PublishEvent(TaskSetup, new TaskSetupEventArgs(taskSetupContext));
#pragma warning restore 618

// Trying to stay consistent with the behavior of script-level Setup & Teardown (if setup fails, don't run the task, but still run the teardown)
try
{
Expand Down Expand Up @@ -408,9 +383,6 @@ private void PerformTaskTeardown(ICakeContext context, IExecutionStrategy strate

var taskTeardownContext = new TaskTeardownContext(context, task, duration, skipped, taskException);
PublishEvent(BeforeTaskTeardown, new BeforeTaskTeardownEventArgs(taskTeardownContext));
#pragma warning disable 618
PublishEvent(TaskTeardown, new TaskTeardownEventArgs(taskTeardownContext));
#pragma warning restore 618

try
{
Expand Down Expand Up @@ -493,9 +465,6 @@ private void PerformTeardown(IExecutionStrategy strategy, ICakeContext context,

var teardownContext = new TeardownContext(context, thrownException);
PublishEvent(BeforeTeardown, new BeforeTeardownEventArgs(teardownContext));
#pragma warning disable 618
PublishEvent(Teardown, new TeardownEventArgs(teardownContext));
#pragma warning restore 618

try
{
Expand Down
28 changes: 0 additions & 28 deletions src/Cake.Core/ICakeEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,6 @@ public interface ICakeEngine
/// <value>The registered tasks.</value>
IReadOnlyList<ICakeTaskInfo> Tasks { get; }

/// <summary>
/// [deprecated] Setup is obsolete and will be removed in a future release. Use <see cref="BeforeSetup" /> instead.
/// Raised at the start of setup before any tasks are run.
/// </summary>
[Obsolete("Setup is obsolete and will be removed in a future release. Use BeforeSetup instead.")]
event EventHandler<SetupEventArgs> Setup;

/// <summary>
/// Raised at the start of setup before any tasks are run.
/// </summary>
Expand All @@ -36,13 +29,6 @@ public interface ICakeEngine
/// </summary>
event EventHandler<AfterSetupEventArgs> AfterSetup;

/// <summary>
/// [deprecated] Teardown is obsolete and will be removed in a future release. Use <see cref="BeforeTeardown" /> instead.
/// Raised at the start of teardown after all other tasks have been run.
/// </summary>
[Obsolete("Teardown is obsolete and will be removed in a future release. Use BeforeTeardown instead.")]
event EventHandler<TeardownEventArgs> Teardown;

/// <summary>
/// Raised at the start of teardown after all other tasks have been run.
/// </summary>
Expand All @@ -53,13 +39,6 @@ public interface ICakeEngine
/// </summary>
event EventHandler<AfterTeardownEventArgs> AfterTeardown;

/// <summary>
/// [deprecated] TaskSetup is obsolete and will be removed in a future release. Use <see cref="BeforeTaskSetup" /> instead.
/// Raised at the start of task setup before each task is run.
/// </summary>
[Obsolete("TaskSetup is obsolete and will be removed in a future release. Use BeforeTaskSetup instead.")]
event EventHandler<TaskSetupEventArgs> TaskSetup;

/// <summary>
/// Raised at the start of task setup before each task is run.
/// </summary>
Expand All @@ -70,13 +49,6 @@ public interface ICakeEngine
/// </summary>
event EventHandler<AfterTaskSetupEventArgs> AfterTaskSetup;

/// <summary>
/// [deprecated] TaskTeardown is obsolete and will be removed in a future release. Use <see cref="BeforeTaskTeardown" /> instead.
/// Raised at the start of task teardown after each task has been run.
/// </summary>
[Obsolete("TaskTeardown is obsolete and will be removed in a future release. Use BeforeTaskTeardown instead.")]
event EventHandler<TaskTeardownEventArgs> TaskTeardown;

/// <summary>
/// Raised at the start of task teardown after each task has been run.
/// </summary>
Expand Down
30 changes: 0 additions & 30 deletions src/Cake.Core/SetupEventArgs.cs

This file was deleted.

30 changes: 0 additions & 30 deletions src/Cake.Core/TaskSetupEventArgs.cs

This file was deleted.

30 changes: 0 additions & 30 deletions src/Cake.Core/TaskTeardownEventArgs.cs

This file was deleted.

30 changes: 0 additions & 30 deletions src/Cake.Core/TeardownEventArgs.cs

This file was deleted.

0 comments on commit 9d0f5ca

Please sign in to comment.