Skip to content

Commit

Permalink
Upgrade golangci-lint, more linters
Browse files Browse the repository at this point in the history
Introduces new linters, upgrade golangci-lint to version (v1.63.4)
  • Loading branch information
JoeTurki committed Jan 22, 2025
1 parent 185bbf7 commit d867efd
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 25 deletions.
47 changes: 30 additions & 17 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,32 @@ linters-settings:
- ^os.Exit$
- ^panic$
- ^print(ln)?$
varnamelen:
max-distance: 12
min-name-length: 2
ignore-type-assert-ok: true
ignore-map-index-ok: true
ignore-chan-recv-ok: true
ignore-decls:
- i int
- n int
- w io.Writer
- r io.Reader
- b []byte

linters:
enable:
- asciicheck # Simple linter to check that your code does not contain non-ASCII identifiers
- bidichk # Checks for dangerous unicode character sequences
- bodyclose # checks whether HTTP response body is closed successfully
- containedctx # containedctx is a linter that detects struct contained context.Context field
- contextcheck # check the function whether use a non-inherited context
- cyclop # checks function and package cyclomatic complexity
- decorder # check declaration order and count of types, constants, variables and functions
- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
- dupl # Tool for code clone detection
- durationcheck # check for two durations multiplied together
- err113 # Golang linter to check the errors handling expressions
- errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
- errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occations, where the check for the returned error can be omitted.
- errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.
Expand All @@ -46,66 +61,64 @@ linters:
- forcetypeassert # finds forced type assertions
- gci # Gci control golang package import order and make it always deterministic.
- gochecknoglobals # Checks that no globals are present in Go code
- gochecknoinits # Checks that no init functions are present in Go code
- gocognit # Computes and checks the cognitive complexity of functions
- goconst # Finds repeated strings that could be replaced by a constant
- gocritic # The most opinionated Go source code linter
- gocyclo # Computes and checks the cyclomatic complexity of functions
- godot # Check if comments end in a period
- godox # Tool for detection of FIXME, TODO and other comment keywords
- err113 # Golang linter to check the errors handling expressions
- gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
- gofumpt # Gofumpt checks whether code was gofumpt-ed.
- goheader # Checks is file header matches to pattern
- goimports # Goimports does everything that gofmt does. Additionally it checks unused imports
- gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
- gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
- goprintffuncname # Checks that printf-like functions are named with `f` at the end
- gosec # Inspects source code for security problems
- gosimple # Linter for Go source code that specializes in simplifying a code
- govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
- grouper # An analyzer to analyze expression groups.
- importas # Enforces consistent import aliases
- ineffassign # Detects when assignments to existing variables are not used
- lll # Reports long lines
- maintidx # maintidx measures the maintainability index of each function.
- makezero # Finds slice declarations with non-zero initial length
- misspell # Finds commonly misspelled English words in comments
- nakedret # Finds naked returns in functions greater than a specified function length
- nestif # Reports deeply nested if statements
- nilerr # Finds the code that returns nil even if it checks that the error is not nil.
- nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value.
- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity
- noctx # noctx finds sending http request without context.Context
- predeclared # find code that shadows one of Go's predeclared identifiers
- revive # golint replacement, finds style mistakes
- staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
- stylecheck # Stylecheck is a replacement for golint
- tagliatelle # Checks the struct tags.
- tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17
- tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
- thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
- typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
- unconvert # Remove unnecessary type conversions
- unparam # Reports unused function parameters
- unused # Checks Go code for unused constants, variables, functions and types
- varnamelen # checks that the length of a variable's name matches its scope
- wastedassign # wastedassign finds wasted assignment statements
- whitespace # Tool for detection of leading and trailing whitespace
disable:
- depguard # Go linter that checks if package imports are in a list of acceptable packages
- containedctx # containedctx is a linter that detects struct contained context.Context field
- cyclop # checks function and package cyclomatic complexity
- funlen # Tool for detection of long functions
- gocyclo # Computes and checks the cyclomatic complexity of functions
- godot # Check if comments end in a period
- gomnd # An analyzer to detect magic numbers.
- gochecknoinits # Checks that no init functions are present in Go code
- gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations.
- interfacebloat # A linter that checks length of interface.
- ireturn # Accept Interfaces, Return Concrete Types
- lll # Reports long lines
- maintidx # maintidx measures the maintainability index of each function.
- makezero # Finds slice declarations with non-zero initial length
- nakedret # Finds naked returns in functions greater than a specified function length
- nestif # Reports deeply nested if statements
- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity
- mnd # An analyzer to detect magic numbers
- nolintlint # Reports ill-formed or insufficient nolint directives
- paralleltest # paralleltest detects missing usage of t.Parallel() method in your Go test
- prealloc # Finds slice declarations that could potentially be preallocated
- promlinter # Check Prometheus metrics naming via promlint
- rowserrcheck # checks whether Err of rows is checked successfully
- sqlclosecheck # Checks that sql.Rows and sql.Stmt are closed.
- testpackage # linter that makes you use a separate _test package
- thelper # thelper detects golang test helpers without t.Helper() call and checks the consistency of test helpers
- varnamelen # checks that the length of a variable's name matches its scope
- tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes
- wrapcheck # Checks that errors returned from external packages are wrapped
- wsl # Whitespace Linter - Forces you to use empty lines!

Expand Down
2 changes: 2 additions & 0 deletions crypto.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ func GenerateCryptoRandomString(n int, runes string) (string, error) {
}
b[i] = letters[v.Int64()]
}

return string(b), nil
}

Expand All @@ -29,5 +30,6 @@ func CryptoUint64() (uint64, error) {
if err := binary.Read(crand.Reader, binary.LittleEndian, &v); err != nil {
return 0, err
}

return v, nil
}
8 changes: 6 additions & 2 deletions math.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,30 +39,33 @@ func NewMathRandomGenerator() MathRandomGenerator {
seed, err := CryptoUint64()
if err != nil {
// crypto/rand is unavailable. Fallback to seed by time.
seed = uint64(time.Now().UnixNano())
seed = uint64(time.Now().UnixNano()) //nolint:gosec // G115

Check warning on line 42 in math.go

View check run for this annotation

Codecov / codecov/patch

math.go#L42

Added line #L42 was not covered by tests
}

return &mathRandomGenerator{r: mrand.New(mrand.NewSource(int64(seed)))} //nolint: stylecheck, gosec
return &mathRandomGenerator{r: mrand.New(mrand.NewSource(int64(seed)))} //nolint:stylecheck,gosec
}

func (g *mathRandomGenerator) Intn(n int) int {
g.mu.Lock()
v := g.r.Intn(n)
g.mu.Unlock()

return v
}

func (g *mathRandomGenerator) Uint32() uint32 {
g.mu.Lock()
v := g.r.Uint32()
g.mu.Unlock()

return v
}

func (g *mathRandomGenerator) Uint64() uint64 {
g.mu.Lock()
v := g.r.Uint64()
g.mu.Unlock()

return v
}

Expand All @@ -72,5 +75,6 @@ func (g *mathRandomGenerator) GenerateString(n int, runes string) string {
for i := range b {
b[i] = letters[g.Intn(len(letters))]
}

return string(b)
}
15 changes: 9 additions & 6 deletions rand_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,19 @@ func TestRandomGeneratorCollision(t *testing.T) {
},
"CryptoRandom": {
gen: func(t *testing.T) string {
t.Helper()

s, err := GenerateCryptoRandomString(10, runesAlpha)
if err != nil {
t.Fatal(err)
}

return s
},
},
}

const N = 100
const maxIterations = 100
const iteration = 100

for name, testCase := range testCases {
Expand All @@ -42,9 +45,9 @@ func TestRandomGeneratorCollision(t *testing.T) {
var wg sync.WaitGroup
var mu sync.Mutex

rands := make([]string, 0, N)
rands := make([]string, 0, maxIterations)

for i := 0; i < N; i++ {
for i := 0; i < maxIterations; i++ {
wg.Add(1)
go func() {
r := testCase.gen(t)
Expand All @@ -56,12 +59,12 @@ func TestRandomGeneratorCollision(t *testing.T) {
}
wg.Wait()

if len(rands) != N {
if len(rands) != maxIterations {
t.Fatal("Failed to generate randoms")
}

for i := 0; i < N; i++ {
for j := i + 1; j < N; j++ {
for i := 0; i < maxIterations; i++ {
for j := i + 1; j < maxIterations; j++ {
if rands[i] == rands[j] {
t.Fatalf("generateRandString caused collision: %s == %s", rands[i], rands[j])
}
Expand Down

0 comments on commit d867efd

Please sign in to comment.