yolokube/country-geo-locations
yolokube/country-geo-locations
2
1
Fork 0
Code Issues 2 Pull requests Projects Releases Packages 1 Wiki Activity

chore(deps): update golangci/golangci-lint docker tag to v2 #87

Merged
renovate merged 4 commits from renovate/golangci-golangci-lint-2.x into main 2025-04-18 16:13:23 +02:00
Conversation 1 Commits 4 Files changed 9 +370 -285
9 changed files with 370 additions and 285 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

578
.golangci.yml
View file

@ -1,239 +1,51 @@
# This code is licensed under the terms of the MIT license https://opensource.org/license/mit # This file is licensed under the terms of the MIT license https://opensource.org/license/mit
# Copyright (c) 2021-2025 Marat Reymers # Copyright (c) 2021-2025 Marat Reymers
## Golden config for golangci-lint v1.63.4 ## Golden config for golangci-lint v2.1.2
# #
# This is the best config for golangci-lint based on my experience and opinion. # This is the best config for golangci-lint based on my experience and opinion.
# It is very strict, but not extremely strict. # It is very strict, but not extremely strict.
# Feel free to adapt and change it for your needs. # Feel free to adapt it to suit your needs.
# If this config helps you, please consider keeping a link to this file (see the next comment).
run: # Based on https://gist.github.com/maratori/47a4d00457a92aa426dbd48a18776322
# Timeout for analysis, e.g. 30s, 5m.
# Default: 1m
timeout: 3m
version: "2"
# This file contains only configs which differ from defaults. issues:
# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml # Maximum count of issues with the same text.
linters-settings: # Set to 0 to disable.
cyclop: # Default: 3
# The maximal code complexity to report. max-same-issues: 50
# Default: 10
max-complexity: 30
# The maximal average package complexity.
# If it's higher than 0.0 (float) the check is enabled
# Default: 0.0
package-average: 10.0
errcheck: formatters:
# Report about not checking of errors in type assertions: `a := b.(MyStruct)`. enable:
# Such cases aren't reported by default. - goimports # checks if the code and import statements are formatted according to the 'goimports' command
# Default: false - golines # checks if code is formatted, and fixes long lines
check-type-assertions: true
exhaustive: ## you may want to enable
# Program elements to check for exhaustiveness. #- gci # checks if code and import statements are formatted, with additional rules
# Default: [ switch ] #- gofmt # checks if the code is formatted according to 'gofmt' command
check:
- switch
- map
exhaustruct: ## disabled
# List of regular expressions to exclude struct packages and their names from checks. #- gofumpt # [replaced by goimports, gofumports is not available yet] checks if code and import statements are formatted, with additional rules
# Regular expressions must match complete canonical struct package/name/structname.
# Default: []
exclude:
# std libs
- "^net/http.Client$"
- "^net/http.Cookie$"
- "^net/http.Request$"
- "^net/http.Response$"
- "^net/http.Server$"
- "^net/http.Transport$"
- "^net/url.URL$"
- "^os/exec.Cmd$"
- "^reflect.StructField$"
# public libs
- "^github.com/Shopify/sarama.Config$"
- "^github.com/Shopify/sarama.ProducerMessage$"
- "^github.com/mitchellh/mapstructure.DecoderConfig$"
- "^github.com/prometheus/client_golang/.+Opts$"
- "^github.com/spf13/cobra.Command$"
- "^github.com/spf13/cobra.CompletionOptions$"
- "^github.com/stretchr/testify/mock.Mock$"
- "^github.com/testcontainers/testcontainers-go.+Request$"
- "^github.com/testcontainers/testcontainers-go.FromDockerfile$"
- "^golang.org/x/tools/go/analysis.Analyzer$"
- "^google.golang.org/protobuf/.+Options$"
- "^gopkg.in/yaml.v3.Node$"
funlen: # All settings can be found here https://github.com/golangci/golangci-lint/blob/HEAD/.golangci.reference.yml
# Checks the number of lines in a function. settings:
# If lower than 0, disable the check. goimports:
# Default: 60 # A list of prefixes, which, if set, checks import paths
lines: 100 # with the given prefixes are grouped after 3rd-party packages.
# Checks the number of statements in a function.
# If lower than 0, disable the check.
# Default: 40
statements: 50
# Ignore comments when counting lines.
# Default false
ignore-comments: true
gochecksumtype:
# Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed.
# Default: true
default-signifies-exhaustive: false
gocognit:
# Minimal code complexity to report.
# Default: 30 (but we recommend 10-20)
min-complexity: 20
gocritic:
# Settings passed to gocritic.
# The settings key is the name of a supported gocritic checker.
# The list of supported checkers can be find in https://go-critic.github.io/overview.
settings:
captLocal:
# Whether to restrict checker to params only.
# Default: true
paramsOnly: false
underef:
# Whether to skip (*x).method() calls where x is a pointer receiver.
# Default: true
skipRecvDeref: false
gomodguard:
blocked:
# List of blocked modules.
# Default: [] # Default: []
modules: local-prefixes:
- github.com/golang/protobuf: - github.com/my/project
recommendations:
- google.golang.org/protobuf
reason: "see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules"
- github.com/satori/go.uuid:
recommendations:
- github.com/google/uuid
reason: "satori's package is not maintained"
- github.com/gofrs/uuid:
recommendations:
- github.com/gofrs/uuid/v5
reason: "gofrs' package was not go module before v5"
govet:
# Enable all analyzers.
# Default: false
enable-all: true
# Disable analyzers by name.
# Run `go tool vet help` to see all analyzers.
# Default: []
disable:
- fieldalignment # too strict
# Settings per analyzer.
settings:
shadow:
# Whether to be strict about shadowing; can be noisy.
# Default: false
strict: true
inamedparam:
# Skips check for interface methods with only a single parameter.
# Default: false
skip-single-param: true
mnd:
# List of function patterns to exclude from analysis.
# Values always ignored: `time.Date`,
# `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
# `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
# Default: []
ignored-functions:
- args.Error
- flag.Arg
- flag.Duration.*
- flag.Float.*
- flag.Int.*
- flag.Uint.*
- os.Chmod
- os.Mkdir.*
- os.OpenFile
- os.WriteFile
- prometheus.ExponentialBuckets.*
- prometheus.LinearBuckets
nakedret:
# Make an issue if func has more lines of code than this setting, and it has naked returns.
# Default: 30
max-func-lines: 0
nolintlint:
# Exclude following linters from requiring an explanation.
# Default: []
allow-no-explanation: [ funlen, gocognit, lll ]
# Enable to require an explanation of nonzero length after each nolint directive.
# Default: false
require-explanation: true
# Enable to require nolint directives to mention the specific linter being suppressed.
# Default: false
require-specific: true
perfsprint:
# Optimizes into strings concatenation.
# Default: true
strconcat: false
reassign:
# Patterns for global variable names that are checked for reassignment.
# See https://github.com/curioswitch/go-reassign#usage
# Default: ["EOF", "Err.*"]
patterns:
- ".*"
rowserrcheck:
# database/sql is always checked
# Default: []
packages:
- github.com/jmoiron/sqlx
sloglint:
# Enforce not using global loggers.
# Values:
# - "": disabled
# - "all": report all global loggers
# - "default": report only the default slog logger
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global
# Default: ""
no-global: "all"
# Enforce using methods that accept a context.
# Values:
# - "": disabled
# - "all": report all contextless calls
# - "scope": report only if a context exists in the scope of the outermost function
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only
# Default: ""
context: "scope"
tenv:
# The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
# Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
# Default: false
all: true
golines:
# Target maximum line length.
# Default: 100
max-len: 120
linters: linters:
disable-all: true
enable: enable:
## enabled by default
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
- gosimple # specializes in simplifying a code
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
- ineffassign # detects when assignments to existing variables are not used
- staticcheck # is a go vet on steroids, applying a ton of static analysis checks
- typecheck # like the front-end of a Go compiler, parses and type-checks Go code
- unused # checks for unused constants, variables, functions and types
## disabled by default
- asasalint # checks for pass []any as any in variadic func(...any) - asasalint # checks for pass []any as any in variadic func(...any)
- asciicheck # checks that your code does not contain non-ASCII identifiers - asciicheck # checks that your code does not contain non-ASCII identifiers
- bidichk # checks for dangerous unicode character sequences - bidichk # checks for dangerous unicode character sequences
@ -241,14 +53,17 @@ linters:
- canonicalheader # checks whether net/http.Header uses canonical header - canonicalheader # checks whether net/http.Header uses canonical header
- copyloopvar # detects places where loop variables are copied (Go 1.22+) - copyloopvar # detects places where loop variables are copied (Go 1.22+)
- cyclop # checks function and package cyclomatic complexity - cyclop # checks function and package cyclomatic complexity
- depguard # checks if package imports are in a list of acceptable packages
- dupl # tool for code clone detection - dupl # tool for code clone detection
- durationcheck # checks for two durations multiplied together - durationcheck # checks for two durations multiplied together
- errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
- errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
- errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13 - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
- exhaustive # checks exhaustiveness of enum switch statements - exhaustive # checks exhaustiveness of enum switch statements
- exptostd # detects functions from golang.org/x/exp/ that can be replaced by std functions - exptostd # detects functions from golang.org/x/exp/ that can be replaced by std functions
- fatcontext # detects nested contexts in loops - fatcontext # detects nested contexts in loops
- forbidigo # forbids identifiers - forbidigo # forbids identifiers
- funcorder # checks the order of functions, methods, and constructors
- funlen # tool for detection of long functions - funlen # tool for detection of long functions
- gocheckcompilerdirectives # validates go compiler directive comments (//go:) - gocheckcompilerdirectives # validates go compiler directive comments (//go:)
- gochecknoglobals # checks that no global variables exist - gochecknoglobals # checks that no global variables exist
@ -259,17 +74,17 @@ linters:
- gocritic # provides diagnostics that check for bugs, performance and style issues - gocritic # provides diagnostics that check for bugs, performance and style issues
- gocyclo # computes and checks the cyclomatic complexity of functions - gocyclo # computes and checks the cyclomatic complexity of functions
- godot # checks if comments end in a period - godot # checks if comments end in a period
- goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod - gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
- gomodguard # allow and block lists 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 - goprintffuncname # checks that printf-like functions are named with f at the end
- gosec # inspects source code for security problems - gosec # inspects source code for security problems
- govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
- iface # checks the incorrect use of interfaces, helping developers avoid interface pollution - iface # checks the incorrect use of interfaces, helping developers avoid interface pollution
- ineffassign # detects when assignments to existing variables are not used
- intrange # finds places where for loops could make use of an integer range - intrange # finds places where for loops could make use of an integer range
- lll # reports long lines
- loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap) - loggercheck # checks key value pairs for common logger libraries (kitlog,klog,logr,zap)
- makezero # finds slice declarations with non-zero initial length - makezero # finds slice declarations with non-zero initial length
- mirror # reports wrong mirror patterns of bytes/strings usage - mirror # reports wrong mirror patterns of bytes/strings usage
- misspell # finds commonly misspelled English words in comments
- mnd # detects magic numbers - mnd # detects magic numbers
- musttag # enforces field tags in (un)marshaled structs - musttag # enforces field tags in (un)marshaled structs
- nakedret # finds naked returns in functions greater than a specified function length - nakedret # finds naked returns in functions greater than a specified function length
@ -292,14 +107,14 @@ linters:
- sloglint # ensure consistent code style when using log/slog - sloglint # ensure consistent code style when using log/slog
- spancheck # checks for mistakes with OpenTelemetry/Census spans - spancheck # checks for mistakes with OpenTelemetry/Census spans
- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed - sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
- stylecheck # is a replacement for golint - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
- tenv # detects using os.Setenv instead of t.Setenv since Go1.17
- testableexamples # checks if examples are testable (have an expected output) - testableexamples # checks if examples are testable (have an expected output)
- testifylint # checks usage of github.com/stretchr/testify - testifylint # checks usage of github.com/stretchr/testify
- testpackage # makes you use a separate _test package - testpackage # makes you use a separate _test package
- tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
- unconvert # removes unnecessary type conversions - unconvert # removes unnecessary type conversions
- unparam # reports unused function parameters - unparam # reports unused function parameters
- unused # checks for unused constants, variables, functions and types
- usestdlibvars # detects the possibility to use variables/constants from the Go standard library - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
- usetesting # reports uses of functions with replacement inside the testing package - usetesting # reports uses of functions with replacement inside the testing package
- wastedassign # finds wasted assignment statements - wastedassign # finds wasted assignment statements
@ -308,9 +123,8 @@ linters:
## you may want to enable ## you may want to enable
#- decorder # checks declaration order and count of types, constants, variables and functions #- decorder # checks declaration order and count of types, constants, variables and functions
#- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized #- exhaustruct # [highly recommend to enable] checks if all structure fields are initialized
#- gci # controls golang package import order and makes it always deterministic
#- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega #- ginkgolinter # [if you use ginkgo/gomega] enforces standards of using ginkgo and gomega
#- godox # detects FIXME, TODO and other comment keywords #- godox # detects usage of FIXME, TODO and other keywords inside comments
#- goheader # checks is file header matches to pattern #- goheader # checks is file header matches to pattern
#- inamedparam # [great idea, but too strict, need to ignore a lot of cases by default] reports interfaces with unnamed method parameters #- inamedparam # [great idea, but too strict, need to ignore a lot of cases by default] reports interfaces with unnamed method parameters
#- interfacebloat # checks the number of methods inside an interface #- interfacebloat # checks the number of methods inside an interface
@ -324,45 +138,307 @@ linters:
## disabled ## disabled
#- containedctx # detects struct contained context.Context field #- containedctx # detects struct contained context.Context field
#- contextcheck # [too many false positives] checks the function whether use a non-inherited context #- contextcheck # [too many false positives] checks the function whether use a non-inherited context
#- depguard # [replaced by gomodguard] checks if package imports are in a list of acceptable packages
#- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) #- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
#- dupword # [useless without config] checks for duplicate words in the source code #- dupword # [useless without config] checks for duplicate words in the source code
#- err113 # [too strict] checks the errors handling expressions #- err113 # [too strict] checks the errors handling expressions
#- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted #- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted
#- exportloopref # [not necessary from Go 1.22] checks for pointers to enclosing loop variables
#- forcetypeassert # [replaced by errcheck] finds forced type assertions #- forcetypeassert # [replaced by errcheck] finds forced type assertions
#- gofmt # [replaced by goimports] checks whether code was gofmt-ed #- gomodguard # [use more powerful depguard] allow and block lists linter for direct Go module dependencies
#- gofumpt # [replaced by goimports, gofumports is not available yet] checks whether code was gofumpt-ed
#- gosmopolitan # reports certain i18n/l10n anti-patterns in your Go codebase #- gosmopolitan # reports certain i18n/l10n anti-patterns in your Go codebase
#- grouper # analyzes expression groups #- grouper # analyzes expression groups
#- importas # enforces consistent import aliases #- importas # enforces consistent import aliases
#- lll # [replaced by golines] reports long lines
#- maintidx # measures the maintainability index of each function #- maintidx # measures the maintainability index of each function
#- misspell # [useless] finds commonly misspelled English words in comments
#- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity #- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
#- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test #- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test
#- tagliatelle # checks the struct tags #- tagliatelle # checks the struct tags
#- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers #- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers
#- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines #- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines
# All settings can be found here https://github.com/golangci/golangci-lint/blob/HEAD/.golangci.reference.yml
settings:
cyclop:
# The maximal code complexity to report.
# Default: 10
max-complexity: 30
# The maximal average package complexity.
# If it's higher than 0.0 (float) the check is enabled.
# Default: 0.0
package-average: 10.0
issues: depguard:
# Maximum count of issues with the same text. # Rules to apply.
# Set to 0 to disable. #
# Default: 3 # Variables:
max-same-issues: 50 # - File Variables
# Use an exclamation mark `!` to negate a variable.
# Example: `!$test` matches any file that is not a go test file.
#
# `$all` - matches all go files
# `$test` - matches all go test files
#
# - Package Variables
#
# `$gostd` - matches all of go's standard library (Pulled from `GOROOT`)
#
# Default (applies if no custom rules are defined): Only allow $gostd in all files.
rules:
"deprecated":
# List of file globs that will match this list of settings to compare against.
# By default, if a path is relative, it is relative to the directory where the golangci-lint command is executed.
# The placeholder '${base-path}' is substituted with a path relative to the mode defined with `run.relative-path-mode`.
# The placeholder '${config-path}' is substituted with a path relative to the configuration file.
# Default: $all
files:
- "$all"
# List of packages that are not allowed.
# Entries can be a variable (starting with $), a string prefix, or an exact match (if ending with $).
# Default: []
deny:
- pkg: github.com/golang/protobuf
desc: Use google.golang.org/protobuf instead, see https://developers.google.com/protocol-buffers/docs/reference/go/faq#modules
- pkg: github.com/satori/go.uuid
desc: Use github.com/google/uuid instead, satori's package is not maintained
- pkg: github.com/gofrs/uuid$
desc: Use github.com/gofrs/uuid/v5 or later, it was not a go module before v5
"non-test files":
files:
- "!$test"
deny:
- pkg: math/rand$
desc: Use math/rand/v2 instead, see https://go.dev/blog/randv2
"non-main files":
files:
- "!**/main.go"
deny:
- pkg: log$
desc: Use log/slog instead, see https://go.dev/blog/slog
exclude-rules: errcheck:
- source: "(noinspection|TODO)" # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
linters: [ godot ] # Such cases aren't reported by default.
- source: "//noinspection" # Default: false
linters: [ gocritic ] check-type-assertions: true
- path: "_test\\.go"
linters: exhaustive:
- bodyclose # Program elements to check for exhaustiveness.
- dupl # Default: [ switch ]
- errcheck check:
- funlen - switch
- goconst - map
- gosec
- noctx exhaustruct:
- wrapcheck # List of regular expressions to exclude struct packages and their names from checks.
# Regular expressions must match complete canonical struct package/name/structname.
# Default: []
exclude:
# std libs
- ^net/http.Client$
- ^net/http.Cookie$
- ^net/http.Request$
- ^net/http.Response$
- ^net/http.Server$
- ^net/http.Transport$
- ^net/url.URL$
- ^os/exec.Cmd$
- ^reflect.StructField$
# public libs
- ^github.com/Shopify/sarama.Config$
- ^github.com/Shopify/sarama.ProducerMessage$
- ^github.com/mitchellh/mapstructure.DecoderConfig$
- ^github.com/prometheus/client_golang/.+Opts$
- ^github.com/spf13/cobra.Command$
- ^github.com/spf13/cobra.CompletionOptions$
- ^github.com/stretchr/testify/mock.Mock$
- ^github.com/testcontainers/testcontainers-go.+Request$
- ^github.com/testcontainers/testcontainers-go.FromDockerfile$
- ^golang.org/x/tools/go/analysis.Analyzer$
- ^google.golang.org/protobuf/.+Options$
- ^gopkg.in/yaml.v3.Node$
funcorder:
# Checks if the exported methods of a structure are placed before the non-exported ones.
# Default: true
struct-method: false
funlen:
# Checks the number of lines in a function.
# If lower than 0, disable the check.
# Default: 60
lines: 100
# Checks the number of statements in a function.
# If lower than 0, disable the check.
# Default: 40
statements: 50
gochecksumtype:
# Presence of `default` case in switch statements satisfies exhaustiveness, if all members are not listed.
# Default: true
default-signifies-exhaustive: false
gocognit:
# Minimal code complexity to report.
# Default: 30 (but we recommend 10-20)
min-complexity: 20
gocritic:
# Settings passed to gocritic.
# The settings key is the name of a supported gocritic checker.
# The list of supported checkers can be found at https://go-critic.com/overview.
settings:
captLocal:
# Whether to restrict checker to params only.
# Default: true
paramsOnly: false
underef:
# Whether to skip (*x).method() calls where x is a pointer receiver.
# Default: true
skipRecvDeref: false
govet:
# Enable all analyzers.
# Default: false
enable-all: true
# Disable analyzers by name.
# Run `GL_DEBUG=govet golangci-lint run --enable=govet` to see default, all available analyzers, and enabled analyzers.
# Default: []
disable:
- fieldalignment # too strict
# Settings per analyzer.
settings:
shadow:
# Whether to be strict about shadowing; can be noisy.
# Default: false
strict: true
inamedparam:
# Skips check for interface methods with only a single parameter.
# Default: false
skip-single-param: true
mnd:
# List of function patterns to exclude from analysis.
# Values always ignored: `time.Date`,
# `strconv.FormatInt`, `strconv.FormatUint`, `strconv.FormatFloat`,
# `strconv.ParseInt`, `strconv.ParseUint`, `strconv.ParseFloat`.
# Default: []
ignored-functions:
- args.Error
- flag.Arg
- flag.Duration.*
- flag.Float.*
- flag.Int.*
- flag.Uint.*
- os.Chmod
- os.Mkdir.*
- os.OpenFile
- os.WriteFile
- prometheus.ExponentialBuckets.*
- prometheus.LinearBuckets
nakedret:
# Make an issue if func has more lines of code than this setting, and it has naked returns.
# Default: 30
max-func-lines: 0
nolintlint:
# Exclude following linters from requiring an explanation.
# Default: []
allow-no-explanation: [ funlen, gocognit, golines ]
# Enable to require an explanation of nonzero length after each nolint directive.
# Default: false
require-explanation: true
# Enable to require nolint directives to mention the specific linter being suppressed.
# Default: false
require-specific: true
perfsprint:
# Optimizes into strings concatenation.
# Default: true
strconcat: false
reassign:
# Patterns for global variable names that are checked for reassignment.
# See https://github.com/curioswitch/go-reassign#usage
# Default: ["EOF", "Err.*"]
patterns:
- ".*"
rowserrcheck:
# database/sql is always checked.
# Default: []
packages:
- github.com/jmoiron/sqlx
sloglint:
# Enforce not using global loggers.
# Values:
# - "": disabled
# - "all": report all global loggers
# - "default": report only the default slog logger
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#no-global
# Default: ""
no-global: ""
# Enforce using methods that accept a context.
# Values:
# - "": disabled
# - "all": report all contextless calls
# - "scope": report only if a context exists in the scope of the outermost function
# https://github.com/go-simpler/sloglint?tab=readme-ov-file#context-only
# Default: ""
context: scope
staticcheck:
# SAxxxx checks in https://staticcheck.dev/docs/configuration/options/#checks
# Example (to disable some checks): [ "all", "-SA1000", "-SA1001"]
# Default: ["all", "-ST1000", "-ST1003", "-ST1016", "-ST1020", "-ST1021", "-ST1022"]
checks:
- all
# Incorrect or missing package comment.
# https://staticcheck.dev/docs/checks/#ST1000
- -ST1000
# Use consistent method receiver names.
# https://staticcheck.dev/docs/checks/#ST1016
- -ST1016
# Omit embedded fields from selector expression.
# https://staticcheck.dev/docs/checks/#QF1008
- -QF1008
usetesting:
# Enable/disable `os.TempDir()` detections.
# Default: false
os-temp-dir: true
exclusions:
# Log a warning if an exclusion rule is unused.
# Default: false
warn-unused: true
# Predefined exclusion rules.
# Default: []
presets:
- std-error-handling
- common-false-positives
# Excluding configuration per-path, per-linter, per-text and per-source.
rules:
- source: 'TODO'
linters: [ godot ]
- text: 'should have a package comment'
linters: [ revive ]
- text: 'exported \S+ \S+ should have comment( \(or a comment on this block\))? or be unexported'
linters: [ revive ]
- text: 'package comment should be of the form ".+"'
source: '// ?(nolint|TODO)'
linters: [ revive ]
- text: 'comment on exported \S+ \S+ should be of the form ".+"'
source: '// ?(nolint|TODO)'
linters: [ revive, staticcheck ]
- path: '_test\.go'
linters:
- bodyclose
- dupl
- errcheck
- funlen
- goconst
- gosec
- noctx
- wrapcheck

2
.woodpecker/.lint.yaml
View file

@ -13,7 +13,7 @@ steps:
when: when:
- event: push - event: push
- name: golangci-linter - name: golangci-linter
image: golangci/golangci-lint:v1.64.8 image: golangci/golangci-lint:v2.1.2
commands: commands:
- golangci-lint run ./... - golangci-lint run ./...
when: when:

3
api/v1/renderer.go
View file

@ -1,7 +1,6 @@
package apiv1 package apiv1
import ( import (
"log"
"net/http" "net/http"
"github.com/go-chi/render" "github.com/go-chi/render"
@ -34,6 +33,6 @@ func errRender(err error) render.Renderer {
func renderResponse(w http.ResponseWriter, r *http.Request, v render.Renderer) { func renderResponse(w http.ResponseWriter, r *http.Request, v render.Renderer) {
if err := render.Render(w, r, v); err != nil { if err := render.Render(w, r, v); err != nil {
log.Fatal(err) panic(err)
} }
} }

16
internal/cmd/cli.go
View file

@ -22,14 +22,14 @@ type AppSettings struct {
//nolint:lll // ignore line length //nolint:lll // ignore line length
type CLI struct { type CLI struct {
ServerAddress string `name:"listen-address" env:"GEOIP_LISTEN_ADDRESS" help:"Address to use for the api server" default:"${default_address}"` ServerAddress string `name:"listen-address" env:"GEOIP_LISTEN_ADDRESS" help:"Address to use for the api server" default:"${default_address}"`
DataFile string `name:"data-file" env:"GEOIP_DATA_FILE" help:"path to data file" default:"${default_file_path}"` DataFile string `name:"data-file" env:"GEOIP_DATA_FILE" help:"path to data file" default:"${default_file_path}"`
DataURL string `name:"data-url" env:"GEOIP_DATA_URL" help:"url to data file"` DataURL string `name:"data-url" env:"GEOIP_DATA_URL" help:"url to data file"`
CacheTTL string `name:"cache-ttl" env:"GEOIP_CACHE_TTL" help:"ttl for response cache" default:"${default_cache_ttl}"` CacheTTL string `name:"cache-ttl" env:"GEOIP_CACHE_TTL" help:"ttl for response cache" default:"${default_cache_ttl}"`
ReadHeaderTimeout string `name:"read-header-timeout" env:"GEOIP_READ_HEADER_TIMEOUT" help:"timeout for reading http header" default:"${default_read_header_timeout}"` ReadHeaderTimeout string `name:"read-header-timeout" env:"GEOIP_READ_HEADER_TIMEOUT" help:"timeout for reading http header" default:"${default_read_header_timeout}"`
EnableExporter bool `name:"enable-exporter" env:"GEOIP_ENABLE_EXPORTER" help:"enable prometheus exporter" default:"${default_enable_exporter}"` EnableExporter bool `name:"enable-exporter" env:"GEOIP_ENABLE_EXPORTER" help:"enable prometheus exporter" default:"${default_enable_exporter}"`
ExporterAddress string `name:"exporter-address" env:"GEOIP_EXPORTER_ADDRESS" help:"Address to use for the prometheus metrics server" default:"${default_exporter_address}"` ExporterAddress string `name:"exporter-address" env:"GEOIP_EXPORTER_ADDRESS" help:"Address to use for the prometheus metrics server" default:"${default_exporter_address}"`
ExporterInterval string `name:"exporter-interval" env:"GEOIP_EXPORTER_INTERVAL" help:"Interval to scrape the new metrics data" default:"${default_exporter_interval}"` ExporterInterval string `name:"exporter-interval" env:"GEOIP_EXPORTER_INTERVAL" help:"Interval to scrape the new metrics data" default:"${default_exporter_interval}"`
} }
func (c *CLI) Parse() (*AppSettings, error) { func (c *CLI) Parse() (*AppSettings, error) {

9
internal/downloader/downloader.go
View file

@ -40,7 +40,10 @@ func (c *Context) Download() error {
} }
return err return err
} }
defer resp.Close() if err = resp.Close(); err != nil {
return err
}
if resp.StatusCode == http.StatusNotFound { if resp.StatusCode == http.StatusNotFound {
return ErrInvalidURL return ErrInvalidURL
} }
@ -50,19 +53,19 @@ func (c *Context) Download() error {
if resp.StatusCode != http.StatusOK { if resp.StatusCode != http.StatusOK {
return errors.New(resp.RawResponse.Status) return errors.New(resp.RawResponse.Status)
} }
resp.Close()
resp, err = req.Get(c.Link, nil) resp, err = req.Get(c.Link, nil)
if err != nil { if err != nil {
return err return err
} }
defer resp.Close()
var filesize int64 var filesize int64
if resp.RawResponse.ContentLength > -1 { if resp.RawResponse.ContentLength > -1 {
filesize = resp.RawResponse.ContentLength filesize = resp.RawResponse.ContentLength
} }
destFile, err := os.OpenFile(c.Filename, os.O_CREATE|os.O_WRONLY, 0644) destFile, err := os.OpenFile(c.Filename, os.O_CREATE|os.O_WRONLY, 0600)
if err != nil { if err != nil {
return err return err
} }

5
internal/downloader/downloader_test.go
View file

@ -58,7 +58,10 @@ func TestDownload(t *testing.T) {
t.Run("CertificateError", func(t *testing.T) { t.Run("CertificateError", func(t *testing.T) {
// This test assumes a self-signed certificate or similar issue. This is hard to simulate in a unit test. // This test assumes a self-signed certificate or similar issue. This is hard to simulate in a unit test.
ctx := downloader.NewContext("test_cert_error.txt", "https://self-signed.badssl.com/") // Example URL that can be used ctx := downloader.NewContext(
"test_cert_error.txt",
"https://self-signed.badssl.com/", // Example URL that can be used
)
if err := ctx.Download(); err == nil || err.Error() != "certificate from unknown authority" { if err := ctx.Download(); err == nil || err.Error() != "certificate from unknown authority" {
t.Errorf("expected certificate from unknown authority error, got %v", err) t.Errorf("expected certificate from unknown authority error, got %v", err)

4
internal/exporter/metrics.go
View file

@ -1,7 +1,7 @@
package exporter package exporter
import ( import (
"log" "log/slog"
"github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus"
) )
@ -95,7 +95,7 @@ func (m *Metrics) collectCurrentlyCachedMetric() {
func (m *Metrics) collectDatabaseTimestampMetric() { func (m *Metrics) collectDatabaseTimestampMetric() {
timestamp, err := m.exporter.database.Timestamp() timestamp, err := m.exporter.database.Timestamp()
if err != nil { if err != nil {
log.Printf("failed to read file timestamp: %v", err) slog.Warn("failed to read file timestamp", "error", err)
return return
} }

30
main.go
View file

@ -1,7 +1,7 @@
package main package main
import ( import (
"log" "log/slog"
"net/http" "net/http"
"os" "os"
"os/signal" "os/signal"
@ -24,7 +24,7 @@ func main() {
cli := cmd.CLI{} cli := cmd.CLI{}
config, err := cli.Parse() config, err := cli.Parse()
if err != nil { if err != nil {
log.Fatal(err) panic(err)
} }
handleGracefulShutdown() handleGracefulShutdown()
@ -38,15 +38,16 @@ func main() {
ctx := downloader.NewContext(config.DataFile, config.DataURL) ctx := downloader.NewContext(config.DataFile, config.DataURL)
if !ctx.FileExists() { if !ctx.FileExists() {
if downloadErr := ctx.Download(); downloadErr != nil { if downloadErr := ctx.Download(); downloadErr != nil {
log.Fatal(downloadErr) panic(err)
} }
log.Printf("saved file to %s\n", ctx.Filename) slog.Info("saved file", "path", ctx.Filename)
} }
cache := cache.NewCache(config.CacheTTL) cache := cache.NewCache(config.CacheTTL)
db, err := database.NewDatabase(config) db, err := database.NewDatabase(config)
if err != nil { if err != nil {
log.Fatal("database creation failed", err) slog.Error("database creation failed")
panic(err)
} }
if config.EnableExporter { if config.EnableExporter {
@ -66,23 +67,24 @@ func main() {
} }
} }
}() }()
log.Println("prometheus exporter refreshes metric data every", config.ExporterInterval) slog.Info("prometheus exporter refreshes metric data", "interval", config.ExporterInterval)
go func() { go func() {
err = exporter.Start() err = exporter.Start()
if err != nil { if err != nil {
log.Panic(err) panic(err)
} }
}() }()
log.Println("prometheus exporter started at", config.ExporterAddress) slog.Info("prometheus exporter started", "address", config.ExporterAddress)
} }
log.Println("importing data from file", config.DataFile) slog.Info("importing data from file", "path", config.DataFile)
err = csvimporter.ImportCSV(config.DataFile, db) err = csvimporter.ImportCSV(config.DataFile, db)
if err != nil { if err != nil {
log.Fatal("data Import from file failed", err) slog.Error("data import from file failed")
panic(err)
} }
log.Println("imported data from file successful") slog.Info("imported data from file successfully")
lh := apiv1.NewLocationHandler(cache, db) lh := apiv1.NewLocationHandler(cache, db)
r.Mount("/api/v1", apiv1.NewRouter(lh)) r.Mount("/api/v1", apiv1.NewRouter(lh))
@ -93,9 +95,9 @@ func main() {
ReadHeaderTimeout: config.ReadHeaderTimeout, ReadHeaderTimeout: config.ReadHeaderTimeout,
} }
log.Println("starting server at", server.Addr) slog.Info("starting server", "address", server.Addr)
if err = server.ListenAndServe(); err != nil { if err = server.ListenAndServe(); err != nil {
log.Panic(err) panic(err)
} }
} }
@ -106,7 +108,7 @@ func handleGracefulShutdown() {
go func() { go func() {
sig := <-signals sig := <-signals
log.Printf("caught signal: %+v", sig) slog.Info("caught signal", "signal", sig)
os.Exit(0) os.Exit(0)
}() }()
} }

8
renovate.json
View file

@ -2,7 +2,7 @@
"$schema": "https://docs.renovatebot.com/renovate-schema.json", "$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [ "extends": [
"config:recommended", "config:recommended",
"customManagers:dockerfileVersions" "docker:enableMajor"
], ],
"packageRules": [ "packageRules": [
{ {
@ -16,6 +16,8 @@
} }
], ],
"postUpdateOptions": [ "postUpdateOptions": [
"gomodTidy" "gomodTidy",
] "gomodUpdateImportPaths"
],
"semanticCommits": "enabled"
} }