Fix lint and fail on error in the ci build

tair129 · May 31, 2021 · 1256f16 · 1256f16
1 parent dbb9811
commit 1256f16
Show file tree

Hide file tree

Showing 51 changed files with 216 additions and 201 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -20,7 +20,6 @@ jobs:
             ${{ runner.os }}-go-
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
-        continue-on-error: true
         with:
           version: latest
   test:

diff --git a/.golangci.yml b/.golangci.yml
@@ -1,13 +1,23 @@
 linters:
   enable:
-  - megacheck
-  - govet
-  - unparam
-  - unconvert
-  - misspell
+  - asciicheck
+  - bodyclose
+  - depguard
+  - dogsled
+  - durationcheck
+  - errcheck
+  - exportloopref
   - gofmt
-  - golint
+  - gofumpt
+  - goimports
   - gosec
+  - govet
+  - importas
+  - megacheck
+  - misspell
   - nakedret
-  - dogsled
-  - depguard
+  - nolintlint
+  - revive
+  - unconvert
+  - unparam
+  - wastedassign
diff --git a/analyzer.go b/analyzer.go
@@ -28,7 +28,6 @@ import (
 	"reflect"
 	"regexp"
 	"strconv"
-
 	"strings"
 
 	"golang.org/x/tools/go/packages"

diff --git a/analyzer_test.go b/analyzer_test.go
@@ -17,7 +17,6 @@ import (
 )
 
 var _ = Describe("Analyzer", func() {
-
 	var (
 		analyzer  *gosec.Analyzer
 		logger    *log.Logger
@@ -30,7 +29,6 @@ var _ = Describe("Analyzer", func() {
 	})
 
 	Context("when processing a package", func() {
-
 		It("should not report an error if the package contains no Go files", func() {
 			analyzer.LoadRules(rules.Generate().Builders())
 			dir, err := ioutil.TempDir("", "empty")
@@ -118,7 +116,6 @@ var _ = Describe("Analyzer", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 			controlIssues, _, _ := analyzer.Report()
 			Expect(controlIssues).Should(HaveLen(sample.Errors))
-
 		})
 
 		It("should report Go build errors and invalid files", func() {
@@ -262,7 +259,6 @@ var _ = Describe("Analyzer", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 			nosecIssues, _, _ := customAnalyzer.Report()
 			Expect(nosecIssues).Should(HaveLen(sample.Errors))
-
 		})
 
 		It("should be possible to use an alternative nosec tag", func() {
@@ -286,7 +282,6 @@ var _ = Describe("Analyzer", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 			nosecIssues, _, _ := customAnalyzer.Report()
 			Expect(nosecIssues).Should(HaveLen(0))
-
 		})
 
 		It("should ignore vulnerabilities when the default tag is found", func() {
@@ -310,7 +305,6 @@ var _ = Describe("Analyzer", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 			nosecIssues, _, _ := customAnalyzer.Report()
 			Expect(nosecIssues).Should(HaveLen(0))
-
 		})
 
 		It("should be able to analyze Go test package", func() {
@@ -356,7 +350,6 @@ var _ = Describe("Analyzer", func() {
 	})
 
 	Context("when parsing errors from a package", func() {
-
 		It("should return no error when the error list is empty", func() {
 			pkg := &packages.Package{}
 			err := analyzer.ParseErrors(pkg)

diff --git a/call_list_test.go b/call_list_test.go
@@ -10,9 +10,7 @@ import (
 )
 
 var _ = Describe("Call List", func() {
-	var (
-		calls gosec.CallList
-	)
+	var calls gosec.CallList
 	BeforeEach(func() {
 		calls = gosec.NewCallList()
 	})

diff --git a/cmd/gosec/main.go b/cmd/gosec/main.go
@@ -120,7 +120,7 @@ var (
 	// stdout the results as well as write it in the output file
 	flagStdOut = flag.Bool("stdout", false, "Stdout the results as well as write it in the output file")
 
-	//print the text report with color, this is enabled by default
+	// print the text report with color, this is enabled by default
 	flagColor = flag.Bool("color", true, "Prints the text format report with colorization when it goes in the stdout")
 
 	// overrides the output format when stdout the results while saving them in the output file
@@ -209,15 +209,14 @@ func getRootPaths(paths []string) []string {
 }
 
 func getPrintedFormat(format string, verbose string) string {
-	var fileFormat = format
+	fileFormat := format
 	if format != "" && verbose != "" {
 		fileFormat = verbose
 	}
 	return fileFormat
 }
 
 func printReport(format string, color bool, rootPaths []string, reportInfo *gosec.ReportInfo) error {
-
 	err := report.CreateReport(os.Stdout, format, color, rootPaths, reportInfo)
 	if err != nil {
 		return err
@@ -226,7 +225,6 @@ func printReport(format string, color bool, rootPaths []string, reportInfo *gose
 }
 
 func saveReport(filename, format string, rootPaths []string, reportInfo *gosec.ReportInfo) error {
-
 	outfile, err := os.Create(filename)
 	if err != nil {
 		return err
@@ -386,7 +384,7 @@ func main() {
 	reportInfo := gosec.NewReportInfo(issues, metrics, errors).WithVersion(Version)
 
 	if *flagOutput == "" || *flagStdOut {
-		var fileFormat = getPrintedFormat(*flagOutput, *flagVerbose)
+		fileFormat := getPrintedFormat(*flagOutput, *flagVerbose)
 		if err := printReport(fileFormat, *flagColor, rootPaths, reportInfo); err != nil {
 			logger.Fatal((err))
 		}

diff --git a/cmd/gosec/sort_issues.go b/cmd/gosec/sort_issues.go
@@ -12,7 +12,6 @@ import (
 func extractLineNumber(s string) int {
 	lineNumber, _ := strconv.Atoi(strings.Split(s, "-")[0])
 	return lineNumber
-
 }
 
 type sortBySeverity []*gosec.Issue

diff --git a/cmd/gosecutil/tools.go b/cmd/gosecutil/tools.go
@@ -26,11 +26,13 @@ import (
 	"strings"
 )
 
-type command func(args ...string)
-type utilities struct {
-	commands map[string]command
-	call     []string
-}
+type (
+	command   func(args ...string)
+	utilities struct {
+		commands map[string]command
+		call     []string
+	}
+)
 
 // Custom commands / utilities to run instead of default analyzer
 func newUtils() *utilities {
@@ -58,7 +60,6 @@ func (u *utilities) String() string {
 func (u *utilities) Set(opt string) error {
 	if _, ok := u.commands[opt]; !ok {
 		return fmt.Errorf("valid tools are: %s", u.String())
-
 	}
 	u.call = append(u.call, opt)
 	return nil
@@ -171,7 +172,6 @@ func checkContext(ctx *context, file string) bool {
 }
 
 func dumpCallObj(files ...string) {
-
 	for _, file := range files {
 		if shouldSkip(file) {
 			continue
@@ -184,9 +184,9 @@ func dumpCallObj(files ...string) {
 			var obj types.Object
 			switch node := n.(type) {
 			case *ast.Ident:
-				obj = context.info.ObjectOf(node) //context.info.Uses[node]
+				obj = context.info.ObjectOf(node) // context.info.Uses[node]
 			case *ast.SelectorExpr:
-				obj = context.info.ObjectOf(node.Sel) //context.info.Uses[node.Sel]
+				obj = context.info.ObjectOf(node.Sel) // context.info.Uses[node.Sel]
 			default:
 				obj = nil
 			}

diff --git a/config.go b/config.go
@@ -56,7 +56,7 @@ func (c Config) convertGlobals() {
 
 // ReadFrom implements the io.ReaderFrom interface. This
 // should be used with io.Reader to load configuration from
-//file or from string etc.
+// file or from string etc.
 func (c Config) ReadFrom(r io.Reader) (int64, error) {
 	data, err := ioutil.ReadAll(r)
 	if err != nil {

diff --git a/config_test.go b/config_test.go
@@ -16,7 +16,6 @@ var _ = Describe("Configuration", func() {
 	})
 
 	Context("when loading from disk", func() {
-
 		It("should be possible to load configuration from a file", func() {
 			json := `{"G101": {}}`
 			buffer := bytes.NewBufferString(json)
@@ -35,7 +34,6 @@ var _ = Describe("Configuration", func() {
 			_, err = configuration.ReadFrom(emptyBuffer)
 			Expect(err).Should(HaveOccurred())
 		})
-
 	})
 
 	Context("when saving to disk", func() {
@@ -49,7 +47,6 @@ var _ = Describe("Configuration", func() {
 		})
 
 		It("should be possible to save configuration to file", func() {
-
 			configuration.Set("G101", map[string]string{
 				"mode": "strict",
 			})
@@ -59,12 +56,10 @@ var _ = Describe("Configuration", func() {
 			Expect(int(nbytes)).ShouldNot(BeZero())
 			Expect(err).ShouldNot(HaveOccurred())
 			Expect(buffer.String()).Should(Equal(`{"G101":{"mode":"strict"},"global":{}}`))
-
 		})
 	})
 
 	Context("when configuring rules", func() {
-
 		It("should be possible to get configuration for a rule", func() {
 			settings := map[string]string{
 				"ciphers": "AES256-GCM",

diff --git a/cwe/cwe_suite_test.go b/cwe/cwe_suite_test.go
@@ -1,10 +1,10 @@
 package cwe_test
 
 import (
+	"testing"
+
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-
-	"testing"
 )
 
 func TestCwe(t *testing.T) {

diff --git a/cwe/data.go b/cwe/data.go
@@ -1,15 +1,15 @@
 package cwe
 
 const (
-	//Acronym is the acronym of CWE
+	// Acronym is the acronym of CWE
 	Acronym = "CWE"
-	//Version the CWE version
+	// Version the CWE version
 	Version = "4.4"
-	//ReleaseDateUtc the release Date of CWE Version
+	// ReleaseDateUtc the release Date of CWE Version
 	ReleaseDateUtc = "2021-03-15"
-	//Organization MITRE
+	// Organization MITRE
 	Organization = "MITRE"
-	//Description the description of CWE
+	// Description the description of CWE
 	Description = "The MITRE Common Weakness Enumeration"
 )
 
@@ -126,7 +126,7 @@ func init() {
 	}
 }
 
-//Get Retrieves a CWE weakness by it's id
+// Get Retrieves a CWE weakness by it's id
 func Get(id string) *Weakness {
 	weakness, ok := data[id]
 	if ok && weakness != nil {

diff --git a/cwe/data_test.go b/cwe/data_test.go
@@ -17,6 +17,5 @@ var _ = Describe("CWE data", func() {
 			Expect(weakness.Name).ShouldNot(BeNil())
 			Expect(weakness.Description).ShouldNot(BeNil())
 		})
-
 	})
 })
diff --git a/cwe/types.go b/cwe/types.go
@@ -12,17 +12,17 @@ type Weakness struct {
 	Description string
 }
 
-//SprintURL format the CWE URL
+// SprintURL format the CWE URL
 func (w *Weakness) SprintURL() string {
 	return fmt.Sprintf("https://cwe.mitre.org/data/definitions/%s.html", w.ID)
 }
 
-//SprintID format the CWE ID
+// SprintID format the CWE ID
 func (w *Weakness) SprintID() string {
 	return fmt.Sprintf("%s-%s", Acronym, w.ID)
 }
 
-//MarshalJSON print only id and URL
+// MarshalJSON print only id and URL
 func (w *Weakness) MarshalJSON() ([]byte, error) {
 	return json.Marshal(&struct {
 		ID  string `json:"id"`
@@ -33,12 +33,12 @@ func (w *Weakness) MarshalJSON() ([]byte, error) {
 	})
 }
 
-//InformationURI link to the published CWE PDF
+// InformationURI link to the published CWE PDF
 func InformationURI() string {
 	return fmt.Sprintf("https://cwe.mitre.org/data/published/cwe_v%s.pdf/", Version)
 }
 
-//DownloadURI link to the zipped XML of the CWE list
+// DownloadURI link to the zipped XML of the CWE list
 func DownloadURI() string {
 	return fmt.Sprintf("https://cwe.mitre.org/data/xml/cwec_v%s.xml.zip", Version)
 }
diff --git a/gosec_suite_test.go b/gosec_suite_test.go
@@ -1,10 +1,10 @@
 package gosec_test
 
 import (
+	"testing"
+
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
-
-	"testing"
 )
 
 func TestGosec(t *testing.T) {

diff --git a/helpers.go b/helpers.go
@@ -168,7 +168,6 @@ func GetCallInfo(n ast.Node, ctx *Context) (string, string, error) {
 							}
 						}
 					}
-
 				}
 			}
 		case *ast.Ident:
@@ -220,7 +219,6 @@ func GetIdentStringValues(ident *ast.Ident) []string {
 				}
 			}
 		}
-
 	}
 	return values
 }
@@ -298,7 +296,7 @@ func Gopath() []string {
 }
 
 // Getenv returns the values of the environment variable, otherwise
-//returns the default if variable is not set
+// returns the default if variable is not set
 func Getenv(key, userDefault string) string {
 	if val := os.Getenv(key); val != "" {
 		return val

diff --git a/issue.go b/issue.go
@@ -19,11 +19,12 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
-	"github.com/securego/gosec/v2/cwe"
 	"go/ast"
 	"go/token"
 	"os"
 	"strconv"
+
+	"github.com/securego/gosec/v2/cwe"
 )
 
 // Score type used by severity and confidence values
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,5 @@ var _ = Describe("CWE data", func() { @@
     			Expect(weakness.Name).ShouldNot(BeNil())
     			Expect(weakness.Description).ShouldNot(BeNil())
     		})
     	})
     })