1b0ba920fe
Fix a couple of problems related to data used by the phases runners of `init` and `join`. 1) make `newInitData()` and `newJoinData()` return pointers. Methods of the data objects returned by these functions should be able to modify fields in the data objects - e.g. `func (d initData) Client()`. This allows us to store a state and not execute the same logic multiple times - e.g. obtaining a client. A side effect of this change is that the `new...` functions must return pointers, so that casting the data object in a phase, from `workflow.RunData` to a locally defined interface, works. 2) Make it possible to pass arguments from a parent command to a sub-phase with regards to data initialization.
112 lines
2.7 KiB
Go
112 lines
2.7 KiB
Go
/*
|
|
Copyright 2018 The Kubernetes Authors.
|
|
|
|
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.
|
|
*/
|
|
|
|
package workflow
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var myWorkflowRunner = NewRunner()
|
|
|
|
type myWorkflowData struct {
|
|
data string
|
|
}
|
|
|
|
func (c *myWorkflowData) Data() string {
|
|
return c.data
|
|
}
|
|
|
|
type myPhaseData interface {
|
|
Data() string
|
|
}
|
|
|
|
func ExamplePhase() {
|
|
// Create a phase
|
|
var myPhase1 = Phase{
|
|
Name: "myPhase1",
|
|
Short: "A phase of a kubeadm composable workflow...",
|
|
Run: func(data RunData) error {
|
|
// transform data into a typed data struct
|
|
d, ok := data.(myPhaseData)
|
|
if !ok {
|
|
return errors.New("invalid RunData type")
|
|
}
|
|
|
|
// implement your phase logic...
|
|
fmt.Printf("%v", d.Data())
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// Create another phase
|
|
var myPhase2 = Phase{
|
|
Name: "myPhase2",
|
|
Short: "Another phase of a kubeadm composable workflow...",
|
|
Run: func(data RunData) error {
|
|
// transform data into a typed data struct
|
|
d, ok := data.(myPhaseData)
|
|
if !ok {
|
|
return errors.New("invalid RunData type")
|
|
}
|
|
|
|
// implement your phase logic...
|
|
fmt.Printf("%v", d.Data())
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// Adds the new phases to the workflow
|
|
// Phases will be executed the same order they are added to the workflow
|
|
myWorkflowRunner.AppendPhase(myPhase1)
|
|
myWorkflowRunner.AppendPhase(myPhase2)
|
|
}
|
|
|
|
func ExampleRunner_Run() {
|
|
// Create a phase
|
|
var myPhase = Phase{
|
|
Name: "myPhase",
|
|
Short: "A phase of a kubeadm composable workflow...",
|
|
Run: func(data RunData) error {
|
|
// transform data into a typed data struct
|
|
d, ok := data.(myPhaseData)
|
|
if !ok {
|
|
return errors.New("invalid RunData type")
|
|
}
|
|
|
|
// implement your phase logic...
|
|
fmt.Printf("%v", d.Data())
|
|
return nil
|
|
},
|
|
}
|
|
|
|
// Adds the new phase to the workflow
|
|
var myWorkflowRunner = NewRunner()
|
|
myWorkflowRunner.AppendPhase(myPhase)
|
|
|
|
// Defines the method that creates the runtime data shared
|
|
// among all the phases included in the workflow
|
|
myWorkflowRunner.SetDataInitializer(func(cmd *cobra.Command, args []string) (RunData, error) {
|
|
return myWorkflowData{data: "some data"}, nil
|
|
})
|
|
|
|
// Runs the workflow by passing a list of arguments
|
|
myWorkflowRunner.Run([]string{})
|
|
}
|