Make validate report exit code 2 on schema validation failure (#215)

Signed-off-by: Juan Cruz Viotti <[email protected]>
sourcemeta · Jan 22, 2025 · 7842cee · 7842cee
1 parent 8dce649
commit 7842cee
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 14 deletions.
diff --git a/docs/validate.markdown b/docs/validate.markdown
@@ -18,6 +18,9 @@ information on unsuccessful validation.
 **If you want to validate that a schema adheres to its metaschema, use the
 [`metaschema`](./metaschema.markdown) command instead.**
 
+To help scripts distinguish validation errors, these are reported using exit
+code 2.
+
 Examples
 --------
 

diff --git a/src/command_validate.cc b/src/command_validate.cc
@@ -178,5 +178,8 @@ auto sourcemeta::jsonschema::cli::validate(
     }
   }
 
-  return result ? EXIT_SUCCESS : EXIT_FAILURE;
+  return result ? EXIT_SUCCESS
+                // Report a different exit code for validation failures, to
+                // distinguish them from other errors
+                : 2;
 }
diff --git a/test/validate/fail_2019_09.sh b/test/validate/fail_2019_09.sh
@@ -25,7 +25,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.json

diff --git a/test/validate/fail_2020_12.sh b/test/validate/fail_2020_12.sh
@@ -25,7 +25,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.json

diff --git a/test/validate/fail_draft4.sh b/test/validate/fail_draft4.sh
@@ -25,7 +25,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.json

diff --git a/test/validate/fail_draft6.sh b/test/validate/fail_draft6.sh
@@ -25,7 +25,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.json

diff --git a/test/validate/fail_draft7.sh b/test/validate/fail_draft7.sh
@@ -25,7 +25,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.json

diff --git a/test/validate/fail_jsonl_all.sh b/test/validate/fail_jsonl_all.sh
@@ -22,7 +22,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.jsonl" 2>"$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.jsonl (entry #1)

diff --git a/test/validate/fail_jsonl_all_verbose.sh b/test/validate/fail_jsonl_all_verbose.sh
@@ -22,7 +22,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.jsonl" --verbose 2>"$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 Interpreting input as JSONL: $(realpath "$TMP")/instance.jsonl

diff --git a/test/validate/fail_jsonl_one.sh b/test/validate/fail_jsonl_one.sh
@@ -22,7 +22,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.jsonl" 2>"$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.jsonl (entry #2)

diff --git a/test/validate/fail_jsonl_one_verbose.sh b/test/validate/fail_jsonl_one_verbose.sh
@@ -22,7 +22,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.jsonl" --verbose 2>"$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 Interpreting input as JSONL: $(realpath "$TMP")/instance.jsonl

diff --git a/test/validate/fail_many.sh b/test/validate/fail_many.sh
@@ -37,7 +37,7 @@ EOF
   "$TMP/instance_3.json" \
   2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance_2.json

diff --git a/test/validate/fail_many_verbose.sh b/test/validate/fail_many_verbose.sh
@@ -37,7 +37,7 @@ EOF
   "$TMP/instance_3.json" \
   --verbose 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 ok: $(realpath "$TMP")/instance_1.json

diff --git a/test/validate/fail_trace.sh b/test/validate/fail_trace.sh
@@ -24,7 +24,7 @@ EOF
 
 "$1" validate "$TMP/schema.json" "$TMP/instance.json" --trace > "$TMP/output.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 -> (push) "/properties/foo/type"

diff --git a/test/validate/fail_yaml.sh b/test/validate/fail_yaml.sh
@@ -21,7 +21,7 @@ EOF
 
 "$1" validate "$TMP/schema.yaml" "$TMP/instance.yaml" 2> "$TMP/stderr.txt" \
   && CODE="$?" || CODE="$?"
-test "$CODE" = "1" || exit 1
+test "$CODE" = "2" || exit 1
 
 cat << EOF > "$TMP/expected.txt"
 fail: $(realpath "$TMP")/instance.yaml