hooks

Documentation

Index

• Variables
• func SetupStaticEnvOptions(cfg Config)
• type BuildEnvOpts
  • func NewBuildEnvOpts(a *v1.Artifact, image string, pushImage bool) (BuildEnvOpts, error)
• type Config
• type DeployEnvOpts
  • func NewDeployEnvOpts(runID string, kubeContext string, namespaces []string) DeployEnvOpts
• type MockRunner
  • func (m MockRunner) RunPostHooks(ctx context.Context, out io.Writer) error
  • func (m MockRunner) RunPreHooks(ctx context.Context, out io.Writer) error
• type Runner
  • func BuildRunner(d v1.BuildHooks, opts BuildEnvOpts) Runner
  • func NewSyncRunner(cli *kubectl.CLI, imageName, imageRef string, namespaces []string, ...) Runner
• type StaticEnvOpts
• type SyncEnvOpts
  • func NewSyncEnvOpts(a *v1.Artifact, image string, addOrModifyFiles []string, deleteFiles []string, ...) (SyncEnvOpts, error)

Variables

var (
	NewDeployRunner = newDeployRunner
)

for testing

Functions

func SetupStaticEnvOptions

func SetupStaticEnvOptions(cfg Config)

Types

type BuildEnvOpts

type BuildEnvOpts struct {
	Image        string
	PushImage    bool
	ImageRepo    string
	ImageTag     string
	BuildContext string
}

BuildEnvOpts contains the environment variables to be set in a build type lifecycle hook executor.

func NewBuildEnvOpts

func NewBuildEnvOpts(a *v1.Artifact, image string, pushImage bool) (BuildEnvOpts, error)

NewBuildEnvOpts returns `BuildEnvOpts` required to create a `Runner` for build lifecycle hooks

type Config

type Config interface {
	DefaultRepo() *string
	GetWorkingDir() string
	RPCPort() *int
	RPCHTTPPort() *int
}

type DeployEnvOpts

type DeployEnvOpts struct {
	RunID       string
	KubeContext string
	Namespaces  string
}

DeployEnvOpts contains the environment variables to be set in a deploy type lifecycle hook executor.

func NewDeployEnvOpts

func NewDeployEnvOpts(runID string, kubeContext string, namespaces []string) DeployEnvOpts

type MockRunner

type MockRunner struct {
	PreHooks  func(ctx context.Context, out io.Writer) error
	PostHooks func(ctx context.Context, out io.Writer) error
}

MockRunner implements the Runner interface, to be used in unit tests

func (MockRunner) RunPostHooks

func (m MockRunner) RunPostHooks(ctx context.Context, out io.Writer) error

func (MockRunner) RunPreHooks

func (m MockRunner) RunPreHooks(ctx context.Context, out io.Writer) error

type Runner

type Runner interface {
	// RunPreHooks executes all pre-step hooks defined by the `Runner`
	RunPreHooks(ctx context.Context, out io.Writer) error
	// RunPostHooks executes all post-step hooks defined by the `Runner`
	RunPostHooks(ctx context.Context, out io.Writer) error
}

Runner represents a lifecycle hooks runner

func BuildRunner

func BuildRunner(d v1.BuildHooks, opts BuildEnvOpts) Runner

BuildRunner creates a new runner for pre-build and post-build lifecycle hooks

func NewSyncRunner

func NewSyncRunner(cli *kubectl.CLI, imageName, imageRef string, namespaces []string, formatter logger.Formatter, d v1.SyncHooks, opts SyncEnvOpts) Runner

type StaticEnvOpts

type StaticEnvOpts struct {
	DefaultRepo *string
	RPCPort     *int
	HTTPPort    *int
	WorkDir     string
}

StaticEnvOpts contains the environment variables to be set in a lifecycle hook executor that don't change during the lifetime of the process.

type SyncEnvOpts

type SyncEnvOpts struct {
	Image                string
	BuildContext         string
	FilesAddedOrModified *string
	FilesDeleted         *string
	KubeContext          string
	Namespaces           string
}

SyncEnvOpts contains the environment variables to be set in a sync type lifecycle hook executor.

func NewSyncEnvOpts

func NewSyncEnvOpts(a *v1.Artifact, image string, addOrModifyFiles []string, deleteFiles []string, namespaces []string, kubeContext string) (SyncEnvOpts, error)