-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: consider severity flag for JSON and YAML format (#512)
* fix: consider severity flag for JSON and YAML format * feat: add tests around summary and severity
- Loading branch information
Showing
4 changed files
with
247 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| (map[string][]summary.Result) (len=1) { | ||
| (string) (len=8) "critical": ([]summary.Result) (len=2) { | ||
| (summary.Result) { | ||
| PolicyName: (string) "", | ||
| PolicyDSRID: (string) (len=5) "DSR-5", | ||
| PolicyDisplayId: (string) (len=17) "ruby_rails_logger", | ||
| PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.", | ||
| LineNumber: (int) 1, | ||
| Filename: (string) (len=20) "pkg/datatype_leak.rb", | ||
| CategoryGroups: ([]string) (len=2) { | ||
| (string) (len=3) "PII", | ||
| (string) (len=13) "Personal Data" | ||
| }, | ||
| ParentLineNumber: (int) 1, | ||
| ParentContent: (string) (len=29) "Rails.logger.info(user.email)", | ||
| OmitParent: (bool) false, | ||
| DetailedContext: (string) "" | ||
| }, | ||
| (summary.Result) { | ||
| PolicyName: (string) "", | ||
| PolicyDSRID: (string) (len=5) "DSR-5", | ||
| PolicyDisplayId: (string) (len=17) "ruby_rails_logger", | ||
| PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.", | ||
| LineNumber: (int) 2, | ||
| Filename: (string) (len=20) "pkg/datatype_leak.rb", | ||
| CategoryGroups: ([]string) (len=2) { | ||
| (string) (len=3) "PII", | ||
| (string) (len=13) "Personal Data" | ||
| }, | ||
| ParentLineNumber: (int) 2, | ||
| ParentContent: (string) (len=41) "Rails.logger.info(user.browsing_behavior)", | ||
| OmitParent: (bool) false, | ||
| DetailedContext: (string) "" | ||
| } | ||
| } | ||
| } |
36 changes: 36 additions & 0 deletions
36
pkg/report/output/summary/.snapshots/TestSummaryWithSeverity
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| (map[string][]summary.Result) (len=1) { | ||
| (string) (len=8) "critical": ([]summary.Result) (len=2) { | ||
| (summary.Result) { | ||
| PolicyName: (string) "", | ||
| PolicyDSRID: (string) (len=5) "DSR-5", | ||
| PolicyDisplayId: (string) (len=17) "ruby_rails_logger", | ||
| PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.", | ||
| LineNumber: (int) 1, | ||
| Filename: (string) (len=20) "pkg/datatype_leak.rb", | ||
| CategoryGroups: ([]string) (len=2) { | ||
| (string) (len=3) "PII", | ||
| (string) (len=13) "Personal Data" | ||
| }, | ||
| ParentLineNumber: (int) 1, | ||
| ParentContent: (string) (len=29) "Rails.logger.info(user.email)", | ||
| OmitParent: (bool) false, | ||
| DetailedContext: (string) "" | ||
| }, | ||
| (summary.Result) { | ||
| PolicyName: (string) "", | ||
| PolicyDSRID: (string) (len=5) "DSR-5", | ||
| PolicyDisplayId: (string) (len=17) "ruby_rails_logger", | ||
| PolicyDescription: (string) (len=38) "Do not send sensitive data to loggers.", | ||
| LineNumber: (int) 2, | ||
| Filename: (string) (len=20) "pkg/datatype_leak.rb", | ||
| CategoryGroups: ([]string) (len=2) { | ||
| (string) (len=3) "PII", | ||
| (string) (len=13) "Personal Data" | ||
| }, | ||
| ParentLineNumber: (int) 2, | ||
| ParentContent: (string) (len=41) "Rails.logger.info(user.browsing_behavior)", | ||
| OmitParent: (bool) false, | ||
| DetailedContext: (string) "" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| package summary_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/bearer/curio/pkg/commands/process/settings" | ||
| "github.com/bearer/curio/pkg/flag" | ||
| "github.com/bearer/curio/pkg/report/output/dataflow" | ||
| "github.com/bearer/curio/pkg/report/output/dataflow/types" | ||
| "github.com/bearer/curio/pkg/report/output/summary" | ||
| "github.com/bearer/curio/pkg/report/schema" | ||
| "github.com/bradleyjkemp/cupaloy" | ||
| ) | ||
|
|
||
| func TestSummary(t *testing.T) { | ||
| config, err := generateConfig(flag.ReportOptions{ | ||
| Report: "summary", | ||
| Severity: map[string]bool{ | ||
| "critical": true, | ||
| "high": true, | ||
| "medium": true, | ||
| "low": true, | ||
| "warning": true, | ||
| }, | ||
| }) | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("failed to generate config:%s", err) | ||
| } | ||
|
|
||
| dataflow := dummyDataflow() | ||
|
|
||
| res, err := summary.GetOutput(&dataflow, config) | ||
| if err != nil { | ||
| t.Fatalf("failed to generate summary output err:%s", err) | ||
| } | ||
|
|
||
| cupaloy.SnapshotT(t, res) | ||
| } | ||
|
|
||
| func TestSummaryWithSeverity(t *testing.T) { | ||
| config, err := generateConfig(flag.ReportOptions{ | ||
| Report: "summary", | ||
| Severity: map[string]bool{ | ||
| "critical": true, | ||
| "high": true, | ||
| "medium": false, | ||
| "low": false, | ||
| "warning": false, | ||
| }, | ||
| }) | ||
|
|
||
| if err != nil { | ||
| t.Fatalf("failed to generate config:%s", err) | ||
| } | ||
|
|
||
| dataflow := dummyDataflow() | ||
|
|
||
| res, err := summary.GetOutput(&dataflow, config) | ||
| if err != nil { | ||
| t.Fatalf("failed to generate summary output err:%s", err) | ||
| } | ||
|
|
||
| cupaloy.SnapshotT(t, res) | ||
| } | ||
|
|
||
| func generateConfig(reportOptions flag.ReportOptions) (settings.Config, error) { | ||
| opts := flag.Options{ | ||
| ScanOptions: flag.ScanOptions{}, | ||
| RuleOptions: flag.RuleOptions{}, | ||
| RepoOptions: flag.RepoOptions{}, | ||
| ReportOptions: reportOptions, | ||
| GeneralOptions: flag.GeneralOptions{}, | ||
| } | ||
|
|
||
| return settings.FromOptions(opts) | ||
| } | ||
|
|
||
| func dummyDataflow() dataflow.DataFlow { | ||
| subject := "User" | ||
| loggerRisk := types.RiskDetector{ | ||
| DetectorID: "ruby_rails_logger", | ||
| DataTypes: []types.RiskDatatype{ | ||
| { | ||
| Name: "Email Address", | ||
| Stored: false, | ||
| UUID: "22e24c62-82d3-4b72-827c-e261533331bd", | ||
| CategoryUUID: "cef587dd-76db-430b-9e18-7b031e1a193b", | ||
| Locations: []types.RiskLocation{ | ||
| { | ||
| Filename: "pkg/datatype_leak.rb", | ||
| LineNumber: 1, | ||
| FieldName: "email", | ||
| ObjectName: "user", | ||
| SubjectName: &subject, | ||
| Parent: &schema.Parent{ | ||
| LineNumber: 1, | ||
| Content: "Rails.logger.info(user.email)", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Name: "Browsing Behavior", | ||
| Stored: false, | ||
| UUID: "c73ae276-b1b1-4b70-b6d5-ed73a83e87ed", | ||
| CategoryUUID: "8099225c-7e49-414f-aac2-e7045379bb40", | ||
| Locations: []types.RiskLocation{ | ||
| { | ||
| Filename: "pkg/datatype_leak.rb", | ||
| LineNumber: 2, | ||
| FieldName: "browsing_behavior", | ||
| ObjectName: "user", | ||
| SubjectName: &subject, | ||
| Parent: &schema.Parent{ | ||
| LineNumber: 2, | ||
| Content: "Rails.logger.info(user.browsing_behavior)", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| risks := make([]interface{}, 1) | ||
| risks[0] = loggerRisk | ||
|
|
||
| return dataflow.DataFlow{ | ||
| Datatypes: []types.Datatype{ | ||
| { | ||
| Name: "Email Address", | ||
| UUID: "22e24c62-82d3-4b72-827c-e261533331bd", | ||
| CategoryUUID: "cef587dd-76db-430b-9e18-7b031e1a193b", | ||
| Detectors: []types.DatatypeDetector{ | ||
| { | ||
| Name: "ruby", | ||
| Locations: []types.DatatypeLocation{ | ||
| { | ||
| Filename: "pkg/datatype_leak.rb", | ||
| LineNumber: 1, | ||
| FieldName: "email", | ||
| ObjectName: "user", | ||
| SubjectName: &subject, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| Name: "Browsing Behavior", | ||
| UUID: "c73ae276-b1b1-4b70-b6d5-ed73a83e87ed", | ||
| CategoryUUID: "8099225c-7e49-414f-aac2-e7045379bb40", | ||
| Detectors: []types.DatatypeDetector{ | ||
| { | ||
| Name: "ruby", | ||
| Locations: []types.DatatypeLocation{ | ||
| { | ||
| Filename: "pkg/datatype_leak.rb", | ||
| LineNumber: 2, | ||
| FieldName: "browsing_behavior", | ||
| ObjectName: "user", | ||
| SubjectName: &subject, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| Risks: risks, | ||
| Components: []types.Component{}, | ||
| } | ||
| } |