fix: pluralize category groups (#196)

Bearer · Dec 6, 2022 · aa131b7 · aa131b7
1 parent a9f52d4
commit aa131b7
Show file tree

Hide file tree

Showing 15 changed files with 28 additions and 28 deletions.
diff --git a/integration/flags/.snapshots/TestInitCommand-init b/integration/flags/.snapshots/TestInitCommand-init
@@ -380,7 +380,7 @@ scan:
                         not location.encrypted
 
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(datatype),
+                            "category_groups": data.bearer.common.groups_for_datatype(datatype),
                             "severity": data.bearer.common.severity_of_datatype(datatype),
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -457,7 +457,7 @@ scan:
 
                         location = data_type.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": data.bearer.common.severity_of_datatype(data_type),
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -535,7 +535,7 @@ scan:
 
                         location = detector.locations[_]
                         item := {
-                          "category_group": data.bearer.common.groups_for_datatype(data_type),
+                          "category_groups": data.bearer.common.groups_for_datatype(data_type),
                           "severity": "medium",
                           "filename": location.filename,
                           "line_number": location.line_number,
@@ -613,7 +613,7 @@ scan:
 
                         location = detector.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": "medium",
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -691,7 +691,7 @@ scan:
 
                         location = detector.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": "medium",
                             "line_number": location.line_number,
                             "parent_line_number": location.parent.line_number,
@@ -767,7 +767,7 @@ scan:
 
                         location = data_type.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": data.bearer.common.severity_of_datatype(data_type),
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -844,7 +844,7 @@ scan:
 
                         location = data_type.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": data.bearer.common.severity_of_datatype(data_type),
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -921,7 +921,7 @@ scan:
 
                         location = data_type.locations[_]
                         item := {
-                            "category_group": data.bearer.common.groups_for_datatype(data_type),
+                            "category_groups": data.bearer.common.groups_for_datatype(data_type),
                             "severity": data.bearer.common.severity_of_datatype(data_type),
                             "filename": location.filename,
                             "line_number": location.line_number,
@@ -999,7 +999,7 @@ scan:
                       location = detector.locations[_]
 
                       item = {
-                        "category_group": data.bearer.common.groups_for_datatype(data_type),
+                        "category_groups": data.bearer.common.groups_for_datatype(data_type),
                         "severity": "medium",
                         "filename": location.filename,
                         "line_number": location.line_number,

diff --git a/integration/flags/.snapshots/TestReportFlags-report-policies b/integration/flags/.snapshots/TestReportFlags-report-policies
@@ -3,7 +3,7 @@ high:
       policy_description: Logger leaks detected
       line_number: 1
       filename: testdata/policies/users.rb
-      category_group:
+      category_groups:
         - PII
       parent_line_number: 1
       parent_content: logger.info(user.address)

diff --git a/integration/policies/.snapshots/TestPolicies-http_get_parameters b/integration/policies/.snapshots/TestPolicies-http_get_parameters
@@ -3,7 +3,7 @@ critical:
       policy_description: Sending data as HTTP GET parameters
       line_number: 1
       filename: testdata/ruby/http_get_parameters.rb
-      category_group:
+      category_groups:
         - PII
         - Sensitive data
       parent_line_number: 1
@@ -13,7 +13,7 @@ high:
       policy_description: Sending data as HTTP GET parameters
       line_number: 4
       filename: testdata/ruby/http_get_parameters.rb
-      category_group:
+      category_groups:
         - PII
       parent_line_number: 5
       parent_content: URI.encode_www_form(user)

diff --git a/integration/policies/.snapshots/TestPolicies-insecure_communication_with_sensitive_data b/integration/policies/.snapshots/TestPolicies-insecure_communication_with_sensitive_data
@@ -3,7 +3,7 @@ medium:
       policy_description: Insecure communication in an application processing sensitive data
       line_number: 8
       filename: testdata/ruby/insecure_communication/with_sensitive_data.rb
-      category_group:
+      category_groups:
         - PII
         - Sensitive data
       parent_line_number: 1

diff --git a/integration/policies/.snapshots/TestPolicies-insecure_ftp_with_sensitive_data b/integration/policies/.snapshots/TestPolicies-insecure_ftp_with_sensitive_data
@@ -3,7 +3,7 @@ medium:
       policy_description: Communication with insecure FTP in an application processing sensitive data
       line_number: 10
       filename: testdata/ruby/insecure_ftp/with_sensitive_data.rb
-      category_group:
+      category_groups:
         - PII
         - Sensitive data
       parent_line_number: 10

diff --git a/integration/policies/.snapshots/TestPolicies-insecure_smtp_with_sensitive_data b/integration/policies/.snapshots/TestPolicies-insecure_smtp_with_sensitive_data
@@ -2,7 +2,7 @@ medium:
     - policy_name: Insecure SMTP
       policy_description: Communication with insecure SMTP in an application processing sensitive data
       line_number: 8
-      category_group:
+      category_groups:
         - PII
         - Sensitive data
       parent_line_number: 1
@@ -41,7 +41,7 @@ medium:
     - policy_name: Insecure SMTP
       policy_description: Communication with insecure SMTP in an application processing sensitive data
       line_number: 14
-      category_group:
+      category_groups:
         - PII
         - Sensitive data
       parent_line_number: 1

diff --git a/integration/policies/.snapshots/TestPolicies-logger_leaking b/integration/policies/.snapshots/TestPolicies-logger_leaking
@@ -3,7 +3,7 @@ high:
       policy_description: Logger leaks detected
       line_number: 1
       filename: testdata/ruby/logger_leaking.rb
-      category_group:
+      category_groups:
         - PII
       parent_line_number: 1
       parent_content: logger.info(user.address)

diff --git a/pkg/commands/process/settings/policies/application_level_encryption.rego b/pkg/commands/process/settings/policies/application_level_encryption.rego
@@ -13,7 +13,7 @@ policy_breach contains item if {
     not location.encrypted
 
     item := {
-        "category_group": data.bearer.common.groups_for_datatype(datatype),
+        "category_groups": data.bearer.common.groups_for_datatype(datatype),
         "severity": data.bearer.common.severity_of_datatype(datatype),
         "filename": location.filename,
         "line_number": location.line_number,

diff --git a/pkg/commands/process/settings/policies/http_get_parameters.rego b/pkg/commands/process/settings/policies/http_get_parameters.rego
@@ -12,7 +12,7 @@ policy_breach contains item if {
 
     location = data_type.locations[_]
     item := {
-        "category_group": data.bearer.common.groups_for_datatype(data_type),
+        "category_groups": data.bearer.common.groups_for_datatype(data_type),
         "severity": data.bearer.common.severity_of_datatype(data_type),
         "filename": location.filename,
         "line_number": location.line_number,

diff --git a/pkg/commands/process/settings/policies/insecure_communication.rego b/pkg/commands/process/settings/policies/insecure_communication.rego
@@ -13,7 +13,7 @@ policy_breach contains item if {
 
     location = detector.locations[_]
     item := {
-      "category_group": data.bearer.common.groups_for_datatype(data_type),
+      "category_groups": data.bearer.common.groups_for_datatype(data_type),
       "severity": "medium",
       "filename": location.filename,
       "line_number": location.line_number,

diff --git a/pkg/commands/process/settings/policies/insecure_ftp.rego b/pkg/commands/process/settings/policies/insecure_ftp.rego
@@ -13,7 +13,7 @@ policy_breach[item] {
 
     location = detector.locations[_]
     item := {
-        "category_group": data.bearer.common.groups_for_datatype(data_type),
+        "category_groups": data.bearer.common.groups_for_datatype(data_type),
         "severity": "medium",
         "filename": location.filename,
         "line_number": location.line_number,

diff --git a/pkg/commands/process/settings/policies/insecure_smtp.rego b/pkg/commands/process/settings/policies/insecure_smtp.rego
@@ -13,7 +13,7 @@ policy_breach contains item if {
 
     location = detector.locations[_]
     item := {
-        "category_group": data.bearer.common.groups_for_datatype(data_type),
+        "category_groups": data.bearer.common.groups_for_datatype(data_type),
         "severity": "medium",
         "line_number": location.line_number,
         "parent_line_number": location.parent.line_number,

diff --git a/pkg/commands/process/settings/policies/leakage.rego b/pkg/commands/process/settings/policies/leakage.rego
@@ -12,7 +12,7 @@ policy_breach contains item if {
 
     location = data_type.locations[_]
     item := {
-        "category_group": data.bearer.common.groups_for_datatype(data_type),
+        "category_groups": data.bearer.common.groups_for_datatype(data_type),
         "severity": data.bearer.common.severity_of_datatype(data_type),
         "filename": location.filename,
         "line_number": location.line_number,

diff --git a/pkg/commands/process/settings/policies/ssl_certificate_verification_disabled.rego b/pkg/commands/process/settings/policies/ssl_certificate_verification_disabled.rego
@@ -13,7 +13,7 @@ policy_breach contains item if {
   location = detector.locations[_]
 
   item = {
-    "category_group": data.bearer.common.groups_for_datatype(data_type),
+    "category_groups": data.bearer.common.groups_for_datatype(data_type),
     "severity": "medium",
     "filename": location.filename,
     "line_number": location.line_number,

diff --git a/pkg/report/output/policies/policies.go b/pkg/report/output/policies/policies.go
@@ -33,7 +33,7 @@ type PolicyOutput struct {
 	ParentContent    string   `json:"parent_content,omitempty" yaml:"parent_content,omitempty"`
 	LineNumber       int      `json:"line_number,omitempty" yaml:"line_number,omitempty"`
 	Filename         string   `json:"filename,omitempty" yaml:"filename,omitempty"`
-	CategoryGroup    []string `json:"category_group,omitempty" yaml:"category_group,omitempty"`
+	CategoryGroups   []string `json:"category_groups,omitempty" yaml:"category_groups,omitempty"`
 	Severity         string   `json:"severity,omitempty" yaml:"severity,omitempty"`
 }
 
@@ -42,7 +42,7 @@ type PolicyResult struct {
 	PolicyDescription string   `json:"policy_description" yaml:"policy_description"`
 	LineNumber        int      `json:"line_number,omitempty" yaml:"line_number,omitempty"`
 	Filename          string   `json:"filename,omitempty" yaml:"filename,omitempty"`
-	CategoryGroup     []string `json:"category_group,omitempty" yaml:"category_group,omitempty"`
+	CategoryGroups    []string `json:"category_groups,omitempty" yaml:"category_groups,omitempty"`
 	ParentLineNumber  int      `json:"parent_line_number,omitempty" yaml:"parent_line_number,omitempty"`
 	ParentContent     string   `json:"parent_content,omitempty" yaml:"parent_content,omitempty"`
 }
@@ -82,7 +82,7 @@ func GetOutput(dataflow *dataflow.DataFlow, config settings.Config) (map[string]
 					PolicyDescription: policy.Description,
 					Filename:          policyOutput.Filename,
 					LineNumber:        policyOutput.LineNumber,
-					CategoryGroup:     policyOutput.CategoryGroup,
+					CategoryGroups:    policyOutput.CategoryGroups,
 					ParentLineNumber:  policyOutput.ParentLineNumber,
 					ParentContent:     policyOutput.ParentContent,
 				}
@@ -196,7 +196,7 @@ func writeSummaryToString(
 func writePolicyBreachToString(reportStr *strings.Builder, policyBreach PolicyResult, policySeverity string) {
 	reportStr.WriteString("\n\n")
 	reportStr.WriteString(formatSeverity(policySeverity))
-	reportStr.WriteString(policyBreach.PolicyName + " policy breach with " + strings.Join(policyBreach.CategoryGroup, ", ") + "\n")
+	reportStr.WriteString(policyBreach.PolicyName + " policy breach with " + strings.Join(policyBreach.CategoryGroups, ", ") + "\n")
 	reportStr.WriteString(color.HiBlackString(policyBreach.PolicyDescription + "\n"))
 	reportStr.WriteString("\n")
 	reportStr.WriteString(color.HiBlueString("File: " + underline(policyBreach.Filename+":"+fmt.Sprint(policyBreach.LineNumber)) + "\n"))