CakeEngine Class

Summary

The Cake execution engine.
Namespace
Cake.Core
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ICakeEngine"] click Interface0 "/api/Cake.Core/ICakeEngine" Type["CakeEngine"] class Type type-node

Syntax

public sealed class CakeEngine : ICakeEngine

Constructors

Name Summary
CakeEngine(ICakeDataService, ICakeLog) Initializes a new instance of the CakeEngine class.

Events

Name Type Summary
AfterSetup EventHandler<AfterSetupEventArgs>
Raised at the end of setup before any tasks are run.
AfterTaskSetup EventHandler<AfterTaskSetupEventArgs>
Raised at the end of task setup before each task is run.
AfterTaskTeardown EventHandler<AfterTaskTeardownEventArgs>
Raised at the end of task teardown after each task has been run.
AfterTeardown EventHandler<AfterTeardownEventArgs>
Raised at the end of teardown after all other tasks have been run.
BeforeSetup EventHandler<BeforeSetupEventArgs>
Raised at the start of setup before any tasks are run.
BeforeTaskSetup EventHandler<BeforeTaskSetupEventArgs>
Raised at the start of task setup before each task is run.
BeforeTaskTeardown EventHandler<BeforeTaskTeardownEventArgs>
Raised at the start of task teardown after each task has been run.
BeforeTeardown EventHandler<BeforeTeardownEventArgs>
Raised at the start of teardown after all other tasks have been run.
Setup EventHandler<SetupEventArgs>
[deprecated] Setup is obsolete and will be removed in a future release. Use BeforeSetup instead. Raised at the start of setup before any tasks are run.
TaskSetup EventHandler<TaskSetupEventArgs>
[deprecated] TaskSetup is obsolete and will be removed in a future release. Use BeforeTaskSetup instead. Raised at the start of task setup before each task is run.
TaskTeardown EventHandler<TaskTeardownEventArgs>
[deprecated] TaskTeardown is obsolete and will be removed in a future release. Use BeforeTaskTeardown instead. Raised at the start of task teardown after each task has been run.
Teardown EventHandler<TeardownEventArgs>
[deprecated] Teardown is obsolete and will be removed in a future release. Use BeforeTeardown instead. Raised at the start of teardown after all other tasks have been run.

Properties

Name Value Summary
Tasks IReadOnlyList<ICakeTaskInfo>
Gets all registered tasks.

Methods

Name Value Summary
RegisterSetupAction(Action<ISetupContext>) void
Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
RegisterSetupAction<TData>(Func<ISetupContext, TData>) void
Allows registration of an action that's executed before any tasks are run. If setup fails, no tasks will be executed but teardown will be performed.
RegisterTask(string) CakeTaskBuilder
Creates and registers a new Cake task.
RegisterTaskSetupAction(Action<ITaskSetupContext>) void
Allows registration of an action that's executed before each task is run. If the task setup fails, the task will not be executed but the task's teardown will be performed.
RegisterTaskSetupAction<TData>(Action<ITaskSetupContext, TData>) void
Allows registration of an action that's executed before each task is run. If the task setup fails, the task will not be executed but the task's teardown will be performed.
RegisterTaskTeardownAction(Action<ITaskTeardownContext>) void
Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
RegisterTaskTeardownAction<TData>(Action<ITaskTeardownContext, TData>) void
Allows registration of an action that's executed after each task has been run. If a task setup action or a task fails with or without recovery, the specified task teardown action will still be executed.
RegisterTeardownAction(Action<ITeardownContext>) void
Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
RegisterTeardownAction<TData>(Action<ITeardownContext, TData>) void
Allows registration of an action that's executed after all other tasks have been run. If a setup action or a task fails with or without recovery, the specified teardown action will still be executed.
RunTargetAsync(ICakeContext, IExecutionStrategy, ExecutionSettings) Task<CakeReport>
Runs the specified target using the specified IExecutionStrategy.

Extension Methods

Name Value Summary
Dump<CakeEngine>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CakeEngine>(CakeEngine[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CakeEngine>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<CakeEngine>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<CakeEngine>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CakeEngine>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin