targetsuccess

Documentation

Index

• Variables
• func Load() (string, job.ReporterFactory)
• func New() job.Reporter
• type FinalParameters
• type RunParameters
• type TargetSuccessReport
• type TargetSuccessReporter
  • func (ts *TargetSuccessReporter) FinalReport(ctx xcontext.Context, parameters interface{}, runStatuses []job.RunStatus, ...) (bool, interface{}, error)
  • func (ts *TargetSuccessReporter) Name() string
  • func (ts *TargetSuccessReporter) RunReport(ctx xcontext.Context, parameters interface{}, runStatus *job.RunStatus, ...) (bool, interface{}, error)
  • func (ts *TargetSuccessReporter) ValidateFinalParameters(params []byte) (interface{}, error)
  • func (ts *TargetSuccessReporter) ValidateRunParameters(params []byte) (interface{}, error)

Variables

var Name = "TargetSuccess"

Name defines the name of the reporter used within the plugin registry

Functions

func Load

func Load() (string, job.ReporterFactory)

Load returns the name and factory which are needed to register the Reporter

func New

func New() job.Reporter

New builds a new TargetSuccessReporter

Types

type FinalParameters

type FinalParameters struct {
	AverageSuccessExpression string
}

FinalParameters contains the parameters necessary for the final reporter to elaborate the results of the Job

type RunParameters

type RunParameters struct {
	SuccessExpression string
}

RunParameters contains the parameters necessary for the run reporter to elaborate the results of the Job

type TargetSuccessReport

type TargetSuccessReport struct {
	Message         string
	AchievedSuccess string
	DesiredSuccess  string
}

TargetSuccessReport wraps a report with target success information.

type TargetSuccessReporter

type TargetSuccessReporter struct {
}

TargetSuccessReporter implements a reporter which determines whether the Job has been successful or not based on the number of Targets which succeeded/failed during the various Test runs

func (*TargetSuccessReporter) FinalReport

func (ts *TargetSuccessReporter) FinalReport(ctx xcontext.Context, parameters interface{}, runStatuses []job.RunStatus, ev testevent.Fetcher) (bool, interface{}, error)

FinalReport calculates the final report to be associated to a job.

func (*TargetSuccessReporter) Name

func (ts *TargetSuccessReporter) Name() string

Name returns the Name of the reporter

func (*TargetSuccessReporter) RunReport

func (ts *TargetSuccessReporter) RunReport(ctx xcontext.Context, parameters interface{}, runStatus *job.RunStatus, ev testevent.Fetcher) (bool, interface{}, error)

RunReport calculates the report to be associated with a job run.

func (*TargetSuccessReporter) ValidateFinalParameters

func (ts *TargetSuccessReporter) ValidateFinalParameters(params []byte) (interface{}, error)

ValidateFinalParameters validates the parameters for the final reporter

func (*TargetSuccessReporter) ValidateRunParameters

func (ts *TargetSuccessReporter) ValidateRunParameters(params []byte) (interface{}, error)

ValidateRunParameters validates the parameters for the run reporter