Initial adoption of golangci-lint for CI

.github/workflows/build.yaml

@@ -4,11 +4,33 @@ on:
     branches:
       - master
   pull_request:
-
-jobs:          
+
+jobs:
+  lint:
+    name: golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v1
+        with:
+          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
+          version: v1.29
+          args: --timeout 5m
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          # args: --issues-exit-code=0
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
   build:
     name: Build
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-latest
     steps:
       - name: Set up Go
         uses: actions/setup-go@v2
@@ -20,8 +42,8 @@ jobs:
 
       - name: Test
         run: go test .
-        working-directory: v2/cmd/nuclei/
+        working-directory: cmd/nuclei/
 
       - name: Build
         run: go build .
-        working-directory: v2/cmd/nuclei/
+        working-directory: cmd/nuclei/

.golangci.yml

@@ -0,0 +1,116 @@
+linters-settings:
+  dupl:
+    threshold: 100
+  exhaustive:
+    default-signifies-exhaustive: false
+  # funlen:
+  #   lines: 100
+  #   statements: 50
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+    disabled-checks:
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
+      - ifElseChain
+  # gocyclo:
+  #   min-complexity: 15
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint
+  golint:
+    min-confidence: 0
+  gomnd:
+    settings:
+      mnd:
+        # don't include the "operation" and "assign"
+        checks: argument,case,condition,return
+  govet:
+    check-shadowing: true
+    settings:
+      printf:
+        funcs:
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+          - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+  # lll:
+  #   line-length: 140
+  maligned:
+    suggest-new: true
+  misspell:
+    locale: US
+  nolintlint:
+    allow-leading-space: true # don't require machine-readable nolint directives (i.e. with no leading space)
+    allow-unused: false # report any unused nolint directives
+    require-explanation: false # don't require an explanation for nolint directives
+    require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+
+linters:
+  # please, do not use `enable-all`: it's deprecated and will be removed soon.
+  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
+  disable-all: true
+  enable:
+    - bodyclose
+    - deadcode
+    - dogsled
+    - dupl
+    - errcheck
+    - exhaustive
+    - gochecknoinits
+    - goconst
+    - gocritic
+    - gofmt
+    - goimports
+    - golint
+    - gomnd
+    - goprintffuncname
+    - gosimple
+    - govet
+    - ineffassign
+    - interfacer
+    - maligned
+    - misspell
+    - nakedret
+    - noctx
+    - nolintlint
+    - rowserrcheck
+    - scopelint
+    - staticcheck
+    - structcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - varcheck
+    - whitespace
+
+  # don't enable:
+  # - depguard
+  # - asciicheck
+  # - funlen
+  # - gochecknoglobals
+  # - gocognit
+  # - gocyclo
+  # - godot
+  # - godox
+  # - goerr113
+  # - gosec
+  # - lll
+  # - nestif
+  # - prealloc
+  # - testpackage
+  # - wsl
+
+# golangci.com configuration
+# https://github.com/golangci/golangci/wiki/Configuration
+service:
+  golangci-lint-version: 1.29.x # use the fixed version to not introduce new linters unexpectedly
+  prepare:
+    - echo "here I can run custom commands, but no preparation needed for this repo"

v2/cmd/nuclei/main.go → cmd/nuclei/main.go

@@ -9,11 +9,11 @@ func main() {
 	// Parse the command line flags and read config files
 	options := runner.ParseOptions()
 
-	runner, err := runner.New(options)
+	nucleiRunner, err := runner.New(options)
 	if err != nil {
 		gologger.Fatalf("Could not create runner: %s\n", err)
 	}
 
-	runner.RunEnumeration()
-	runner.Close()
+	nucleiRunner.RunEnumeration()
+	nucleiRunner.Close()
 }

v2/go.mod → go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/projectdiscovery/gologger v1.0.1
 	github.com/projectdiscovery/retryabledns v1.0.4
 	github.com/projectdiscovery/retryablehttp-go v1.0.1
+	github.com/stretchr/testify v1.5.1
 	github.com/vbauerster/mpb/v5 v5.2.4
 	golang.org/x/net v0.0.0-20200707034311-ab3426394381
 	gopkg.in/yaml.v2 v2.3.0

v2/go.sum → go.sum

@@ -14,6 +14,7 @@ github.com/d5/tengo v1.24.8 h1:PRJ+NWt7ae/9sSbIfThOBTkPSvNV+dwYoBAvwfNgNJY=
 github.com/d5/tengo/v2 v2.6.0 h1:D0cJtpiBzaLJ/Smv6nnUc/LIfO46oKwDx85NZtIRNRI=
 github.com/d5/tengo/v2 v2.6.0/go.mod h1:XRGjEs5I9jYIKTxly6HCF8oiiilk5E/RYXOZ5b0DZC8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/google/go-github v17.0.0+incompatible h1:N0LgJ1j65A7kfXrZnUDaYCs/Sf4rEjNlfyDHW9dolSY=
@@ -32,6 +33,7 @@ github.com/logrusorgru/aurora v2.0.3+incompatible/go.mod h1:7rIyQOR62GCctdiQpZ/z
 github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/miekg/dns v1.1.29/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
+github.com/miekg/dns v1.1.30/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
 github.com/miekg/dns v1.1.31 h1:sJFOl9BgwbYAWOGEwr61FU28pqsBNdpRBnhGXtO06Oo=
 github.com/miekg/dns v1.1.31/go.mod h1:KNUDUusw/aVsxyTYZM1oqvCicbwhgbNgztCETuNZ7xM=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
@@ -40,15 +42,20 @@ github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLD
 github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/projectdiscovery/gologger v1.0.1 h1:FzoYQZnxz9DCvSi/eg5A6+ET4CQ0CDUs27l6Exr8zMQ=
 github.com/projectdiscovery/gologger v1.0.1/go.mod h1:Ok+axMqK53bWNwDSU1nTNwITLYMXMdZtRc8/y1c7sWE=
+github.com/projectdiscovery/nuclei v1.1.7 h1:5Z1fBHcjyAuuI89xcCzv8tYK7b6ucqLxs+mCC/nJjno=
+github.com/projectdiscovery/nuclei/v2 v2.1.0 h1:TUr9lwJ8lulBmEfz6AQHoKPiBQocl4PrPXSu3ekXsXY=
+github.com/projectdiscovery/nuclei/v2 v2.1.0/go.mod h1:iufrjj0m0PCZc8J8eVLZqZMyiCaMMv4R5d6QKBdqpZA=
 github.com/projectdiscovery/retryabledns v1.0.4 h1:0Va7qHlWQsIXjRLISTjzfN3tnJmHYDudY05Nu3IJd60=
 github.com/projectdiscovery/retryabledns v1.0.4/go.mod h1:/UzJn4I+cPdQl6pKiiQfvVAT636YZvJQYZhYhGB0dUQ=
 github.com/projectdiscovery/retryablehttp-go v1.0.1 h1:V7wUvsZNq1Rcz7+IlcyoyQlNwshuwptuBVYWw9lx8RE=
 github.com/projectdiscovery/retryablehttp-go v1.0.1/go.mod h1:SrN6iLZilNG1X4neq1D+SBxoqfAF4nyzvmevkTkWsek=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/vbauerster/mpb v1.1.3 h1:IRgic8VFaURXkW0VxDLkNOiNaAgtw0okB2YIaVvJDI4=
 github.com/vbauerster/mpb v3.4.0+incompatible h1:mfiiYw87ARaeRW6x5gWwYRUawxaW1tLAD8IceomUCNw=

v2/internal/progress/progress.go → internal/progress/progress.go

@@ -2,19 +2,24 @@ package progress
 
 import (
 	"fmt"
-	"github.com/logrusorgru/aurora"
-	"github.com/projectdiscovery/gologger"
-	"github.com/vbauerster/mpb/v5"
-	"github.com/vbauerster/mpb/v5/decor"
 	"io"
 	"os"
 	"strings"
 	"sync"
 	"time"
+
+	"github.com/logrusorgru/aurora"
+	"github.com/projectdiscovery/gologger"
+	"github.com/vbauerster/mpb/v5"
+	"github.com/vbauerster/mpb/v5/decor"
 )
 
-// global output refresh rate
-const RefreshHz = 8
+const (
+	// global output refresh rate
+	refreshHz   = 8
+	settleMilis = 250
+	mili        = 1000.
+)
 
 // Encapsulates progress tracking.
 type IProgress interface {
@@ -45,12 +50,12 @@ type Progress struct {
 }
 
 // Creates and returns a new progress tracking object.
-func NewProgress(noColor bool, active bool) IProgress {
+func NewProgress(noColor, active bool) IProgress {
 	if !active {
 		return &NoOpProgress{}
 	}
 
-	refreshMillis := int64(1. / float64(RefreshHz) * 1000.)
+	refreshMillis := int64(1. / float64(refreshHz) * mili)
 
 	renderChan := make(chan time.Time)
 	p := &Progress{
@@ -70,6 +75,7 @@ func NewProgress(noColor bool, active bool) IProgress {
 		stdRenderEvent:     time.NewTicker(time.Millisecond * time.Duration(refreshMillis)),
 		stdRenderWaitGroup: &sync.WaitGroup{},
 	}
+
 	return p
 }
 
@@ -144,17 +150,19 @@ func (p *Progress) Wait() {
 func (p *Progress) renderStdData() {
 	// trigger a render event
 	p.renderChan <- time.Now()
+
 	gologger.Infof("Waiting for your terminal to settle..")
-	time.Sleep(time.Millisecond * 250)
+	time.Sleep(time.Millisecond * settleMilis)
 
 	p.stdRenderWaitGroup.Add(1)
+
 	go func(waitGroup *sync.WaitGroup) {
 		for {
 			select {
 			case <-p.stdStopRenderEvent:
 				waitGroup.Done()
 				return
-			case _ = <-p.stdRenderEvent.C:
+			case <-p.stdRenderEvent.C:
 				p.stdCaptureMutex.Lock()
 				{
 					hasStdout := p.stdOut.Len() > 0
@@ -212,6 +220,7 @@ func pluralize(count int64, singular, plural string) string {
 	if count > 1 {
 		return plural
 	}
+
 	return singular
 }
 

v2/internal/progress/stdcapture.go → internal/progress/stdcapture.go

@@ -5,11 +5,17 @@ package progress
 */
 import (
 	"bufio"
-	"github.com/projectdiscovery/gologger"
 	"io"
 	"os"
 	"strings"
 	"sync"
+
+	"github.com/projectdiscovery/gologger"
+)
+
+const (
+	fourMegas = 4 * 1024
+	two       = 2
 )
 
 type captureData struct {
@@ -20,7 +26,7 @@ type captureData struct {
 	waitFinishRead *sync.WaitGroup
 }
 
-func startCapture(writeMutex *sync.Mutex, stdout *strings.Builder, stderr *strings.Builder) *captureData {
+func startCapture(writeLocker sync.Locker, stdout, stderr *strings.Builder) *captureData {
 	rStdout, wStdout, errStdout := os.Pipe()
 	if errStdout != nil {
 		panic(errStdout)
@@ -46,32 +52,39 @@ func startCapture(writeMutex *sync.Mutex, stdout *strings.Builder, stderr *strin
 
 	stdCopy := func(builder *strings.Builder, reader *os.File, waitGroup *sync.WaitGroup) {
 		r := bufio.NewReader(reader)
-		buf := make([]byte, 0, 4*1024)
+		buf := make([]byte, 0, fourMegas)
+
 		for {
 			n, err := r.Read(buf[:cap(buf)])
 			buf = buf[:n]
+
 			if n == 0 {
 				if err == nil {
 					continue
 				}
+
 				if err == io.EOF {
 					waitGroup.Done()
 					break
 				}
+
 				waitGroup.Done()
 				gologger.Fatalf("stdcapture error: %s", err)
 			}
+
 			if err != nil && err != io.EOF {
 				waitGroup.Done()
 				gologger.Fatalf("stdcapture error: %s", err)
 			}
-			writeMutex.Lock()
+
+			writeLocker.Lock()
 			builder.Write(buf)
-			writeMutex.Unlock()
+			writeLocker.Unlock()
 		}
 	}
 
-	c.waitFinishRead.Add(2)
+	c.waitFinishRead.Add(two)
+
 	go stdCopy(stdout, rStdout, c.waitFinishRead)
 	go stdCopy(stderr, rStderr, c.waitFinishRead)
 

v2/internal/runner/banner.go → internal/runner/banner.go

@@ -3,11 +3,11 @@ package runner
 import "github.com/projectdiscovery/gologger"
 
 const banner = `
-                       __     _ 
+                       __     _
      ____  __  _______/ /__  (_)
-    / __ \/ / / / ___/ / _ \/ / 
-   / / / / /_/ / /__/ /  __/ /  
-  /_/ /_/\__,_/\___/_/\___/_/   v2.1									  
+    / __ \/ / / / ___/ / _ \/ /
+   / / / / /_/ / /__/ /  __/ /
+  /_/ /_/\__,_/\___/_/\___/_/   v2.1
 `
 
 // Version is the current version of nuclei