Skip to content

Commit e287c64

Browse files
committed
Update README with note about compliance tests
1 parent fe07f08 commit e287c64

1 file changed

Lines changed: 28 additions & 6 deletions

File tree

README.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -240,24 +240,46 @@ in quotes, as shown in the example above.
240240
## Testing
241241

242242
The parsing and evaluation of JMESPath expression is done in the
243-
go-jmespath library, which is a dependencty of this project. ``go-jmespath``
243+
go-jmespath library, which is a dependency of this project. ``go-jmespath``
244244
has extensive testing to ensure it is parsing and evaluating JMESPath
245245
expressions correctly.
246246

247+
To ensure that there are no regressions between `go-imespath` and `jp`,
248+
the entire suite of [JMESPath compliance tests](https://github.com/jmespath/jmespath.test)
249+
are run against the `jp` executable.
250+
247251
This repo also include CLI specific test that verify the command line
248-
options and output work as intended. To run these ``jp`` specific
249-
tests, you can run ``make test``:
252+
options and output work as intended.
253+
254+
You can run all of these tests for `jp` by running `make test`:
250255

251256
```
252257
$ make test
258+
# CLI specific test cases.
253259
test/vendor/bats/libexec/bats test/cases
254260
✓ Has valid help output
255261
✓ Can display version
256262
✓ Can search basic expression
257263
✓ Can search subexpr expression
258264
✓ Can read input from file
259265
✓ Can print result unquoted
260-
....
261-
262-
X tests, 0 failures
266+
✓ Bad JMESPath expression has non zero rc
267+
- Large numbers are not printed with scientific notation (skipped)
268+
✓ Can accept expression from file
269+
✓ Can pretty print expr AST
270+
✓ Can sort int array
271+
272+
X tests, 0 failures, 1 skipped
273+
# JMESPath compliance tests, using the jp-compliance
274+
# runner from github.com/jmespath/jmespath.test
275+
test/jp-compliance -d test/compliance/ -e ./jp
276+
............................................................
277+
............................................................
278+
............................................................
279+
............................................................
280+
............................................................
281+
............................................................
282+
............................................................
283+
............................................................
284+
OK
263285
```

0 commit comments

Comments
 (0)