utils

Documentation

Index

• func BeEquivalentToError(expected error) types.GomegaMatcher
• func CleanStatusFromStep(steps []v1alpha1.WorkflowStep, stepStatus []v1alpha1.WorkflowStepStatus, ...) ([]v1alpha1.WorkflowStepStatus, *corev1.ConfigMap, error)
• func GetDataFromContext(ctx context.Context, cli client.Client, ctxName, name, ns string, ...) (*value.Value, error)
• func GetLogConfigFromStep(ctx context.Context, cli client.Client, ctxName, name, ns, step string) (*types.LogConfig, error)
• func GetLogsFromPod(ctx context.Context, clientSet kubernetes.Interface, cli client.Client, ...) (io.ReadCloser, error)
• func GetLogsFromURL(ctx context.Context, url string) (io.ReadCloser, error)
• func GetPodListFromResources(ctx context.Context, cli client.Client, resources []types.Resource) ([]corev1.Pod, error)
• func JSONMarshal(o interface{}) []byte
• func NewRecycleCronJob(cli client.Client, duration time.Duration, cron, label string) manager.Runnable
• func OperateSteps(status []v1alpha1.WorkflowStepStatus, i, j int, ...)
• func RestartFromStep(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, ...) error
• func RestartWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, step string) error
• func ResumeWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, ...) error
• func SuspendWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, ...) error
• func TerminateWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun) error
• type AlreadyExistMatcher
  • func (matcher AlreadyExistMatcher) FailureMessage(actual interface{}) (message string)
  • func (matcher AlreadyExistMatcher) Match(actual interface{}) (success bool, err error)
  • func (matcher AlreadyExistMatcher) NegatedFailureMessage(actual interface{}) (message string)
• type ErrorMatcher
  • func (matcher ErrorMatcher) FailureMessage(actual interface{}) (message string)
  • func (matcher ErrorMatcher) Match(actual interface{}) (success bool, err error)
  • func (matcher ErrorMatcher) NegatedFailureMessage(actual interface{}) (message string)
• type NotFoundMatcher
  • func (matcher NotFoundMatcher) FailureMessage(actual interface{}) (message string)
  • func (matcher NotFoundMatcher) Match(actual interface{}) (success bool, err error)
  • func (matcher NotFoundMatcher) NegatedFailureMessage(actual interface{}) (message string)
• type WorkflowOperator
  • func NewWorkflowRunOperator(cli client.Client, w io.Writer, run *v1alpha1.WorkflowRun) WorkflowOperator
• type WorkflowStepOperator
  • func NewWorkflowRunStepOperator(cli client.Client, w io.Writer, run *v1alpha1.WorkflowRun) WorkflowStepOperator

Functions

func BeEquivalentToError

func BeEquivalentToError(expected error) types.GomegaMatcher

BeEquivalentToError matches the error to take care of nil.

func CleanStatusFromStep

func CleanStatusFromStep(steps []v1alpha1.WorkflowStep, stepStatus []v1alpha1.WorkflowStepStatus, mode v1alpha1.WorkflowExecuteMode, contextCM *corev1.ConfigMap, stepName string) ([]v1alpha1.WorkflowStepStatus, *corev1.ConfigMap, error)

CleanStatusFromStep cleans status and context data from a specified step

func GetDataFromContext

func GetDataFromContext(ctx context.Context, cli client.Client, ctxName, name, ns string, paths ...string) (*value.Value, error)

GetDataFromContext get data from workflow context

func GetLogConfigFromStep

func GetLogConfigFromStep(ctx context.Context, cli client.Client, ctxName, name, ns, step string) (*types.LogConfig, error)

GetLogConfigFromStep get log config from step

func GetLogsFromPod

func GetLogsFromPod(ctx context.Context, clientSet kubernetes.Interface, cli client.Client, podName, ns, cluster string, opts *corev1.PodLogOptions) (io.ReadCloser, error)

GetLogsFromPod get logs from pod

func GetLogsFromURL

func GetLogsFromURL(ctx context.Context, url string) (io.ReadCloser, error)

GetLogsFromURL get logs from url

func GetPodListFromResources

func GetPodListFromResources(ctx context.Context, cli client.Client, resources []types.Resource) ([]corev1.Pod, error)

GetPodListFromResources get pod list from resources

func JSONMarshal

func JSONMarshal(o interface{}) []byte

JSONMarshal returns the JSON encoding

func NewRecycleCronJob

func NewRecycleCronJob(cli client.Client, duration time.Duration, cron, label string) manager.Runnable

NewRecycleCronJob returns a new recycleCronJob

func OperateSteps

func OperateSteps(status []v1alpha1.WorkflowStepStatus, i, j int, phase v1alpha1.WorkflowStepPhase)

OperateSteps handles the operations to the steps

func RestartFromStep

func RestartFromStep(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, stepName string) error

RestartFromStep restart workflow from a failed step

func RestartWorkflow

func RestartWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, step string) error

RestartWorkflow restart workflow

func ResumeWorkflow

func ResumeWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, stepName string) error

ResumeWorkflow resume workflow

func SuspendWorkflow

func SuspendWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun, stepName string) error

SuspendWorkflow suspend workflow

func TerminateWorkflow

func TerminateWorkflow(ctx context.Context, cli client.Client, run *v1alpha1.WorkflowRun) error

TerminateWorkflow terminate workflow

Types

type AlreadyExistMatcher

type AlreadyExistMatcher struct {
}

AlreadyExistMatcher matches the error to be already exist

func (AlreadyExistMatcher) FailureMessage

func (matcher AlreadyExistMatcher) FailureMessage(actual interface{}) (message string)

FailureMessage builds an error message.

func (AlreadyExistMatcher) Match

func (matcher AlreadyExistMatcher) Match(actual interface{}) (success bool, err error)

Match matches error.

func (AlreadyExistMatcher) NegatedFailureMessage

func (matcher AlreadyExistMatcher) NegatedFailureMessage(actual interface{}) (message string)

NegatedFailureMessage builds an error message.

type ErrorMatcher

type ErrorMatcher struct {
	ExpectedError error
}

ErrorMatcher matches errors.

func (ErrorMatcher) FailureMessage

func (matcher ErrorMatcher) FailureMessage(actual interface{}) (message string)

FailureMessage builds an error message.

func (ErrorMatcher) Match

func (matcher ErrorMatcher) Match(actual interface{}) (success bool, err error)

Match matches an error.

func (ErrorMatcher) NegatedFailureMessage

func (matcher ErrorMatcher) NegatedFailureMessage(actual interface{}) (message string)

NegatedFailureMessage builds an error message.

type NotFoundMatcher

type NotFoundMatcher struct {
}

NotFoundMatcher matches the error to be not found.

func (NotFoundMatcher) FailureMessage

func (matcher NotFoundMatcher) FailureMessage(actual interface{}) (message string)

FailureMessage builds an error message.

func (NotFoundMatcher) Match

func (matcher NotFoundMatcher) Match(actual interface{}) (success bool, err error)

Match matches the api error.

func (NotFoundMatcher) NegatedFailureMessage

func (matcher NotFoundMatcher) NegatedFailureMessage(actual interface{}) (message string)

NegatedFailureMessage builds an error message.

type WorkflowOperator

type WorkflowOperator interface {
	Suspend(ctx context.Context) error
	Resume(ctx context.Context) error
	Rollback(ctx context.Context) error
	Restart(ctx context.Context) error
	Terminate(ctx context.Context) error
}

WorkflowOperator is operation handler for workflow's suspend/resume/rollback/restart/terminate

func NewWorkflowRunOperator

func NewWorkflowRunOperator(cli client.Client, w io.Writer, run *v1alpha1.WorkflowRun) WorkflowOperator

NewWorkflowRunOperator get an workflow operator with k8sClient, ioWriter(optional, useful for cli) and workflow run

type WorkflowStepOperator

type WorkflowStepOperator interface {
	Suspend(ctx context.Context, step string) error
	Resume(ctx context.Context, step string) error
	Restart(ctx context.Context, step string) error
}

WorkflowStepOperator is operation handler for workflow steps' operations

func NewWorkflowRunStepOperator

func NewWorkflowRunStepOperator(cli client.Client, w io.Writer, run *v1alpha1.WorkflowRun) WorkflowStepOperator

NewWorkflowRunStepOperator get an workflow step operator with k8sClient, ioWriter(optional, useful for cli) and workflow run