AbstractSoftwareDeliveryMachine

Abstract support class for implementing a SoftwareDeliveryMachine.

Type parameters

O: SoftwareDeliveryMachineConfiguration = SoftwareDeliveryMachineConfiguration

Hierarchy

ListenerRegistrationManagerSupport
- AbstractSoftwareDeliveryMachine
  - HandlerBasedSoftwareDeliveryMachine
  - TestSoftwareDeliveryMachine

Implements

Index

Constructors

constructor

Accessors

Methods

Constructors

Protected constructor

new AbstractSoftwareDeliveryMachine(name: string, configuration: O, goalSetters: Array<GoalSetter | GoalSetter[]>): AbstractSoftwareDeliveryMachine

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:301
Construct a new software delivery machine, with zero or more goal setters.

Parameters
- name: string
- configuration: O
 
 automation client configuration we're running in
- goalSetters: Array<GoalSetter | GoalSetter[]>
 
 tell me what to do on a push. Hint: start with "whenPushSatisfies(...)"
Returns AbstractSoftwareDeliveryMachine

Properties

Readonly channelLinkListeners

channelLinkListeners: ChannelLinkListener[] = []

Readonly closedIssueListeners

closedIssueListeners: ClosedIssueListener[] = []

Readonly Abstract commandHandlers

commandHandlers: Array<Maker<HandleCommand>>

Readonly configuration

configuration: O

automation client configuration we're running in

Protected Readonly disposalGoalSetters

disposalGoalSetters: GoalSetter[] = []

Readonly Abstract eventHandlers

eventHandlers: Array<Maker<HandleEvent<any>>>

Readonly extensionPacks

extensionPacks: ExtensionPack[] = []

Readonly firstPushListeners

firstPushListeners: PushListener[] = []

Private fulfillmentMapper

fulfillmentMapper: DefaultGoalImplementationMapper

Protected goalApprovalRequestVoteDecisionManager

goalApprovalRequestVoteDecisionManager: GoalApprovalRequestVoteDecisionManager = UnanimousGoalApprovalRequestVoteDecisionManager

Protected Readonly goalApprovalRequestVoters

goalApprovalRequestVoters: GoalApprovalRequestVoter[] = []

Readonly goalCompletionListeners

goalCompletionListeners: GoalCompletionListener[] = []

Readonly goalExecutionListeners

goalExecutionListeners: GoalExecutionListener[] = []

Readonly goalsSetListeners

goalsSetListeners: GoalsSetListener[] = []

Readonly Abstract ingesters

ingesters: string[]

Readonly name

name: string

Readonly newIssueListeners

newIssueListeners: NewIssueListener[] = []

Readonly pullRequestListeners

pullRequestListeners: PullRequestListener[] = []

Private pushMap

pushMap: GoalSetter

Protected Readonly registrationManager

registrationManager: HandlerRegistrationManagerSupport = new HandlerRegistrationManagerSupport(this)

Readonly repoCreationListeners

repoCreationListeners: RepoCreationListener[] = []

Readonly repoOnboardingListeners

repoOnboardingListeners: ProjectListener[] = []

Readonly startupListeners

startupListeners: StartupListener[] = []

Readonly tagListeners

tagListeners: TagListener[] = []

Readonly triggeredListeners

triggeredListeners: TriggeredListenerRegistration[] = []

Readonly updatedIssueListeners

updatedIssueListeners: UpdatedIssueListener[] = []

Readonly userJoiningChannelListeners

userJoiningChannelListeners: UserJoiningChannelListener[] = []

Accessors

goalFulfillmentMapper

get goalFulfillmentMapper(): DefaultGoalImplementationMapper

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:99
Returns DefaultGoalImplementationMapper

pushMapping

get pushMapping(): PushMapping<Goals>

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:111
Return the PushMapping that will be used on pushes. Useful in testing goal setting.

Returns PushMapping<Goals>

Methods

addChannelLinkListener

addChannelLinkListener(e: ChannelLinkListener): this

Implementation of SoftwareDeliveryMachine.addChannelLinkListener

Inherited from ListenerRegistrationManagerSupport.addChannelLinkListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:105
Parameters
- e: ChannelLinkListener
Returns this

addClosedIssueListener

addClosedIssueListener(e: ClosedIssueListener): this

Implementation of SoftwareDeliveryMachine.addClosedIssueListener

Inherited from ListenerRegistrationManagerSupport.addClosedIssueListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:95
Parameters
- e: ClosedIssueListener
Returns this

addCodeInspectionCommand

addCodeInspectionCommand<R, P>(cir: CodeInspectionRegistration<R, P>): this

Implementation of SoftwareDeliveryMachine.addCodeInspectionCommand
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:178
Type parameters
- R
- P
Parameters
- cir: CodeInspectionRegistration<R, P>
Returns this

addCodeTransformCommand

addCodeTransformCommand(ct: CodeTransformRegistration): this

Implementation of SoftwareDeliveryMachine.addCodeTransformCommand
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:171
Type parameters
- P
Parameters
- ct: CodeTransformRegistration
Returns this

addCommand

addCommand(cmd: CommandHandlerRegistration): this

Implementation of SoftwareDeliveryMachine.addCommand
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:157
Type parameters
- P
Parameters
- cmd: CommandHandlerRegistration
Returns this

addEvent

addEvent<T, P>(e: EventHandlerRegistration<T, P>): this

Implementation of SoftwareDeliveryMachine.addEvent
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:185
Type parameters
- T
- P
Parameters
- e: EventHandlerRegistration<T, P>
Returns this

Private addExtensionPack

addExtensionPack(pack: ExtensionPack): this

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:248
Parameters
- pack: ExtensionPack
Returns this

addExtensionPacks

addExtensionPacks(...packs: ExtensionPack[]): this

Implementation of SoftwareDeliveryMachine.addExtensionPacks
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:234
Parameters
- Rest ...packs: ExtensionPack[]
Returns this

addFirstPushListener

addFirstPushListener(pls: PushListener): this

Implementation of SoftwareDeliveryMachine.addFirstPushListener

Inherited from ListenerRegistrationManagerSupport.addFirstPushListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:120
Parameters
- pls: PushListener
Returns this

addGeneratorCommand

addGeneratorCommand(gen: GeneratorRegistration): this

Implementation of SoftwareDeliveryMachine.addGeneratorCommand
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:164
Type parameters
- P = NoParameters
Parameters
- gen: GeneratorRegistration
Returns this

addGoalApprovalRequestVoter

addGoalApprovalRequestVoter(vote: GoalApprovalRequestVoter): this

Implementation of SoftwareDeliveryMachine.addGoalApprovalRequestVoter
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:147
Parameters
- vote: GoalApprovalRequestVoter
Returns this

addGoalCompletionListener

addGoalCompletionListener(l: GoalCompletionListener): this

Implementation of SoftwareDeliveryMachine.addGoalCompletionListener

Inherited from ListenerRegistrationManagerSupport.addGoalCompletionListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:135
Parameters
- l: GoalCompletionListener
Returns this

addGoalContributions

addGoalContributions(goalContributions: GoalSetter): this

Implementation of SoftwareDeliveryMachine.addGoalContributions
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:220
Parameters
- goalContributions: GoalSetter
Returns this

addGoalExecutionListener

addGoalExecutionListener(e: GoalExecutionListener): this

Implementation of SoftwareDeliveryMachine.addGoalExecutionListener

Inherited from ListenerRegistrationManagerSupport.addGoalExecutionListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:90
Parameters
- e: GoalExecutionListener
Returns this

addGoalImplementation

addGoalImplementation(implementationName: string, goal: Goal, goalExecutor: ExecuteGoal, options?: Partial<{ logInterpreter: InterpretLog; progressReporter: ReportProgress; projectListeners: GoalProjectListenerRegistration | GoalProjectListenerRegistration[]; pushTest: PushTest }>): this

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:127
Provide the implementation for a goal. The SDM will run it as soon as the goal is ready (all preconditions are met). If you provide a PushTest, then the SDM can assign different implementations to the same goal based on the code in the project.

Parameters
- implementationName: string
- goal: Goal
- goalExecutor: ExecuteGoal
- Optional options: Partial<{ logInterpreter: InterpretLog; progressReporter: ReportProgress; projectListeners: GoalProjectListenerRegistration | GoalProjectListenerRegistration[]; pushTest: PushTest }>
 
 PushTest to narrow matching & InterpretLog that can handle the log from the goalExecutor function
Returns this

addGoalSideEffect

addGoalSideEffect(goal: Goal, sideEffectName: string, registration?: string, pushTest?: PushTest): this

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:207
Declare that a goal will become successful based on something outside. For instance, ArtifactGoal succeeds because of an ImageLink event. This tells the SDM that it does not need to run anything when this goal becomes ready.

Parameters
- goal: Goal
- sideEffectName: string
- Optional registration: string
- Default value pushTest: PushTest = AnyPush
Returns this

addGoalsSetListener

addGoalsSetListener(l: GoalsSetListener): this

Implementation of SoftwareDeliveryMachine.addGoalsSetListener

Inherited from ListenerRegistrationManagerSupport.addGoalsSetListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:130
Parameters
- l: GoalsSetListener
Returns this

addIngester

addIngester(i: string | IngesterRegistration): this

Implementation of SoftwareDeliveryMachine.addIngester
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:190
Parameters
- i: string | IngesterRegistration
Returns this

addNewIssueListener

addNewIssueListener(e: NewIssueListener): this

Implementation of SoftwareDeliveryMachine.addNewIssueListener

Inherited from ListenerRegistrationManagerSupport.addNewIssueListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:80
Parameters
- e: NewIssueListener
Returns this

addPullRequestListener

addPullRequestListener(pls: PullRequestListener): this

Implementation of SoftwareDeliveryMachine.addPullRequestListener

Inherited from ListenerRegistrationManagerSupport.addPullRequestListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:125
Parameters
- pls: PullRequestListener
Returns this

addRepoCreationListener

addRepoCreationListener(rcls: RepoCreationListener): this

Implementation of SoftwareDeliveryMachine.addRepoCreationListener

Inherited from ListenerRegistrationManagerSupport.addRepoCreationListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:110
Parameters
- rcls: RepoCreationListener
Returns this

addRepoOnboardingListener

addRepoOnboardingListener(rols: ProjectListener): this

Implementation of SoftwareDeliveryMachine.addRepoOnboardingListener

Inherited from ListenerRegistrationManagerSupport.addRepoOnboardingListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:115
Parameters
- rols: ProjectListener
Returns this

addStartupListener

addStartupListener(l: StartupListener): this

Implementation of SoftwareDeliveryMachine.addStartupListener

Inherited from ListenerRegistrationManagerSupport.addStartupListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:70
Parameters
- l: StartupListener
Returns this

addTagListener

addTagListener(e: TagListener): this

Implementation of SoftwareDeliveryMachine.addTagListener

Inherited from ListenerRegistrationManagerSupport.addTagListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:100
Parameters
- e: TagListener
Returns this

addTriggeredListener

addTriggeredListener(t: TriggeredListenerRegistration): this

Implementation of SoftwareDeliveryMachine.addTriggeredListener

Inherited from ListenerRegistrationManagerSupport.addTriggeredListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:75
Parameters
- t: TriggeredListenerRegistration
Returns this

addUpdatedIssueListener

addUpdatedIssueListener(e: UpdatedIssueListener): this

Implementation of SoftwareDeliveryMachine.addUpdatedIssueListener

Inherited from ListenerRegistrationManagerSupport.addUpdatedIssueListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:85
Parameters
- e: UpdatedIssueListener
Returns this

addUserJoiningChannelListener

addUserJoiningChannelListener(l: UserJoiningChannelListener): this

Implementation of SoftwareDeliveryMachine.addUserJoiningChannelListener

Inherited from ListenerRegistrationManagerSupport.addUserJoiningChannelListener
- Defined in lib/api-helper/machine/ListenerRegistrationManagerSupport.ts:140
Parameters
- l: UserJoiningChannelListener
Returns this

notifyStartupListeners

notifyStartupListeners(): Promise<void>

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:260
Invoke StartupListeners.

Returns Promise<void>

scheduleTriggeredListeners

scheduleTriggeredListeners(): void

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:279
Schedule the triggered listeners

Returns void

setGoalApprovalRequestVoteDecisionManager

setGoalApprovalRequestVoteDecisionManager(manager: GoalApprovalRequestVoteDecisionManager): this

Implementation of SoftwareDeliveryMachine.setGoalApprovalRequestVoteDecisionManager
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:152
Parameters
- manager: GoalApprovalRequestVoteDecisionManager
Returns this

Private shouldRegister

shouldRegister(cm: CommandRegistration): boolean

- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:325
Type parameters
- P
Parameters
- cm: CommandRegistration
Returns boolean

withPushRules

withPushRules(contributor: GoalContribution<any>, ...contributors: Array<GoalContribution<any>>): this

Implementation of SoftwareDeliveryMachine.withPushRules
- Defined in lib/api-helper/machine/AbstractSoftwareDeliveryMachine.ts:229
Parameters
- contributor: GoalContribution<any>
- Rest ...contributors: Array<GoalContribution<any>>
Returns this

Type parameters

O: SoftwareDeliveryMachineConfiguration = SoftwareDeliveryMachineConfiguration

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

name: string

configuration: O

goalSetters: Array<GoalSetter | GoalSetter[]>

Returns AbstractSoftwareDeliveryMachine

Properties

Readonly channelLinkListeners

Readonly closedIssueListeners

Readonly Abstract commandHandlers

Readonly configuration

Protected Readonly disposalGoalSetters

Readonly Abstract eventHandlers

Readonly extensionPacks

Readonly firstPushListeners

Private fulfillmentMapper

Protected goalApprovalRequestVoteDecisionManager

Protected Readonly goalApprovalRequestVoters

Readonly goalCompletionListeners

Readonly goalExecutionListeners

Readonly goalsSetListeners

Readonly Abstract ingesters

Readonly name

Readonly newIssueListeners

Readonly pullRequestListeners

Private pushMap

Protected Readonly registrationManager

Readonly repoCreationListeners

Readonly repoOnboardingListeners

Readonly startupListeners

Readonly tagListeners

Readonly triggeredListeners

Readonly updatedIssueListeners

Readonly userJoiningChannelListeners

Accessors

goalFulfillmentMapper

Returns DefaultGoalImplementationMapper

pushMapping

Returns PushMapping<Goals>

Methods

addChannelLinkListener

Parameters

e: ChannelLinkListener

Returns this

addClosedIssueListener

Parameters

e: ClosedIssueListener

Returns this

addCodeInspectionCommand

Type parameters

R

P

Parameters

cir: CodeInspectionRegistration<R, P>

Returns this

addCodeTransformCommand

Type parameters

P

Parameters

ct: CodeTransformRegistration<P>

Returns this

addCommand

Type parameters

P

Parameters

cmd: CommandHandlerRegistration<P>

Returns this

addEvent

Type parameters

T