Refactor the validation output formatter callback (#154)

Signed-off-by: Juan Cruz Viotti <[email protected]>

DEPENDENCIES

@@ -1,4 +1,4 @@
 vendorpull https://github.com/sourcemeta/vendorpull dea311b5bfb53b6926a4140267959ae334d3ecf4
 noa https://github.com/sourcemeta/noa 7e26abce7a4e31e86a16ef2851702a56773ca527
-jsontoolkit https://github.com/sourcemeta/jsontoolkit c9b844557d3b116b272be5198ec547a7eee18347
+jsontoolkit https://github.com/sourcemeta/jsontoolkit 760aecee95213152bfea907c19cdaa43f616dc9b
 hydra https://github.com/sourcemeta/hydra 3c53d3fdef79e9ba603d48470a508cc45472a0dc

src/command_metaschema.cc

@@ -39,17 +39,16 @@ auto intelligence::jsonschema::cli::metaschema(
       cache.insert({dialect.value(), metaschema_template});
     }
 
-    std::ostringstream error;
+    sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput output{metaschema};
     if (sourcemeta::jsontoolkit::evaluate(
             cache.at(dialect.value()), entry.second,
             sourcemeta::jsontoolkit::SchemaCompilerEvaluationMode::Fast,
-            pretty_evaluate_callback(error, metaschema,
-                                     sourcemeta::jsontoolkit::empty_pointer))) {
+            std::ref(output))) {
       log_verbose(options)
           << entry.first.string()
           << ": The schema is valid with respect to its metaschema\n";
     } else {
-      std::cerr << error.str();
+      print(output, std::cerr);
       std::cerr << entry.first.string()
                 << ": The schema is NOT valid with respect to its metaschema\n";
       result = false;

src/command_test.cc

@@ -237,12 +237,13 @@ auto intelligence::jsonschema::cli::test(
         return EXIT_FAILURE;
       }
 
-      std::ostringstream error;
+      sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput output{
+          schema.value(), {"$ref"}};
       const auto case_result{sourcemeta::jsontoolkit::evaluate(
           schema_template,
           get_data(test_case, entry.first.parent_path(), verbose),
           sourcemeta::jsontoolkit::SchemaCompilerEvaluationMode::Fast,
-          pretty_evaluate_callback(error, schema.value(), {"$ref"}))};
+          std::ref(output))};
 
       std::ostringstream test_case_description;
       if (test_case.defines("description")) {
@@ -278,7 +279,7 @@ auto intelligence::jsonschema::cli::test(
 
         std::cout << "  " << index << "/" << total << " FAIL "
                   << test_case_description.str() << "\n\n";
-        std::cout << error.str();
+        print(output, std::cout);
 
         if (index != total && verbose) {
           std::cout << "\n";

src/command_validate.cc

@@ -69,6 +69,8 @@ auto intelligence::jsonschema::cli::validate(
         for (const auto &instance : sourcemeta::jsontoolkit::JSONL{stream}) {
           index += 1;
           std::ostringstream error;
+          sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput output{
+              instance};
           bool subresult = true;
           if (benchmark) {
             const auto timestamp_start{
@@ -88,8 +90,7 @@ auto intelligence::jsonschema::cli::validate(
             subresult = sourcemeta::jsontoolkit::evaluate(
                 schema_template, instance,
                 sourcemeta::jsontoolkit::SchemaCompilerEvaluationMode::Fast,
-                pretty_evaluate_callback(
-                    error, instance, sourcemeta::jsontoolkit::empty_pointer));
+                std::ref(output));
           }
 
           if (subresult) {
@@ -108,6 +109,7 @@ auto intelligence::jsonschema::cli::validate(
             sourcemeta::jsontoolkit::prettify(instance, std::cerr);
             std::cerr << "\n\n";
             std::cerr << error.str();
+            print(output, std::cerr);
             result = false;
             break;
           }
@@ -123,6 +125,7 @@ auto intelligence::jsonschema::cli::validate(
     } else {
       const auto instance{sourcemeta::jsontoolkit::from_file(instance_path)};
       std::ostringstream error;
+      sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput output{instance};
       bool subresult{true};
       if (benchmark) {
         const auto timestamp_start{std::chrono::high_resolution_clock::now()};
@@ -142,8 +145,7 @@ auto intelligence::jsonschema::cli::validate(
         subresult = sourcemeta::jsontoolkit::evaluate(
             schema_template, instance,
             sourcemeta::jsontoolkit::SchemaCompilerEvaluationMode::Fast,
-            pretty_evaluate_callback(error, instance,
-                                     sourcemeta::jsontoolkit::empty_pointer));
+            std::ref(output));
       }
 
       if (subresult) {
@@ -157,6 +159,7 @@ auto intelligence::jsonschema::cli::validate(
                   << std::filesystem::weakly_canonical(instance_path).string()
                   << "\n";
         std::cerr << error.str();
+        print(output, std::cerr);
         result = false;
       }
     }

src/utils.cc

@@ -175,37 +175,19 @@ auto parse_options(const std::span<const std::string> &arguments,
   return options;
 }
 
-auto pretty_evaluate_callback(std::ostringstream &output,
-                              const sourcemeta::jsontoolkit::JSON &instance,
-                              const sourcemeta::jsontoolkit::Pointer &base)
-    -> sourcemeta::jsontoolkit::SchemaCompilerEvaluationCallback {
-  output << "error: Schema validation failure\n";
-  return [&output, &instance, &base](
-             const sourcemeta::jsontoolkit::SchemaCompilerEvaluationType,
-             const bool result,
-             const sourcemeta::jsontoolkit::SchemaCompilerTemplate::value_type
-                 &step,
-             const sourcemeta::jsontoolkit::Pointer &evaluate_path,
-             const sourcemeta::jsontoolkit::Pointer &instance_location,
-             const sourcemeta::jsontoolkit::JSON &annotation) -> void {
-    if (result) {
-      return;
-    }
-
-    output << "  "
-           << sourcemeta::jsontoolkit::describe(result, step, evaluate_path,
-                                                instance_location, instance,
-                                                annotation)
-           << "\n";
-    output << "    at instance location \"";
-    sourcemeta::jsontoolkit::stringify(instance_location, output);
-    output << "\"\n";
-
-    output << "    at evaluate path \"";
-    sourcemeta::jsontoolkit::stringify(evaluate_path.resolve_from(base),
-                                       output);
-    output << "\"\n";
-  };
+auto print(
+    const sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput &output,
+    std::ostream &stream) -> void {
+  stream << "error: Schema validation failure\n";
+  for (const auto &entry : output) {
+    stream << "  " << entry.message << "\n";
+    stream << "    at instance location \"";
+    sourcemeta::jsontoolkit::stringify(entry.instance_location, stream);
+    stream << "\"\n";
+    stream << "    at evaluate path \"";
+    sourcemeta::jsontoolkit::stringify(entry.evaluate_path, stream);
+    stream << "\"\n";
+  }
 }
 
 static auto fallback_resolver(

src/utils.h

@@ -27,10 +27,9 @@ auto for_each_json(const std::vector<std::string> &arguments,
     -> std::vector<
         std::pair<std::filesystem::path, sourcemeta::jsontoolkit::JSON>>;
 
-auto pretty_evaluate_callback(std::ostringstream &,
-                              const sourcemeta::jsontoolkit::JSON &,
-                              const sourcemeta::jsontoolkit::Pointer &)
-    -> sourcemeta::jsontoolkit::SchemaCompilerEvaluationCallback;
+auto print(
+    const sourcemeta::jsontoolkit::SchemaCompilerErrorTraceOutput &output,
+    std::ostream &stream) -> void;
 
 auto resolver(const std::map<std::string, std::vector<std::string>> &options,
               const bool remote = false)

test/test/fail_true_resolve_fragment.sh

@@ -43,9 +43,6 @@ error: Schema validation failure
   The value was expected to be of type string but it was of type object
     at instance location ""
     at evaluate path "/type"
-  The object value was expected to validate against the statically referenced schema
-    at instance location ""
-    at evaluate path ""
 EOF
 
 diff "$TMP/output.txt" "$TMP/expected.txt"