1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Contributor:
// - Aaron Meihm ameihm@mozilla.com
package scribe
import (
"fmt"
)
// Object describes data that will be sourced from the system and used in a
// test. Tests specify the criteria that will be applied to determine a true
// or false result, and tests reference an Object which provides the data the
// criteria will be compared to.
type Object struct {
Object string `json:"object" yaml:"object"`
FileContent FileContent `json:"filecontent" yaml:"filecontent"`
FileName FileName `json:"filename" yaml:"filename"`
Package Pkg `json:"package" yaml:"package"`
Raw Raw `json:"raw" yaml:"raw"`
HasLine HasLine `json:"hasline" yaml:"hasline"`
isChain bool // True if object is part of an import chain.
prepared bool // True if object has been prepared.
err error // The last error condition encountered during preparation.
}
type genericSource interface {
prepare() error
getCriteria() []evaluationCriteria
isChain() bool
expandVariables([]Variable)
validate(d *Document) error
mergeCriteria([]evaluationCriteria)
fireChains(*Document) ([]evaluationCriteria, error)
}
func (o *Object) validate(d *Document) error {
if len(o.Object) == 0 {
return fmt.Errorf("an object in document has no identifier")
}
si := o.getSourceInterface()
if si == nil {
return fmt.Errorf("%v: no valid source interface", o.Object)
}
err := si.validate(d)
if err != nil {
return fmt.Errorf("%v: %v", o.Object, err)
}
return nil
}
func (o *Object) markChain() {
o.isChain = o.getSourceInterface().isChain()
}
func (o *Object) getSourceInterface() genericSource {
if o.Package.Name != "" {
return &o.Package
} else if o.FileContent.Path != "" {
return &o.FileContent
} else if o.FileName.Path != "" {
return &o.FileName
} else if len(o.Raw.Identifiers) > 0 {
return &o.Raw
} else if o.HasLine.Path != "" {
return &o.HasLine
}
return nil
}
func (o *Object) fireChains(d *Document) error {
si := o.getSourceInterface()
// We only fire chains on root object types, not on chain entries
// themselves.
if si.isChain() {
return nil
}
// If the object already has encountered an error, don't bother
// trying to execute chain entries for it.
if o.err != nil {
debugPrint("fireChains(): skipping failed object \"%v\"\n", o.Object)
return nil
}
criteria, err := si.fireChains(d)
if err != nil {
o.err = err
return err
}
if criteria != nil {
si.mergeCriteria(criteria)
}
return nil
}
func (o *Object) prepare(d *Document) error {
if o.isChain {
debugPrint("prepare(): skipping chain object \"%v\"\n", o.Object)
return nil
}
if o.prepared {
return nil
}
o.prepared = true
p := o.getSourceInterface()
if p == nil {
o.err = fmt.Errorf("object has no valid interface")
return o.err
}
p.expandVariables(d.Variables)
err := p.prepare()
if err != nil {
o.err = err
return err
}
return nil
}
|
