benchmark

Documentation

Overview

Package benchmark runs benchmark tests of Finch.

Package benchmark runs benchmark tests of Finch.

Index

• Constants
• Variables
• func GetSubject() (string, error)
• func Wrapper(b *testing.B, targetFunc func(), cleanupFunc func())
• type Metrics
  • func (m *Metrics) Add(other Metrics)
• type Suite
  • func (suite *Suite) BenchmarkContainerRun(b *testing.B)
  • func (suite *Suite) BenchmarkImageBuild(b *testing.B)
  • func (suite *Suite) BenchmarkVMInit(b *testing.B)
  • func (suite *Suite) BenchmarkVMStart(b *testing.B)
  • func (suite *Suite) InitVM() error
  • func (suite *Suite) RemoveVM() error
  • func (suite *Suite) Setup() error
  • func (suite *Suite) StartVM() error
  • func (suite *Suite) StopVM() error

Constants

const InstalledTestSubject = "finch"

InstalledTestSubject is the test subject when Finch is installed.

Variables

var Installed = flag.Bool("installed", false, "the flag to show whether the tests are run against installed application")

Installed indicates whether the tests are run against installed application.

Functions

func GetSubject

func GetSubject() (string, error)

GetSubject returns the testing subject based on INSTALLED flag.

func Wrapper

func Wrapper(b *testing.B, targetFunc func(), cleanupFunc func())

Wrapper reports the benchmarking metrics of targetFunc to testing.B.

Types

type Metrics

type Metrics struct {
	PeakCPUUsage    float64
	AverageCPUUsage float64
	TotalCPUTime    time.Duration
	DiskUsageDelta  int64
}

Metrics includes all the additional metrics that Finch benchmark reports, except testing.B natively supported metrics like execution time and memory.

func (*Metrics) Add

func (m *Metrics) Add(other Metrics)

Add combines the values of the current Metrics instance with the values of another Metrics instance passed as an argument. It updates the current instance's fields by adding the corresponding values from the other instance.

type Suite

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

Suite is a struct that groups benchmark functions and shared state.

func (*Suite) BenchmarkContainerRun

func (suite *Suite) BenchmarkContainerRun(b *testing.B)

BenchmarkContainerRun measures the metrics to run a container.

func (*Suite) BenchmarkImageBuild

func (suite *Suite) BenchmarkImageBuild(b *testing.B)

BenchmarkImageBuild measures the metrics to build an image.

func (*Suite) BenchmarkVMInit

func (suite *Suite) BenchmarkVMInit(b *testing.B)

BenchmarkVMInit measures the metrics to initialize the VM.

func (*Suite) BenchmarkVMStart

func (suite *Suite) BenchmarkVMStart(b *testing.B)

BenchmarkVMStart measures the metrics to start the VM.

func (*Suite) InitVM

func (suite *Suite) InitVM() error

InitVM initializes a virtual machine.

func (*Suite) RemoveVM

func (suite *Suite) RemoveVM() error

RemoveVM removes the VM.

func (*Suite) Setup

func (suite *Suite) Setup() error

Setup initializes the Suite by getting the subject.

func (*Suite) StartVM

func (suite *Suite) StartVM() error

StartVM starts the VM.

func (*Suite) StopVM

func (suite *Suite) StopVM() error

StopVM stops the VM.