Merge pull request #70 from easy-up/main

BacchusJackson · web-flow · commit b0d7a99e3f7f · 2024-12-11T11:40:02.000-06:00
fix: crash bug when adding a bundle file with no tag
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [UNRELEASED]
 
+## [0.8.0] - 2024-10-23
+
+* Fixed a bug where validation failures were not resulting in a non-zero exit code
+* Renamed the --file / -f CLI argument to --config / -f for consistency with other tools
+* improvements to validate output  
+   These "improvements" are short term hacks. There is a need for a fundamental
+   overhaul of how output is generated to improve usability
+* Implemented code coverage support.
+* Updated the docs to reflect the removal of the --all flag
+
+## [0.7.6] - 2024-09-08
+
+### Fixed
+
+- Crash when running `gatecheck bundle add` with no tags
+
 ## [0.7.5] - 2024-06-18
 
 ### Fixed
diff --git a/cmd/cli-config.go b/cmd/cli-config.go
@@ -45,7 +45,7 @@ var RuntimeConfig = metaConfig{
 	BundleTag: configkit.MetaField{
 		FieldName:    "BundleTag",
 		EnvKey:       "GATECHECK_BUNDLE_TAG",
-		DefaultValue: "",
+		DefaultValue: []string{},
 		FlagValueP:   new([]string),
 		EnvToValueFunc: func(s string) any {
 			return strings.Split(s, ",")
@@ -165,7 +165,7 @@ var RuntimeConfig = metaConfig{
 		CobraSetupFunc: func(f configkit.MetaField, cmd *cobra.Command) {
 			valueP := f.FlagValueP.(*string)
 			usage := f.Metadata[metadataFlagUsage]
-			cmd.PersistentFlags().StringVarP(valueP, "file", "f", "", usage)
+			cmd.PersistentFlags().StringVarP(valueP, "config", "f", "", usage)
 		},
 		Metadata: map[string]string{
 			metadataFlagUsage:       "a validation configuration file",
diff --git a/cmd/validate.go b/cmd/validate.go
@@ -69,7 +69,7 @@ var validateCmd = &cobra.Command{
 			return nil
 		}
 
-		return nil
+		return err
 	},
 }
 
diff --git a/demos/bundle.tape b/demos/bundle.tape
@@ -10,7 +10,7 @@ Set Width 1800
 
 Output dist/gatecheck-bundle.gif
 
-Type "gatecheck ls --all grype-report.json | less"
+Type "gatecheck ls grype-report.json | less"
 Sleep 1
 Enter
 Sleep 5
diff --git a/demos/list.tape b/demos/list.tape
@@ -10,7 +10,7 @@ Set Width 1600
 
 Output dist/gatecheck-list.gif
 
-Type "grype ubuntu:latest -o json | gatecheck ls --all -i grype | less"
+Type "grype ubuntu:latest -o json | gatecheck ls -i grype | less"
 Sleep 1
 Enter
 
diff --git a/demos/validate.tape b/demos/validate.tape
@@ -10,7 +10,7 @@ Set Width 1700
 
 Output dist/gatecheck-validate.gif
 
-Type "gatecheck ls --all grype-report.json | less"
+Type "gatecheck ls grype-report.json | less"
 Sleep 1
 Enter
 Sleep 5
diff --git a/docs/assets/screenshot-grype-list-all.png b/docs/assets/screenshot-grype-list-all.png
diff --git a/docs/list-reports.md b/docs/list-reports.md
@@ -22,11 +22,3 @@ gatecheck ls grype-scan-report.json
 ```
 
 ![Screenshot Example List](assets/screenshot-grype-list.png)
-
-Using the `--all` or `-a` flag will do a full listing, cross-referencing with FIRST EPSS API
-
-```shell
-grype bkimminich/juice-shop:latest -o json | gatecheck ls --all -i grype
-```
-
-![Screenshot Example List All](assets/screenshot-grype-list-all.png)
diff --git a/go.mod b/go.mod
@@ -14,6 +14,7 @@ require (
 )
 
 require (
+	github.com/easy-up/go-coverage v0.0.0-20241018034313-3de592d59a78 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
diff --git a/go.sum b/go.sum
@@ -5,6 +5,8 @@ github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
 github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
+github.com/easy-up/go-coverage v0.0.0-20241018034313-3de592d59a78 h1:e2x+TfIgebN3zfr8wGqAYI9lK4ql7Rut6OTEhBmJr5k=
+github.com/easy-up/go-coverage v0.0.0-20241018034313-3de592d59a78/go.mod h1:fsSINOc273zPnsBaKNjNffZXZpicAArpv/cTiFYgPys=
 github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
 github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA=
diff --git a/pkg/archive/bundle.go b/pkg/archive/bundle.go
@@ -10,6 +10,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/olekukonko/tablewriter"
 	"io"
 	"log/slog"
 	"os"
@@ -159,7 +160,10 @@ func (b *Bundle) Content() string {
 	sort.Sort(matrix)
 	buf := new(bytes.Buffer)
 	header := []string{"Label", "Digest", "Tags", "Size"}
-	matrix.Table(buf, header).Render()
+	table := tablewriter.NewWriter(buf)
+	table.SetHeader(header)
+	matrix.Table(table)
+	table.Render()
 	return buf.String()
 }
 
diff --git a/pkg/artifacts/lcov.go b/pkg/artifacts/lcov.go
@@ -0,0 +1,42 @@
+package artifacts
+
+import (
+	"errors"
+	"github.com/easy-up/go-coverage"
+	"log/slog"
+	"strings"
+)
+
+func example() (coverage.Report, error) {
+	lcovParser := coverage.New(coverage.LCOV)
+	report, err := lcovParser.Parse("./path/to/lcov.info")
+	if err != nil {
+		// Handle error
+		return coverage.Report{}, err
+	}
+	// Use the parsed report
+	return report, nil
+}
+
+func IsCoverageReport(inputFilename string) bool {
+	return strings.Contains(inputFilename, "lcov") ||
+		strings.HasSuffix(inputFilename, ".info") ||
+		strings.Contains(inputFilename, "clover") ||
+		strings.Contains(inputFilename, "cobertura") ||
+		strings.Contains(inputFilename, "coverage")
+}
+
+func GetCoverageMode(inputFilename string) (coverage.CoverageMode, error) {
+	var coverageFormat coverage.CoverageMode
+	if strings.Contains(inputFilename, "lcov") || strings.HasSuffix(inputFilename, ".info") {
+		coverageFormat = coverage.LCOV
+	} else if strings.Contains(inputFilename, "clover") {
+		coverageFormat = coverage.CLOVER
+	} else if strings.HasSuffix(inputFilename, ".xml") {
+		coverageFormat = coverage.COBERTURA
+	} else {
+		slog.Error("unsupported coverage file type, cannot be determined from filename", "filename", inputFilename)
+		return "", errors.New("failed to list coverage content")
+	}
+	return coverageFormat, nil
+}
diff --git a/pkg/format/matrix.go b/pkg/format/matrix.go
@@ -1,8 +1,6 @@
 package format
 
 import (
-	"io"
-
 	"github.com/olekukonko/tablewriter"
 )
 
@@ -28,11 +26,8 @@ func (m *SortableMatrix) Matrix() [][]string {
 	return m.data
 }
 
-func (m *SortableMatrix) Table(w io.Writer, header []string) *tablewriter.Table {
-	table := tablewriter.NewWriter(w)
-	table.SetHeader(header)
+func (m *SortableMatrix) Table(table *tablewriter.Table) {
 	table.AppendBulk(m.data)
-	return table
 }
 
 func (m *SortableMatrix) Len() int {
diff --git a/pkg/gatecheck/config.go b/pkg/gatecheck/config.go
@@ -28,6 +28,7 @@ type Config struct {
 	Cyclonedx reportWithCVEs       `json:"cyclonedx" toml:"cyclonedx" yaml:"cyclonedx"`
 	Semgrep   configSemgrepReport  `json:"semgrep"   toml:"semgrep"   yaml:"semgrep"`
 	Gitleaks  configGitleaksReport `json:"gitleaks"  toml:"gitleaks"  yaml:"gitleaks"`
+	Coverage  configCoverageReport `json:"coverage"  toml:"coverage"  yaml:"coverage"`
 }
 
 func (c *Config) String() string {
@@ -48,6 +49,12 @@ func (c *Config) String() string {
 	return contentBuf.String()
 }
 
+type configCoverageReport struct {
+	LineThreshold     float32 `json:"lineThreshold"   toml:"lineThreshold"   yaml:"lineThreshold"`
+	FunctionThreshold float32 `json:"functionThreshold" toml:"functionThreshold" yaml:"functionThreshold"`
+	BranchThreshold   float32 `json:"branchThreshold"  toml:"branchThreshold"  yaml:"branchThreshold"`
+}
+
 type configGitleaksReport struct {
 	LimitEnabled bool `json:"limitEnabled" toml:"limitEnabled" yaml:"limitEnabled"`
 }
@@ -225,6 +232,11 @@ func NewDefaultConfig() *Config {
 		Gitleaks: configGitleaksReport{
 			LimitEnabled: false,
 		},
+		Coverage: configCoverageReport{
+			LineThreshold:     0,
+			FunctionThreshold: 0,
+			BranchThreshold:   0,
+		},
 	}
 }
 
diff --git a/pkg/gatecheck/list.go b/pkg/gatecheck/list.go
diff --git a/pkg/gatecheck/validate.go b/pkg/gatecheck/validate.go

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ var validateCmd = &cobra.Command{`
`69`	`69`	`return nil`
`70`	`70`	`}`
`71`	`71`
`72`		`- return nil`
	`72`	`+ return err`
`73`	`73`	`},`
`74`	`74`	`}`
`75`	`75`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ require (`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`require (`
	`17`	`+ github.com/easy-up/go-coverage v0.0.0-20241018034313-3de592d59a78 // indirect`
`17`	`18`	`github.com/fsnotify/fsnotify v1.7.0 // indirect`
`18`	`19`	`github.com/hashicorp/hcl v1.0.0 // indirect`
`19`	`20`	`github.com/inconshreveable/mousetrap v1.1.0 // indirect`