validation

Documentation

Overview

Validation invokes language runner for every step in serial fashion with the StepValidateRequest and runner gets back with the StepValidateResponse.

Step Level validation

1. Duplicate step implementation
2. Step implementation not found : Prints a step implementation stub for every unimplemented step

If there is a validation error it skips that scenario and executes other scenarios in the spec.

Index

• Variables
• func FilterDuplicates(validationErrors validationErrors) []error
• func NewValidator(s []*gauge.Specification, r runner.Runner, c *gauge.ConceptDictionary) *validator
• func Validate(args []string)
• type SpecValidationError
  • func NewSpecValidationError(m string, f string) SpecValidationError
  • func (s SpecValidationError) Error() string
• type SpecValidator
  • func (v *SpecValidator) Comment(comment *gauge.Comment)
  • func (v *SpecValidator) DataTable(dataTable *gauge.DataTable)
  • func (v *SpecValidator) Heading(heading *gauge.Heading)
  • func (v *SpecValidator) Scenario(scenario *gauge.Scenario)
  • func (v *SpecValidator) Specification(specification *gauge.Specification)
  • func (v *SpecValidator) Step(s *gauge.Step)
  • func (v *SpecValidator) Table(dataTable *gauge.Table)
  • func (v *SpecValidator) Tags(tags *gauge.Tags)
  • func (v *SpecValidator) TearDown(step *gauge.TearDown)
• type StepValidationError
  • func NewStepValidationError(s *gauge.Step, m string, f string, e *gm.StepValidateResponse_ErrorType, ...) StepValidationError
  • func (s StepValidationError) Error() string
  • func (s StepValidationError) ErrorType() gm.StepValidateResponse_ErrorType
  • func (s StepValidationError) FileName() string
  • func (s StepValidationError) Message() string
  • func (s StepValidationError) Step() *gauge.Step
  • func (s StepValidationError) Suggestion() string
• type ValidationResult
  • func NewValidationResult(s *gauge.SpecCollection, errMap *gauge.BuildErrors, r runner.Runner, ...) *ValidationResult
  • func ValidateSpecs(specsToValidate []string, debug bool) *ValidationResult

Variables

var HideSuggestion bool

HideSuggestion is used decide whether suggestion should be given for the unimplemented step or not based on the flag : --hide-suggestion.

var TableRows = ""

TableRows is used to check for table rows range validation.

Functions

func FilterDuplicates

func FilterDuplicates(validationErrors validationErrors) []error

func NewValidator

func NewValidator(s []*gauge.Specification, r runner.Runner, c *gauge.ConceptDictionary) *validator

func Validate

func Validate(args []string)

Validate validates specs and if it has any errors, it exits.

Types

type SpecValidationError

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

func NewSpecValidationError

func NewSpecValidationError(m string, f string) SpecValidationError

NewSpecValidationError generates new spec validation error with error message and filename.

func (SpecValidationError) Error

func (s SpecValidationError) Error() string

Error prints a spec validation error with filename and error message.

type SpecValidator

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

func (*SpecValidator) Comment

func (v *SpecValidator) Comment(comment *gauge.Comment)

func (*SpecValidator) DataTable

func (v *SpecValidator) DataTable(dataTable *gauge.DataTable)

func (*SpecValidator) Heading

func (v *SpecValidator) Heading(heading *gauge.Heading)

func (*SpecValidator) Scenario

func (v *SpecValidator) Scenario(scenario *gauge.Scenario)

func (*SpecValidator) Specification

func (v *SpecValidator) Specification(specification *gauge.Specification)

Validates data table for the range, if any error found append to the validation errors

func (*SpecValidator) Step

func (v *SpecValidator) Step(s *gauge.Step)

Validates a step. If validation result from runner is not valid then it creates a new validation error. If the error type is StepValidateResponse_STEP_IMPLEMENTATION_NOT_FOUND then gives suggestion with step implementation stub.

func (*SpecValidator) Table

func (v *SpecValidator) Table(dataTable *gauge.Table)

func (*SpecValidator) Tags

func (v *SpecValidator) Tags(tags *gauge.Tags)

func (*SpecValidator) TearDown

func (v *SpecValidator) TearDown(step *gauge.TearDown)

type StepValidationError

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

func NewStepValidationError

func NewStepValidationError(s *gauge.Step, m string, f string, e *gm.StepValidateResponse_ErrorType, suggestion string) StepValidationError

NewStepValidationError generates new step validation error with error message, filename and error type.

func (StepValidationError) Error

func (s StepValidationError) Error() string

Error prints a step validation error with filename, line number, error message, step text and suggestion in case of step implementation not found.

func (StepValidationError) ErrorType

func (s StepValidationError) ErrorType() gm.StepValidateResponse_ErrorType

func (StepValidationError) FileName

func (s StepValidationError) FileName() string

func (StepValidationError) Message

func (s StepValidationError) Message() string

func (StepValidationError) Step

func (s StepValidationError) Step() *gauge.Step

func (StepValidationError) Suggestion

func (s StepValidationError) Suggestion() string

type ValidationResult

type ValidationResult struct {
	SpecCollection *gauge.SpecCollection
	ErrMap         *gauge.BuildErrors
	Runner         runner.Runner
	Errs           []error
	ParseOk        bool
}

func NewValidationResult

func NewValidationResult(s *gauge.SpecCollection, errMap *gauge.BuildErrors, r runner.Runner, parseOk bool, e ...error) *ValidationResult

NewValidationResult creates a new Validation result

func ValidateSpecs

func ValidateSpecs(specsToValidate []string, debug bool) *ValidationResult

ValidateSpecs parses the specs, creates a new validator and call the runner to get the validation result.