function to validate formatter fields for cleaner code (#250)

Author: MichelKazi

internal/audit/auditlog.go

@@ -24,11 +24,19 @@ import (
 	"github.com/sonatype-nexus-community/nancy/buildversion"
 )
 
+func isEntryValid(params ...interface{}) bool {
+	for _, v := range params {
+		if v == nil {
+			return false
+		}
+	}
+	return true
+}
+
 // LogResults will given a number of expected results and the results themselves, log the
 // results.
 func LogResults(formatter log.Formatter, packageCount int, coordinates []types.Coordinate, invalidCoordinates []types.Coordinate, exclusions []string) int {
 	vulnerableCount := 0
-	exclusionCount := 0
 
 	for _, c := range coordinates {
 		c.ExcludeVulnerabilities(exclusions)
@@ -42,7 +50,6 @@ func LogResults(formatter log.Formatter, packageCount int, coordinates []types.C
 		coordinate := coordinates[i]
 		for _, v := range coordinate.Vulnerabilities {
 			if v.Excluded {
-				exclusionCount++
 				excludedVulnerabilities = append(excludedVulnerabilities, v)
 			}
 		}
@@ -63,6 +70,8 @@ func LogResults(formatter log.Formatter, packageCount int, coordinates []types.C
 		vulnerableCoordinates = make([]types.Coordinate, 0)
 	}
 
+	exclusionCount := len(excludedVulnerabilities)
+
 	log.SetFormatter(formatter)
 	log.SetOutput(os.Stdout)
 	log.WithFields(log.Fields{

internal/audit/auditlogtextformatter.go

@@ -158,7 +158,7 @@ func (f AuditLogTextFormatter) Format(entry *Entry) ([]byte, error) {
 	numVulnerable := entry.Data["num_vulnerable"]
 	numExcluded := entry.Data["num_exclusions"]
 	buildVersion := entry.Data["version"]
-	if auditedEntries != nil && invalidEntries != nil && excludedEntries != nil && packageCount != nil && numVulnerable != nil && numExcluded != nil && buildVersion != nil {
+	if isEntryValid(auditedEntries, invalidEntries, excludedEntries, packageCount, numVulnerable, numExcluded, buildVersion) {
 		auditedEntries := entry.Data["audited"].([]types.Coordinate)
 		invalidEntries := entry.Data["invalid"].([]types.Coordinate)
 		packageCount := entry.Data["num_audited"].(int)
@@ -182,10 +182,10 @@ func (f AuditLogTextFormatter) Format(entry *Entry) ([]byte, error) {
 		t.AppendRow([]interface{}{"Audited Dependencies", strconv.Itoa(packageCount)})
 		t.AppendSeparator()
 		t.AppendRow([]interface{}{"Vulnerable Dependencies", au.Bold(au.Red(strconv.Itoa(numVulnerable)))})
-    if numExcluded > 0 {
-      t.AppendSeparator()
-      t.AppendRow([]interface{}{"Ignored Vulnerabilities", au.Bold(au.Yellow(strconv.Itoa(numExcluded)))})
-    }
+		if numExcluded > 0 {
+			t.AppendSeparator()
+			t.AppendRow([]interface{}{"Ignored Vulnerabilities", au.Bold(au.Yellow(strconv.Itoa(numExcluded)))})
+		}
 		sb.WriteString(t.Render())
 		sb.WriteString("\n")
 

internal/audit/csvformatter.go

@@ -44,7 +44,7 @@ func (f CsvFormatter) Format(entry *Entry) ([]byte, error) {
 	excludedCount := entry.Data["num_exclusions"]
 	buildVersion := entry.Data["version"]
 
-	if auditedEntries != nil && invalidEntries != nil && packageCount != nil && numVulnerable != nil && excludedCount != nil && buildVersion != nil {
+	if isEntryValid(auditedEntries, invalidEntries, packageCount, numVulnerable, excludedCount, buildVersion) {
 		auditedEntries := entry.Data["audited"].([]types.Coordinate)
 		invalidEntries := entry.Data["invalid"].([]types.Coordinate)
 		packageCount := entry.Data["num_audited"].(int)