Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

spec

package

Go to main page

Versions in this module

v2

v2.1.0

May 12, 2023

v2.0.8

Mar 14, 2022

v2.0.7

Feb 17, 2022

v2.0.6

Feb 16, 2022

v2.0.5

Nov 19, 2020

v2.0.4

Sep 25, 2020

v2.0.3

Sep 22, 2020

Changes in this version

+ var NoopNode = Node

+ func ParseSpec(specFile string) (Specs, *CheckResult)

+ func ParseSpecsDir(specsDir string) (Specs, *CheckResults, error)

+ func ProcessSpecs(specs *Specs)

+ type ACL struct

+ Admin bool

+ Ops []string

+ Role string

+ type ACLAdminXorOpsSequenceCheck struct

+ func (check ACLAdminXorOpsSequenceCheck) CheckSequence(sequence Sequence) error

+ type ACLsHaveRolesSequenceCheck struct

+ func (check ACLsHaveRolesSequenceCheck) CheckSequence(sequence Sequence) error

+ type Arg struct

+ Default *string

+ Desc string

+ Name *string

+ type ArgsAreNamedNodeCheck struct

+ func (check ArgsAreNamedNodeCheck) CheckNode(node Node) error

+ type ArgsExpectedUniqueNodeCheck struct

+ func (check ArgsExpectedUniqueNodeCheck) CheckNode(node Node) error

+ type ArgsNotNilNodeCheck struct

+ func (check ArgsNotNilNodeCheck) CheckNode(node Node) error

+ type ArgsNotRenamedTwiceNodeCheck struct

+ func (check ArgsNotRenamedTwiceNodeCheck) CheckNode(node Node) error

+ type BaseCheckFactory struct

+ AllSpecs Specs

+ func (c BaseCheckFactory) MakeNodeErrorChecks() ([]NodeCheck, error)

+ func (c BaseCheckFactory) MakeNodeWarningChecks() ([]NodeCheck, error)

+ func (c BaseCheckFactory) MakeSequenceErrorChecks() ([]SequenceCheck, error)

+ func (c BaseCheckFactory) MakeSequenceWarningChecks() ([]SequenceCheck, error)

+ type CheckFactory interface

+ MakeNodeErrorChecks func() ([]NodeCheck, error)

+ MakeNodeWarningChecks func() ([]NodeCheck, error)

+ MakeSequenceErrorChecks func() ([]SequenceCheck, error)

+ MakeSequenceWarningChecks func() ([]SequenceCheck, error)

+ type CheckResult struct

+ Errors []error

+ Warnings []error

+ type CheckResults struct

+ AnyError bool

+ AnyWarning bool

+ Results map[string]*CheckResult

+ func NewCheckResults() *CheckResults

+ func (c *CheckResults) AddError(key string, err error)

+ func (c *CheckResults) AddResult(key string, result *CheckResult)

+ func (c *CheckResults) AddWarning(key string, err error)

+ func (c *CheckResults) Get(key string) (*CheckResult, bool)

+ func (c *CheckResults) Union(other *CheckResults)

+ type Checker struct

+ func NewChecker(checkFactories []CheckFactory) (*Checker, error)

+ func (checker *Checker) RunChecks(allSpecs Specs) *CheckResults

+ type ConditionalHasEqNodeCheck struct

+ func (check ConditionalHasEqNodeCheck) CheckNode(node Node) error

+ type ConditionalHasIfNodeCheck struct

+ func (check ConditionalHasIfNodeCheck) CheckNode(node Node) error

+ type ConditionalNoTypeNodeCheck struct

+ func (check ConditionalNoTypeNodeCheck) CheckNode(node Node) error

+ type DefaultCheckFactory struct

+ AllSpecs Specs

+ func (c DefaultCheckFactory) MakeNodeErrorChecks() ([]NodeCheck, error)

+ func (c DefaultCheckFactory) MakeNodeWarningChecks() ([]NodeCheck, error)

+ func (c DefaultCheckFactory) MakeSequenceErrorChecks() ([]SequenceCheck, error)

+ func (c DefaultCheckFactory) MakeSequenceWarningChecks() ([]SequenceCheck, error)

+ type DuplicateValueError struct

+ Explanation string

+ Field string

+ Node *string

+ Values []string

+ func (e DuplicateValueError) Error() string

+ type EachElementDoesNotDuplicateArgsExpectedNodeCheck struct

+ func (check EachElementDoesNotDuplicateArgsExpectedNodeCheck) CheckNode(node Node) error

+ type EachElementUniqueNodeCheck struct

+ func (check EachElementUniqueNodeCheck) CheckNode(node Node) error

+ type EachIfParallelNodeCheck struct

+ func (check EachIfParallelNodeCheck) CheckNode(node Node) error

+ type EachListDoesNotDuplicateArgsGivenNodeCheck struct

+ func (check EachListDoesNotDuplicateArgsGivenNodeCheck) CheckNode(node Node) error

+ type EachNotRenamedTwiceNodeCheck struct

+ func (check EachNotRenamedTwiceNodeCheck) CheckNode(node Node) error

+ type HasCategoryNodeCheck struct

+ func (check HasCategoryNodeCheck) CheckNode(node Node) error

+ type HasNodesSequenceCheck struct

+ func (check HasNodesSequenceCheck) CheckSequence(sequence Sequence) error

+ type InvalidValueError struct

+ Expected string

+ Field string

+ Node *string

+ Values []string

+ func (e InvalidValueError) Error() string

+ type MissingValueError struct

+ Explanation string

+ Field string

+ Node *string

+ func (e MissingValueError) Error() string

+ type NoDuplicateACLRolesSequenceCheck struct

+ func (check NoDuplicateACLRolesSequenceCheck) CheckSequence(sequence Sequence) error

+ type NoDuplicateArgsSequenceCheck struct

+ func (check NoDuplicateArgsSequenceCheck) CheckSequence(sequence Sequence) error

+ type NoExtraSequenceArgsProvidedNodeCheck struct

+ AllSpecs Specs

+ func (check NoExtraSequenceArgsProvidedNodeCheck) CheckNode(node Node) error

+ type Node struct

+ Args []*NodeArg

+ Category *string

+ Dependencies []string

+ Each []string

+ Eq map[string]string

+ If *string

+ Name string

+ NodeType *string

+ Parallel *uint

+ Retry uint

+ RetryWait string

+ Sets []*NodeSet

+ func (j *Node) IsConditional() bool

+ func (j *Node) IsJob() bool

+ func (j *Node) IsSequence() bool

+ type NodeArg struct

+ Expected *string

+ Given *string

+ type NodeCheck interface

+ CheckNode func(Node) error

+ type NodeSet struct

+ Arg *string

+ As *string

+ type NodesSetsUniqueSequenceCheck struct

+ func (check NodesSetsUniqueSequenceCheck) CheckSequence(sequence Sequence) error

+ type NonconditionalHasTypeNodeCheck struct

+ func (check NonconditionalHasTypeNodeCheck) CheckNode(node Node) error

+ type NonconditionalNoEqNodeCheck struct

+ func (check NonconditionalNoEqNodeCheck) CheckNode(node Node) error

+ type NonconditionalNoIfNodeCheck struct

+ func (check NonconditionalNoIfNodeCheck) CheckNode(node Node) error

+ type OptionalArgsHaveDefaultsSequenceCheck struct

+ func (check OptionalArgsHaveDefaultsSequenceCheck) CheckSequence(sequence Sequence) error

+ type OptionalArgsNamedSequenceCheck struct

+ func (check OptionalArgsNamedSequenceCheck) CheckSequence(sequence Sequence) error

+ type RequiredArgsHaveNoDefaultsSequenceCheck struct

+ func (check RequiredArgsHaveNoDefaultsSequenceCheck) CheckSequence(sequence Sequence) error

+ type RequiredArgsNamedSequenceCheck struct

+ func (check RequiredArgsNamedSequenceCheck) CheckSequence(sequence Sequence) error

+ type RequiredArgsProvidedNodeCheck struct

+ AllSpecs Specs

+ func (check RequiredArgsProvidedNodeCheck) CheckNode(node Node) error

+ type RetryIfRetryWaitNodeCheck struct

+ func (check RetryIfRetryWaitNodeCheck) CheckNode(node Node) error

+ type Sequence struct

+ ACL []ACL

+ Args SequenceArgs

+ Filename string

+ Name string

+ Nodes map[string]*Node

+ Request bool

+ type SequenceArgs struct

+ Optional []*Arg

+ Required []*Arg

+ Static []*Arg

+ type SequenceCheck interface

+ CheckSequence func(Sequence) error

+ type SetsAreNamedNodeCheck struct

+ func (check SetsAreNamedNodeCheck) CheckNode(node Node) error

+ type SetsAsUniqueNodeCheck struct

+ func (check SetsAsUniqueNodeCheck) CheckNode(node Node) error

+ type SetsNotNilNodeCheck struct

+ func (check SetsNotNilNodeCheck) CheckNode(node Node) error

+ type SetsNotRenamedTwiceNodeCheck struct

+ func (check SetsNotRenamedTwiceNodeCheck) CheckNode(node Node) error

+ type Specs struct

+ Sequences map[string]*Sequence

+ type StaticArgsHaveDefaultsSequenceCheck struct

+ func (check StaticArgsHaveDefaultsSequenceCheck) CheckSequence(sequence Sequence) error

+ type StaticArgsNamedSequenceCheck struct

+ func (check StaticArgsNamedSequenceCheck) CheckSequence(sequence Sequence) error

+ type SubsequencesExistNodeCheck struct

+ AllSpecs Specs

+ func (check SubsequencesExistNodeCheck) CheckNode(node Node) error

+ type ValidCategoryNodeCheck struct

+ func (check ValidCategoryNodeCheck) CheckNode(node Node) error

+ type ValidEachNodeCheck struct

+ func (check ValidEachNodeCheck) CheckNode(node Node) error

+ type ValidParallelNodeCheck struct

+ func (check ValidParallelNodeCheck) CheckNode(node Node) error

+ type ValidRetryWaitNodeCheck struct

+ func (check ValidRetryWaitNodeCheck) CheckNode(node Node) error