-
Notifications
You must be signed in to change notification settings - Fork 1
/
test_snapshots.go
291 lines (257 loc) · 8.79 KB
/
test_snapshots.go
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
package command
import (
"encoding/json"
"fmt"
"io"
"math/rand"
"net/http"
"os"
"path"
"slices"
"time"
"github.com/hasura/ndc-sdk-go/cmd/ndc-go-sdk/command/internal"
"github.com/hasura/ndc-sdk-go/schema"
)
// GenTestSnapshotArguments represents arguments for test snapshot generation
type GenTestSnapshotArguments struct {
Schema string `help:"NDC schema file path. Use either endpoint or schema path"`
Endpoint string `help:"The endpoint of the connector. Use either endpoint or schema path"`
Dir string `help:"The directory of test snapshots."`
Depth uint `help:"The selection depth of nested fields in result types." default:"10"`
Query []string `help:"Specify individual queries to be generated. Separated by commas, or 'all' for all queries"`
Mutation []string `help:"Specify individual mutations to be generated. Separated by commas, or 'all' for all mutations"`
Strategy internal.WriteFileStrategy `help:"Decide the strategy to do when the snapshot file exists. Accept: none, override" enum:"none,override" default:"none"`
}
// genTestSnapshotsCommand
type genTestSnapshotsCommand struct {
args *GenTestSnapshotArguments
schema schema.SchemaResponse
random *rand.Rand
}
// GenTestSnapshots generates test snapshots from NDC schema
func GenTestSnapshots(args *GenTestSnapshotArguments) error {
seed := time.Now().UnixNano()
random := rand.New(rand.NewSource(seed))
cmd := genTestSnapshotsCommand{
args: args,
random: random,
}
if err := cmd.fetchSchema(); err != nil {
return err
}
for _, fn := range cmd.schema.Functions {
if err := cmd.genFunction(&fn); err != nil {
return err
}
}
for _, proc := range cmd.schema.Procedures {
if err := cmd.genProcedure(&proc); err != nil {
return err
}
}
return nil
}
func (cmd *genTestSnapshotsCommand) fetchSchema() error {
if cmd.args.Schema != "" {
rawBytes, err := os.ReadFile(cmd.args.Schema)
if err != nil {
return fmt.Errorf("failed to read schema from %s: %s", cmd.args.Schema, err)
}
if err := json.Unmarshal(rawBytes, &cmd.schema); err != nil {
return fmt.Errorf("failed to decode schema json from %s: %s", cmd.args.Schema, err)
}
return nil
}
if cmd.args.Endpoint != "" {
resp, err := http.Get(fmt.Sprintf("%s/schema", cmd.args.Endpoint))
if err != nil {
return fmt.Errorf("failed to fetch schema from %s: %s", cmd.args.Endpoint, err)
}
if resp.StatusCode != http.StatusOK {
var respBytes []byte
if resp.Body != nil {
respBytes, _ = io.ReadAll(resp.Body)
}
if len(respBytes) == 0 {
respBytes = []byte(http.StatusText(resp.StatusCode))
}
return fmt.Errorf("failed to fetch schema from %s: %s", cmd.args.Endpoint, string(respBytes))
}
if resp.Body == nil {
return fmt.Errorf("received empty response from %s", cmd.args.Endpoint)
}
if err := json.NewDecoder(resp.Body).Decode(&cmd.schema); err != nil {
return fmt.Errorf("failed to decode schema json from %s: %s", cmd.args.Schema, err)
}
return nil
}
return fmt.Errorf("required either endpoint or file path to the schema")
}
func (cmd *genTestSnapshotsCommand) genFunction(fn *schema.FunctionInfo) error {
if !cmd.hasQuery(fn.Name) {
return nil
}
args, err := cmd.genQueryArguments(fn.Arguments)
if err != nil {
return fmt.Errorf("failed to generate arguments for %s function: %s", fn.Name, err)
}
fields, value, err := cmd.genNestFieldAndValue(fn.ResultType)
if err != nil {
return fmt.Errorf("failed to generate result for %s function: %s", fn.Name, err)
}
queryReq := schema.QueryRequest{
Collection: fn.Name,
Query: schema.Query{
Fields: schema.QueryFields{
"__value": schema.NewColumnField("__value", fields).Encode(),
},
},
Arguments: args,
CollectionRelationships: schema.QueryRequestCollectionRelationships{},
}
queryResp := schema.QueryResponse{
{
Rows: []map[string]any{
{
"__value": value,
},
},
},
}
snapshotDir := path.Join(cmd.args.Dir, "query", queryReq.Collection)
if err := os.MkdirAll(snapshotDir, 0755); err != nil {
return err
}
if err := internal.WritePrettyFileJSON(path.Join(snapshotDir, "request.json"), queryReq, cmd.args.Strategy); err != nil {
return err
}
return internal.WritePrettyFileJSON(path.Join(snapshotDir, "expected.json"), queryResp, cmd.args.Strategy)
}
func (cmd *genTestSnapshotsCommand) genQueryArguments(arguments schema.FunctionInfoArguments) (schema.QueryRequestArguments, error) {
result := schema.QueryRequestArguments{}
for key, arg := range arguments {
_, value, err := cmd.genNestFieldAndValue(arg.Type)
if err != nil {
return nil, err
}
result[key] = schema.Argument{
Type: schema.ArgumentTypeLiteral,
Value: value,
}
}
return result, nil
}
func (cmd *genTestSnapshotsCommand) genProcedure(proc *schema.ProcedureInfo) error {
if !cmd.hasMutation(proc.Name) {
return nil
}
args, err := cmd.genOperationArguments(proc.Arguments)
if err != nil {
return fmt.Errorf("failed to generate arguments for %s procedure: %s", proc.Name, err)
}
fields, value, err := cmd.genNestFieldAndValue(proc.ResultType)
if err != nil {
return fmt.Errorf("failed to generate result for %s procedure: %s", proc.Name, err)
}
var rawFields schema.NestedField
if fields != nil {
rawFields = fields.Encode()
}
mutationReq := schema.MutationRequest{
Operations: []schema.MutationOperation{
{
Type: schema.MutationOperationProcedure,
Name: proc.Name,
Arguments: args,
Fields: rawFields,
},
},
CollectionRelationships: make(schema.MutationRequestCollectionRelationships),
}
mutationResp := schema.MutationResponse{
OperationResults: []schema.MutationOperationResults{
schema.NewProcedureResult(value).Encode(),
},
}
snapshotDir := path.Join(cmd.args.Dir, "mutation", proc.Name)
if err := os.MkdirAll(snapshotDir, 0755); err != nil {
return err
}
if err := internal.WritePrettyFileJSON(path.Join(snapshotDir, "request.json"), mutationReq, cmd.args.Strategy); err != nil {
return err
}
return internal.WritePrettyFileJSON(path.Join(snapshotDir, "expected.json"), mutationResp, cmd.args.Strategy)
}
func (cmd *genTestSnapshotsCommand) genOperationArguments(arguments schema.ProcedureInfoArguments) ([]byte, error) {
result := map[string]any{}
for key, arg := range arguments {
_, value, err := cmd.genNestFieldAndValue(arg.Type)
if err != nil {
return nil, err
}
result[key] = value
}
return json.Marshal(result)
}
func (cmd *genTestSnapshotsCommand) genNestFieldAndValue(rawType schema.Type) (schema.NestedFieldEncoder, any, error) {
nestedField, value, _, err := cmd.genNestFieldAndValueInternal(rawType, 0)
return nestedField, value, err
}
func (cmd *genTestSnapshotsCommand) genNestFieldAndValueInternal(rawType schema.Type, currentDepth uint) (schema.NestedFieldEncoder, any, bool, error) {
resultType, err := rawType.InterfaceT()
switch ty := resultType.(type) {
case *schema.NullableType:
return cmd.genNestFieldAndValueInternal(ty.UnderlyingType, currentDepth)
case *schema.ArrayType:
if currentDepth >= cmd.args.Depth {
return nil, nil, false, nil
}
innerType, data, isScalar, err := cmd.genNestFieldAndValueInternal(ty.ElementType, currentDepth+1)
if err != nil {
return nil, nil, false, err
}
if innerType == nil || isScalar {
return nil, []any{data}, isScalar, nil
}
return schema.NewNestedArray(innerType), []any{data}, isScalar, nil
case *schema.NamedType:
if currentDepth >= cmd.args.Depth {
return nil, nil, false, nil
}
if scalar, ok := cmd.schema.ScalarTypes[ty.Name]; ok {
return nil, internal.GenRandomScalarValue(cmd.random, ty.Name, &scalar), true, nil
}
objectType, ok := cmd.schema.ObjectTypes[ty.Name]
if !ok {
return nil, nil, false, fmt.Errorf("the named type <%s> does not exist", ty.Name)
}
fields := make(map[string]schema.FieldEncoder)
values := make(map[string]any)
for key, field := range objectType.Fields {
innerType, value, _, err := cmd.genNestFieldAndValueInternal(field.Type, currentDepth+1)
if err != nil {
return nil, nil, false, err
}
fields[key] = schema.NewColumnField(key, innerType)
values[key] = value
}
if len(fields) == 0 {
return nil, values, false, nil
}
return schema.NewNestedObject(fields), values, false, nil
default:
return nil, nil, false, err
}
}
func (cmd genTestSnapshotsCommand) hasQuery(name string) bool {
if (len(cmd.args.Query) == 0 && len(cmd.args.Mutation) == 0) || slices.Contains(cmd.args.Query, "all") {
return true
}
return slices.Contains(cmd.args.Query, name)
}
func (cmd genTestSnapshotsCommand) hasMutation(name string) bool {
if (len(cmd.args.Query) == 0 && len(cmd.args.Mutation) == 0) || slices.Contains(cmd.args.Mutation, "all") {
return true
}
return slices.Contains(cmd.args.Mutation, name)
}