benchmark

Documentation

Overview

Package benchmark provides interfaces related to rebuild benchmarks.

Index

• func RunBench(ctx context.Context, client *http.Client, apiURL *url.URL, set PackageSet, ...) (<-chan schema.Verdict, error)
• type BenchmarkMode
• type Metadata
• type Package
• type PackageSet
  • func ReadBenchmark(filename string) (ps PackageSet, err error)
  • func (ps *PackageSet) Hash(h hash.Hash) []byte
• type RunBenchOpts

Functions

func RunBench

func RunBench(ctx context.Context, client *http.Client, apiURL *url.URL, set PackageSet, opts RunBenchOpts) (<-chan schema.Verdict, error)

Types

type BenchmarkMode

type BenchmarkMode string

const (
	SmoketestMode BenchmarkMode = "smoketest"
	AttestMode    BenchmarkMode = "attest"
)

type Metadata

type Metadata struct {
	Count   int
	Updated time.Time
}

Metadata describes characteristics of a PackageSet.

type Package

type Package struct {
	Ecosystem string
	Name      string
	Versions  []string
}

Package corresponds to one or more versions of a package to rebuild.

* Only the versions provided will be rebuilt. * All supported artifacts will be built for each provided version.

TODO: Possible extension of this form would include specific artifacts:

 {
   ...,
	  "artifacts": {"1.2.0": [...]},
 }

type PackageSet

type PackageSet struct {
	Metadata
	Packages []Package
}

PackageSet is a grouping of packages to evaluate rebuilds.

func ReadBenchmark

func ReadBenchmark(filename string) (ps PackageSet, err error)

func (*PackageSet) Hash

func (ps *PackageSet) Hash(h hash.Hash) []byte

Hash canonicalizes and returns a hash on its Packages using "h".

type RunBenchOpts

type RunBenchOpts struct {
	Mode BenchmarkMode
	// RunID is the ID for this run. Leave blank for one to be generated.
	RunID          string
	MaxConcurrency int
}