Update regression test. Support unordered results

Author: cburgmer

project.clj

@@ -5,5 +5,6 @@
   :dependencies [[org.clojure/clojure "1.10.1"]]
   :profiles {:dev {:dependencies [[midje "1.9.6"]
                                   [org.flatland/ordered "1.5.7"] ;; https://github.com/owainlewis/yaml/issues/28
+                                  [org.clojure/data.json "0.2.7"]
                                   [io.forward/yaml "1.0.9"]]
                    :plugins [[lein-midje "3.2.1"]]}})

test/Clojure_json-path.yaml

@@ -18,11 +18,16 @@ queries:
     document: {"a": "first", "2": "second", "b": "third"}
     result: "second"
     status: pass
+  - id: array_index_first
+    selector: $[0]
+    document: ["first", "second", "third", "forth", "fifth"]
+    result: "first"
+    status: pass
   - id: array_index_last
     selector: $[-1]
     document: ["first", "second", "third"]
     result: "third"
-    status: open
+    status: pass
   - id: array_index_slice_end_out_of_bounds
     selector: $[1:10]
     document: ["first", "second", "third"]
@@ -89,12 +94,14 @@ queries:
     selector: $[0:4:2]
     document: ["first", "second", "third", "forth", "fifth"]
     result: "first"
-    status: open
+    status: fail
+    consensus: ["first", "third"]
   - id: array_index_slice_start_equals_end
     selector: $[0:0]
     document: ["first", "second"]
     result: "first"
-    status: open
+    status: fail
+    consensus: []
   - id: array_index_slice_start_plus_one
     selector: $[0:1]
     document: ["first", "second"]
@@ -113,6 +120,17 @@ queries:
     result: "first"
     status: fail
     consensus: ["first", "second"]
+  - id: filter_current_object_with_value
+    selector: $[?(@)]
+    document: ["some value", null, "value"]
+    result: ["some value", "value"]
+    status: open
+  - id: filter_equal
+    selector: $[?(@.key==42)]
+    document: [{"key": 0}, {"key": 42}, {"key": -1}, {"key": 41}, {"key": 43}, {"key": 42.0001}, {"key": 41.9999}, {"key": 100}, {"some": "value"}]
+    result: [{"some": "value"}]
+    status: fail
+    consensus: [{"key": 42}]
   - id: filter_greater_than
     selector: $[?(@.key>42)]
     document: [{"key": 0}, {"key": 42}, {"key": -1}, {"key": 41}, {"key": 43}, {"key": 42.0001}, {"key": 41.9999}, {"key": 100}]
@@ -135,11 +153,31 @@ queries:
     selector: $[?(@.key<=42)]
     document: [{"key": 0}, {"key": 42}, {"key": -1}, {"key": 41}, {"key": 43}, {"key": 42.0001}, {"key": 41.9999}, {"key": 100}, {"some": "value"}]
     status: error
+  - id: filter_null
+    selector: $[?(@.key==null)]
+    document: [{"some": "some value"}, {"key": null}, {"key": "value"}]
+    result: [{"some": "some value"}, {"key": null}]
+    status: open
+  - id: filter_with_boolean_operation
+    selector: $[?(@.key>42 && @.key<44)]
+    document: [{"key": 42}, {"key": 43}, {"key": 44}]
+    result: [{"key": 43}, {"key": 44}]
+    status: open
   - id: filter_with_value
     selector: $[?(@.key)]
     document: [{"some": "some value"}, {"key": "value"}]
     result: [{"key": "value"}]
     status: pass
+  - id: filter_with_value_on_null
+    selector: $[?(@.key)]
+    document: [{"some": "some value"}, {"key": null}, {"key": "value"}]
+    result: [{"key": "value"}]
+    status: open
+  - id: filter_without_value
+    selector: $[?(!@.key)]
+    document: [{"some": "some value"}, {"key": null}, {"key": "value"}]
+    result: [{"key": "value"}]
+    status: open
   - id: key_bracket_notation
     selector: $['key']
     document: {"key": "value"}
@@ -149,10 +187,34 @@ queries:
     selector: $['key','another']
     document: {"key": "value", "another": "entry"}
     status: error
+  - id: key_bracket_notation_union_with_key_on_nested_objects
+    selector: $['one','three'].key
+    document: {"one": {"key": "value"}, "two": {"k": "v"}, "three": {"some": "more", "key": "other value"}}
+    status: error
+  - id: key_bracket_notation_with_at_literal
+    selector: $['@']
+    document: {"@": "value", "another": "entry"}
+    status: error
+    consensus: "value"
+  - id: key_bracket_notation_with_dollar_literal
+    selector: $['$']
+    document: {"$": "value", "another": "entry"}
+    status: error
+    consensus: "value"
+  - id: key_bracket_notation_with_dot
+    selector: $['two.some']
+    document: {"one": {"key": "value"}, "two": {"some": "more", "key": "other value"}, "two.some": "42"}
+    status: error
+    consensus: ["42"]
+  - id: key_bracket_notation_with_dot_without_quotes
+    selector: $[two.some]
+    document: {"one": {"key": "value"}, "two": {"some": "more", "key": "other value"}, "two.some": "42"}
+    status: error
   - id: key_bracket_notation_with_double_quotes
     selector: $["key"]
     document: {"key": "value"}
     status: error
+    consensus: "value"
   - id: key_bracket_notation_with_number
     selector: $['0']
     document: {"0": "value"}
@@ -177,8 +239,8 @@ queries:
     consensus: "value"
   - id: key_bracket_notation_with_star_literal
     selector: $['*']
-    document: {"*": "value"}
-    result: ["value"]
+    document: {"*": "value", "another": "entry"}
+    result: ["value", "entry"]
     status: fail
     consensus: "value"
   - id: key_bracket_notation_without_quotes
@@ -189,7 +251,6 @@ queries:
     selector: $.['key']
     document: {"key": "value"}
     status: error
-    consensus: "value"
   - id: key_dot_bracket_notation_with_double_quotes
     selector: $.["key"]
     document: {"key": "value"}
@@ -230,27 +291,32 @@ queries:
   - id: recursive_key
     selector: $..key
     document: {"object": {"key": "value", "array": [{"key": "something"}, {"key": {"key": "russian dolls"}}]}, "key": "top"}
-    result: ["top", "value", "something", {"key": "russian dolls"}, "russian dolls"]
+    ordered: false
+    result: ["russian dolls", "something", "top", "value", {"key": "russian dolls"}]
     status: pass
   - id: recursive_key_with_double_quotes
     selector: $.."key"
     document: {"object": {"key": "value", "array": [{"key": "something"}, {"key": {"key": "russian dolls"}}]}, "key": "top"}
+    ordered: false
     result: []
     status: open
   - id: recursive_key_with_single_quotes
     selector: $..'key'
     document: {"object": {"key": "value", "array": [{"key": "something"}, {"key": {"key": "russian dolls"}}]}, "key": "top"}
-    result: ["top", "value", "something", {"key": "russian dolls"}, "russian dolls"]
+    ordered: false
+    result: ["russian dolls", "something", "top", "value", {"key": "russian dolls"}]
     status: open
   - id: recursive_on_nested_object
     selector: $.store..price
     document: {"store": {"book": [{"category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95}, {"category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99}, {"category": "fiction", "author": "Herman Melville", "title": "Moby Dick", "isbn": "0-553-21311-3", "price": 8.99}, {"category": "fiction", "author": "J. R. R. Tolkien", "title": "The Lord of the Rings", "isbn": "0-395-19395-8", "price": 22.99}], "bicycle": {"color": "red", "price": 19.95}}}
-    result: [8.95, 12.99, 8.99, 22.99, 19.95]
+    ordered: false
+    result: [12.99, 19.95, 22.99, 8.95, 8.99]
     status: pass
   - id: recursive_wildcard
     selector: $..*
     document: {"key": "value", "another key": {"complex": "string", "primitives": [0, 1]}}
-    result: ["value", {"complex": "string", "primitives": [0, 1]}, "string", [0, 1], 0, 1]
+    ordered: false
+    result: ["string", "value", 0, 1, [0, 1], {"complex": "string", "primitives": [0, 1]}]
     status: pass
   - id: recursive_wildcard_on_null_value_array
     selector: $..*
@@ -285,7 +351,8 @@ queries:
   - id: wildcard_bracket_notation_on_object
     selector: $[*]
     document: {"some": "string", "int": 42, "object": {"key": "value"}, "array": [0, 1]}
-    result: ["string", 42, {"key": "value"}, [0, 1]]
+    ordered: false
+    result: ["string", 42, [0, 1], {"key": "value"}]
     status: pass
   - id: wildcard_bracket_notation_with_key_on_nested_objects
     selector: $[*].bar[*].baz
@@ -300,5 +367,6 @@ queries:
   - id: wildcard_dot_notation_on_object
     selector: $.*
     document: {"some": "string", "int": 42, "object": {"key": "value"}, "array": [0, 1]}
-    result: ["string", 42, {"key": "value"}, [0, 1]]
+    ordered: false
+    result: ["string", 42, [0, 1], {"key": "value"}]
     status: pass

test/json_path/test/regression_test.clj

@@ -1,6 +1,7 @@
 (ns json-path.test.regression-test
   (:use [json-path])
   (:require [yaml.core :as yaml]
+            [clojure.data.json :as json]
             [clojure
              [test :refer :all]]))
 
@@ -10,24 +11,28 @@
 (deftest regression
   (->> (queries_from_suite "test/Clojure_json-path.yaml")
        (filter (fn [{status :status}] (= status "pass")))
-       (map (fn [{:keys [selector document result id]}]
-              (testing id
-                (is (= result
-                       (json-path/at-path selector document))))))
+       (map (fn [{:keys [selector document result id ordered]}]
+              (let [current (json-path/at-path selector document)
+                    current-reordered (if (= ordered false)
+                                        (sort-by json/write-str current)
+                                        current)]
+                (testing id
+                  (is (= result
+                         current-reordered))))))
        doall))
 
-(defn- report-change [current {:keys [selector document result status consensus id]}]
+(defn- report-change [current-reordered {:keys [selector document result status consensus id]}]
   (println
    (format "Warning: implementation has changed for %s: %s (previous status %s)"
            id selector status))
   (when (or (nil? consensus)
-            (not= consensus current))
+            (not= consensus current-reordered))
     (when-not (= status "error")
-      (println (format "         was           %s" (pr-str current))))
-    (println (format "         now is        %s" (pr-str current))))
+      (println (format "         was           %s" (pr-str result))))
+    (println (format "         now is        %s" (pr-str current-reordered))))
   (when-not (nil? consensus)
     (if (= consensus
-           current)
+           current-reordered)
       (println "         now matching consensus")
       (println (format "         but should be %s" (pr-str consensus))))))
 
@@ -37,12 +42,15 @@
 (deftest warning-on-changes-for-non-conforming-queries-based-on-consensus
   (->> (queries_from_suite "test/Clojure_json-path.yaml")
        (filter (fn [{status :status}] (not= status "pass")))
-       (map (fn [{:keys [selector document result status consensus id] :as query}]
+       (map (fn [{:keys [selector document result status consensus id ordered] :as query}]
               (testing id
                 (try
-                  (let [current (doall (json-path/at-path selector document))]
+                  (let [current (doall (json-path/at-path selector document))
+                        current-reordered (if (= ordered false)
+                                            (sort-by json/write-str current)
+                                            current)]
                     (when (or (= "error" status)
-                              (not= result current))
+                              (not= result current-reordered))
                       (report-change current query)))
                   (catch Exception e
                     (when (not= "error"