-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathrunner.go
More file actions
455 lines (394 loc) · 13.8 KB
/
Copy pathrunner.go
File metadata and controls
455 lines (394 loc) · 13.8 KB
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
package runner
import (
"context"
"embed"
"encoding/json"
"fmt"
"io/fs"
"log/slog"
"os"
"path/filepath"
"slices"
"strings"
"time"
"github.com/santhosh-tekuri/jsonschema/v6"
)
// VerbosityLevel represents different levels of test output verbosity
type VerbosityLevel int
const (
// VerbosityQuiet shows minimal output (only test results)
VerbosityQuiet VerbosityLevel = iota
// VerbosityOnFailure shows detailed output for failed tests only
VerbosityOnFailure
// VerbosityAlways shows detailed output for all tests
VerbosityAlways
)
// TestRunner executes test suites against a handler binary
type TestRunner struct {
handler *Handler
handlerConfig *HandlerConfig
timeout time.Duration
responseSchemas map[string]*jsonschema.Schema
}
// NewTestRunner creates a new test runner for executing test suites against a handler binary.
// The handlerTimeout parameter specifies the maximum duration to wait for the handler to
// respond to each test case. If zero, defaults to 10 seconds.
// The timeout parameter specifies the total duration allowed for running all tests
// across all test suites. If zero, defaults to 30 seconds.
func NewTestRunner(handlerPath string, handlerTimeout time.Duration, timeout time.Duration) (*TestRunner, error) {
if _, err := os.Stat(handlerPath); os.IsNotExist(err) {
return nil, fmt.Errorf("handler binary not found: %s", handlerPath)
}
handler, err := NewHandler(&HandlerConfig{
Path: handlerPath,
Timeout: handlerTimeout,
})
if err != nil {
return nil, err
}
if timeout == 0 {
timeout = 30 * time.Second
}
responseSchemas, err := loadEmbeddedResponseSchemas()
if err != nil {
return nil, fmt.Errorf("failed to load response schemas: %w", err)
}
return &TestRunner{
handler: handler,
handlerConfig: &HandlerConfig{
Path: handlerPath,
Timeout: handlerTimeout,
},
timeout: timeout,
responseSchemas: responseSchemas,
}, nil
}
// SendRequest sends a request to the handler, spawning a new handler if needed
func (tr *TestRunner) SendRequest(req Request) error {
if tr.handler == nil {
handler, err := NewHandler(tr.handlerConfig)
if err != nil {
return fmt.Errorf("failed to spawn new handler: %w", err)
}
tr.handler = handler
}
reqData, err := json.Marshal(req)
if err != nil {
return fmt.Errorf("failed to marshal request: %w", err)
}
if err := tr.handler.SendLine(reqData); err != nil {
slog.Warn("Failed to write request, cleaning up handler (will spawn new one for remaining tests)", "error", err)
tr.CloseHandler()
return fmt.Errorf("failed to write request: %w", err)
}
return nil
}
// ReadResponseLine reads a raw JSON response line from the handler.
func (tr *TestRunner) ReadResponseLine() ([]byte, error) {
line, err := tr.handler.ReadLine()
if err != nil {
slog.Warn("Failed to read response, cleaning up handler (will spawn new one for remaining tests)", "error", err)
tr.CloseHandler()
return nil, err
}
return line, nil
}
// CloseHandler closes the handler and sets it to nil
func (tr *TestRunner) CloseHandler() {
if tr.handler == nil {
return
}
tr.handler.Close()
tr.handler = nil
}
// RunTestSuite executes a test suite. The context can be used to enforce a total
// execution timeout across all test suites.
// The verbosity parameter controls output detail.
func (tr *TestRunner) RunTestSuite(ctx context.Context, suite TestSuite, verbosity VerbosityLevel) TestResult {
// Create dependency tracker to manage test dependencies and build request chains
depTracker := NewDependencyTracker()
result := TestResult{
SuiteTitle: suite.Title,
SuiteFileName: suite.FileName,
TotalTests: len(suite.Tests),
}
skipTests := false
for i := range suite.Tests {
test := &suite.Tests[i]
// Run the test case
var testResult SingleTestResult
if skipTests {
// In stateful suites, if any previous test failed, fail all subsequent tests
testResult = SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: "Skipped due to previous test failure in stateful suite",
}
} else {
// Execute the test against the handler
testResult = tr.runTest(ctx, test)
// Track dependencies and add verbose output if requested or on failure
if verbosity != VerbosityQuiet {
requestChain := depTracker.OnTestExecuted(test)
if (verbosity == VerbosityAlways) || (verbosity == VerbosityOnFailure && !testResult.Passed) {
verboseOutput := formatVerboseOutput(suite.Tests, i, requestChain, &testResult)
if testResult.Message != "" {
testResult.Message = fmt.Sprintf("%s\n%s", testResult.Message, verboseOutput)
} else {
testResult.Message = verboseOutput
}
}
}
}
// Collect test case result
result.TestResults = append(result.TestResults, testResult)
if testResult.Passed {
result.PassedTests++
} else {
result.FailedTests++
if suite.Stateful {
skipTests = true
}
}
}
return result
}
// runTest executes a single test case by sending a request, reading the response,
// and validating the result matches expected output
func (tr *TestRunner) runTest(ctx context.Context, test *TestCase) SingleTestResult {
// Check if context is already cancelled
select {
case <-ctx.Done():
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Total execution timeout exceeded (%v)", tr.timeout),
}
default:
}
err := tr.SendRequest(test.Request)
if err != nil {
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Failed to send request: %v", err),
}
}
line, err := tr.ReadResponseLine()
if err != nil {
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Failed to read response: %v", err),
}
}
schema := tr.responseSchemas[test.Request.Method]
if schema == nil {
panic(fmt.Sprintf("missing response schema for method %q", test.Request.Method))
}
if err := validateJSONAgainstSchema(schema, line); err != nil {
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Invalid response: schema validation failed for method %s: %v", test.Request.Method, err),
}
}
var resp Response
err = json.Unmarshal(line, &resp)
if err != nil {
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Invalid response JSON: %v", err),
}
}
if err := validateResponse(test, &resp); err != nil {
return SingleTestResult{
TestID: test.Request.ID,
Passed: false,
Message: fmt.Sprintf("Invalid response: %s", err.Error()),
ReceivedResponse: &resp,
}
}
return SingleTestResult{
TestID: test.Request.ID,
Passed: true,
ReceivedResponse: &resp,
}
}
// validateResponse validates that a response matches the expected test outcome.
// Returns an error if the response does not match the expected outcome (error or success).
func validateResponse(test *TestCase, resp *Response) error {
if test.ExpectedResponse.Error != nil {
return validateResponseForError(test, resp)
}
return validateResponseForSuccess(test, resp)
}
// validateResponseForError validates that a response correctly represents an error case.
// It ensures the response contains an error, the result is null or omitted, and if an
// error code is expected, it matches the expected type and member.
func validateResponseForError(test *TestCase, resp *Response) error {
if test.ExpectedResponse.Error == nil {
panic("validateResponseForError expects non-nil error")
}
if resp.Error == nil {
if test.ExpectedResponse.Error.Code != nil {
return fmt.Errorf("expected error %s.%s, but got no error",
test.ExpectedResponse.Error.Code.Type, test.ExpectedResponse.Error.Code.Member)
}
return fmt.Errorf("expected error, but got no error")
}
if !resp.Result.IsNullOrOmitted() {
return fmt.Errorf("expected result to be null or omitted when error is present, got: %s", string(resp.Result))
}
if test.ExpectedResponse.Error.Code != nil {
if resp.Error.Code == nil {
return fmt.Errorf("expected error code %s.%s, but got error with no code",
test.ExpectedResponse.Error.Code.Type, test.ExpectedResponse.Error.Code.Member)
}
if resp.Error.Code.Type != test.ExpectedResponse.Error.Code.Type {
return fmt.Errorf("expected error type %s, got %s", test.ExpectedResponse.Error.Code.Type, resp.Error.Code.Type)
}
if resp.Error.Code.Member != test.ExpectedResponse.Error.Code.Member {
return fmt.Errorf("expected error member %s, got %s", test.ExpectedResponse.Error.Code.Member, resp.Error.Code.Member)
}
}
return nil
}
// validateResponseForSuccess validates that a response correctly represents a success case.
// It ensures the response contains no error, and if a result is expected, it matches the
// expected value.
func validateResponseForSuccess(test *TestCase, resp *Response) error {
if test.ExpectedResponse.Error != nil {
panic("validateResponseForSuccess expects nil error")
}
if resp.Error != nil {
if resp.Error.Code != nil {
return fmt.Errorf("expected success with no error, but got error: %s.%s", resp.Error.Code.Type, resp.Error.Code.Member)
}
return fmt.Errorf("expected success with no error, but got error")
}
if test.ExpectedResponse.Result.IsNullOrOmitted() {
if !resp.Result.IsNullOrOmitted() {
return fmt.Errorf("expected null or omitted result, got: %s", string(resp.Result))
}
return nil
}
if resp.Result.IsNullOrOmitted() {
return fmt.Errorf("expected result with value, got null or omitted result")
}
// If the request has a ref field, validate that the response is a reference object
if test.Request.Ref != "" {
refValue, ok := ParseRefObject(resp.Result)
if !ok {
return fmt.Errorf("expected reference object result for request with ref field, got: %s", string(resp.Result))
}
if refValue != test.Request.Ref {
return fmt.Errorf("reference mismatch: expected ref %q, got %q", test.Request.Ref, refValue)
}
return nil
}
// For non-ref results, normalize and compare
expectedNorm, err := test.ExpectedResponse.Result.Normalize()
if err != nil {
return fmt.Errorf("failed to normalize expected result: %w", err)
}
actualNorm, err := resp.Result.Normalize()
if err != nil {
return fmt.Errorf("failed to normalize actual result: %w", err)
}
if expectedNorm != actualNorm {
return fmt.Errorf("result mismatch: expected %s, got %s", expectedNorm, actualNorm)
}
return nil
}
// TestResult contains results from running a test suite
type TestResult struct {
SuiteTitle string
SuiteFileName string
TotalTests int
PassedTests int
FailedTests int
TestResults []SingleTestResult
}
// SingleTestResult contains the result of a single test
type SingleTestResult struct {
TestID string
Passed bool
Message string
ReceivedResponse *Response // The actual response received from the handler
}
// LoadTestSuiteFromFS loads a test suite from an embedded filesystem
func LoadTestSuiteFromFS(fsys embed.FS, filePath string) (*TestSuite, error) {
data, err := fs.ReadFile(fsys, filePath)
if err != nil {
return nil, fmt.Errorf("failed to read file: %w", err)
}
var suite TestSuite
if err := json.Unmarshal(data, &suite); err != nil {
return nil, fmt.Errorf("failed to parse JSON: %w", err)
}
suite.FileName = filepath.Base(filePath)
return &suite, nil
}
// formatVerboseOutput formats the complete verbose output including requestChain,
// received response, and expected response for a test
func formatVerboseOutput(allTests []TestCase, testIdx int, requestChain []int, testResult *SingleTestResult) string {
var result strings.Builder
// Add request chain header
result.WriteString("\n")
result.WriteString(" Request chain\n")
result.WriteString(" ────────────────────────────────────────\n")
// Build requests for all dependencies
for _, depIdx := range requestChain {
reqJSON, err := json.Marshal(allTests[depIdx].Request)
if err == nil {
result.WriteString(string(reqJSON))
result.WriteString("\n")
}
}
// Add the current test request
reqJSON, err := json.Marshal(allTests[testIdx].Request)
if err == nil {
result.WriteString(string(reqJSON))
result.WriteString("\n")
}
if testResult.Passed {
// When test passes, only show expected response
result.WriteString("\n Response:\n")
result.WriteString(" ────────────────────────────────────────\n")
} else {
// When test fails, show both received and expected responses
// Add received response
result.WriteString("\n Received response\n")
result.WriteString(" ────────────────────────────────────────\n")
if testResult.ReceivedResponse != nil {
respJSON, err := json.Marshal(testResult.ReceivedResponse)
if err == nil {
result.WriteString(" ")
result.WriteString(string(respJSON))
result.WriteString("\n")
}
} else {
result.WriteString(" (no response received)\n")
}
// Add expected response header
result.WriteString("\n Expected response\n")
result.WriteString(" ────────────────────────────────────────\n")
}
expectedJSON, err := json.Marshal(allTests[testIdx].ExpectedResponse)
if err == nil {
result.WriteString(" ")
result.WriteString(string(expectedJSON))
result.WriteString("\n")
}
result.WriteString("\n")
return result.String()
}
// mergeSortedUnique returns a sorted array containing unique values from all input arrays.
// NOTE: Since each input array is already sorted, this can be optimized using k-way merge if needed.
func mergeSortedUnique(arrays ...[]int) []int {
merged := slices.Concat(arrays...)
slices.Sort(merged)
return slices.Compact(merged)
}