Create options for human-readable output formats

v2/cmd/zlint/main.go

@@ -25,8 +25,10 @@ import (
 	"os"
 	"regexp"
 	"sort"
+	"strconv"
 	"strings"
 
+	"github.com/olekukonko/tablewriter"
 	log "github.com/sirupsen/logrus"
 	"github.com/zmap/zcrypto/x509"
 	"github.com/zmap/zlint/v2"
@@ -36,6 +38,8 @@ import (
 var ( // flags
 	listLintsJSON   bool
 	listLintSources bool
+	summary         bool
+	longsummary     bool
 	prettyprint     bool
 	format          string
 	nameFilter      string
@@ -51,14 +55,16 @@ var ( // flags
 func init() {
 	flag.BoolVar(&listLintsJSON, "list-lints-json", false, "Print lints in JSON format, one per line")
 	flag.BoolVar(&listLintSources, "list-lints-source", false, "Print list of lint sources, one per line")
+	flag.BoolVar(&summary, "summary", false, "Prints a short human-readable summary report")
+	flag.BoolVar(&longsummary, "longsummary", false, "Prints a human-readable summary report with details")
 	flag.StringVar(&format, "format", "pem", "One of {pem, der, base64}")
 	flag.StringVar(&nameFilter, "nameFilter", "", "Only run lints with a name matching the provided regex. (Can not be used with -includeNames/-excludeNames)")
 	flag.StringVar(&includeNames, "includeNames", "", "Comma-separated list of lints to include by name")
 	flag.StringVar(&excludeNames, "excludeNames", "", "Comma-separated list of lints to exclude by name")
 	flag.StringVar(&includeSources, "includeSources", "", "Comma-separated list of lint sources to include")
 	flag.StringVar(&excludeSources, "excludeSources", "", "Comma-separated list of lint sources to exclude")
 
-	flag.BoolVar(&prettyprint, "pretty", false, "Pretty-print output")
+	flag.BoolVar(&prettyprint, "pretty", false, "Pretty-print JSON output")
 	flag.Usage = func() {
 		fmt.Fprintf(os.Stderr, "ZLint version %s\n\n", version)
 		fmt.Fprintf(os.Stderr, "Usage: %s [flags] file...\n", os.Args[0])
@@ -156,6 +162,10 @@ func doLint(inputFile *os.File, inform string, registry lint.Registry) {
 			log.Fatalf("can't format output: %s", err)
 		}
 		os.Stdout.Write(out.Bytes())
+	} else if summary {
+		outputSummary(zlintResult, false)
+	} else if longsummary {
+		outputSummary(zlintResult, true)
 	} else {
 		os.Stdout.Write(jsonBytes)
 	}
@@ -210,3 +220,83 @@ func setLints() (lint.Registry, error) {
 
 	return lint.GlobalRegistry().Filter(filterOpts)
 }
+
+func outputSummary(zlintResult *zlint.ResultSet, longSummary bool) {
+	var sortedLevels []int
+	resultCount := make(map[lint.LintStatus]int)
+	resultDetails := make(map[lint.LintStatus][]string)
+	lintLevelsAboveThreshold := make(map[int]lint.LintStatus)
+	// Set the threashold under which (inclusive) events are not
+	// counted
+	threshold := lint.Pass
+
+	// Make the list of lint levels that matter
+	for _, i := range lint.StatusLabelToLintStatus {
+		if i <= threshold {
+			continue
+		}
+		lintLevelsAboveThreshold[int(i)] = i
+	}
+	// Set all of the levels to 0 events to they are all displayed
+	// in the -summary table
+	for _, level := range lintLevelsAboveThreshold {
+		resultCount[level] = 0
+	}
+	// Count up the number of each event
+	for key, value := range zlintResult.Results {
+		if value.Status > threshold {
+			resultCount[value.Status]++
+			if longSummary {
+				resultDetails[value.Status] = append(
+					resultDetails[value.Status],
+					string(key),
+				)
+			}
+		}
+	}
+	// Sort the levels we have so we can get a nice output
+	for key, _ := range resultCount {
+		sortedLevels = append(sortedLevels, int(key))
+	}
+	sort.Ints(sortedLevels)
+	// make the requested table type
+	if longSummary {
+		// make a table with the internal lint names grouped
+		// by type
+		longTable := tablewriter.NewWriter(os.Stdout)
+		longTable.SetHeader([]string{"Level", "# occurances", "Details"})
+		longTable.SetAutoMergeCells(true)
+		for _, level := range sortedLevels {
+			foundDetail := false
+			for _, detail := range resultDetails[lint.LintStatus(level)] {
+				longTable.Append([]string{
+					fmt.Sprintf("%s", lint.LintStatus(level)),
+					strconv.Itoa(resultCount[lint.LintStatus(level)]),
+					detail,
+				})
+				foundDetail = true
+			}
+			if !foundDetail {
+				longTable.Append([]string{
+					fmt.Sprintf("%s", lint.LintStatus(level)),
+					strconv.Itoa(resultCount[lint.LintStatus(level)]),
+					" - ",
+				})
+			}
+		}
+		longTable.Render()
+	} else {
+		// Make a table of the count of each error type and
+		// print it nicely
+		table := tablewriter.NewWriter(os.Stdout)
+		table.SetHeader([]string{"Level", "# occurances"})
+
+		for _, level := range sortedLevels {
+			table.Append([]string{
+				fmt.Sprintf("%s", lint.LintStatus(level)),
+				strconv.Itoa(resultCount[lint.LintStatus(level)]),
+			})
+		}
+		table.Render()
+	}
+}

v2/go.mod

@@ -1,6 +1,7 @@
 module github.com/zmap/zlint/v2
 
 require (
+	github.com/olekukonko/tablewriter v0.0.4
 	github.com/sirupsen/logrus v1.3.0
 	github.com/weppos/publicsuffix-go v0.4.0
 	github.com/zmap/zcrypto v0.0.0-20200513165325-16679db567ff

v2/go.sum

@@ -8,7 +8,11 @@ github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORN
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/mattn/go-runewidth v0.0.7 h1:Ei8KR0497xHyKJPAv59M1dkC+rOZCMBJ+t3fZ+twI54=
+github.com/mattn/go-runewidth v0.0.7/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mreiferson/go-httpclient v0.0.0-20160630210159-31f0106b4474/go.mod h1:OQA4XLvDbMgS8P0CevmM4m9Q3Jq4phKUzcocxuGJ5m8=
+github.com/olekukonko/tablewriter v0.0.4 h1:vHD/YYe1Wolo78koG299f7V/VAS08c6IpCLn+Ejf/w8=
+github.com/olekukonko/tablewriter v0.0.4/go.mod h1:zq6QwlOf5SlnkVbMSr5EoBv3636FWnp+qbPhuoO21uA=
 github.com/op/go-logging v0.0.0-20160315200505-970db520ece7/go.mod h1:HzydrMdWErDVzsI23lYNej1Htcns9BCg93Dk0bBINWk=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=

v2/lint/result.go

@@ -42,10 +42,10 @@ const (
 )
 
 var (
-	// statusLabelToLintStatus is used to work backwards from
+	// StatusLabelToLintStatus is used to work backwards from
 	// a LintStatus.String() to the LintStatus. This is used by
 	// LintStatus.Unmarshal.
-	statusLabelToLintStatus = map[string]LintStatus{
+	StatusLabelToLintStatus = map[string]LintStatus{
 		Reserved.String(): Reserved,
 		NA.String():       NA,
 		NE.String():       NE,
@@ -73,7 +73,7 @@ func (e LintStatus) MarshalJSON() ([]byte, error) {
 // UnmarshalJSON implements the json.Unmarshaler interface.
 func (e *LintStatus) UnmarshalJSON(data []byte) error {
 	key := strings.ReplaceAll(string(data), `"`, "")
-	if status, ok := statusLabelToLintStatus[key]; ok {
+	if status, ok := StatusLabelToLintStatus[key]; ok {
 		*e = status
 	} else {
 		return fmt.Errorf("bad LintStatus JSON value: %s", string(data))