buffer JSON output for unit tests

Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>

cmd/root.go

@@ -85,7 +85,7 @@ const (
 	MSG_FLAG_DEBUG          = "enable debug logging"
 	MSG_FLAG_INPUT          = "input filename (e.g., \"path/sbom.json\")"
 	MSG_FLAG_OUTPUT         = "output filename"
-	MSG_FLAG_LOG_QUIET      = "enable quiet logging mode (removes all information messages from console output); overrides other logging commands"
+	MSG_FLAG_LOG_QUIET      = "enable quiet logging mode (removes all informational messages from console output); overrides other logging commands"
 	MSG_FLAG_LOG_INDENT     = "enable log indentation of functional callstack"
 	MSG_FLAG_CONFIG_SCHEMA  = "provide custom application schema configuration file (i.e., overrides default `config.json`)"
 	MSG_FLAG_CONFIG_LICENSE = "provide custom application license policy configuration file (i.e., overrides default `license.json`)"

cmd/validate.go

@@ -21,6 +21,7 @@ package cmd
 import (
 	"encoding/json"
 	"fmt"
+	"io"
 	"os"
 	"strings"
 
@@ -112,22 +113,21 @@ func validateCmdImpl(cmd *cobra.Command, args []string) error {
 	getLogger().Enter()
 	defer getLogger().Exit()
 
-	// TODO - support an output file for errors
 	// Create output writer
-	// outputFilename := utils.GlobalFlags.PersistentFlags.OutputFile
-	// outputFile, writer, err := createOutputFile(outputFilename)
-
-	// // use function closure to assure consistent error output based upon error type
-	// defer func() {
-	// 	// always close the output file
-	// 	if outputFile != nil {
-	// 		err = outputFile.Close()
-	// 		getLogger().Infof("Closed output file: `%s`", outputFilename)
-	// 	}
-	// }()
+	outputFilename := utils.GlobalFlags.PersistentFlags.OutputFile
+	outputFile, writer, err := createOutputFile(outputFilename)
+
+	// use function closure to assure consistent error output based upon error type
+	defer func() {
+		// always close the output file
+		if outputFile != nil {
+			err = outputFile.Close()
+			getLogger().Infof("Closed output file: `%s`", outputFilename)
+		}
+	}()
 
 	// invoke validate and consistently manage exit messages and codes
-	isValid, _, _, err := Validate(utils.GlobalFlags.PersistentFlags, utils.GlobalFlags.ValidateFlags)
+	isValid, _, _, err := Validate(writer, utils.GlobalFlags.PersistentFlags, utils.GlobalFlags.ValidateFlags)
 
 	// Note: all invalid SBOMs (that fail schema validation) MUST result in an InvalidSBOMError()
 	if err != nil {
@@ -180,7 +180,7 @@ func normalizeValidationErrorTypes(document *schema.Sbom, valid bool, err error)
 	getLogger().Info(message)
 }
 
-func Validate(persistentFlags utils.PersistentCommandFlags, validateFlags utils.ValidateCommandFlags) (valid bool, document *schema.Sbom, schemaErrors []gojsonschema.ResultError, err error) {
+func Validate(output io.Writer, persistentFlags utils.PersistentCommandFlags, validateFlags utils.ValidateCommandFlags) (valid bool, document *schema.Sbom, schemaErrors []gojsonschema.ResultError, err error) {
 	getLogger().Enter()
 	defer getLogger().Exit()
 
@@ -299,7 +299,14 @@ func Validate(persistentFlags utils.PersistentCommandFlags, validateFlags utils.
 			schemaErrors)
 
 		// Format error results and append to InvalidSBOMError error "details"
-		errInvalid.Details = FormatSchemaErrors(schemaErrors, validateFlags, persistentFlags.OutputFormat)
+		formattedErrors := FormatSchemaErrors(schemaErrors, validateFlags, persistentFlags.OutputFormat)
+		errInvalid.Details = formattedErrors
+
+		// Always produce JSON output (since it is considered non-informational), ignoring the `--quiet` flags
+		if persistentFlags.Quiet && persistentFlags.OutputFormat == FORMAT_JSON {
+			// Note: JSON data files MUST ends in a newline s as this is a POSIX standard
+			fmt.Fprintf(output, "%s\n", formattedErrors)
+		}
 
 		return INVALID, document, schemaErrors, errInvalid
 	}
@@ -313,6 +320,8 @@ func Validate(persistentFlags utils.PersistentCommandFlags, validateFlags utils.
 		}
 	}
 
+	// TODO: Need to perhaps factor in these errors into the JSON output as if they
+	// were actual schema errors...
 	// Perform additional validation in document composition/structure
 	// and "custom" required data within specified fields
 	if utils.GlobalFlags.ValidateFlags.CustomValidation {

cmd/validate_test.go

@@ -18,9 +18,12 @@
 package cmd
 
 import (
+	"bufio"
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"io/fs"
+	"os"
 	"testing"
 
 	"github.com/CycloneDX/sbom-utility/schema"
@@ -63,8 +66,8 @@ func innerValidateError(t *testing.T, filename string, variant string, format st
 
 	// Invoke the actual validate function
 	var isValid bool
-	//isValid, document, schemaErrors, actualError = Validate()
-	isValid, document, schemaErrors, actualError = Validate(utils.GlobalFlags.PersistentFlags, utils.GlobalFlags.ValidateFlags)
+
+	isValid, document, schemaErrors, actualError = Validate(os.Stdout, utils.GlobalFlags.PersistentFlags, utils.GlobalFlags.ValidateFlags)
 
 	getLogger().Tracef("document: `%s`, isValid=`%t`, actualError=`%T`", document.GetFilename(), isValid, actualError)
 
@@ -96,6 +99,19 @@ func innerValidateError(t *testing.T, filename string, variant string, format st
 	return
 }
 
+func innerValidateErrorBuffered(t *testing.T, filename string, variant string, format string, expectedError error) (schemaErrors []gojsonschema.ResultError, outputBuffer bytes.Buffer, err error) {
+	// Declare an output outputBuffer/outputWriter to use used during tests
+	var outputWriter = bufio.NewWriter(&outputBuffer)
+	// ensure all data is written to buffer before further validation
+	defer outputWriter.Flush()
+
+	// Invoke the actual command (API)
+	isValid, document, schemaErrors, actualError := Validate(outputWriter, utils.GlobalFlags.PersistentFlags, utils.GlobalFlags.ValidateFlags)
+	getLogger().Tracef("document: `%s`, isValid=`%t`, actualError=`%T`", document.GetFilename(), isValid, actualError)
+
+	return
+}
+
 // Tests *ErrorInvalidSBOM error types and any (lower-level) errors they "wrapped"
 func innerValidateInvalidSBOMInnerError(t *testing.T, filename string, variant string, innerError error) (document *schema.Sbom, schemaErrors []gojsonschema.ResultError, actualError error) {
 	getLogger().Enter()
@@ -277,7 +293,7 @@ func TestValidateForceCustomSchemaCdxSchemaOlder(t *testing.T) {
 
 func TestValidateCdx14ErrorResultsUniqueComponentsJson(t *testing.T) {
 	//utils.GlobalFlags.ValidateFlags.ForcedJsonSchemaFile = TEST_SCHEMA_CDX_1_3_CUSTOM
-	innerValidateError(t,
+	innerValidateErrorBuffered(t,
 		TEST_CDX_1_4_VALIDATE_ERR_COMPONENTS_UNIQUE,
 		SCHEMA_VARIANT_NONE,
 		FORMAT_JSON,
@@ -286,7 +302,7 @@ func TestValidateCdx14ErrorResultsUniqueComponentsJson(t *testing.T) {
 
 func TestValidateCdx14ErrorResultsFormatIriReferencesJson(t *testing.T) {
 	//utils.GlobalFlags.ValidateFlags.ForcedJsonSchemaFile = TEST_SCHEMA_CDX_1_3_CUSTOM
-	innerValidateError(t,
+	innerValidateErrorBuffered(t,
 		TEST_CDX_1_4_VALIDATE_ERR_FORMAT_IRI_REFERENCE,
 		SCHEMA_VARIANT_NONE,
 		FORMAT_JSON,