util

Documentation

Overview

Package util has convenience functions for use throughout TestGrid.

Index

• Variables
• func ExpandTemplate(template *configpb.LinkTemplate, parameters map[string]string) (string, error)
• func Progress(ctx context.Context, log logrus.FieldLogger, every time.Duration, total int, ...) func(int)
• func Tokens(template *configpb.LinkTemplate) []string
• type Strings
  • func (s *Strings) Set(value string) error
  • func (s *Strings) String() string
  • func (s *Strings) Strings() []string

Variables

var (

	// Substitute a particular custom column value for this token.
	// TODO: Handle start/end columns (for custom columns and build IDs).
	CustomColumnRe = regexp.MustCompile(`<custom-\d+>`)

	// Simple tokens.
	TestStatus      = "<test-status>"
	TestID          = "<test-id>"
	WorkflowID      = "<workflow-id>"
	WorkflowName    = "<workflow-name>"
	TestName        = "<test-name>"
	DisplayName     = "<display-name>"
	MethodName      = "<method-name>"
	TestURL         = "<test-url>"
	BuildID         = "<build-id>"
	BugComponent    = "<bug-component>"
	Owner           = "<owner>"
	Cc              = "<cc>"
	GcsPrefix       = "<gcs-prefix>"
	Environment     = "<environment>" // dashboard tab name
	ResultsExplorer = "<results-explorer>"
	CodeSearchPath  = "<cs-path>"
)

Functions

func ExpandTemplate

func ExpandTemplate(template *configpb.LinkTemplate, parameters map[string]string) (string, error)

ExpandTemplate expands the given link template with given parameters.

func Progress

func Progress(ctx context.Context, log logrus.FieldLogger, every time.Duration, total int, msg string) func(int)

Progress log every duration, including an ETA for completion. Returns a function for updating the current index

func Tokens

func Tokens(template *configpb.LinkTemplate) []string

Tokens returns the unique list of all Tokens that could be replaced in this template.

Types

type Strings

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

Strings represents the value of a flag that accept multiple strings.

func (*Strings) Set

func (s *Strings) Set(value string) error

Set records the value passed

func (*Strings) String

func (s *Strings) String() string

String returns a concatenated string of all the values joined by commas.

func (*Strings) Strings

func (s *Strings) Strings() []string

Strings returns the slice of strings set for this value instance.