chore: write unit tests for the functions that throw a "Too many arguments" error

Author: josdejong

README.md

@@ -208,7 +208,7 @@ When using multiple operators, they will be evaluated according to their precede
 filter(.age >= 18 and .age <= 65)
 ```
 
-Note that some operators, like `and`, `or`, `+`, and `-`, support more than two values, like `2 + 3 + 4`. Others, like `^` and `==`, do not support more than two values. If needed, it is always possible to use parenthesis, like `(2 ^ 3) ^ 4`.
+Note that some operators, like `and`, `or`, `+`, and `-`, support more than two values and are evaluated left-to-right (left associative), like `2 + 3 + 4` Others, like `^` and `==`, do not support more than two values. If needed, it is always possible to use parenthesis, like `(2 ^ 3) ^ 4`.
 
 The operators have the following precedence, from highest to lowest:
 

src/compile.test.ts

@@ -1,12 +1,16 @@
 import Ajv from 'ajv'
 import { describe, expect, test } from 'vitest'
-import type { CompileTestSuite } from '../test-suite/compile.test'
+import type { CompileTestException, CompileTestSuite } from '../test-suite/compile.test'
 import suite from '../test-suite/compile.test.json'
 import schema from '../test-suite/compile.test.schema.json'
 import { compile } from './compile'
 import { buildFunction } from './functions'
 import type { JSONQuery, JSONQueryCompileOptions } from './types'
 
+function isTestException(test: unknown): test is CompileTestException {
+  return !!test && typeof (test as Record<string, unknown>).throws === 'string'
+}
+
 const data = [
   { name: 'Chris', age: 23, city: 'New York' },
   { name: 'Emily', age: 19, city: 'Atlanta' },
@@ -31,13 +35,20 @@ const testsByCategory = groupByCategory(suite.tests) as Record<string, CompileTe
 for (const [category, tests] of Object.entries(testsByCategory)) {
   describe(category, () => {
     for (const currentTest of tests) {
-      const { description, input, query, output } = currentTest
-
-      test(description, () => {
-        const actualOutput = compile(query)(input)
-
-        expect({ input, query, output: actualOutput }).toEqual({ input, query, output })
-      })
+      if (isTestException(currentTest)) {
+        test(currentTest.description, () => {
+          const { input, query, throws } = currentTest
+
+          expect(() => compile(query)(input)).toThrow(throws)
+        })
+      } else {
+        test(currentTest.description, () => {
+          const { input, query, output } = currentTest
+          const actualOutput = compile(query)(input)
+
+          expect({ input, query, output: actualOutput }).toEqual({ input, query, output })
+        })
+      }
     }
   })
 }

test-suite/compile.test.d.ts

@@ -1,13 +1,23 @@
 import type { JSONQuery } from '../src/types'
 
-export interface CompileTest {
+export interface CompileTestOutput {
   category: string
   description: string
   input: unknown
   query: JSONQuery
   output: unknown
 }
 
+export interface CompileTestException {
+  category: string
+  description: string
+  input: unknown
+  query: JSONQuery
+  throws: string
+}
+
+export type CompileTest = CompileTestOutput | CompileTestException
+
 export interface CompileTestSuite {
   updated: string
   tests: CompileTest[]

test-suite/compile.test.json

@@ -753,6 +753,13 @@
       "query": ["eq", 2, 2],
       "output": true
     },
+    {
+      "category": "eq",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["eq", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "gt",
@@ -782,6 +789,13 @@
       "query": ["gt", 3, 2],
       "output": true
     },
+    {
+      "category": "gt",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["gt", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "gte",
@@ -811,6 +825,13 @@
       "query": ["gte", 3, 2],
       "output": true
     },
+    {
+      "category": "gte",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["gte", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "lt",
@@ -840,6 +861,13 @@
       "query": ["lt", 1, 2],
       "output": true
     },
+    {
+      "category": "lt",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["lt", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "lte",
@@ -869,6 +897,13 @@
       "query": ["lte", 2, 2],
       "output": true
     },
+    {
+      "category": "lte",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["lte", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "ne",
@@ -898,6 +933,13 @@
       "query": ["ne", 3, 2],
       "output": true
     },
+    {
+      "category": "ne",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["ne", 2, 3, 4],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "and",
@@ -1377,6 +1419,13 @@
       "query": ["pow", ["get"], 0.5],
       "output": 5
     },
+    {
+      "category": "pow",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["pow", 3, 2, 3],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "mod",
@@ -1392,6 +1441,13 @@
       "query": ["mod", 8, 3],
       "output": 2
     },
+    {
+      "category": "mod",
+      "description": "should throw when passing more than two arguments",
+      "input": null,
+      "query": ["mod", 20, 12, 3],
+      "throws": "Too many arguments"
+    },
 
     {
       "category": "abs",

test-suite/compile.test.schema.json

@@ -9,16 +9,32 @@
     "tests": {
       "type": "array",
       "items": {
-        "type": "object",
-        "properties": {
-          "category": { "type": "string" },
-          "description": { "type": "string" },
-          "input": {},
-          "query": {},
-          "output": {}
-        },
-        "required": ["category", "description", "input", "query", "output"],
-        "additionalProperties": false
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "category": { "type": "string" },
+              "description": { "type": "string" },
+              "input": {},
+              "query": {},
+              "output": {}
+            },
+            "required": ["category", "description", "input", "query", "output"],
+            "additionalProperties": false
+          },
+          {
+            "type": "object",
+            "properties": {
+              "category": { "type": "string" },
+              "description": { "type": "string" },
+              "input": {},
+              "query": {},
+              "throws": { "type": "string" }
+            },
+            "required": ["category", "description", "input", "query", "throws"],
+            "additionalProperties": false
+          }
+        ]
       }
     }
   },