@@ -29,17 +29,25 @@ Each JMESPath test case can have the following keys:
29
29
* ``result `` - The expected result from evaluating the JMESPath expression
30
30
against the ``given `` input.
31
31
* ``error `` - The type of error that should be raised as a result of evaluating
32
- the JMESPath expression.
32
+ the JMESPath expression. The valid values for an error are:
33
+
34
+ * ``syntax `` - Syntax error from an invalid JMESPath expression.
35
+ * ``invalid-arity `` - Wrong number of arguments passed to a function.
36
+ * ``invalid-type `` - Invalid argument type for a function.
37
+ * ``invalid-value `` - Semantically incorrect value (used in slice tests)
38
+ * ``unknown-function `` - Attempting to invoke an unknown function.
39
+
33
40
* ``bench `` - If the case is a benchmark, ``bench `` contains the type of
34
41
benchmark. Available ``bench `` types are as follows:
42
+
35
43
* ``parse `` - Benchmark only the parsing of an expression.
36
- ``interpret `` - Benchmark only the interpreting of an expression.
37
- ``full `` - Benchmark both parsing and interepreting an expression.
44
+ * ``interpret `` - Benchmark only the interpreting of an expression.
45
+ * ``full `` - Benchmark both parsing and interepreting an expression.
38
46
* ``comment `` - An optional comment containing a description of the specific
39
47
test case.
40
48
41
49
For each test case, either ``result ``, ``error ``, or ``bench `` must be
42
- specified. Both keys cannot be present in a single test case.
50
+ specified. Only one of these keys can be present in a single test case.
43
51
44
52
The error type (if the ``error `` key is present) indicates the type of error
45
53
that an implementation should raise, but it does not indicate **when ** this
0 commit comments