Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add identifiers to the report metadata section #71

Merged
merged 4 commits into from
Aug 8, 2022
Merged

Add identifiers to the report metadata section #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5094e82
Add identifiers to the report metadata section
rgreinho Jul 20, 2022
9c69490
Merge branch 'main' into metadata/identifiers
rgreinho Jul 25, 2022
61900bc
Merge branch 'main' into metadata/identifiers
rgreinho Jul 26, 2022
7ec92ba
Merge branch 'main' into metadata/identifiers
morwn Jul 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ require (
github.com/alexeyco/simpletable v1.0.0
github.com/argonsecurity/pipeline-parser v0.1.12
github.com/google/go-github/v41 v41.0.0
github.com/google/uuid v1.2.0
github.com/imdario/mergo v0.3.12
github.com/migueleliasweb/go-github-mock v0.0.8
github.com/rs/zerolog v1.26.1
Expand Down
1 change: 1 addition & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,7 @@ github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm4
github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/google/uuid v1.2.0 h1:qJYtXnJRWmpe7m/3XlyhrsLrEURqHRM2kxzoxXqyUDs=
github.com/google/uuid v1.2.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/googleapis/gax-go/v2 v2.0.4/go.mod h1:0Wqv26UfaUD9n4G6kQubkQ+KchISgw+vpHVxEJEs9eg=
github.com/googleapis/gax-go/v2 v2.0.5/go.mod h1:DWXyrwAJ9X0FpwwEdw+IPEYBICEFu5mhpdKc/us6bOk=
Expand Down
2 changes: 1 addition & 1 deletion internal/commands/scan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func NewScanCommand() *cobra.Command {
checks := checks.GetChecks(assetsData)
results, errors := checker.RunChecks(assetsData, chainbenchConfig, checks)

printer.PrintFindings(results, outputFilePath, isQuiet)
printer.PrintFindings(results, outputFilePath, isQuiet, repositoryUrl)
printer.PrintErrors(errors)
elapsed := time.Since(start)
logger.Infof("Scan completed: %s", elapsed.Round(time.Millisecond))
Expand Down
7 changes: 6 additions & 1 deletion internal/printer/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"time"

"github.com/aquasecurity/chain-bench/internal/models/checkmodels"
"github.com/google/uuid"
)

var (
Expand All @@ -28,7 +29,9 @@ type reportResult struct {

type reportMetadata struct {
Date string `json:"date"`
ScanID uuid.UUID `json:"scan_id"`
Statistics Statistics `json:"statistics"`
Url string `json:"url,omitempty"`
}

type reportResults struct {
Expand All @@ -41,12 +44,14 @@ func println(msg string) {
fmt.Fprintln(output, msg)
}

func PrintOutputToFile(data []checkmodels.CheckRunResult, outputFilePath string) {
func PrintOutputToFile(data []checkmodels.CheckRunResult, outputFilePath string, repositoryUrl string) {
reportRes, statistics := getPrintFormat(data)

// Populate the report metadata.
reportMetadata := reportMetadata{
Date: time.Now().Format(time.RFC3339),
ScanID: uuid.New(),
Url: repositoryUrl,
Statistics: statistics,
}

Expand Down
4 changes: 2 additions & 2 deletions internal/printer/printer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ func init() {
table.SetStyle(simpletable.StyleCompactLite)
}

func PrintFindings(results []checkmodels.CheckRunResult, outputFilePath string, isQuiet bool) {
func PrintFindings(results []checkmodels.CheckRunResult, outputFilePath string, isQuiet bool, repositoryUrl string) {
sortResuls(results)
if outputFilePath != "" {
PrintOutputToFile(results, outputFilePath)
PrintOutputToFile(results, outputFilePath, repositoryUrl)
}
if !isQuiet {
s := NewStatistics()
Expand Down