Support schema error results to be output in JSON format including custom format flags #40

mrutkows · 2023-06-21T21:02:32Z

Provides requested JSON format for issue/fixes: #36
and goes beyond that preparing for customized error handlers to better format verbose errors (and lay the foundation for de-duplication) which is part of this issue: #37

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

sonatype-lift · 2023-06-21T21:03:47Z

cmd/errors.go

 func (base BaseError) AppendMessage(addendum string) {
 	// Ignore (invalid) static linting message:
 	// "ineffective assignment to field (SA4005)"
-	base.Message += addendum
+	base.Message += addendum //nolint:staticcheck


SA4005: ineffective assignment to field BaseError.Message

ℹ️ Expand to see all @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

sonatype-lift · 2023-06-21T21:03:49Z

cmd/resource.go

@@ -187,7 +188,7 @@ func resourceCmdImpl(cmd *cobra.Command, args []string) (err error) {
 	var resourceType string
 	resourceType, err = retrieveResourceType(cmd)

-	ListResources(writer, utils.GlobalFlags.OutputFormat, resourceType, whereFilters)
+	ListResources(writer, utils.GlobalFlags.PersistentFlags.OutputFormat, resourceType, whereFilters)


G104: Errors unhandled.

ℹ️ Expand to see all @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

…an old file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>

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

sonatype-lift · 2023-06-23T14:34:43Z

cmd/validate.go

@@ -142,7 +165,7 @@ func processValidationResults(document *schema.Sbom, valid bool, err error) {
 			// Note: InvalidSBOMError type errors include schema errors which have already
 			// been added to the error type and will shown with the Error() interface
 			if valid {
-				getLogger().Errorf("invalid state: error (%T) returned, but SBOM valid !!!", t)
+				getLogger().Errorf("invalid state: error (%T) returned, but SBOM valid!", t)


G104: Errors unhandled.

ℹ️ Expand to see all @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

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

mrutkows · 2023-06-26T20:57:32Z

Fixes #26

…stom format flags (CycloneDX#40) * Create a framework for validation error special case handling Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Create a framework for validation error special case handling Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust JSON output formatting as an array Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Separate format related functions into their own file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Separate format related functions into their own file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Format value for unique item error Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Consolidate validation flags and use on top-level API call Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust JSON error result output prefix and indent Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add validation test case for bad iri-format Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add validation test case for bad iri-format Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Consolidate persistent command flags into a struct Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * represent array type, index and item as a map in json error results Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Support flag true|false on validate command Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Fix even more Sonatype errors that seem to chnage every time I touch an old file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust help for validate given new formats/flags Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update README to show validate JSON output and new flags Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * buffer JSON output for unit tests Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Streamline json and text formatting paths Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust colorized indent to match normal indent Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add additional test assertions to validate # errs and error conext Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Assure forced schema file tests reset to default schema Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> --------- Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>

* replace deprecated ioutil functions Signed-off-by: ajistrying <ajistrying@gmail.com> * remove comments Signed-off-by: ajistrying <ajistrying@gmail.com> * G304 suppress warnings Signed-off-by: ajistrying <ajistrying@gmail.com> Signed-off-by: ajistrying <ajistrying@gmail.com> * Support schema error results to be ouptut in JSON format including custom format flags (#40) * Create a framework for validation error special case handling Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Create a framework for validation error special case handling Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust JSON output formatting as an array Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Use an ordered map to control JSON output marshaling order Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Separate format related functions into their own file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Separate format related functions into their own file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Format value for unique item error Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Consolidate validation flags and use on top-level API call Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust JSON error result output prefix and indent Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add validation test case for bad iri-format Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add validation test case for bad iri-format Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Consolidate persistent command flags into a struct Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * represent array type, index and item as a map in json error results Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Support flag true|false on validate command Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Fix even more Sonatype errors that seem to chnage every time I touch an old file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust help for validate given new formats/flags Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update README to show validate JSON output and new flags Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * buffer JSON output for unit tests Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Update the text format logic to mirror new json formatting Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Streamline json and text formatting paths Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Adjust colorized indent to match normal indent Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add additional test assertions to validate # errs and error conext Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Assure forced schema file tests reset to default schema Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> --------- Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add CycloneDX v1.5 JSON schema and update resource config (#41) * Add CycloneDX v1.5 JSON schema and update resource config Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add minimal tests for 1.5 schema Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Add minimal tests for 1.5 schema Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> --------- Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> Signed-off-by: ajistrying <ajistrying@gmail.com> * Remove invalid output file warning (#42) Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> Signed-off-by: ajistrying <ajistrying@gmail.com> * Put back inputFilename as parm. in os.ReadFile() call Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Attempt to ignore underlying golang sonatype error Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Attempt to ignore underlying golang sonatype error Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> * Attempt to ignore underlying golang sonatype error Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> --------- Signed-off-by: ajistrying <ajistrying@gmail.com> Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com> Co-authored-by: Matt Rutkowski <mrutkows@us.ibm.com>

mrutkows added 17 commits June 16, 2023 13:57

Create a framework for validation error special case handling

47bbdcc

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

Create a framework for validation error special case handling

2688048

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

Adjust JSON output formatting as an array

8369472

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

Use an ordered map to control JSON output marshaling order

bfa6985

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

Use an ordered map to control JSON output marshaling order

7776c34

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

Use an ordered map to control JSON output marshaling order

09bf70a

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

Use an ordered map to control JSON output marshaling order

fd9cba3

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

Separate format related functions into their own file

bc89b66

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

Separate format related functions into their own file

086f09d

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

Format value for unique item error

55810a6

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

Consolidate validation flags and use on top-level API call

54449f2

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

Adjust JSON error result output prefix and indent

e3bf5c4

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

Add validation test case for bad iri-format

7d23529

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

Add validation test case for bad iri-format

38511c1

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

Consolidate persistent command flags into a struct

292a82d

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

represent array type, index and item as a map in json error results

4ab94f6

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

Support flag true|false on validate command

5b57e38

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

mrutkows added the enhancement New feature or request label Jun 21, 2023

mrutkows self-assigned this Jun 21, 2023

sonatype-lift bot reviewed Jun 21, 2023

View reviewed changes

Fix even more Sonatype errors that seem to chnage every time I touch …

a630b7e

…an old file Signed-off-by: Matt Rutkowski <mrutkows@us.ibm.com>

This was referenced Jun 22, 2023

replace deprecated ioutil package functions with latest advised io and os package replacements #39

Closed

Enhancement: Summarize "duplicate components" schema error #37

Open

mrutkows added 4 commits June 22, 2023 10:41

Adjust help for validate given new formats/flags

16f8ce6

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

Update README to show validate JSON output and new flags

ff1c278

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

buffer JSON output for unit tests

7258d9e

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

Update the text format logic to mirror new json formatting

577e945

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

sonatype-lift bot reviewed Jun 23, 2023

View reviewed changes

Update the text format logic to mirror new json formatting

b02cebc

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

mrutkows added 5 commits June 23, 2023 10:30

Update the text format logic to mirror new json formatting

bf72268

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

Streamline json and text formatting paths

ac503d5

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

Adjust colorized indent to match normal indent

d646e3e

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

Add additional test assertions to validate # errs and error conext

62deaed

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

Assure forced schema file tests reset to default schema

64af463

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

mrutkows merged commit 5c10806 into main Jun 26, 2023

mrutkows deleted the schema-errs branch June 26, 2023 20:56

mrutkows mentioned this pull request Jun 26, 2023

Add flag to output JSON errors from the validate command #26

Closed

mrutkows mentioned this pull request Jun 29, 2023

Add custom JSON Marshallers functions for CycloneDX vulnerability data structures #25

Open

mrutkows changed the title ~~Support schema error results to be ouptut in JSON format including custom format flags~~ Support schema error results to be output in JSON format including custom format flags Jul 12, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support schema error results to be output in JSON format including custom format flags #40

Support schema error results to be output in JSON format including custom format flags #40

mrutkows commented Jun 21, 2023 •

edited

Loading

sonatype-lift bot Jun 21, 2023

sonatype-lift bot Jun 21, 2023

sonatype-lift bot Jun 23, 2023

mrutkows commented Jun 26, 2023

Command	Usage
`@sonatype-lift ignore`	Leave out the above finding from this PR
`@sonatype-lift ignoreall`	Leave out all the existing findings from this PR
`@sonatype-lift exclude <file\|issue\|path\|tool>`	Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file

Support schema error results to be output in JSON format including custom format flags #40

Support schema error results to be output in JSON format including custom format flags #40

Conversation

mrutkows commented Jun 21, 2023 • edited Loading

sonatype-lift bot Jun 21, 2023

Choose a reason for hiding this comment

sonatype-lift bot Jun 21, 2023

Choose a reason for hiding this comment

sonatype-lift bot Jun 23, 2023

Choose a reason for hiding this comment

mrutkows commented Jun 26, 2023

mrutkows commented Jun 21, 2023 •

edited

Loading