Move function tests to function yaml (#56)

* Add tests

* Configure test matrix

* Limit test trigger on spec folders

* Quote special characters in tests

* Move function tests to function yaml

* Add function_schema.yml and refactor test_schema.json

* Clean up extra commas

* Remove leading "$" for variadic function arguments

* refer to jmespath.site domain name in schema

Author: innovate-invent

.github/workflows/test_validate.yaml

@@ -2,6 +2,10 @@ name: Validate tests
 on:
   push:
     branches: [ main ]
+    paths:
+      - grammar/**
+      - test_data/**
+      - functions/**
   pull_request:
     branches: [ main ]
 
@@ -14,8 +18,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - id: set-matrix
-        run: echo "::set-output name=matrix::$(ls grammar/*.json functions/*.json | jq -R -s -c 'split("\n")[:-1]')"
-  validate:
+        run: echo "::set-output name=matrix::$(ls grammar/*.json | jq -R -s -c 'split("\n")[:-1]')"
+  validate-tests:
     needs: list-tests
     runs-on: ubuntu-latest
     strategy:
@@ -28,5 +32,29 @@ jobs:
           cache: pip
           cache-dependency-path: .github/workflows/validate_requirements.txt
       - run: pip install -r .github/workflows/validate_requirements.txt
-      - name: Validate tests
-        run: "jsonschema test_schema.json -o pretty -i ${{ matrix.manifest }}"
+      - name: Validate grammar tests
+        run: "check-jsonschema --schemafile test_schema.yml ${{ matrix.manifest }}"
+
+  list-functions:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v2
+      - id: set-matrix
+        run: echo "::set-output name=matrix::$(ls functions/*.yml | jq -R -s -c 'split("\n")[:-1]')"
+  validate-functions:
+    needs: list-functions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        manifest: ${{ fromJson(needs.list-functions.outputs.matrix) }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v3
+        with:
+          cache: pip
+          cache-dependency-path: .github/workflows/validate_requirements.txt
+      - run: pip install -r .github/workflows/validate_requirements.txt
+      - name: Validate function spec
+        run: "check-jsonschema --schemafile function_schema.yml ${{ matrix.manifest }}"

.github/workflows/validate_requirements.txt

@@ -1 +1 @@
-jsonschema==4.4.0
+check-jsonschema

function_schema.yml

@@ -0,0 +1,88 @@
+---
+$schema: https://json-schema.org/draft/2020-12/schema
+$id: https://jmespath.site/function_schema.yml
+title: JMESPath function
+description: JMESPath function definition and tests
+type: object
+required: [name, topic, args, returns, desc, examples]
+properties:
+  name:
+    type: string
+    description: function identifier
+  topic:
+    enum: [math, strings, collections, conversion, misc]
+    description: related function topic
+  args:
+    type: object
+    additionalProperties: false
+    properties:
+      required: &arg
+        type: array
+        description: ""
+        items:
+          type: object
+          description: ""
+          additionalProperties: false
+          properties:
+            name:
+              type: string
+              description: ""
+            type: &type
+              description: ""
+              oneOf:
+                - enum: &types [any, number, string, boolean, array, object, "null", expression, "array[number]", "array[string]", "array[boolean]", "array[object]", "array[any]", "expression->number", "expression->string"]
+                - type: array
+                  items:
+                    enum: *types
+            desc:
+              type: string
+              description: ""
+      optional: *arg
+  returns:
+    type: object
+    description: ""
+    required: [type, desc]
+    additionalProperties: false
+    properties:
+      type:
+        <<: *type
+        description: ""
+      desc:
+        type: string
+        description: ""
+  desc:
+    type: string
+    description: ""
+  examples:
+    type: array
+    description: ""
+    minItems: 1
+    uniqueItems: true
+    items:
+      description: ""
+      oneOf:
+        - type: object
+          required: [context, args, returns]
+          additionalProperties: false
+          properties:
+            context: &context
+              type: &any ["number","string","boolean","object","array","null"]
+              description: ""
+            args: &args
+              type: array
+              description: ""
+              items:
+                type: *any
+                description: ""
+            returns:
+              type: *any
+              description: ""
+        - type: object
+          required: [context, args, error]
+          additionalProperties: false
+          properties:
+            context: *context
+            args: *args
+            error:
+              type: string
+              description: ""

functions/abs.yml

@@ -1,108 +1,141 @@
 name: abs
-topic:
+topic: math
 args:
   required:
   - name: value
     type: [number]
-    desc:
+    desc: positive or negative number
   optional: []
 returns:
   type: number
-  desc:
+  desc: positive magnitude of input value
 desc: |
   Returns the absolute value of the provided argument.  The signature indicates
   that a number is returned, and that the input argument `$value` **must**
   resolve to a number, otherwise a `invalid-type` error is triggered.
-  
+
   Below is a worked example.  Given:
-  
+
   ```
   {"foo": -1, "bar": "2"}
   ```
-  
+
   Evaluating `abs(foo)` works as follows:
-  
-  
+
+
   1. Evaluate the input argument against the current data:
-  
+
   ```
   search(foo, {"foo": -1, "bar": "2"}) -> -1
   ```
-  
-  
+
+
   2. Validate the type of the resolved argument.  In this case
   `-1` is of type `number` so it passes the type check.
-  
-  
+
+
   3. Call the function with the resolved argument:
-  
+
   ```
   abs(-1) -> 1
   ```
-  
-  
+
+
   4. The value of `1` is the resolved value of the function expression
   `abs(foo)`.
-  
+
   Below is the same steps for evaluating `abs(bar)`:
-  
-  
+
+
   1. Evaluate the input argument against the current data:
-  
+
   ```
   search(bar, {"foo": -1, "bar": "2"}) -> "2"
   ```
-  
-  
+
+
   2. Validate the type of the resolved argument.  In this case
   `"2"` is of type `string` so we immediately indicate that
   an `invalid-type` error occurred.
-  
+
   As a final example, here is the steps for evaluating `abs(to_number(bar))`:
-  
-  
+
+
   1. Evaluate the input argument against the current data:
-  
+
   ```
   search(to_number(bar), {"foo": -1, "bar": "2"})
   ```
-  
-  
+
+
   2. In order to evaluate the above expression, we need to evaluate
   `to_number(bar)`:
-  
+
   ```
   search(bar, {"foo": -1, "bar": "2"}) -> "2"
   # Validate "2" passes the type check for to_number, which it does.
   to_number("2") -> 2
   ```
-  
+
   Note that to_number is defined below.
-  
-  
+
+
   3. Now we can evaluate the original expression:
-  
+
   ```
   search(to_number(bar), {"foo": -1, "bar": "2"}) -> 2
   ```
-  
-  
+
+
   4. Call the function with the final resolved value:
-  
+
   ```
   abs(2) -> 2
   ```
-  
-  
+
+
   5. The value of `2` is the resolved value of the function expression
   `abs(to_number(bar))`.
 examples:
-- context: None
+- context:
   args: [1]
   returns: 1
-- context: None
+- context:
   args: [-1]
   returns: 1
-- context: None
-  args: ["abc"]
-  returns: "<error: invalid-type>"
+- context:
+  args: [abc]
+  error: invalid-type
+- context: &data
+    foo: -1
+    zero: 0
+    numbers: [-1, 3, 4, 5]
+    array: [-1, 3, 4, 5, a, '100']
+    strings: [a, b, c]
+    decimals: [1.01, 1.2, -1.5]
+    str: Str
+    'false': false
+    empty_list: []
+    empty_hash: {}
+    objects: {foo: bar, bar: baz}
+    null_key:
+  args: [foo]
+  returns: 1
+- context: *data
+  args: [str]
+  error: invalid-type
+- context: *data
+  args: ['array[1]']
+  returns: 3
+- context: *data
+  args: ['`false`']
+  error: invalid-type
+- context: *data
+  args: ['`-24`']
+  returns: 24
+- context: *data
+  args: ['`1`', '`2`']
+  error: invalid-arity
+- context: *data
+  args: ['']
+  error: invalid-arity