core

Documentation

Index

• Variables
• type JobParameters
• type JobRecord
  • func LoadJob(data []byte) (*JobRecord, error)
  • func NewJob(params JobParameters) *JobRecord
  • func (jr *JobRecord) Bytes() []byte
  • func (jr *JobRecord) RunTime() string
  • func (jr *JobRecord) SetFinalStatus(s JobStatus)
  • func (jr *JobRecord) SetRunningStatus()
• type JobStatus
  • func (jr JobStatus) Icon() string
  • func (jr JobStatus) String() string
• type QueueStatus
• type WorkerInfo

Variables

var BuildDate = "?"

var Name = "go-bench-away"

Substituted at build time using -X linker flag https://pkg.go.dev/cmd/link See Makefile and Goreleaser configuration

var SHA = "?"

var Version = "dev"

Types

type JobParameters

type JobParameters struct {
	GitRemote       string
	GitRef          string
	TestsSubDir     string
	TestsFilterExpr string
	Reps            uint
	TestMinRuntime  time.Duration
	Timeout         time.Duration
	SkipCleanup     bool
	Username        string
	GoPath          string
	CleanupCmd      string
}

type JobRecord

type JobRecord struct {
	Id         string
	Status     JobStatus
	Parameters JobParameters

	Created   time.Time
	Started   time.Time
	Completed time.Time

	SHA       string
	GoVersion string

	// Artifacts from job execution
	Log     string
	Results string
	Script  string

	WorkerInfo WorkerInfo
}

func LoadJob

func LoadJob(data []byte) (*JobRecord, error)

func NewJob

func NewJob(params JobParameters) *JobRecord

func (*JobRecord) Bytes

func (jr *JobRecord) Bytes() []byte

func (*JobRecord) RunTime

func (jr *JobRecord) RunTime() string

func (*JobRecord) SetFinalStatus

func (jr *JobRecord) SetFinalStatus(s JobStatus)

func (*JobRecord) SetRunningStatus

func (jr *JobRecord) SetRunningStatus()

type JobStatus

type JobStatus int

const (
	Submitted JobStatus = iota
	Running
	Failed
	Succeeded
)

func (JobStatus) Icon

func (jr JobStatus) Icon() string

func (JobStatus) String

func (jr JobStatus) String() string

type QueueStatus

type QueueStatus struct {
	SubmittedCount uint64
	RunningJob     *JobRecord
}

type WorkerInfo

type WorkerInfo struct {
	Hostname string
	Uname    string
	Version  string
}