Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

executor

package

Go to main page

Versions in this module

v0

v0.121.0

Jul 18, 2024

v0.120.6

Jul 18, 2024

v0.120.5

Jul 16, 2024

v0.120.4

Jul 15, 2024

v0.120.3

Jul 12, 2024

v0.120.2

Jul 3, 2024

v0.120.1

Jun 19, 2024

v0.120.0

Jun 18, 2024

v0.119.1

Jun 10, 2024

v0.119.0

Jun 7, 2024

v0.118.1

Jun 4, 2024

v0.118.0

May 21, 2024

Changes in this version

+ var ErrTimedOut = errors.New("timed out")

v0.117.0

Apr 23, 2024

Changes in this version

+ var ErrArtifactsPathOutsideWorkingDir = errors.New("path is outside of CIRRUS_WORKING_DIR")

+ var ErrInvalidWindowsErrorMode = errors.New("invalid CIRRUS_WINDOWS_ERROR_MODE value") — windows/amd64

+ var ErrStepExit = errors.New("executor step requested to terminate execution")

+ var TimeOutError = errors.New("timed out")

+ func BoundedCommands(commands []*api.Command, fromName, toName string) []*api.Command

+ func CloneRepository(ctx context.Context, logUploader io.Writer, env *environment.Environment) bool

+ func ConvertAnnotations(annotations []model.Annotation) []*api.Annotation

+ func DeduplicatePaths(paths []string) (result []string)

+ func EnsureFolderExists(path string)

+ func EnvMapAsSlice(env map[string]string) []string

+ func FetchCache(ctx context.Context, logUploader *LogUploader, commandName string, ...) (*os.File, time.Duration, error)

+ func InitializeLogSaveClient(ctx context.Context, taskIdentification *api.TaskIdentification, ...) (api.CirrusCIService_SaveLogsClient, error)

+ func InitializeLogStreamClient(ctx context.Context, taskIdentification *api.TaskIdentification, ...) (api.CirrusCIService_StreamLogsClient, error)

+ func ShellCommandsAndWait(ctx context.Context, scripts []string, custom_env *environment.Environment, ...) (*exec.Cmd, error)

+ func TempFileName(prefix, suffix string) (*os.File, error)

+ func UploadCacheFile(ctx context.Context, cacheURL string, cacheFile *os.File) error

+ type ArtifactUploader interface

+ Finish func(ctx context.Context) error

+ Upload func(ctx context.Context, artifact io.Reader, relativeArtifactPath string, ...) error

+ func NewGRPCUploader(ctx context.Context, taskIdentification *api.TaskIdentification, ...) (ArtifactUploader, error)

+ func NewHTTPSUploader(ctx context.Context, taskIdentification *api.TaskIdentification, ...) (ArtifactUploader, error)

+ type Artifacts struct

+ Format string

+ Name string

+ Type string

+ func NewArtifacts(name string, artifactsInstruction *api.ArtifactsInstruction, ...) (*Artifacts, error)

+ func (artifacts *Artifacts) UploadableFiles() []*api.ArtifactFileInfo

+ type Cache struct

+ BaseFolder string

+ CacheAvailable bool

+ FileHasher *hasher.Hasher

+ Key string

+ Name string

+ PartiallyExpandedFolders []string

+ SkipUpload bool

+ func FindCache(cacheName string) *Cache

+ type CacheAttempts struct

+ func NewCacheAttempts() *CacheAttempts

+ func (ca *CacheAttempts) Failed(key string, error string)

+ func (ca *CacheAttempts) Hit(key string, size uint64, downloadedIn, extractedIn time.Duration)

+ func (ca *CacheAttempts) Miss(key string, size uint64, archivedIn, uploadedIn time.Duration)

+ func (ca *CacheAttempts) PopulatedIn(key string, populatedIn time.Duration)

+ func (ca *CacheAttempts) ToProto() map[string]*api.CacheRetrievalAttempt

+ type CommandAndLogs struct

+ Cmd *exec.Cmd

+ Logs *LogUploader

+ Name string

+ type Executor struct

+ func NewExecutor(taskId int64, clientToken, serverToken string, commandFrom string, ...) *Executor

+ func (executor *Executor) CreateFile(ctx context.Context, logUploader *LogUploader, ...) bool

+ func (executor *Executor) DownloadCache(ctx context.Context, logUploader *LogUploader, commandName string, ...) bool

+ func (executor *Executor) ExecuteScriptsAndStreamLogs(ctx context.Context, logUploader *LogUploader, scripts []string, ...) (*exec.Cmd, error)

+ func (executor *Executor) ExecuteScriptsStreamLogsAndWait(ctx context.Context, logUploader *LogUploader, commandName string, ...) (*exec.Cmd, error)

+ func (executor *Executor) RunBuild(ctx context.Context)

+ func (executor *Executor) UploadArtifacts(ctx context.Context, logUploader *LogUploader, name string, ...) bool

+ func (executor *Executor) UploadCache(ctx context.Context, logUploader *LogUploader, commandName string, ...) bool

+ type GRPCUploader struct

+ func (uploader *GRPCUploader) Finish(ctx context.Context) error

+ func (uploader *GRPCUploader) Upload(ctx context.Context, artifact io.Reader, relativeArtifactPath string, _ int64) error

+ type HTTPSUploader struct

+ func (uploader *HTTPSUploader) Finish(ctx context.Context) error

+ func (uploader *HTTPSUploader) Upload(ctx context.Context, artifact io.Reader, relativeArtifactPath string, ...) error

+ type InstantiateArtifactUploaderFunc func(ctx context.Context, taskIdentification *api.TaskIdentification, ...) (ArtifactUploader, error)

+ type LogUploader struct

+ GetTimestamp func() time.Time

+ LogTimestamps bool

+ OweTimestamp bool

+ func NewLogUploader(ctx context.Context, executor *Executor, commandName string) (*LogUploader, error)

+ func (uploader *LogUploader) Finalize()

+ func (uploader *LogUploader) ReadAvailableChunks() ([]byte, bool)

+ func (uploader *LogUploader) StreamLogs()

+ func (uploader *LogUploader) UploadStoredOutput(ctx context.Context) error

+ func (uploader *LogUploader) WithTimestamps(input []byte) []byte

+ func (uploader *LogUploader) Write(bytes []byte) (int, error)

+ func (uploader *LogUploader) WriteChunk(bytesToWrite []byte) (int, error)

+ type ProcessedPath struct

+ type ProcessedPattern struct

+ Paths []*ProcessedPath

+ Pattern string

+ type ShellCommands struct

+ func NewShellCommands(ctx context.Context, scripts []string, custom_env *environment.Environment, ...) (*ShellCommands, error)

+ type ShellOutputHandler func(bytes []byte) (int, error)

+ type ShellOutputWriter struct

+ func (writer ShellOutputWriter) Write(bytes []byte) (int, error)

+ type StepResult struct

+ Duration time.Duration

+ SignaledToExit bool

+ Success bool

+ type UploadDescriptor struct