artifact

Documentation

Index

• Constants
• Variables
• func ByBuildId(id string) db.Q
• func ByTaskId(id string) db.Q
• type Entry
  • func FindAll(query db.Q) ([]Entry, error)
  • func FindOne(query db.Q) (*Entry, error)
  • func (e Entry) Upsert() error
• type File
• type Params
  • func (params Params) Array() []File

Constants

const (
	// strings for setting visibility
	Public  = "public"
	Private = "private"
	None    = "none"
)

const Collection = "artifact_files"

Variables

var (
	// BSON fields for artifact file structs
	TaskIdKey   = bsonutil.MustHaveTag(Entry{}, "TaskId")
	TaskNameKey = bsonutil.MustHaveTag(Entry{}, "TaskDisplayName")
	BuildIdKey  = bsonutil.MustHaveTag(Entry{}, "BuildId")
	FilesKey    = bsonutil.MustHaveTag(Entry{}, "Files")
	NameKey     = bsonutil.MustHaveTag(File{}, "Name")
	LinkKey     = bsonutil.MustHaveTag(File{}, "Link")
)

var ValidVisibilities = []string{Public, Private, None, ""}

Functions

func ByBuildId

func ByBuildId(id string) db.Q

ByBuildId returns all entries with the given Build Id, sorted by Task name

func ByTaskId

func ByTaskId(id string) db.Q

ByTaskId returns a query for entries with the given Task Id

Types

type Entry

type Entry struct {
	TaskId          string `json:"task" bson:"task"`
	TaskDisplayName string `json:"task_name" bson:"task_name"`
	BuildId         string `json:"build" bson:"build"`
	Files           []File `json:"files" bson:"files"`
}

Entry stores groups of names and links (not content!) for files uploaded to the api server by a running agent. These links could be for build or task-relevant files (things like extra results, test coverage, etc.)

func FindAll

func FindAll(query db.Q) ([]Entry, error)

FindAll gets every Entry for the given query

func FindOne

func FindOne(query db.Q) (*Entry, error)

FindOne ets one Entry for the given query

func (Entry) Upsert

func (e Entry) Upsert() error

Upsert updates the files entry in the db if an entry already exists, overwriting the existing file data. If no entry exists, one is created

type File

type File struct {
	// Name is a human-readable name for the file being linked, e.g. "Coverage Report"
	Name string `json:"name" bson:"name"`
	// Link is the link to the file, e.g. "http://fileserver/coverage.html"
	Link string `json:"link" bson:"link"`
	// Visibility determines who can see the file in the UI
	Visibility string `json:"visibility" bson:"visibility"`
}

File is a pairing of name and link for easy storage/display

type Params

type Params map[string]string

Params stores file entries as key-value pairs, for easy parameter parsing.

Key = Human-readable name for file
Value = link for the file

func (Params) Array

func (params Params) Array() []File

Array turns the parameter map into an array of File structs. Deprecated.