From 938ceb872ac4b5460379c86b89b6ca0db6ed72f2 Mon Sep 17 00:00:00 2001
From: koplas <pschwabauer@intevation.de>
Date: Wed, 4 Dec 2024 13:53:56 +0100
Subject: [PATCH] Return exit code based on validation result

---
 cmd/csaf_validator/main.go | 13 +++++++++++++
 docs/csaf_validator.md     |  7 +++++++
 2 files changed, 20 insertions(+)

diff --git a/cmd/csaf_validator/main.go b/cmd/csaf_validator/main.go
index 69855099..4a9e8273 100644
--- a/cmd/csaf_validator/main.go
+++ b/cmd/csaf_validator/main.go
@@ -22,6 +22,13 @@ import (
 	"github.com/gocsaf/csaf/v3/util"
 )
 
+const (
+	exitCodeAllValid               = 0
+	exitCodeSchemaInvalid          = 1 << 0
+	exitCodeNoRemoteValidator      = 1 << 1
+	exitCodeFailedRemoteValidation = 1 << 2
+)
+
 type options struct {
 	Version                bool     `long:"version" description:"Display version of the binary"`
 	RemoteValidator        string   `long:"validator" description:"URL to validate documents remotely" value-name:"URL"`
@@ -53,6 +60,7 @@ func main() {
 
 // run validates the given files.
 func run(opts *options, files []string) error {
+	exitCode := exitCodeAllValid
 
 	var validator csaf.RemoteValidator
 	eval := util.NewPathEval()
@@ -70,6 +78,7 @@ func run(opts *options, files []string) error {
 		}
 		defer validator.Close()
 	} else {
+		exitCode |= exitCodeNoRemoteValidator
 		log.Printf("warn: no remote validator specified")
 	}
 
@@ -106,6 +115,7 @@ func run(opts *options, files []string) error {
 
 		}
 		if len(validationErrs) > 0 {
+			exitCode |= exitCodeSchemaInvalid
 			fmt.Printf("schema validation errors of %q\n", file)
 			for _, vErr := range validationErrs {
 				fmt.Printf("  * %s\n", vErr)
@@ -132,12 +142,15 @@ func run(opts *options, files []string) error {
 			if rvr.Valid {
 				passes = "passes"
 			} else {
+				exitCode |= exitCodeFailedRemoteValidation
 				passes = "does not pass"
 			}
 			fmt.Printf("%q %s remote validation.\n", file, passes)
 		}
 	}
 
+	// Exit code is based on validation results
+	os.Exit(exitCodeAllValid)
 	return nil
 }
 
diff --git a/docs/csaf_validator.md b/docs/csaf_validator.md
index dfa0c9a3..74dbaaf7 100644
--- a/docs/csaf_validator.md
+++ b/docs/csaf_validator.md
@@ -2,6 +2,13 @@
 
 is a tool to validate local advisories files against the JSON Schema and an optional remote validator.
 
+### Exit codes
+If no fatal error occurs the program will exit with the following codes:
+- `0`: all valid
+- `2⁰`: schema invalid
+- `2¹`: no remote validator configured
+- `2²`: failure in remote validation
+
 ### Usage
 
 ```