taskoutput

Documentation

Overview

Task Output Directory

The task output directory establishes an API, via the file system, for the handling of output generated by an Evergreen task. It sits on the top level of the task's working directory and contains subdirectories that map to specific types of task output. Any data written to these subdirectories is automatically ingested, processed, and persisted in a well defined manner established with with users. A subdirectory may require a specification file written by the task workload detailing versions, formats, etc. In general, a task output subdirectory is free to establish its own requirements, conventions, and behavior.

This package implements the task output directory API for the Evergreen agent.

Index

• func AppendTestLog(ctx context.Context, comm client.Communicator, tsk *task.Task, ...) error
• type Directory
  • func NewDirectory(root string, tsk *task.Task, redactorOpts redactor.RedactionOptions, ...) *Directory
  • func (d *Directory) Run(ctx context.Context) error
  • func (d *Directory) Setup() error

Functions

func AppendTestLog

func AppendTestLog(ctx context.Context, comm client.Communicator, tsk *task.Task, redactionOptions redactor.RedactionOptions, testLog *testlog.TestLog) error

AppendTestLog appends log lines to the specified test log for the given task run.

Types

type Directory

type Directory struct {
	// contains filtered or unexported fields
}

Directory is the application representation of a task's reserved output directory. It coordinates the automated handling of task output written to the reserved directory while a task runs.

func NewDirectory

func NewDirectory(root string, tsk *task.Task, redactorOpts redactor.RedactionOptions, logger client.LoggerProducer) *Directory

NewDirectory returns a new task output directory with the specified root for the given task.

func (*Directory) Run

func (d *Directory) Run(ctx context.Context) error

Run runs each directory handler and removes the task output directory.

func (*Directory) Setup

func (d *Directory) Setup() error

Setup creates the subdirectories for each handler and should be called during task set up.