|
| 1 | +//go:build compare |
| 2 | + |
| 3 | +// Package compare tests theory/jsonpath against the [json-path-comparison] |
| 4 | +// project's regression suite. It requires the file regression_suite.yaml to |
| 5 | +// be in this directory. The test only runs with the "compare" tag. Use make |
| 6 | +// for the easiest way to download regression_suite.yaml and run the tests: |
| 7 | +// |
| 8 | +// make test-compare |
| 9 | +// |
| 10 | +// [json-path-comparison]: https://github.com/cburgmer/json-path-comparison |
| 11 | +package compare |
| 12 | + |
| 13 | +import ( |
| 14 | + "os" |
| 15 | + "path/filepath" |
| 16 | + "runtime" |
| 17 | + "testing" |
| 18 | + |
| 19 | + "github.com/stretchr/testify/assert" |
| 20 | + "github.com/stretchr/testify/require" |
| 21 | + "github.com/theory/jsonpath" |
| 22 | + "gopkg.in/yaml.v3" |
| 23 | +) |
| 24 | + |
| 25 | +type Query struct { |
| 26 | + ID string `yaml:"id"` |
| 27 | + Selector string `yaml:"selector"` |
| 28 | + Document any `yaml:"document"` |
| 29 | + Consensus any `yaml:"consensus"` |
| 30 | + Ordered bool `yaml:"ordered"` |
| 31 | + // NotFoundConsensus string `yaml:"not-found-consensus"` |
| 32 | + // ScalarNotFoundConsensus string `yaml:"scalar-not-found-consensus"` |
| 33 | +} |
| 34 | + |
| 35 | +func file(t *testing.T) string { |
| 36 | + t.Helper() |
| 37 | + _, fn, _, ok := runtime.Caller(0) |
| 38 | + assert.True(t, ok) |
| 39 | + return filepath.Clean(filepath.Join( |
| 40 | + filepath.Dir(fn), |
| 41 | + "regression_suite.yaml", |
| 42 | + )) |
| 43 | +} |
| 44 | + |
| 45 | +func queries(t *testing.T) []Query { |
| 46 | + t.Helper() |
| 47 | + data, err := os.ReadFile(file(t)) |
| 48 | + require.NoError(t, err) |
| 49 | + var q struct { |
| 50 | + Queries []Query `yaml:"queries"` |
| 51 | + } |
| 52 | + require.NoError(t, yaml.Unmarshal(data, &q)) |
| 53 | + return q.Queries |
| 54 | +} |
| 55 | + |
| 56 | +func TestConsensus(t *testing.T) { |
| 57 | + t.Parallel() |
| 58 | + |
| 59 | + skip := map[string]string{ |
| 60 | + "array_slice_with_step_and_leading_zeros": "leading zeros disallowed integers; see RFC 9535 sections 2.3.3.1, 2.3.4.1", |
| 61 | + "dot_notation_with_number_on_object": "leading digits disallowed in shorthand names; see RFC 9535 section 2.5.1.1", |
| 62 | + "dot_notation_with_dash": "dash disallowed in shorthand hames; see RFC 9535 section 2.5.1.1", |
| 63 | + } |
| 64 | + |
| 65 | + for _, q := range queries(t) { |
| 66 | + t.Run(q.ID, func(t *testing.T) { |
| 67 | + t.Parallel() |
| 68 | + |
| 69 | + if q.Consensus == "NOT_SUPPORTED" { |
| 70 | + t.Skip(q.Consensus) |
| 71 | + } |
| 72 | + |
| 73 | + if r, ok := skip[q.ID]; ok { |
| 74 | + t.Skip(r) |
| 75 | + } |
| 76 | + |
| 77 | + path, err := jsonpath.Parse(q.Selector) |
| 78 | + // XXX Why is consensus empty? |
| 79 | + if q.Consensus != nil { |
| 80 | + require.NoError(t, err) |
| 81 | + } |
| 82 | + if err != nil { |
| 83 | + // XXX Why is there an error? TODOs? |
| 84 | + assert.Nil(t, path) |
| 85 | + return |
| 86 | + } |
| 87 | + result := []any(path.Select(q.Document)) |
| 88 | + |
| 89 | + switch { |
| 90 | + case q.Ordered: |
| 91 | + assert.Equal(t, q.Consensus, result) |
| 92 | + case q.Consensus == nil: |
| 93 | + // XXX What to do here? |
| 94 | + // assert.Empty(t, result) |
| 95 | + default: |
| 96 | + assert.ElementsMatch(t, q.Consensus, result) |
| 97 | + } |
| 98 | + }) |
| 99 | + } |
| 100 | +} |
0 commit comments