local

Documentation

Overview

Package local provides the ability for Vela to integrate with the local system.

Usage:

import "github.com/go-vela/worker/executor/local"

Index

• func Equal(a, b *client) bool
• func New(opts ...Opt) (*client, error)
• type MockedClient
• type Opt
  • func WithBuild(b *library.Build) Opt
  • func WithHostname(hostname string) Opt
  • func WithMockStdout(mock bool) Opt
  • func WithPipeline(p *pipeline.Build) Opt
  • func WithRepo(r *library.Repo) Opt
  • func WithRuntime(r runtime.Engine) Opt
  • func WithUser(u *library.User) Opt
  • func WithVelaClient(cli *vela.Client) Opt
  • func WithVersion(version string) Opt

Functions

func Equal

func Equal(a, b *client) bool

equal returns true if the other client is the equivalent.

func New

func New(opts ...Opt) (*client, error)

New returns an Executor implementation that integrates with the local system.

Types

type MockedClient

type MockedClient interface {
	MockStdout() *os.File
}

MockedClient is for internal use to facilitate testing the local executor.

type Opt

type Opt func(*client) error

Opt represents a configuration option to initialize the executor client for Local.

func WithBuild

func WithBuild(b *library.Build) Opt

WithBuild sets the library build in the executor client for Local.

func WithHostname

func WithHostname(hostname string) Opt

WithHostname sets the hostname in the executor client for Local.

func WithMockStdout

func WithMockStdout(mock bool) Opt

WithMockStdout adds a mock stdout writer to the client if mock is true. If mock is true, then you must use a goroutine to read from MockStdout as quickly as possible, or writing to stdout will hang.

func WithPipeline

func WithPipeline(p *pipeline.Build) Opt

WithPipeline sets the pipeline build in the executor client for Local.

func WithRepo

func WithRepo(r *library.Repo) Opt

WithRepo sets the library repo in the executor client for Local.

func WithRuntime

func WithRuntime(r runtime.Engine) Opt

WithRuntime sets the runtime engine in the executor client for Local.

func WithUser

func WithUser(u *library.User) Opt

WithUser sets the library user in the executor client for Local.

func WithVelaClient

func WithVelaClient(cli *vela.Client) Opt

WithVelaClient sets the Vela client in the executor client for Local.

func WithVersion

func WithVersion(version string) Opt

WithVersion sets the version in the executor client for Local.