Merge pull request #361 from LPCIC/jdiff

Jdiff

Author: gares

CHANGES.md

@@ -1,3 +1,10 @@
+# v3.3.1 (September 2025)
+
+Requires Menhir 20211230 and OCaml 4.13 or above.
+
+- Tests:
+  - compare json files semantically
+
 # v3.3.0 (September 2025)
 
 Requires Menhir 20211230 and OCaml 4.13 or above.

elpi.opam

@@ -24,6 +24,7 @@ depends: [
   "ANSITerminal" {with-test}
   "cmdliner" {with-test}
   "fileutils" {with-test}
+  "yojson" {with-test}
   "dune" {>= "2.9.0"}
   "conf-time" {with-test}
   "atdgen" {>= "2.10.0"}

tests/sources/trace.elab.json

@@ -9,8 +9,7 @@
     "step_id": 1,
     "runtime_id": 0,
     "step": [
-      "Inference",
-      {
+      "Inference",       {
         "current_goal_id": 4,
         "current_goal_text": "main",
         "current_goal_predicate": "main",

tests/suite/dune

@@ -1,6 +1,6 @@
 (library
   (name test_suite)
-  (libraries str unix fileutils)
+  (libraries str unix fileutils yojson)
   (library_flags -linkall)
 )
 

tests/suite/suite.ml

@@ -329,6 +329,31 @@ let match_file ~log file adjust reference =
     | _ -> false
   end
 
+let match_json_file ~log file adjust reference =
+  let file = adjust file in
+  let dig1 = Digest.to_hex (Digest.file file) in
+  let dig2 = Digest.(to_hex (file reference)) in
+  if dig1 = dig2 then begin
+    Util.write log (Printf.sprintf "Digest of %s and %s is %s\n" file reference dig2);
+    true
+  end else
+    let yreference = Yojson.Safe.from_file reference in
+    let yfile = Yojson.Safe.from_file file in
+    Yojson.Safe.equal yreference yfile ||
+  begin
+    Util.write log (Printf.sprintf "Diffing %s against %s\n" file reference);
+      match
+      Util.exec ~timeout:5.0 ~env:(Unix.environment ())
+        ~log ~close_output:false
+        ~executable:"diff" ~args:["-u";"--strip-trailing-cr";reference;file] ()
+    with
+    | Util.Exit(0,_,_) -> true
+    | Util.Exit(n,_,_) ->
+      Util.write log (Printf.sprintf "Exit code: %d\n" n);
+      Util.write log (Printf.sprintf "Promotion: cp %s %s\n" file reference);
+      false
+    | _ -> false
+  end
 
 module Elpi = struct
 
@@ -486,7 +511,7 @@ module ElpiTraceElab = struct
         match outcome, outcomey, test.Test.expectation with
         | Util.Exit(0,walltime,mem), Some(Util.Exit(0,_,_)), Test.SuccessOutputTxt f when f (Util.read_lines (snd log)) -> 
             Runner.Success { walltime; typechecking; execution; mem }
-        | Util.Exit(0,walltime,mem), Some(Util.Exit(0,_,_)), Test.SuccessOutputFile { sample; adjust; reference } when match_file ~log sample adjust (sources^"/"^reference) ->
+        | Util.Exit(0,walltime,mem), Some(Util.Exit(0,_,_)), Test.SuccessOutputFile { sample; adjust; reference } when match_json_file ~log sample adjust (sources^"/"^reference) ->
             Runner.Success { walltime; typechecking; execution; mem }
         | Util.Exit(0,walltime,mem), Some(Util.Exit(0,_,_)), Test.SuccessOutputFile { sample; adjust; reference } when promote ->
             FileUtil.cp [adjust sample] (sources^"/"^reference);