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

fix(output): ordering queries and files on output json #6902

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open

fix(output): ordering queries and files on output json #6902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a97b00a
queries and files sorted on output json
JulioSCX Feb 22, 2024
c8d21dc
lint fix
JulioSCX Feb 23, 2024
2442511
lint fixes
JulioSCX Feb 23, 2024
5a5e949
Merge branch 'master' into kics-1343
JulioSCX Feb 23, 2024
58ec3f6
removed query sorting
JulioSCX Feb 23, 2024
014ca1a
Merge branch 'kics-1343' of https://github.com/Checkmarx/kics into ki…
JulioSCX Feb 23, 2024
81e0c83
Merge branch 'master' into kics-1343
JulioSCX Feb 23, 2024
6890488
Merge branch 'master' into kics-1343
JulioSCX Feb 23, 2024
255663d
changed unit tests
JulioSCX Feb 23, 2024
874458b
Merge branch 'kics-1343' of https://github.com/Checkmarx/kics into ki…
JulioSCX Feb 23, 2024
b143f13
changed tests
JulioSCX Feb 23, 2024
01c2fdc
changed unit tests
JulioSCX Feb 23, 2024
900818a
changed sonarqube unit test
JulioSCX Feb 23, 2024
97ecdf2
Merge branch 'master' into kics-1343
JulioSCX Feb 23, 2024
022beb7
addec back query sorting
JulioSCX Feb 26, 2024
ab30bbc
sorting query by name instead of id
JulioSCX Feb 26, 2024
1e5ef72
Merge branch 'master' into kics-1343
JulioSCX Feb 26, 2024
b378e2b
Merge branch 'master' into kics-1343
JulioSCX Feb 27, 2024
c12abc3
Merge branch 'master' into kics-1343
JulioSCX Feb 27, 2024
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
12 changes: 6 additions & 6 deletions pkg/printer/printer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,20 +111,20 @@ var printTests = []struct {

{
caseTest: test.ComplexSummaryMock,
expectedResult: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\n\t[1]: positive.tf:30\n\t[2]: positive.tf:35\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\n\t[1]: positive.tf:25\n\t[2]: positive.tf:19\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResultFull: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\nDescription: AWS AMI Encryption is not enabled\nPlatform: \nCWE: 22\nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/97707503-a22c-4cd7-b7c0-f088fa7cf830\n\n\t[1]: positive.tf:30\n\n\n\n\t[2]: positive.tf:35\n\n\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/aws/3db3f534-e3a3-487f-88c7-0a9fbf64b702\n\n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nDescription: ALB protocol is HTTP Description\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/de7f5e83-da88-4046-871f-ea18504b1d43\n\n\t[1]: positive.tf:25\n\n\n\n\t[2]: positive.tf:19\n\n\n\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResult: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\n\t[1]: positive.tf:35\n\t[2]: positive.tf:30\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\n\t[1]: positive.tf:19\n\t[2]: positive.tf:25\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResultFull: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\nDescription: AWS AMI Encryption is not enabled\nPlatform: \nCWE: 22\nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/97707503-a22c-4cd7-b7c0-f088fa7cf830\n\n\t[1]: positive.tf:35\n\n\n\n\t[2]: positive.tf:30\n\n\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/aws/3db3f534-e3a3-487f-88c7-0a9fbf64b702\n\n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nDescription: ALB protocol is HTTP Description\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/de7f5e83-da88-4046-871f-ea18504b1d43\n\n\t[1]: positive.tf:19\n\n\n\n\t[2]: positive.tf:25\n\n\n\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
customQueries: false,
},
{
caseTest: test.ComplexSummaryMock,
expectedResult: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\n\t[1]: positive.tf:30\n\t[2]: positive.tf:35\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\n\t[1]: positive.tf:25\n\t[2]: positive.tf:19\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResultFull: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\nDescription: AWS AMI Encryption is not enabled\nPlatform: \nCWE: 22\n\t[1]: positive.tf:30\n\n\n\n\t[2]: positive.tf:35\n\n\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nDescription: ALB protocol is HTTP Description\nPlatform: \n\t[1]: positive.tf:25\n\n\n\n\t[2]: positive.tf:19\n\n\n\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResult: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\n\t[1]: positive.tf:35\n\t[2]: positive.tf:30\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\n\t[1]: positive.tf:19\n\t[2]: positive.tf:25\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
expectedResultFull: "\n\nAMI Not Encrypted, Severity: HIGH, Results: 2\nDescription: AWS AMI Encryption is not enabled\nPlatform: \nCWE: 22\n\t[1]: positive.tf:35\n\n\n\n\t[2]: positive.tf:30\n\n\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nDescription: ALB protocol is HTTP Description\nPlatform: \n\t[1]: positive.tf:19\n\n\n\n\t[2]: positive.tf:25\n\n\n\n\nResults Summary:\nHIGH: 4\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 5\n\n",
customQueries: true,
},
{
caseTest: test.ComplexSummaryMockWithExperimental,
expectedResult: "\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\nNote: this is an experimental query\n\t[1]: positive.tf:25\n\t[2]: positive.tf:19\n\nResults Summary:\nHIGH: 2\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 3\n\n",
expectedResultFull: "\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/aws/3db3f534-e3a3-487f-88c7-0a9fbf64b702\n\n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nNote: this is an experimental query\nDescription: ALB protocol is HTTP Description\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/de7f5e83-da88-4046-871f-ea18504b1d43\n\n\t[1]: positive.tf:25\n\n\n\n\t[2]: positive.tf:19\n\n\n\n\nResults Summary:\nHIGH: 2\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 3\n\n",
expectedResult: "\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\n\t[1]: positive.tf:1\nALB protocol is HTTP, Severity: HIGH, Results: 2\nNote: this is an experimental query\n\t[1]: positive.tf:19\n\t[2]: positive.tf:25\n\nResults Summary:\nHIGH: 2\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 3\n\n",
expectedResultFull: "\n\nAmazonMQ Broker Encryption Disabled, Severity: MEDIUM, Results: 1\nDescription: AmazonMQ Broker should have Encryption Options defined\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/aws/3db3f534-e3a3-487f-88c7-0a9fbf64b702\n\n\t[1]: positive.tf:1\n\n\n\nALB protocol is HTTP, Severity: HIGH, Results: 2\nNote: this is an experimental query\nDescription: ALB protocol is HTTP Description\nPlatform: \nLearn more about this vulnerability: https://docs.kics.io/latest/queries/-queries/de7f5e83-da88-4046-871f-ea18504b1d43\n\n\t[1]: positive.tf:19\n\n\n\n\t[2]: positive.tf:25\n\n\n\n\nResults Summary:\nHIGH: 2\nMEDIUM: 1\nLOW: 0\nINFO: 0\nTOTAL: 3\n\n",
customQueries: false,
},
}
Expand Down
48 changes: 41 additions & 7 deletions pkg/report/json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
package report

import "github.com/Checkmarx/kics/internal/constants"
import (
"sort"

"github.com/Checkmarx/kics/internal/constants"
)

const jsonExtension = ".json"

Expand All @@ -11,12 +15,42 @@ func PrintJSONReport(path, filename string, body interface{}) error {
if err != nil {
return err
}
for idx := range summary.Queries {
summary.Queries[idx].CISBenchmarkName = ""
summary.Queries[idx].CISBenchmarkVersion = ""
summary.Queries[idx].CISDescriptionID = ""
summary.Queries[idx].CISDescriptionText = ""
summary.Queries[idx].CISRationaleText = ""

queries := summary.Queries
sort.SliceStable(queries, func(i, j int) bool {
if queries[i].Severity == queries[j].Severity {
return queries[i].QueryName < queries[j].QueryName
}

return false
})

for idx := range queries {
queries[idx].CISBenchmarkName = ""
queries[idx].CISBenchmarkVersion = ""
queries[idx].CISDescriptionID = ""
queries[idx].CISDescriptionText = ""
queries[idx].CISRationaleText = ""

files := queries[idx].Files
sort.Slice(files, func(i, j int) bool {
if files[i].FileName != files[j].FileName {
return files[i].FileName < files[j].FileName
}

if files[i].SimilarityID != files[j].SimilarityID {
return files[i].SimilarityID < files[j].SimilarityID
}

if files[i].IssueType != files[j].IssueType {
return files[i].IssueType < files[j].IssueType
}

return files[i].KeyExpectedValue < files[j].KeyExpectedValue
})

queries[idx].Files = files
summary.Queries = queries
}
summary.Version = constants.Version
body = summary
Expand Down
8 changes: 4 additions & 4 deletions pkg/report/model/code_climate_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ func TestBuildCodeClimateReport(t *testing.T) {
Categories: []string{"Security"},
Location: location{
Path: "positive.tf",
Lines: lines{Begin: 25},
Lines: lines{Begin: 19},
},
Severity: "critical",
CWE: "",
Expand All @@ -37,7 +37,7 @@ func TestBuildCodeClimateReport(t *testing.T) {
Categories: []string{"Security"},
Location: location{
Path: "positive.tf",
Lines: lines{Begin: 19},
Lines: lines{Begin: 25},
},
Severity: "critical",
CWE: "",
Expand All @@ -55,7 +55,7 @@ func TestBuildCodeClimateReport(t *testing.T) {
Categories: []string{"Security"},
Location: location{
Path: "positive.tf",
Lines: lines{Begin: 30},
Lines: lines{Begin: 35},
},
Severity: "critical",
CWE: "22",
Expand All @@ -67,7 +67,7 @@ func TestBuildCodeClimateReport(t *testing.T) {
Categories: []string{"Security"},
Location: location{
Path: "positive.tf",
Lines: lines{Begin: 35},
Lines: lines{Begin: 30},
},
Severity: "critical",
CWE: "22",
Expand Down
24 changes: 12 additions & 12 deletions pkg/report/model/csv_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ func TestBuildCSVReport(t *testing.T) {
CISDescriptionTitle: "testCISTitle",
CISDescriptionTextFormatted: "testCISDescription",
FileName: "positive.tf",
Line: 25,
IssueType: "MissingAttribute",
Line: 19,
IssueType: "IncorrectValue",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
ExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
ActualValue: "'default_action.redirect.protocol' is missing",
ActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
},
{
QueryName: "ALB protocol is HTTP",
Expand All @@ -46,11 +46,11 @@ func TestBuildCSVReport(t *testing.T) {
CISDescriptionTitle: "testCISTitle",
CISDescriptionTextFormatted: "testCISDescription",
FileName: "positive.tf",
Line: 19,
IssueType: "IncorrectValue",
Line: 25,
IssueType: "MissingAttribute",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
ExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
ActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
ActualValue: "'default_action.redirect.protocol' is missing",
},
},
},
Expand All @@ -69,11 +69,11 @@ func TestBuildCSVReport(t *testing.T) {
CISDescriptionTitle: "testCISTitle",
CISDescriptionTextFormatted: "testCISDescription",
FileName: "positive.tf",
Line: 30,
IssueType: "MissingAttribute",
Line: 35,
IssueType: "IncorrectValue",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
ExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
ActualValue: "'default_action.redirect.protocol' is missing",
ActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
},
{
QueryName: "AMI Not Encrypted",
Expand All @@ -86,11 +86,11 @@ func TestBuildCSVReport(t *testing.T) {
CISDescriptionTitle: "testCISTitle",
CISDescriptionTextFormatted: "testCISDescription",
FileName: "positive.tf",
Line: 35,
IssueType: "IncorrectValue",
Line: 30,
IssueType: "MissingAttribute",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
ExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
ActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
ActualValue: "'default_action.redirect.protocol' is missing",
},
},
},
Expand Down
8 changes: 4 additions & 4 deletions pkg/report/model/sonarqube_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ func TestSonarQubeReportBuilder_BuildReport(t *testing.T) {
Message: "ALB protocol is HTTP Description",
FilePath: "positive.tf",
TextRange: &Range{
StartLine: 25,
StartLine: 19,
},
},
SecondaryLocations: []*Location{
{
Message: "ALB protocol is HTTP Description",
FilePath: "positive.tf",
TextRange: &Range{
StartLine: 19,
StartLine: 25,
},
},
},
Expand Down Expand Up @@ -111,15 +111,15 @@ func TestSonarQubeReportBuilder_BuildReport(t *testing.T) {
Message: "AWS AMI Encryption is not enabled",
FilePath: "positive.tf",
TextRange: &Range{
StartLine: 30,
StartLine: 35,
},
},
SecondaryLocations: []*Location{
{
Message: "AWS AMI Encryption is not enabled",
FilePath: "positive.tf",
TextRange: &Range{
StartLine: 35,
StartLine: 30,
},
},
},
Expand Down
36 changes: 18 additions & 18 deletions test/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,21 +120,21 @@ var queryHigh = model.QueryResult{ //nolint
Files: []model.VulnerableFile{
{
FileName: positive,
Line: 25,
IssueType: "MissingAttribute",
Line: 19,
IssueType: "IncorrectValue",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
{
FileName: positive,
Line: 19,
IssueType: "IncorrectValue",
Line: 25,
IssueType: "MissingAttribute",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
Expand Down Expand Up @@ -228,21 +228,21 @@ var queryHighExperimental = model.QueryResult{
Files: []model.VulnerableFile{
{
FileName: positive,
Line: 25,
IssueType: "MissingAttribute",
Line: 19,
IssueType: "IncorrectValue",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
{
FileName: positive,
Line: 19,
IssueType: "IncorrectValue",
Line: 25,
IssueType: "MissingAttribute",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
Expand Down Expand Up @@ -304,21 +304,21 @@ var queryHighCWE = model.QueryResult{ //nolint
Files: []model.VulnerableFile{
{
FileName: positive,
Line: 30,
IssueType: "MissingAttribute",
Line: 35,
IssueType: "IncorrectValue",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
{
FileName: positive,
Line: 35,
IssueType: "IncorrectValue",
Line: 30,
IssueType: "MissingAttribute",
SearchKey: "aws_alb_listener[front_end].default_action.redirect",
KeyExpectedValue: "'default_action.redirect.protocol' is equal 'HTTPS'",
KeyActualValue: "'default_action.redirect.protocol' is equal 'HTTP'",
KeyActualValue: "'default_action.redirect.protocol' is missing",
Value: nil,
VulnLines: &[]model.CodeLine{},
},
Expand Down
Loading