Streamline formatting of schema list command output

mrutkows · mrutkows · commit ba838f643704 · 2024-02-13T10:41:44.000-06:00
Signed-off-by: Matt Rutkowski &lt;mrutkows@us.ibm.com&gt;
diff --git a/README.md b/README.md
@@ -888,18 +888,21 @@ This command supports the `--format` flag with any of the following values:
 ##### Example: schema list
 
 ```bash
-name                          format     version   variant      file (local)                                     url (remote)
-----                          ------     -------   -------      ------------                                     ------------
-CycloneDX v1.5 (development)  CycloneDX  1.5       development  schema/cyclonedx/1.5/bom-1.5-dev.schema.json     https://raw.githubusercontent.com/CycloneDX/specification/v1.5-dev/schema/bom-1.5.schema.json
-CycloneDX v1.4                CycloneDX  1.4       (latest)     schema/cyclonedx/1.4/bom-1.4.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.4.schema.json
-CycloneDX v1.3 (strict)       CycloneDX  1.3       strict       schema/cyclonedx/1.3/bom-1.3-strict.schema.json  https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.3-strict.schema.json
-CycloneDX v1.3                CycloneDX  1.3       (latest)     schema/cyclonedx/1.3/bom-1.3.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.3.schema.json
-CycloneDX v1.2 (strict)       CycloneDX  1.2       strict       schema/cyclonedx/1.2/bom-1.2-strict.schema.json  https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.2-strict.schema.json
-CycloneDX v1.2                CycloneDX  1.2       (latest)     schema/cyclonedx/1.2/bom-1.2.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.2.schema.json
-SPDX v2.3.1 (development)     SPDX       SPDX-2.3  development  schema/spdx/2.3.1/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/development/v2.3.1/schemas/spdx-schema.json
-SPDX v2.3                     SPDX       SPDX-2.3  (latest)     schema/spdx/2.3/spdx-schema.json                 https://raw.githubusercontent.com/spdx/spdx-spec/development/v2.3/schemas/spdx-schema.json
-SPDX v2.2.2                   SPDX       SPDX-2.2  (latest)     schema/spdx/2.2.2/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/v2.2.2/schemas/spdx-schema.json
-SPDX v2.2.1                   SPDX       SPDX-2.2  2.2.1        schema/spdx/2.2.1/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/v2.2.1/schemas/spdx-schema.json
+name            variant      format     version   file                                             url
+----            -------      ------     -------   ----                                             ---
+CycloneDX v1.6  development  CycloneDX  1.6       schema/cyclonedx/1.6/bom-1.6.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/1.6-dev/schema/bom-1.6.schema.json
+CycloneDX v1.5  (latest)     CycloneDX  1.5       schema/cyclonedx/1.5/bom-1.5.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.5.schema.json
+CycloneDX v1.4  (latest)     CycloneDX  1.4       schema/cyclonedx/1.4/bom-1.4.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.4.schema.json
+CycloneDX v1.4  custom       CycloneDX  1.4       schema/test/bom-1.4-custom.schema.json
+CycloneDX v1.3  (latest)     CycloneDX  1.3       schema/cyclonedx/1.3/bom-1.3.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.3.schema.json
+CycloneDX v1.3  custom       CycloneDX  1.3       schema/test/bom-1.3-custom.schema.json
+CycloneDX v1.3  strict       CycloneDX  1.3       schema/cyclonedx/1.3/bom-1.3-strict.schema.json  https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.3-strict.schema.json
+CycloneDX v1.2  (latest)     CycloneDX  1.2       schema/cyclonedx/1.2/bom-1.2.schema.json         https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.2.schema.json
+CycloneDX v1.2  strict       CycloneDX  1.2       schema/cyclonedx/1.2/bom-1.2-strict.schema.json  https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.2-strict.schema.json
+SPDX v2.3       (latest)     SPDX       SPDX-2.3  schema/spdx/2.3/spdx-schema.json                 https://raw.githubusercontent.com/spdx/spdx-spec/development/v2.3/schemas/spdx-schema.json
+SPDX v2.3.1     development  SPDX       SPDX-2.3  schema/spdx/2.3.1/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/development/v2.3.1/schemas/spdx-schema.json
+SPDX v2.2.2     (latest)     SPDX       SPDX-2.2  schema/spdx/2.2.2/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/v2.2.2/schemas/spdx-schema.json
+SPDX v2.2.1     2.2.1        SPDX       SPDX-2.2  schema/spdx/2.2.1/spdx-schema.json               https://raw.githubusercontent.com/spdx/spdx-spec/v2.2.1/schemas/spdx-schema.json
 ```
 
 #### Adding schemas
diff --git a/cmd/schema.go b/cmd/schema.go
@@ -48,20 +48,20 @@ const (
 )
 
 const (
-	SCHEMA_DATA_KEY_KEY_NAME    = "name"    // summary
-	SCHEMA_DATA_KEY_KEY_FORMAT  = "format"  // summary
-	SCHEMA_DATA_KEY_KEY_VERSION = "version" // summary
-	SCHEMA_DATA_KEY_KEY_VARIANT = "variant" // summary
 	SCHEMA_DATA_KEY_KEY_FILE    = "file"    // summary
+	SCHEMA_DATA_KEY_KEY_FORMAT  = "format"  // summary
+	SCHEMA_DATA_KEY_KEY_NAME    = "name"    // summary
 	SCHEMA_DATA_KEY_KEY_SOURCE  = "url"     // summary
+	SCHEMA_DATA_KEY_KEY_VARIANT = "variant" // summary
+	SCHEMA_DATA_KEY_KEY_VERSION = "version" // summary
 )
 
 // NOTE: columns will be output in order they are listed here:
 var SCHEMA_LIST_ROW_DATA = []ColumnFormatData{
 	{SCHEMA_DATA_KEY_KEY_NAME, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
+	{SCHEMA_DATA_KEY_KEY_VARIANT, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
 	{SCHEMA_DATA_KEY_KEY_FORMAT, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
 	{SCHEMA_DATA_KEY_KEY_VERSION, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
-	{SCHEMA_DATA_KEY_KEY_VARIANT, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
 	{SCHEMA_DATA_KEY_KEY_FILE, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
 	{SCHEMA_DATA_KEY_KEY_SOURCE, DEFAULT_COLUMN_TRUNCATE_LENGTH, REPORT_SUMMARY_DATA_TRUE, false},
 }
@@ -237,7 +237,7 @@ func DisplaySchemasTabbedText(writer io.Writer, filteredSchemas []schema.FormatS
 	w := new(tabwriter.Writer)
 
 	// min-width, tab-width, padding, pad-char, flags
-	w.Init(writer, 8, 2, 2, ' ', 0)
+	w.Init(writer, 2, 2, 2, ' ', 0)
 	defer w.Flush()
 
 	// Emit no schemas found warning into output
@@ -261,9 +261,9 @@ func DisplaySchemasTabbedText(writer io.Writer, filteredSchemas []schema.FormatS
 
 		fmt.Fprintf(w, "%v\t%s\t%s\t%s\t%s\t%s\n",
 			schemaInstance.Name,
+			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.Format,
 			schemaInstance.Version,
-			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.File,
 			schemaInstance.Url,
 		)
@@ -307,9 +307,9 @@ func DisplaySchemasMarkdown(writer io.Writer, filteredSchemas []schema.FormatSch
 
 		line = append(line,
 			schemaInstance.Name,
+			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.Format,
 			schemaInstance.Version,
-			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.File,
 			schemaInstance.Url,
 		)
@@ -356,9 +356,9 @@ func DisplaySchemasCSV(writer io.Writer, filteredSchemas []schema.FormatSchemaIn
 		line = nil
 		line = append(line,
 			schemaInstance.Name,
+			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.Format,
 			schemaInstance.Version,
-			schema.FormatSchemaVariant(schemaInstance.Variant),
 			schemaInstance.File,
 			schemaInstance.Url,
 		)
diff --git a/cmd/validate_cdx_test.go b/cmd/validate_cdx_test.go
@@ -65,6 +65,7 @@ func TestValidateCdx15MinRequiredBasic(t *testing.T) {
 
 func TestValidateCdx16MinRequiredBasic(t *testing.T) {
 	vti := NewValidateTestInfoMinimum(TEST_CDX_1_6_MIN_REQUIRED)
+	vti.SchemaVariant = SCHEMA_VARIANT_DEVELOPMENT
 	innerTestValidate(t, *vti)
 }
 
diff --git a/cmd/validate_custom_test.go b/cmd/validate_custom_test.go
@@ -28,7 +28,6 @@ import (
 
 // Custom JSON schema files for testing
 const (
-	SCHEMA_VARIANT_CUSTOM      = "custom"
 	TEST_SCHEMA_CDX_1_3_CUSTOM = "resources/schema/test/bom-1.3-custom.schema.json"
 	TEST_SCHEMA_CDX_1_4_CUSTOM = "resources/schema/test/bom-1.4-custom.schema.json"
 )
diff --git a/cmd/validate_test.go b/cmd/validate_test.go
@@ -34,7 +34,9 @@ import (
 )
 
 const (
-	SCHEMA_VARIANT_NONE = ""
+	SCHEMA_VARIANT_NONE        = ""
+	SCHEMA_VARIANT_DEVELOPMENT = "development"
+	SCHEMA_VARIANT_CUSTOM      = "custom"
 )
 
 // JSON SBOM files containing syntax errors for testing
diff --git a/resources/config/config.json b/resources/config/config.json
@@ -36,7 +36,7 @@
                 {
                     "version": "SPDX-2.3",
                     "variant": "development",
-                    "name": "SPDX v2.3.1 (development)",
+                    "name": "SPDX v2.3.1",
                     "file": "schema/spdx/2.3.1/spdx-schema.json",
                     "development": "https://github.com/spdx/spdx-spec/blob/development/v2.3.1/schemas/spdx-schema.json",
                     "url": "https://raw.githubusercontent.com/spdx/spdx-spec/development/v2.3.1/schemas/spdx-schema.json",
@@ -62,7 +62,7 @@
                 {
                     "version": "1.2",
                     "variant": "strict",
-                    "name": "CycloneDX v1.2 (strict)",
+                    "name": "CycloneDX v1.2",
                     "file": "schema/cyclonedx/1.2/bom-1.2-strict.schema.json",
                     "development": "https://github.com/CycloneDX/specification/blob/master/schema/bom-1.2-strict.schema.json",
                     "url": "https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.2-strict.schema.json",
@@ -80,7 +80,7 @@
                 {
                     "version": "1.3",
                     "variant": "strict",
-                    "name": "CycloneDX v1.3 (strict)",
+                    "name": "CycloneDX v1.3",
                     "file": "schema/cyclonedx/1.3/bom-1.3-strict.schema.json",
                     "development": "https://github.com/CycloneDX/specification/blob/master/schema/bom-1.3-strict.schema.json",
                     "url": "https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.3-strict.schema.json",
@@ -93,7 +93,7 @@
                     "file": "schema/cyclonedx/1.4/bom-1.4.schema.json",
                     "development": "https://github.com/CycloneDX/specification/blob/master/schema/bom-1.4.schema.json",
                     "url": "https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.4.schema.json",
-                    "default": true
+                    "default": false
                 },
                 {
                     "version": "1.5",
@@ -102,12 +102,12 @@
                     "file": "schema/cyclonedx/1.5/bom-1.5.schema.json",
                     "development": "https://github.com/CycloneDX/specification/blob/master/schema/bom-1.5.schema.json",
                     "url": "https://raw.githubusercontent.com/CycloneDX/specification/master/schema/bom-1.5.schema.json",
-                    "default": false
+                    "default": true
                 },
                 {
                     "version": "1.6",
-                    "variant": "",
-                    "name": "CycloneDX v1.6 (pre-release)",
+                    "variant": "development",
+                    "name": "CycloneDX v1.6",
                     "file": "schema/cyclonedx/1.6/bom-1.6.schema.json",
                     "development": "https://github.com/CycloneDX/specification/blob/1.6-dev/schema/bom-1.6.schema.json",
                     "url": "https://raw.githubusercontent.com/CycloneDX/specification/1.6-dev/schema/bom-1.6.schema.json",
@@ -116,7 +116,7 @@
                 {
                     "version": "1.3",
                     "variant": "custom",
-                    "name": "CycloneDX v1.3 (custom)",
+                    "name": "CycloneDX v1.3",
                     "file": "schema/test/bom-1.3-custom.schema.json",
                     "development":"https://github.com/CycloneDX/sbom-utility/blob/main/resources/schema/test/bom-1.3-custom.schema.json",
                     "url": "",
@@ -125,7 +125,7 @@
                 {
                     "version": "1.4",
                     "variant": "custom",
-                    "name": "CycloneDX v1.4 (custom)",
+                    "name": "CycloneDX v1.4",
                     "file": "schema/test/bom-1.4-custom.schema.json",
                     "development":"https://github.com/CycloneDX/sbom-utility/blob/main/resources/schema/test/bom-1.4-custom.schema.json",
                     "url": "",

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ func TestValidateCdx15MinRequiredBasic(t *testing.T) {`
`65`	`65`
`66`	`66`	`func TestValidateCdx16MinRequiredBasic(t *testing.T) {`
`67`	`67`	`vti := NewValidateTestInfoMinimum(TEST_CDX_1_6_MIN_REQUIRED)`
	`68`	`+ vti.SchemaVariant = SCHEMA_VARIANT_DEVELOPMENT`
`68`	`69`	`innerTestValidate(t, *vti)`
`69`	`70`	`}`
`70`	`71`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ import (`
`28`	`28`
`29`	`29`	`// Custom JSON schema files for testing`
`30`	`30`	`const (`
`31`		`- SCHEMA_VARIANT_CUSTOM = "custom"`
`32`	`31`	`TEST_SCHEMA_CDX_1_3_CUSTOM = "resources/schema/test/bom-1.3-custom.schema.json"`
`33`	`32`	`TEST_SCHEMA_CDX_1_4_CUSTOM = "resources/schema/test/bom-1.4-custom.schema.json"`
`34`	`33`	`)`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,9 @@ import (`
`34`	`34`	`)`
`35`	`35`
`36`	`36`	`const (`
`37`		`- SCHEMA_VARIANT_NONE = ""`
	`37`	`+ SCHEMA_VARIANT_NONE = ""`
	`38`	`+ SCHEMA_VARIANT_DEVELOPMENT = "development"`
	`39`	`+ SCHEMA_VARIANT_CUSTOM = "custom"`
`38`	`40`	`)`
`39`	`41`
`40`	`42`	`// JSON SBOM files containing syntax errors for testing`