feedback - part1

cmd/commands/root.go

@@ -84,7 +84,7 @@ func runAudit(auditable ...kubeaudit.Auditable) func(cmd *cobra.Command, args []
 			sarifReport, err := sarif.Create(report)
 
 			if err != nil {
-				log.WithError(err).Fatal("error generating the SARIF output")
+				log.WithError(err).Fatal("Error generating the SARIF output")
 			}
 
 			sarifReport.WriteFile(rootConfig.sarifOut)

internal/sarif/rules.go

@@ -21,7 +21,7 @@ var allAuditors = map[string]string{
 	apparmor.Name:       "Finds containers that do not have AppArmor enabled",
 	asat.Name:           "Finds containers where the deprecated SA field is used or with a mounted default SA",
 	capabilities.Name:   "Finds containers that do not drop the recommended capabilities or add new ones",
-	deprecatedapis.Name: "Finds any resource defined with a deprecated API version.",
+	deprecatedapis.Name: "Finds any resource defined with a deprecated API version",
 	hostns.Name:         "Finds containers that have HostPID, HostIPC or HostNetwork enabled",
 	image.Name:          "Finds containers which do not use the desired version of an image (via the tag) or use an image without a tag",
 	limits.Name:         "Finds containers which exceed the specified CPU and memory limits or do not specify any",

internal/sarif/rules_test.go

@@ -12,7 +12,7 @@ func TestAuditorsLengthAndDescription(t *testing.T) {
 	// make sure they're added with a matching description
 	assert.Len(t, allAuditors, len(all.AuditorNames))
 	for _, description := range allAuditors {
-		assert.True(t, description != "")
+		assert.NotEmpty(t, description)
 	}
 }
 

internal/sarif/sarif.go

@@ -64,7 +64,7 @@ func Create(kubeauditReport *kubeaudit.Report) (*sarif.Report, error) {
 
 		// SARIF specifies the following severity levels: warning, error, note and none
 		// https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html
-		// so we're converting info to none here so we get valid SARIF output
+		// so we're converting info to note here so we get valid SARIF output
 		if result.Severity.String() == "info" {
 			severityLevel = "note"
 		}
@@ -91,7 +91,7 @@ func Create(kubeauditReport *kubeaudit.Report) (*sarif.Report, error) {
 
 	err, errs := validate(&reportBytes)
 	if err != nil {
-		return nil, fmt.Errorf("error validating SARIF schema: %s", err)
+		return nil, fmt.Errorf("error validating SARIF schema: %w", err)
 	}
 
 	if len(errs) > 0 {

internal/sarif/sarif_test.go

@@ -72,6 +72,8 @@ func TestCreateWithResults(t *testing.T) {
 		manifest, openErr := os.Open(fixture)
 		require.NoError(t, openErr)
 
+		defer manifest.Close()
+
 		kubeAuditReport, err := auditor.AuditManifest(fixture, manifest)
 		require.NoError(t, err)
 
@@ -155,6 +157,8 @@ func TestCreateWithNoResults(t *testing.T) {
 	manifest, openErr := os.Open(fixture)
 	require.NoError(t, openErr)
 
+	defer manifest.Close()
+
 	kubeAuditReport, err := auditor.AuditManifest(fixture, manifest)
 	require.NoError(t, err)
 

internal/test/test.go

@@ -107,6 +107,7 @@ func GetReport(t *testing.T, fixtureDir, fixture string, auditables []kubeaudit.
 	case MANIFEST_MODE:
 		manifest, openErr := os.Open(fixture)
 		require.NoError(openErr)
+		defer manifest.Close()
 		report, err = auditor.AuditManifest("", manifest)
 	case LOCAL_MODE:
 		defer DeleteNamespace(t, namespace)