CakeEngineBase Class

Summary

Base-implementation for a wrapped ICakeEngine - the base Shared Engine used by CI modules.
Assembly
Cake.Module.Shared.dll
Namespace
Cake.Module.Shared
Interfaces
  • ICakeEngine
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type-.->Interface0["ICakeEngine"] Type["CakeEngineBase"] class Type type-node Derived0["AzurePipelinesEngine"]-->Type click Derived0 "/api/Cake.AzurePipelines.Module/AzurePipelinesEngine" Derived1["GitLabCIEngine"]-->Type click Derived1 "/api/Cake.GitLabCI.Module/GitLabCIEngine" Derived2["MyGetEngine"]-->Type click Derived2 "/api/Cake.MyGet.Module/MyGetEngine" Derived3["GitHubActionsEngine"]-->Type click Derived3 "/api/Cake.GitHubActions.Module/GitHubActionsEngine" Derived4["TeamCityEngine"]-->Type click Derived4 "/api/Cake.TeamCity.Module/TeamCityEngine" Derived5["TravisCIEngine"]-->Type click Derived5 "/api/Cake.TravisCI.Module/TravisCIEngine"

Syntax

public abstract class CakeEngineBase : ICakeEngine

Constructors

Name Summary
CakeEngineBase(ICakeEngine) Initializes a new instance of the CakeEngineBase 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.

Fields

Name Constant Value Summary
_engine
Gets the wrapped ICakeEngine.

Properties

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

Methods

Name Value Summary
RegisterSetupAction(Action<ICakeContext>) 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(Action<ISetupContext>) void
RegisterSetupAction<TData>(Func<ISetupContext, TData>) void
RegisterTask(string) CakeTaskBuilder
Registers a new 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
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
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
RunTargetAsync(ICakeContext, IExecutionStrategy, ExecutionSettings) Task<CakeReport>
Runs the specified target using the specified IExecutionStrategy.

Extension Methods

Name Value Summary
Dump<CakeEngineBase>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<CakeEngineBase>(CakeEngineBase[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CakeEngineBase>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CakeEngineBase>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<CakeEngineBase>(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
ThrowIfNull<CakeEngineBase>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin