util

Documentation

Overview

Package util has convenience functions for use throughout TestGrid.

Index

• func Progress(ctx context.Context, log logrus.FieldLogger, every time.Duration, total int, ...) func(int)
• type Queue
  • func (q *Queue) Fix(name string, when time.Time, later bool) error
  • func (q *Queue) FixAll(whens map[string]time.Time, later bool) error
  • func (q *Queue) Init(log logrus.FieldLogger, names []string, when time.Time)
  • func (q *Queue) Send(ctx context.Context, receivers chan<- string, frequency time.Duration) error
  • func (q *Queue) Status() (int, *string, time.Time)
• type Strings
  • func (s *Strings) Set(value string) error
  • func (s *Strings) String() string
  • func (s *Strings) Strings() []string

Functions

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

Types

type Queue

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

Queue can send names to receivers at a specific frequency.

Also contains the ability to modify the next time to send names. First call must be to Init(). Exported methods are safe to call concurrently.

func (*Queue) Fix

func (q *Queue) Fix(name string, when time.Time, later bool) error

Fix the next time to send the group to receivers.

If later is set then it will move out the next update time, otherwise it will only reduce it.

func (*Queue) FixAll

func (q *Queue) FixAll(whens map[string]time.Time, later bool) error

FixAll will fix multiple groups inside a single critical section.

If later is set then it will move out the next update time, otherwise it will only reduce it.

func (*Queue) Init

func (q *Queue) Init(log logrus.FieldLogger, names []string, when time.Time)

Init (or reinit) the queue with the specified groups, which should be updated at frequency.

func (*Queue) Send

func (q *Queue) Send(ctx context.Context, receivers chan<- string, frequency time.Duration) error

Send test groups to receivers until the context expires.

Pops items off the queue when frequency is zero. Otherwise reschedules the item after the specified frequency has elapsed.

func (*Queue) Status

func (q *Queue) Status() (int, *string, time.Time)

Status of the queue: depth, next item and when the next item is ready.

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.