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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
package validator_test
import (
"fmt"
"os"
"path/filepath"
"regexp"
"sort"
"strconv"
"strings"
"testing"
"github.com/stretchr/testify/require"
"github.com/vektah/gqlparser/v2"
"github.com/vektah/gqlparser/v2/ast"
"github.com/vektah/gqlparser/v2/gqlerror"
"gopkg.in/yaml.v2"
)
type Spec struct {
Name string
Rule string
Schema string
Query string
Errors gqlerror.List
}
type Deviation struct {
Rule string
Errors []*gqlerror.Error
Skip string
pattern *regexp.Regexp
}
func TestValidation(t *testing.T) {
var rawSchemas []string
readYaml("./imported/spec/schemas.yml", &rawSchemas)
var deviations []*Deviation
readYaml("./imported/deviations.yml", &deviations)
for _, d := range deviations {
d.pattern = regexp.MustCompile("^" + d.Rule + "$")
}
schemas := make([]*ast.Schema, 0, len(rawSchemas))
for i, schema := range rawSchemas {
schema, err := gqlparser.LoadSchema(&ast.Source{Input: schema, Name: fmt.Sprintf("schemas.yml[%d]", i)})
if err != nil {
panic(err)
}
schemas = append(schemas, schema)
}
err := filepath.Walk("./", func(path string, info os.FileInfo, err error) error {
if info.IsDir() || !strings.HasSuffix(path, ".spec.yml") {
return nil
}
runSpec(t, schemas, deviations, path)
return nil
})
require.NoError(t, err)
}
func runSpec(t *testing.T, schemas []*ast.Schema, deviations []*Deviation, filename string) {
ruleName := strings.TrimSuffix(filepath.Base(filename), ".spec.yml")
var specs []Spec
readYaml(filename, &specs)
t.Run(ruleName, func(t *testing.T) {
for _, spec := range specs {
if len(spec.Errors) == 0 {
spec.Errors = nil
}
t.Run(spec.Name, func(t *testing.T) {
for _, deviation := range deviations {
if deviation.pattern.MatchString(ruleName + "/" + spec.Name) {
if deviation.Skip != "" {
t.Skip(deviation.Skip)
}
if deviation.Errors != nil {
spec.Errors = deviation.Errors
}
}
}
// idx := spec.Schema
var schema *ast.Schema
if idx, err := strconv.Atoi(spec.Schema); err != nil {
var gqlErr error
schema, gqlErr = gqlparser.LoadSchema(&ast.Source{Input: spec.Schema, Name: spec.Name})
if gqlErr != nil {
t.Fatal(err)
}
} else {
schema = schemas[idx]
}
_, errList := gqlparser.LoadQuery(schema, spec.Query)
var finalErrors gqlerror.List
for _, err := range errList {
// ignore errors from other rules
if spec.Rule != "" && err.Rule != spec.Rule {
continue
}
finalErrors = append(finalErrors, err)
}
for i := range spec.Errors {
spec.Errors[i].Rule = spec.Rule
// remove inconsistent use of ;
spec.Errors[i].Message = strings.ReplaceAll(spec.Errors[i].Message, "; Did you mean", ". Did you mean")
}
sort.Slice(spec.Errors, compareErrors(spec.Errors))
sort.Slice(finalErrors, compareErrors(finalErrors))
if len(finalErrors) != len(spec.Errors) {
t.Errorf("wrong number of errors returned\ngot:\n%s\nwant:\n%s", finalErrors.Error(), spec.Errors)
} else {
for i := range spec.Errors {
expected := spec.Errors[i]
actual := finalErrors[i]
if actual.Rule != spec.Rule {
continue
}
var errLocs []string
if expected.Message != actual.Message {
errLocs = append(errLocs, "message mismatch")
}
if len(expected.Locations) > 0 && len(actual.Locations) == 0 {
errLocs = append(errLocs, "missing location")
}
if len(expected.Locations) > 0 && len(actual.Locations) > 0 {
found := false
for _, loc := range expected.Locations {
if actual.Locations[0].Line == loc.Line {
found = true
break
}
}
if !found {
errLocs = append(errLocs, "line")
}
}
if len(errLocs) > 0 {
t.Errorf("%s\ngot: %s\nwant: %s", strings.Join(errLocs, ", "), finalErrors[i].Error(), spec.Errors[i].Error())
}
}
}
if t.Failed() {
t.Logf("name: '%s'", spec.Name)
t.Log("\nquery:", spec.Query)
}
})
}
})
}
func compareErrors(errors gqlerror.List) func(i, j int) bool {
return func(i, j int) bool {
cmp := strings.Compare(errors[i].Message, errors[j].Message)
if cmp == 0 && len(errors[i].Locations) > 0 && len(errors[j].Locations) > 0 {
return errors[i].Locations[0].Line > errors[j].Locations[0].Line
}
return cmp < 0
}
}
func readYaml(filename string, result interface{}) {
b, err := os.ReadFile(filename)
if err != nil {
panic(err)
}
err = yaml.Unmarshal(b, result)
if err != nil {
panic(fmt.Errorf("unable to load %s: %s", filename, err.Error()))
}
}
|
