Add mage

Author: rentziass

.gitignore

@@ -0,0 +1 @@
+bin

.golangci.yml

@@ -0,0 +1,117 @@
+# options for analysis running
+run:
+  deadline: 20s
+  tests: true
+  skip-dirs:
+    - generated
+  skip-files:
+    - ".*\\.pb\\.go"
+  silent: true
+
+# output configuration options
+output:
+  format: colored-line-number
+  print-issued-lines: true
+  print-linter-name: true
+
+# all available settings of specific linters
+linters-settings:
+  errcheck:
+    check-type-assertions: true
+    check-blank: true
+  govet:
+    check-shadowing: false
+    disable:
+      - shadow
+  gofmt:
+    simplify: true
+  goconst:
+    min-len: 3
+    min-occurrences: 3
+  misspell:
+    locale: UK
+    ignore-words:
+      - statuser
+  unused:
+    check-exported: true
+  unparam:
+    algo: cha
+  nakedret:
+    max-func-lines: 30
+  prealloc:
+    simple: true
+    range-loops: true
+    for-loops: true
+
+linters:
+  enable:
+    - golint # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes [fast: true]
+    - misspell # Finds commonly misspelled English words in comments [fast: true]
+    - nakedret # Finds naked returns in functions greater than a specified function length [fast: true]
+    - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases [fast: false]
+    - gas # Inspects source code for security problems [fast: false]
+    - structcheck # Finds an unused struct fields [fast: false]
+    - unconvert # Remove unnecessary type conversions [fast: false]
+    - unparam # Reports unused function parameters [fast: false]
+    - goimports # Goimports does everything that gofmt does. Additionally it checks unused imports [fast: true]
+    - lll # Reports long lines [fast: true]
+    - megacheck # 3 sub-linters in one: unused, gosimple and staticcheck [fast: false]
+
+  disable:
+    - staticcheck # (megacheck) Staticcheck is a go vet on steroids, applying a ton of static analysis checks [fast: false]
+    - prealloc # Finds slice declarations that could potentially be preallocated [fast: true]
+    - unused # (megacheck) Checks Go code for unused constants, variables, functions and types [fast: false]
+    - gosimple # (megacheck) Linter for Go source code that specializes in simplifying a code [fast: false]
+    - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true]
+    - dupl # Tool for code clone detection [fast: true]
+    - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code [fast: false]
+    - depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: false]
+    - varcheck # Finds unused global variables and constants [fast: false]
+    - deadcode # Finds unused code [fast: false]
+    - goconst # Finds repeated strings that could be replaced by a constant [fast: true]
+    - gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true]
+    - maligned # Tool to detect Go structs that would take less memory if their fields were sorted [fast: false]
+
+issues:
+  exclude-use-default: false
+  exclude-rules:
+    - linters:
+        - lll
+      source: "github.com/utilitywarehouse/ordering-platform"
+  exclude:
+    # errcheck: Almost all programs ignore errors on these functions and in most cases it's ok
+    - Error return value of
+      .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*printf?|os\.(Un)?Setenv|.*Disconnect).
+      is not checked
+
+    # golint: Exported variables are rarely used and generally reserved for errors which should be self explanitory
+    - exported var \w+ should have comment or be unexported
+
+    # golint: False positive when tests are defined in package 'test'
+    - func name will be used as test\.Test.* by other packages, and that
+      stutters; consider calling this
+
+    # gas: Too many false-positives on 'unsafe' usage
+    - Use of unsafe calls should be audited
+
+    # gas: Too many false-positives for parametrized shell calls
+    - Subprocess launch(ed with variable|ing should be audited)
+
+    # gas: Duplicated errcheck checks
+    - G104
+
+    # gas: Too many issues in popular repos
+    - (Expect directory permissions to be 0750 or less|Expect file permissions
+      to be 0600 or less)
+
+    # gas: False positive is triggered by 'src, err := ioutil.ReadFile(filename)'
+    - Potential file inclusion via variable
+
+    # govet: Common false positives
+    - (possible misuse of unsafe.Pointer|should have signature)
+
+    # megacheck: Developers tend to write in C-style with an explicit 'break' in a 'switch', so it's ok to ignore
+    - ineffective break statement. Did you mean to break out of the outer loop
+
+    # disable comments
+    - exported [a-z]+ `?[^ ]+ should have comment

go.mod

@@ -4,6 +4,7 @@ go 1.17
 
 require (
 	github.com/go-git/go-git/v5 v5.4.2
+	github.com/magefile/mage v1.11.0
 	github.com/stretchr/testify v1.7.0
 	golang.org/x/mod v0.5.1
 )

go.sum

@@ -44,6 +44,8 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/magefile/mage v1.11.0 h1:C/55Ywp9BpgVVclD3lRnSYCwXTYxmSppIgLeDYlNuls=
+github.com/magefile/mage v1.11.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/matryer/is v1.2.0 h1:92UTHpy8CDwaJ08GqLDzhhuixiBUUD1p3AU6PHddz4A=
 github.com/matryer/is v1.2.0/go.mod h1:2fLPjFQM9rhQ15aVEtbuwhJinnOqrmgXPNdZsdwlWXA=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=

magefile.go

@@ -0,0 +1,56 @@
+//go:build mage
+// +build mage
+
+package main
+
+import (
+	"fmt"
+	"path/filepath"
+	"strings"
+
+	"github.com/magefile/mage/sh"
+)
+
+// Lint runs code linters on current directory and all
+// subdirectories
+func Lint() error {
+	linter := sh.OutCmd(filepath.Join(RepoRoot(), "bin", "golangci-lint"))
+	version := "1.39.0"
+
+	currentVersion, err := linter("--version")
+	if err != nil || !strings.Contains(currentVersion, version) {
+		fmt.Println("linter binary outdated or missing, downloading a new one now")
+		err := updateLinter(version)
+		if err != nil {
+			return err
+		}
+	}
+
+	out, err := linter("run", "--deadline=2m", "--config="+RepoRoot()+"/.golangci.yml", "./...")
+	if out != "" {
+		fmt.Println(out)
+	}
+	return err
+}
+
+// Test tests all go code in the current directory and
+// all subdirectories
+func Test() error {
+	return sh.RunV("go", "test", "./...")
+}
+
+func updateLinter(version string) error {
+	return sh.Run("bash", "-c",
+		"curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "+
+			RepoRoot()+"/bin v"+version,
+	)
+}
+
+func RepoRoot() string {
+	path, err := sh.Output("git", "rev-parse", "--show-toplevel")
+	if err != nil {
+		panic(err)
+	}
+
+	return path
+}

patrol/patrol_test.go

@@ -109,7 +109,7 @@ func copy(source, destination string) error {
 			if err1 != nil {
 				return err1
 			}
-			return ioutil.WriteFile(filepath.Join(destination, relPath), data, 0777)
+			return ioutil.WriteFile(filepath.Join(destination, relPath), data, 0600)
 		}
 
 		return nil