usage

Documentation

Index

• type Properties
  • func (p Properties) SetArtifacts(art config.Artifacts) Properties
  • func (p Properties) SetDocker(d config.Docker) Properties
  • func (p Properties) SetError(errMessage string) Properties
  • func (p Properties) SetFVersion(f string) Properties
  • func (p Properties) SetFlags(flags *pflag.FlagSet) Properties
  • func (p Properties) SetFramework(f string) Properties
  • func (p Properties) SetJobs(jobs []report.TestResult) Properties
  • func (p Properties) SetNPM(npm config.Npm) Properties
  • func (p Properties) SetNotificationsCount(sent, failed int) Properties
  • func (p Properties) SetNumSuites(n int) Properties
  • func (p Properties) SetSauceConfig(c config.SauceConfig) Properties
  • func (p Properties) SetSlack(slack config.Slack) Properties
• type Tracker

Types

type Properties

type Properties map[string]interface{}

Properties is a scoped data transfer object for usage reporting and contains usage event related data.

func (Properties) SetArtifacts

func (p Properties) SetArtifacts(art config.Artifacts) Properties

SetArtifacts reports artifact usage.

func (Properties) SetDocker

func (p Properties) SetDocker(d config.Docker) Properties

SetDocker reports the docker container setup.

func (Properties) SetError

func (p Properties) SetError(errMessage string) Properties

SetError reports an error.

func (Properties) SetFVersion

func (p Properties) SetFVersion(f string) Properties

SetFVersion reports the framework version.

func (Properties) SetFlags

func (p Properties) SetFlags(flags *pflag.FlagSet) Properties

SetFlags reports CLI flags.

func (Properties) SetFramework

func (p Properties) SetFramework(f string) Properties

SetFramework reports the framework.

func (Properties) SetJobs

func (p Properties) SetJobs(jobs []report.TestResult) Properties

SetJobs reports job (aka test results).

func (Properties) SetNPM

func (p Properties) SetNPM(npm config.Npm) Properties

SetNPM reports the npm usage.

func (Properties) SetNotificationsCount

func (p Properties) SetNotificationsCount(sent, failed int) Properties

SetNotificationsCount reports the number of notifications.

func (Properties) SetNumSuites

func (p Properties) SetNumSuites(n int) Properties

SetNumSuites reports the number of configured suites.

func (Properties) SetSauceConfig

func (p Properties) SetSauceConfig(c config.SauceConfig) Properties

SetSauceConfig reports key fields of the sauce config.

func (Properties) SetSlack

func (p Properties) SetSlack(slack config.Slack) Properties

SetSlack reports the info relative to slack notifications.

type Tracker

type Tracker interface {
	io.Closer
	Collect(subject string, props Properties)
}

Tracker is an interface for providing usage tracking.