stages

Documentation

Overview

walter: a deployment pipeline template * Copyright (C) 2014 Recruit Technologies Co., Ltd. and contributors * (see CONTRIBUTORS.md) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

walter: a deployment pipeline template * Copyright (C) 2014 Recruit Technologies Co., Ltd. and contributors * (see CONTRIBUTORS.md) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

walter: a deployment pipeline template * Copyright (C) 2014 Recruit Technologies Co., Ltd. and contributors * (see CONTRIBUTORS.md) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

walter: a deployment pipeline template * Copyright (C) 2014 Recruit Technologies Co., Ltd. and contributors * (see CONTRIBUTORS.md) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

walter: a deployment pipeline template * Copyright (C) 2014 Recruit Technologies Co., Ltd. and contributors * (see CONTRIBUTORS.md) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.

Index

• func PrepareCh(stage Stage)
• type BaseStage
  • func (b *BaseStage) AddChildStage(stage Stage)
  • func (b *BaseStage) GetChildStages() list.List
  • func (b *BaseStage) GetErrResult() string
  • func (b *BaseStage) GetInputCh() *chan Mediator
  • func (b *BaseStage) GetOutResult() string
  • func (b *BaseStage) GetOutputCh() *chan Mediator
  • func (b *BaseStage) GetStageName() string
  • func (b *BaseStage) GetStageOpts() StageOpts
  • func (b *BaseStage) Run() bool
  • func (b *BaseStage) SetErrResult(result string)
  • func (b *BaseStage) SetInputCh(inputCh *chan Mediator)
  • func (b *BaseStage) SetOutResult(result string)
  • func (b *BaseStage) SetOutputCh(outputCh *chan Mediator)
  • func (b *BaseStage) SetStageName(stageName string)
  • func (b *BaseStage) SetStageOpts(stageOpts StageOpts)
• type CommandStage
  • func NewCommandStage() *CommandStage
  • func (self *CommandStage) AddCommand(command string)
  • func (self *CommandStage) GetStdoutResult() string
  • func (self *CommandStage) Run() bool
  • func (self *CommandStage) SetDirectory(directory string)
• type Mediator
  • func (m *Mediator) IsAnyFailure() bool
• type ResourceValidator
  • func NewResourceValidator() *ResourceValidator
  • func (self *ResourceValidator) AddCommandName(c string)
  • func (self *ResourceValidator) AddFile(f string)
  • func (self *ResourceValidator) Validate() bool
• type Runner
• type ShellScriptStage
  • func NewShellScriptStage() *ShellScriptStage
  • func (self *ShellScriptStage) Run() bool
• type Stage
  • func InitStage(stageType string) (Stage, error)
• type StageOpts
  • func NewStageOpts() *StageOpts

Functions

func PrepareCh

func PrepareCh(stage Stage)

Types

type BaseStage

type BaseStage struct {
	Runner
	InputCh     *chan Mediator
	OutputCh    *chan Mediator
	ChildStages list.List
	StageName   string `config:"name"`
	OutResult   string
	ErrResult   string
	Opts        StageOpts
}

func (*BaseStage) AddChildStage

func (b *BaseStage) AddChildStage(stage Stage)

func (*BaseStage) GetChildStages

func (b *BaseStage) GetChildStages() list.List

func (*BaseStage) GetErrResult

func (b *BaseStage) GetErrResult() string

func (*BaseStage) GetInputCh

func (b *BaseStage) GetInputCh() *chan Mediator

func (*BaseStage) GetOutResult

func (b *BaseStage) GetOutResult() string

func (*BaseStage) GetOutputCh

func (b *BaseStage) GetOutputCh() *chan Mediator

func (*BaseStage) GetStageName

func (b *BaseStage) GetStageName() string

func (*BaseStage) GetStageOpts

func (b *BaseStage) GetStageOpts() StageOpts

func (*BaseStage) Run

func (b *BaseStage) Run() bool

func (*BaseStage) SetErrResult

func (b *BaseStage) SetErrResult(result string)

func (*BaseStage) SetInputCh

func (b *BaseStage) SetInputCh(inputCh *chan Mediator)

func (*BaseStage) SetOutResult

func (b *BaseStage) SetOutResult(result string)

func (*BaseStage) SetOutputCh

func (b *BaseStage) SetOutputCh(outputCh *chan Mediator)

func (*BaseStage) SetStageName

func (b *BaseStage) SetStageName(stageName string)

func (*BaseStage) SetStageOpts

func (b *BaseStage) SetStageOpts(stageOpts StageOpts)

type CommandStage

type CommandStage struct {
	BaseStage
	Command   string `config:"command" is_replace:"false"`
	Directory string `config:"directory" is_replace:"true"`
	OnlyIf    string `config:"only_if" is_replace:"false"`
}

func NewCommandStage

func NewCommandStage() *CommandStage

func (*CommandStage) AddCommand

func (self *CommandStage) AddCommand(command string)

func (*CommandStage) GetStdoutResult

func (self *CommandStage) GetStdoutResult() string

func (*CommandStage) Run

func (self *CommandStage) Run() bool

func (*CommandStage) SetDirectory

func (self *CommandStage) SetDirectory(directory string)

type Mediator

type Mediator struct {
	States map[string]string
	Type   string
}

func (*Mediator) IsAnyFailure

func (m *Mediator) IsAnyFailure() bool

type ResourceValidator

type ResourceValidator struct {
	// contains filtered or unexported fields
}

ResourceValidator class check if the resources to run the target staget are satisfied.

func NewResourceValidator

func NewResourceValidator() *ResourceValidator

func (*ResourceValidator) AddCommandName

func (self *ResourceValidator) AddCommandName(c string)

func (*ResourceValidator) AddFile

func (self *ResourceValidator) AddFile(f string)

TODO add permission

func (*ResourceValidator) Validate

func (self *ResourceValidator) Validate() bool

type Runner

type Runner interface {
	Run() bool
}

type ShellScriptStage

type ShellScriptStage struct {
	ResourceValidator
	CommandStage
	File string `config:"file"`
}

func NewShellScriptStage

func NewShellScriptStage() *ShellScriptStage

func (*ShellScriptStage) Run

func (self *ShellScriptStage) Run() bool

type Stage

type Stage interface {
	AddChildStage(Stage)
	GetChildStages() list.List
	GetStageName() string
	SetStageName(string)
	GetStageOpts() StageOpts
	SetStageOpts(StageOpts)
	GetInputCh() *chan Mediator
	SetInputCh(*chan Mediator)
	GetOutputCh() *chan Mediator
	SetOutputCh(*chan Mediator)
	GetOutResult() string
	SetOutResult(string)
	GetErrResult() string
	SetErrResult(string)
}

func InitStage

func InitStage(stageType string) (Stage, error)

type StageOpts

type StageOpts struct {
	ReportingFullOutput bool `config:"report_full_output"`
}

func NewStageOpts

func NewStageOpts() *StageOpts