diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8600570..5dfd147 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,21 +1,31 @@ -# This file is a template, and might need editing before it works on your project. image: golang:latest stages: - test #- build - - deploy test: stage: test + before_script: + - export PATH=$PATH:$GOPATH/bin + - go install gotest.tools/gotestsum@latest script: - - go test -race - -pages: - stage: deploy - script: - - mkdir public - - echo "go/log page" >public/index.html + - gotestsum --junitfile tests.xml -- -coverprofile=coverage.txt -covermode atomic . + after_script: + - export PATH=$PATH:$GOPATH/bin + - go install github.com/boumenot/gocover-cobertura@latest + - gocover-cobertura < coverage.txt > coverage.xml + - go tool cover -func=coverage.txt | grep "total:" + coverage: '/total:\s+\(statements\)\s+(\d+.\d+\%)/' artifacts: - paths: - - public + reports: + junit: tests.xml + coverage_report: + coverage_format: cobertura + path: coverage.xml + +lint: + stage: test + image: golangci/golangci-lint + script: + - golangci-lint run diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..cfc4e80 --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,1625 @@ +# the strings example.com/org/project should be replaced by the current module +run: + # The default concurrency value is the number of available CPU. + #concurrency: 4 + + # Timeout for analysis, e.g. 30s, 5m. + # Default: 1m + timeout: 5m + + # Exit code when at least one issue was found. + # Default: 1 + #issues-exit-code: 2 + + # Include test files or not. + # Default: true + #tests: false + + # List of build tags, all linters use it. + # Default: []. + #build-tags: + # - mytag + + # Which dirs to skip: issues from them won't be reported. + # Can use regexp here: `generated.*`, regexp is applied on full path. + # Default value is empty list, + # but default dirs are skipped independently of this option's value (see skip-dirs-use-default). + # "/" will be replaced by current OS file path separator to properly work on Windows. + #skip-dirs: + # - src/external_libs + # - autogenerated_by_my_lib + + # Enables skipping of directories: + # - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + # Default: true + #skip-dirs-use-default: false + + # Which files to skip: they will be analyzed, but issues from them won't be reported. + # Default value is empty list, + # but there is no need to include all autogenerated files, + # we confidently recognize autogenerated files. + # If it's not please let us know. + # "/" will be replaced by current OS file path separator to properly work on Windows. + #skip-files: + # - ".*\\.my\\.go$" + # - lib/bad.go + + # If set we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + # + # Allowed values: readonly|vendor|mod + # By default, it isn't set. + #modules-download-mode: readonly + + # Allow multiple parallel golangci-lint instances running. + # If false (default) - golangci-lint acquires file lock on start. + allow-parallel-runners: false + + # Define the Go version limit. + # Mainly related to generics support in go1.18. + # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.17 + #go: '1.18' + + +# output configuration options +output: + # Format: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions + # + # Multiple can be specified by separating them by comma, output can be provided + # for each of them by separating format name and path by colon symbol. + # Output path can be either `stdout`, `stderr` or path to the file to write to. + # Example: "checkstyle:report.json,colored-line-number" + # + # Default: colored-line-number + #format: json + + # Print lines of code with issue. + # Default: true + #print-issued-lines: false + + # Print linter name in the end of issue text. + # Default: true + #print-linter-name: false + + # Make issues output unique by line. + # Default: true + uniq-by-line: false + + # Add a prefix to the output file references. + # Default is no prefix. + path-prefix: "" + + # Sort results by: filepath, line and column. + sort-results: true + + +# All available settings of specific linters. +linters-settings: + bidichk: + # The following configurations check for all mentioned invisible unicode runes. + # All runes are enabled by default. + left-to-right-embedding: false + right-to-left-embedding: false + pop-directional-formatting: false + left-to-right-override: false + right-to-left-override: false + left-to-right-isolate: false + right-to-left-isolate: false + first-strong-isolate: false + pop-directional-isolate: false + + cyclop: + # The maximal code complexity to report. + max-complexity: 15 + # The maximal average package complexity. + # If it's higher than 0.0 (float) the check is enabled + # Default: 0.0 + #package-average: 0.5 + # Should ignore tests. + # Default: false + skip-tests: true + + decorder: + # Required order of `type`, `const`, `var` and `func` declarations inside a file. + # Default: types before constants before variables before functions. + dec-order: + - const + - var + - type + - func + + # If true, order of declarations is not checked at all. + # Default: true (disabled) + #disable-dec-order-check: false + + # If true, `init` func can be anywhere in file (does not have to be declared before all other functions). + # Default: true (disabled) + #disable-init-func-first-check: false + + # If true, multiple global `type`, `const` and `var` declarations are allowed. + # Default: true (disabled) + #disable-dec-num-check: false + + depguard: + # Kind of list is passed in. + # Allowed values: allowlist|denylist + # Default: denylist + list-type: allowlist + + # Check the list against standard lib. + # Default: false + #include-go-root: true + + # A list of packages for the list type specified. + # Default: [] + #packages: + # - github.com/sirupsen/logrus + + # A list of packages for the list type specified. + # Specify an error message to output when a denied package is used. + # Default: [] + #packages-with-error-message: + # - github.com/sirupsen/logrus: 'logging is allowed only by logutils.Log' + + # Create additional guards that follow the same configuration pattern. + # Results from all guards are aggregated together. + #additional-guards: + # - list-type: denylist + # include-go-root: false + # packages: + # - github.com/stretchr/testify + # # Specify rules by which the linter ignores certain files for consideration. + # ignore-file-rules: + # - "**/*_test.go" + # - "**/mock/**/*.go" + + dogsled: + # Checks assignments with too many blank identifiers. + # Default: 2 + #max-blank-identifiers: 3 + + dupl: + # Tokens count to trigger issue. + # Default: 150 + threshold: 100 + + errcheck: + # Report about not checking of errors in type assertions: `a := b.(MyStruct)`. + # Such cases aren't reported by default. + # Default: false + check-type-assertions: true + + # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`. + # Such cases aren't reported by default. + # Default: false + check-blank: true + + # To disable the errcheck built-in exclude list. + # See `-excludeonly` option in https://github.com/kisielk/errcheck#excluding-functions for details. + # Default: false + #disable-default-exclusions: true + + # List of functions to exclude from checking, where each entry is a single function to exclude. + # See https://github.com/kisielk/errcheck#excluding-functions for details. + exclude-functions: + - encoding/json.Marshal + - encoding/json.MarshalIndent + + errchkjson: + # With check-error-free-encoding set to true, errchkjson does warn about errors + # from json encoding functions that are safe to be ignored, + # because they are not possible to happen. + # + # if check-error-free-encoding is set to true and errcheck linter is enabled, + # it is recommended to add the following exceptions to prevent from false positives: + # + # linters-settings: + # errcheck: + # exclude-functions: + # - encoding/json.Marshal + # - encoding/json.MarshalIndent + # + # Default: false + check-error-free-encoding: true + + # Issue on struct encoding that doesn't have exported fields. + # Default: false + report-no-exported: true + + errorlint: + # Check whether fmt.Errorf uses the %w verb for formatting errors. + # See the https://github.com/polyfloyd/go-errorlint for caveats. + # Default: true + #errorf: false + # Check for plain type assertions and type switches. + # Default: true + #asserts: false + # Check for plain error comparisons. + # Default: true + #comparison: false + + exhaustive: + # Check switch statements in generated files also. + # Default: false + #check-generated: true + # Presence of "default" case in switch statements satisfies exhaustiveness, + # even if all enum members are not listed. + # Default: false + default-signifies-exhaustive: true + # Enum members matching the supplied regex do not have to be listed in + # switch statements to satisfy exhaustiveness. + # Default: "" + #ignore-enum-members: "Example.+" + # Consider enums only in package scopes, not in inner scopes. + # Default: false + #package-scope-only: true + + exhaustivestruct: + # Struct Patterns is list of expressions to match struct packages and names. + # The struct packages have the form `example.com/package.ExampleStruct`. + # The matching patterns can use matching syntax from https://pkg.go.dev/path#Match. + # If this list is empty, all structs are tested. + #struct-patterns: + # - '*.Test' + # - 'example.com/package.ExampleStruct' + + exhaustruct: + # List of regular expressions to match struct packages and names. + # If this list is empty, all structs are tested. + #include: + # - '.*\.Test' + # - 'example\.com/package\.ExampleStruct[\d]{1,2}' + # List of regular expressions to exclude struct packages and names from check. + #exclude: + # - 'cobra\.Command$' + + forbidigo: + # Forbid the following identifiers (list of regexp). + forbid: + - ^print.*$ + - 'fmt\.Print.*' + # Optionally put comments at the end of the regex, surrounded by `(# )?` + # Escape any special characters. + #- 'fmt\.Print.*(# Do not commit print statements\.)?' + # Exclude godoc examples from forbidigo checks. + # Default: true + #exclude_godoc_examples: false + + funlen: + # Checks the number of lines in a function. + # If lower than 0, disable the check. + # Default: 60 + #lines: -1 + # Checks the number of statements in a function. + # If lower than 0, disable the check. + # Default: 40 + #statements: -1 + + gci: + # Checks that no inline Comments are present. + # Default: false + no-inline-comments: true + + # Checks that no prefix Comments(comment lines above an import) are present. + # Default: false + no-prefix-comments: true + + # Section configuration to compare against. + # Section names are case-insensitive and may contain parameters in (). + # Default: ["standard", "default"] + sections: + - standard # Captures all standard packages if they do not match another section. + - default # Contains all imports that could not be matched to another section type. + - prefix(code.bcarlin.xyz/go/logging) # Groups all imports with the specified Prefix. + + # Separators that should be present between sections. + # Default: ["newLine"] + section-separators: + - newLine + + gocognit: + # Minimal code complexity to report + # Default: 30 (but we recommend 10-20) + min-complexity: 15 + + goconst: + # Minimal length of string constant. + # Default: 3 + #min-len: 2 + # Minimum occurrences of constant string count to trigger issue. + # Default: 3 + #min-occurrences: 2 + # Ignore test files. + # Default: false + ignore-tests: true + # Look for existing constants matching the values. + # Default: true + #match-constant: false + # Search also for duplicated numbers. + # Default: false + numbers: true + # Minimum value, only works with goconst.numbers + # Default: 3 + #min: 2 + # Maximum value, only works with goconst.numbers + # Default: 3 + max: 2 + # Ignore when constant is not used as function argument. + # Default: true + ignore-calls: false + + gocritic: + # Which checks should be enabled; can't be combined with 'disabled-checks'. + # See https://go-critic.github.io/overview#checks-overview. + # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`. + # By default, list of stable checks is used. + #enabled-checks: + # - nestingReduce + # - unnamedResult + # - ruleguard + # - truncateCmp + + # Which checks should be disabled; can't be combined with 'enabled-checks'. + # Default: [] + #disabled-checks: + # - regexpMust + + # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks. + # See https://github.com/go-critic/go-critic#usage -> section "Tags". + # Default: [] + enabled-tags: + - diagnostic + - style + - performance + - experimental + - opinionated + #disabled-tags: + # - diagnostic + # - style + # - performance + # - experimental + # - opinionated + + # 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: + # Must be valid enabled check name. + captLocal: + # Whether to restrict checker to params only. + # Default: true + paramsOnly: false + elseif: + # Whether to skip balanced if-else pairs. + # Default: true + #skipBalanced: false + hugeParam: + # Size in bytes that makes the warning trigger. + # Default: 80 + #sizeThreshold: 70 + nestingReduce: + # Min number of statements inside a branch to trigger a warning. + # Default: 5 + #bodyWidth: 4 + rangeExprCopy: + # Size in bytes that makes the warning trigger. + # Default: 512 + #sizeThreshold: 516 + # Whether to check test functions + # Default: true + #skipTestFuncs: false + rangeValCopy: + # Size in bytes that makes the warning trigger. + # Default: 128 + #sizeThreshold: 32 + # Whether to check test functions. + # Default: true + #skipTestFuncs: false + ruleguard: + # Enable debug to identify which 'Where' condition was rejected. + # The value of the parameter is the name of a function in a ruleguard file. + # + # When a rule is evaluated: + # If: + # The Match() clause is accepted; and + # One of the conditions in the Where() clause is rejected, + # Then: + # ruleguard prints the specific Where() condition that was rejected. + # + # The flag is passed to the ruleguard 'debug-group' argument. + debug: 'emptyDecl' + # Deprecated, use 'failOn' param. + # If set to true, identical to failOn='all', otherwise failOn='' + failOnError: false + # Determines the behavior when an error occurs while parsing ruleguard files. + # If flag is not set, log error and skip rule files that contain an error. + # If flag is set, the value must be a comma-separated list of error conditions. + # - 'all': fail on all errors. + # - 'import': ruleguard rule imports a package that cannot be found. + # - 'dsl': gorule file does not comply with the ruleguard DSL. + failOn: dsl + # Comma-separated list of file paths containing ruleguard rules. + # If a path is relative, it is relative to the directory where the golangci-lint command is executed. + # The special '${configDir}' variable is substituted with the absolute directory containing the golangci config file. + # Glob patterns such as 'rules-*.go' may be specified. + #rules: '${configDir}/ruleguard/rules-*.go,${configDir}/myrule1.go' + tooManyResultsChecker: + # Maximum number of results. + # Default: 5 + #maxResults: 10 + truncateCmp: + # Whether to skip int/uint/uintptr types. + # Default: true + skipArchDependent: false + underef: + # Whether to skip (*x).method() calls where x is a pointer receiver. + # Default: true + #skipRecvDeref: false + unnamedResult: + # Whether to check exported functions. + checkExported: true + + gocyclo: + # Minimal code complexity to report. + # Default: 30 (but we recommend 10-20) + min-complexity: 15 + + godot: + # Comments to be checked: `declarations`, `toplevel`, or `all`. + # Default: declarations + #scope: toplevel + # List of regexps for excluding particular comment lines from check. + exclude: + # Exclude todo and fixme comments. + - "^fixme:|^FIXME:" + - "^todo:|^TODO:" + # Check that each sentence ends with a period. + # Default: true + #period: false + # Check that each sentence starts with a capital letter. + # Default: false + #capital: true + + godox: + # Report any comments starting with keywords, this is useful for TODO or FIXME comments that + # might be left in the code accidentally and should be resolved before merging. + # Default: TODO, BUG, and FIXME. + keywords: + - NOTE + - OPTIMIZE # marks code that should be optimized before merging + - HACK # marks hack-around that should be removed before merging + + gofmt: + # Simplify code: gofmt with `-s` option. + # Default: true + #simplify: false + + gofumpt: + # Select the Go version to target. + # Default: 1.15 + lang-version: "1.18" + + # Module path which contains the source code being formatted. + # Default: empty string + module-path: code.bcarlin.xyz/go/logging + + # Choose whether to use the extra rules. + # Default: false + extra-rules: true + + goheader: + # Supports two types 'const` and `regexp`. + # Values can be used recursively. + values: + const: + # Define here const type values in format k:v. + # For example: + COMPANY: MY COMPANY + regexp: + # Define here regexp type values. + # for example: + AUTHOR: .*@mycompany\.com + # The template use for checking. + template: |- + # Put here copyright header template for source code files + # For example: + # Note: {{ YEAR }} is a builtin value that returns the year relative to the current machine time. + # + # {{ AUTHOR }} {{ COMPANY }} {{ YEAR }} + # SPDX-License-Identifier: Apache-2.0 + + # Licensed under the Apache License, Version 2.0 (the "License"); + # you may not use this file except in compliance with the License. + # You may obtain a copy of the License at: + + # http://www.apache.org/licenses/LICENSE-2.0 + + # Unless required by applicable law or agreed to in writing, software + # distributed under the License is distributed on an "AS IS" BASIS, + # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + # See the License for the specific language governing permissions and + # limitations under the License. + # As alternative of directive 'template', you may put the path to file with the template source. + # Useful if you need to load the template from a specific file. + template-path: /path/to/my/template.tmpl + + goimports: + # Put imports beginning with prefix after 3rd-party packages. + # It's a comma-separated list of prefixes. + local-prefixes: code.bcarlin.xyz/go/logging + + golint: + # Minimal confidence for issues. + # Default: 0.8 + #min-confidence: 0.7 + + gomnd: + # List of enabled checks, see https://github.com/tommy-muehle/go-mnd/#checks for description. + checks: + - argument + - case + - condition + - operation + - return + - assign + # List of numbers to exclude from analysis. + # The numbers should be written as string. + # Values always ignored: "1", "1.0", "0" and "0.0" + ignored-numbers: + - '0o600' + - '0o700' + # List of file patterns to exclude from analysis. + # Values always ignored: `.+_test.go` + ignored-files: + #- 'magic1_.*.go' + # List of function patterns to exclude from analysis. + # Values always ignored: `time.Time` + ignored-functions: + - 'math.*' + - 'http.StatusText' + + gomoddirectives: + # Allow local `replace` directives. + replace-local: false + # List of allowed `replace` directives. + # Default: [] + replace-allow-list: + #- launchpad.net/gocheck + # Allow to not explain why the version has been retracted in the `retract` directives. + # Default: false + retract-allow-no-explanation: false + # Forbid the use of the `exclude` directives. + # Default: false + exclude-forbidden: false + + gomodguard: + allowed: + # List of allowed modules. + modules: + - github.com/stretchr/testify + #- gopkg.in/yaml.v2 + # List of allowed module domains. + domains: + - golang.org + - code.bcarlin.xyz + - code.waarp.fr + blocked: + # List of blocked modules. + modules: + # Blocked module. + #- github.com/uudashr/go-module: + # # Recommended modules that should be used instead. (Optional) + # recommendations: + # - golang.org/x/mod + # # Reason why the recommended module should be used. (Optional) + # reason: "`mod` is the official go.mod parser library." + # List of blocked module version constraints. + versions: + # Blocked module with version constraint. + #- github.com/mitchellh/go-homedir: + # # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons. + # version: "< 1.1.0" + # # Reason why the version constraint exists. (Optional) + # reason: "testing if blocked version constraint works." + # #Set to true to raise lint issues for packages that are loaded from a local path via replace directive. + local_replace_directives: false + + gosimple: + # Select the Go version to target. + # Default: 1.13 + go: "1.18" + # https://staticcheck.io/docs/options#checks + checks: [ "all" ] + + gosec: + # To select a subset of rules to run. + # Available rules: https://github.com/securego/gosec#available-rules + #includes: + # - G101 + + # To specify a set of rules to explicitly exclude. + # Available rules: https://github.com/securego/gosec#available-rules + #excludes: + # - G101 + + # Exclude generated files + # Default: false + exclude-generated: true + + # Filter out the issues with a lower severity than the given value. + # Valid options are: low, medium, high. + # Default: low + #severity: medium + + # Filter out the issues with a lower confidence than the given value. + # Valid options are: low, medium, high. + # Default: low + #confidence: medium + + # Concurrency value. + # Default: the number of logical CPUs usable by the current process. + #concurrency: 12 + + # To specify the configuration of rules. + # The configuration of rules is not fully documented by gosec: + # https://github.com/securego/gosec#configuration + # https://github.com/securego/gosec/blob/569328eade2ccbad4ce2d0f21ee158ab5356a5cf/rules/rulelist.go#L60-L102 + #config: + # G306: "0600" + # G101: + # pattern: "(?i)example" + # ignore_entropy: false + # entropy_threshold: "80.0" + # per_char_threshold: "3.0" + # truncate: "32" + + govet: + # Report about shadowed variables. + # Default: false + check-shadowing: true + + # Settings per analyzer. + settings: + # Analyzer name, run `go tool vet help` to see all analyzers. + #printf: + # # Run `go tool vet help printf` to see available settings for `printf` analyzer. + # 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 + + # Disable all analyzers. + # Default: false + #disable-all: true + # Enable analyzers by name. + # Run `go tool vet help` to see all analyzers. + #enable: + # - asmdecl + + # Enable all analyzers. + # Default: false + enable-all: true + # Disable analyzers by name. + # Run `go tool vet help` to see all analyzers. + disable: + - fieldalignment + + grouper: + # Require the use of a single global 'const' declaration only. + # Default: false + const-require-single-const: true + # Require the use of grouped global 'const' declarations. + # Default: false + const-require-grouping: true + + # Require the use of a single 'import' declaration only. + # Default: false + import-require-single-import: true + # Require the use of grouped 'import' declarations. + # Default: false + import-require-grouping: true + + # Require the use of a single global 'type' declaration only. + # Default: false + #type-require-single-type: true + # Require the use of grouped global 'type' declarations. + # Default: false + #type-require-grouping: true + + # Require the use of a single global 'var' declaration only. + # Default: false + var-require-single-var: true + # Require the use of grouped global 'var' declarations. + # Default: false + var-require-grouping: true + + ifshort: + # Maximum length of variable declaration measured in number of lines, after which linter won't suggest using short syntax. + # Has higher priority than max-decl-chars. + # Default: 1 + max-decl-lines: 2 + # Maximum length of variable declaration measured in number of characters, after which linter won't suggest using short syntax. + # Default: 30 + #max-decl-chars: 40 + + importas: + # Do not allow unaliased imports of aliased packages. + # Default: false + #no-unaliased: true + # Do not allow non-required aliases. + # Default: false + no-extra-aliases: true + # List of aliases + alias: + # Using `servingv1` alias for `knative.dev/serving/pkg/apis/serving/v1` package. + #- pkg: knative.dev/serving/pkg/apis/serving/v1 + # alias: servingv1 + # Using `autoscalingv1alpha1` alias for `knative.dev/serving/pkg/apis/autoscaling/v1alpha1` package. + #- pkg: knative.dev/serving/pkg/apis/autoscaling/v1alpha1 + # alias: autoscalingv1alpha1 + # You can specify the package path by regular expression, + # and alias by regular expression expansion syntax like below. + # see https://github.com/julz/importas#use-regular-expression for details + #- pkg: knative.dev/serving/pkg/apis/(\w+)/(v[\w\d]+) + # alias: $1$2 + + ireturn: + # ireturn allows using `allow` and `reject` settings at the same time. + # Both settings are lists of the keywords and regular expressions matched to interface or package names. + # keywords: + # - `empty` for `interface{}` + # - `error` for errors + # - `stdlib` for standard library + # - `anon` for anonymous interfaces + + # By default, it allows using errors, empty interfaces, anonymous interfaces, + # and interfaces provided by the standard library. + allow: + - anon + - error + - empty + - stdlib + # You can specify idiomatic endings for interface + - (or|er)$ + + # reject-list of interfaces + reject: + #- github.com\/user\/package\/v4\.Type + + lll: + # Max line length, lines longer will be reported. + # '\t' is counted as 1 character by default, and can be changed with the tab-width option. + # Default: 120. + line-length: 90 + # Tab width in spaces. + # Default: 1 + tab-width: 4 + + maintidx: + # Show functions with maintainability index lower than N. + # A high index indicates better maintainability (it's kind of the opposite of complexity). + # Default: 20 + under: 20 + + makezero: + # Allow only slices initialized with a length of zero. + # Default: false + #always: false + + maligned: + # Print struct with more effective memory layout or not. + # Default: false + suggest-new: true + + misspell: + # Correct spellings using locale preferences for US or UK. + # Setting locale to US will correct the British spelling of 'colour' to 'color'. + # Default is to use a neutral variety of English. + locale: US + ignore-words: + #- someword + + nakedret: + # Make an issue if func has more lines of code than this setting, and it has naked returns. + # Default: 30 + #max-func-lines: 31 + + nestif: + # Minimal complexity of if statements to report. + # Default: 5 + #min-complexity: 4 + + nilnil: + # Checks that there is no simultaneous return of `nil` error and an invalid value. + # Default: ptr, func, iface, map, chan + checked-types: + - ptr + - func + - iface + - map + - chan + + nlreturn: + # Size of the block (including return statement that is still "OK") + # so no return split required. + # Default: 1 + block-size: 2 + + nolintlint: + # Disable to ensure that all nolint directives actually have an effect. + # Default: false + #allow-unused: true + # Disable to ensure that nolint directives don't have a leading space. + # Default: true + allow-leading-space: false + # Exclude following linters from requiring an explanation. + # Default: [] + allow-no-explanation: [ ] + # 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 + + prealloc: + # IMPORTANT: we don't recommend using this linter before doing performance profiling. + # For most programs usage of prealloc will be a premature optimization. + + # Report pre-allocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them. + # Default: true + #simple: false + # Report pre-allocation suggestions on range loops. + # Default: true + #range-loops: false + # Report pre-allocation suggestions on for loops. + # Default: false + #for-loops: true + + predeclared: + # Comma-separated list of predeclared identifiers to not report on. + # Default: "" + #ignore: "new,int" + # Include method names and field names (i.e., qualified names) in checks. + # Default: false + #q: true + + promlinter: + # Promlinter cannot infer all metrics name in static analysis. + # Enable strict mode will also include the errors caused by failing to parse the args. + # Default: false + strict: true + # Please refer to https://github.com/yeya24/promlinter#usage for detailed usage. + #disabled-linters: + # - Help + # - MetricUnits + # - Counter + # - HistogramSummaryReserved + # - MetricTypeInName + # - ReservedChars + # - CamelCase + # - UnitAbbreviations + + revive: + # Maximum number of open files at the same time. + # See https://github.com/mgechev/revive#command-line-flags + # Defaults to unlimited. + #max-open-files: 2048 + + # When set to false, ignores files with "GENERATED" header, similar to golint. + # See https://github.com/mgechev/revive#available-rules for details. + # Default: false + ignore-generated-header: true + + # Sets the default severity. + # See https://github.com/mgechev/revive#configuration + # Default: warning + #severity: error + + # Enable all available rules. + # Default: false + enable-all-rules: true + + # Sets the default failure confidence. + # This means that linting errors with less than 0.8 confidence will be ignored. + # Default: 0.8 + #confidence: 0.1 + + rules: + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant + - name: add-constant + severity: warning + disabled: false + arguments: + - maxLitCount: "3" + allowStrs: '""' + allowInts: "0,1,2,0o600,0o700" + allowFloats: "0.0,0.,1.0,1.,2.0,2." + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic + - name: argument-limit + severity: warning + disabled: false + arguments: [4] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic + - name: atomic + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#banned-characters + - name: banned-characters + severity: warning + disabled: false + arguments: ["Ω"] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bare-return + - name: bare-return + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports + - name: blank-imports + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr + - name: bool-literal-in-expr + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc + - name: call-to-gc + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cognitive-complexity + - name: cognitive-complexity + severity: warning + disabled: false + arguments: [ 7 ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming + - name: confusing-naming + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results + - name: confusing-results + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr + - name: constant-logical-expr + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument + - name: context-as-argument + severity: info + disabled: false + arguments: + - allowTypesBefore: "*testing.T" + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type + - name: context-keys-type + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#cyclomatic + - name: cyclomatic + severity: error + disabled: false + arguments: [ 15 ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#deep-exit + - name: deep-exit + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#defer + - name: defer + severity: error + disabled: false + arguments: + - [ "call-chain", "loop" ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports + - name: dot-imports + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports + - name: duplicated-imports + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return + - name: early-return + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block + - name: empty-block + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines + - name: empty-lines + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming + - name: error-naming + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return + - name: error-return + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings + - name: error-strings + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf + - name: errorf + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#exported + - name: exported + severity: warning + disabled: false + arguments: + - "checkPrivateReceivers" + - "sayRepetitiveInsteadOfStutters" + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#file-header + - name: file-header + severity: warning + disabled: true + arguments: + - This is the text that must appear at the top of source files. + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#flag-parameter + - name: flag-parameter + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-result-limit + - name: function-result-limit + severity: warning + disabled: false + arguments: [ 2 ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#function-length + - name: function-length + severity: warning + disabled: false + arguments: [20, 0] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return + - name: get-return + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches + - name: identical-branches + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return + - name: if-return + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement + - name: increment-decrement + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow + - name: indent-error-flow + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#imports-blacklist + - name: imports-blacklist + severity: warning + disabled: false + arguments: + - "crypto/md5" + - "crypto/sha1" + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#import-shadowing + - name: import-shadowing + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#line-length-limit + - name: line-length-limit + severity: warning + disabled: false + arguments: [ 90 ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#max-public-structs + - name: max-public-structs + severity: warning + disabled: false + arguments: [ 5 ] + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-parameter + - name: modifies-parameter + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#modifies-value-receiver + - name: modifies-value-receiver + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#nested-structs + - name: nested-structs + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#optimize-operands-order + - name: optimize-operands-order + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#package-comments + - name: package-comments + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range + - name: range + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure + - name: range-val-in-closure + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address + - name: range-val-address + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming + - name: receiver-naming + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id + - name: redefines-builtin-id + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int + - name: string-of-int + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format + - name: string-format + severity: warning + disabled: false + arguments: + - - 'fmt.Errorf[0]' + - '/(^|[^\.!?])$/' + - must not end in punctuation + - - panic + - '/^[^\n]*$/' + - must not contain line breaks + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag + - name: struct-tag + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else + - name: superfluous-else + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-equal + - name: time-equal + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-naming + - name: time-naming + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-naming + - name: var-naming + severity: warning + disabled: false + arguments: + - [ "ID" ] # AllowList + - [ "VM" ] # DenyList + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#var-declaration + - name: var-declaration + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unconditional-recursion + - name: unconditional-recursion + severity: error + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming + - name: unexported-naming + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return + - name: unexported-return + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error + - name: unhandled-error + severity: warning + disabled: false + arguments: + - "fmt.Printf" + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt + - name: unnecessary-stmt + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code + - name: unreachable-code + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter + - name: unused-parameter + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver + - name: unused-receiver + severity: info + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break + - name: useless-break + severity: warning + disabled: false + # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value + - name: waitgroup-by-value + severity: error + disabled: false + + rowserrcheck: + #packages: + #- github.com/jmoiron/sqlx + + staticcheck: + # Select the Go version to target. + # Default: 1.13 + go: "1.18" + # https://staticcheck.io/docs/options#checks + checks: [ "all" ] + + stylecheck: + # Select the Go version to target. + # Default: 1.13 + go: "1.18" + # https://staticcheck.io/docs/options#checks + checks: [ "all" ] + # https://staticcheck.io/docs/options#dot_import_whitelist + dot-import-whitelist: + - fmt + # https://staticcheck.io/docs/options#initialisms + initialisms: [ "ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS" ] + # https://staticcheck.io/docs/options#http_status_code_whitelist + http-status-code-whitelist: [ "200", "400", "404", "500" ] + + tagliatelle: + # Check the struck tag name case. + case: + # Use the struct field name to check the name of the struct tag. + # Default: false + use-field-name: true + rules: + # Any struct tag type can be used. + # Support string case: `camel`, `pascal`, `kebab`, `snake`, `goCamel`, `goPascal`, `goKebab`, `goSnake`, `upper`, `lower` + json: camel + yaml: camel + xml: camel + bson: camel + avro: snake + mapstructure: kebab + + tenv: + # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures. + # By default, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked. + #all: false + + testpackage: + # regexp pattern to skip files + skip-regexp: (export|internal)_test\.go + + thelper: + # The following configurations enable all checks. + # All checks are enabled by default. + #test: + # first: false + # name: false + # begin: false + #benchmark: + # first: false + # name: false + # begin: false + #tb: + # first: false + # name: false + # begin: false + + unparam: + # Inspect exported functions. + # + # Set to true if no external program/library imports your code. + # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find external interfaces. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + # + # Default: false + #check-exported: true + + varcheck: + # Check usage of exported fields and variables. + # Default: false + #exported-fields: true + + varnamelen: + # The longest distance, in source lines, that is being considered a "small scope". + # Variables used in at most this many lines will be ignored. + # Default: 5 + max-distance: 15 + # The minimum length of a variable's name that is considered "long". + # Variable names that are at least this long will be ignored. + # Default: 3 + #min-name-length: 2 + # Check method receivers. + # Default: false + #check-receiver: true + # Check named return values. + # Default: false + check-return: true + # Check type parameters. + # Default: false + check-type-param: true + # Ignore "ok" variables that hold the bool return value of a type assertion. + # Default: false + ignore-type-assert-ok: true + # Ignore "ok" variables that hold the bool return value of a map index. + # Default: false + ignore-map-index-ok: true + # Ignore "ok" variables that hold the bool return value of a channel receive. + # Default: false + ignore-chan-recv-ok: true + # Optional list of variable names that should be ignored completely. + # Default: [] + ignore-names: + - err + - rv + # Optional list of variable declarations that should be ignored completely. + # Entries must be in one of the following forms (see below for examples): + # - for variables, parameters, named return values, method receivers, or type parameters: + # ( can also be a pointer/slice/map/chan/...) + # - for constants: const + # + # Default: [] + ignore-decls: + - t *testing.T + - w http.ResponseWriter + - r *http.Request + - r io.Reader + - c convey.C + - i int + - T any + + whitespace: + # Enforces newlines (or comments) after every multi-line if statement. + # Default: false + multi-if: true + # Enforces newlines (or comments) after every multi-line function signature. + # Default: false + multi-func: true + + wrapcheck: + # An array of strings that specify substrings of signatures to ignore. + # If this set, it will override the default set of ignored signatures. + # See https://github.com/tomarrell/wrapcheck#configuration for more information. + #ignoreSigs: + # - .Errorf( + # - errors.New( + # - errors.Unwrap( + # - .Wrap( + # - .Wrapf( + # - .WithMessage( + # - .WithMessagef( + # - .WithStack( + #ignoreSigRegexps: + # - \.New.*Error\( + #ignorePackageGlobs: + # - encoding/* + # - github.com/pkg/* + #ignoreInterfaceRegexps: + # - ^(?i)c(?-i)ach(ing|e) + + wsl: + # See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for documentation of available settings. + # These are the defaults for `golangci-lint`. + + # Controls if you may cuddle assignments and anything without needing an empty line between them. + # Default: false + allow-assign-and-anything: false + + # Controls if you may cuddle assignments and calls without needing an empty line between them. + # Default: true + allow-assign-and-call: true + + # Controls if you're allowed to cuddle multiple declarations. + # This is false by default to encourage you to group them in one var block. + # One major benefit with this is that if the variables are assigned the assignments will be tabulated. + # Default: false + allow-cuddle-declarations: false + + # Controls if you may cuddle assignments even if they span over multiple lines. + # Default: true + allow-multiline-assign: true + + # This option allows whitespace after each comment group that begins a block. + # Default: false + allow-separated-leading-comment: false + + # Controls if blocks can end with comments. + # This is not encouraged sine it's usually code smell but might be useful do improve understanding or learning purposes. + # To be allowed there must be no whitespace between the comment and the last statement or the comment and the closing brace. + # Default: false + allow-trailing-comment: false + + # Can be set to force trailing newlines at the end of case blocks to improve readability. + # If the number of lines (including comments) in a case block exceeds this number + # a linter error will be yielded if the case does not end with a newline. + # Default: 0 + force-case-trailing-whitespace: 0 + + # Enforces that an `if` statement checking an error variable is cuddled + # with the line that assigned that error variable. + # Default: false + force-err-cuddling: false + + # Enforces that an assignment which is actually a short declaration (using `:=`) + # is only allowed to cuddle with other short declarations, and not plain assignments, blocks, etc. + # This rule helps make declarations stand out by themselves, much the same as grouping var statement. + # Default: false + force-short-decl-cuddling: false + + # Controls if the checks for slice append should be "strict" + # in the sense that it will only allow these assignments to be cuddled with variables being appended. + # Default: true + strict-append: true + + +linters: + # Disable all linters. + # Default: false + #disable-all: true + # Enable specific linter + # https://golangci-lint.run/usage/linters/#enabled-by-default-linters + enable: + #- asciicheck + + # Enable all available linters. + # Default: false + enable-all: true + # Disable specific linter + # https://golangci-lint.run/usage/linters/#disabled-by-default-linters--e--enable + disable: + - depguard # gomodguard is better + - exhaustivestruct + - exhaustruct + - goheader + - golint # Deprecated + - grouper + - interfacer # Deprecated + - lll # Done by revive with better messages + - maligned # Deprecated + - prealloc + - scopelint # Deprecated + - testpackage + - varcheck # also done by unused and deadcode + + # Enable presets. + # https://golangci-lint.run/usage/linters + #presets: + # - bugs + # - comment + # - complexity + # - error + # - format + # - import + # - metalinter + # - module + # - performance + # - sql + # - style + # - test + # - unused + + # Run only fast linters from enabled linters set (first run won't be fast) + # Default: false + #fast: true + + +issues: + # List of regexps of issue texts to exclude. + # + # But independently of this option we use default exclude patterns, + # it can be disabled by `exclude-use-default: false`. + # To list all excluded by default patterns execute `golangci-lint run --help` + # + # Default: [] + exclude: + - abcdef + + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + # Exclude some linters from running on tests files. + - path: _test\.go + linters: + - cyclop + - dupl + - errcheck + - funlen + - goconst + - gocognit + - gocyclo + - goerr113 + - gosec + - varnamelen + + # Exclude known linters from partially hard-vendored code, + # which is impossible to exclude via `nolint` comments. + - path: internal/hmac/ + text: "weak cryptographic primitive" + linters: + - gosec + + # Exclude some `staticcheck` messages. + #- linters: + # - staticcheck + # text: "SA9003:" + + # Exclude `lll` issues for long lines with `go:generate`. + - linters: + - lll + source: "^//go:generate " + + # Independently of option `exclude` we use default exclude patterns, + # it can be disabled by this option. + # To list all excluded by default patterns execute `golangci-lint run --help`. + # Default: true. + exclude-use-default: false + + # If set to true exclude and exclude-rules regular expressions become case-sensitive. + # Default: false + exclude-case-sensitive: false + + # The list of ids of default excludes to include or disable. + # Default: [] + include: + #- EXC0002 # disable excluding of issues about comments from golint. + + # Maximum issues count per one linter. + # Set to 0 to disable. + # Default: 50 + max-issues-per-linter: 0 + + # Maximum count of issues with the same text. + # Set to 0 to disable. + # Default: 3 + max-same-issues: 0 + + # Show only new issues: if there are unstaged changes or untracked files, + # only those changes are analyzed, else only changes in HEAD~ are analyzed. + # It's a super-useful option for integration of golangci-lint into existing large codebase. + # It's not practical to fix all existing issues at the moment of integration: + # much better don't allow issues in new code. + # + # Default: false. + #new: true + + # Show only new issues created after git revision `REV`. + #new-from-rev: HEAD + + # Show only new issues created in git patch with set file path. + #new-from-patch: path/to/patch/file + + # Fix found issues (if it's supported by the linter). + fix: false + + +severity: + # Set the default severity for issues. + # + # If severity rules are defined and the issues do not match or no severity is provided to the rule + # this will be the default severity applied. + # Severities should match the supported severity names of the selected out format. + # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity + # - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity + # - GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message + # + # Default value is an empty string. + default-severity: error + + # If set to true `severity-rules` regular expressions become case-sensitive. + # Default: false + #case-sensitive: true + + # When a list of severity rules are provided, severity information will be added to lint issues. + # Severity rules have the same filtering capability as exclude rules + # except you are allowed to specify one matcher per severity rule. + # Only affects out formats that support setting severity information. + # + # Default: [] + rules: + - linters: + - dupl + severity: info diff --git a/CHANGELOG.md b/CHANGELOG.md index dccd862..63f4d7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ ## Unreleased +## v0.4.0 (2020-05-17) + +- Add three new log levels: `Trace`, `Notice` and `Alert` with the following + order: `Trace`, `Debug`, `Info`, `Notice`, `Warning`, `Error`, `Critical`, + `Alert`, `Fatal`. + As Syslog has no equivalent of `Trace`, it is mapped to `Debug`. + ## v0.3.0 (2020-05-17) ### Incompatible Changes diff --git a/backend.go b/backend.go index fe6359a..db5d365 100644 --- a/backend.go +++ b/backend.go @@ -4,13 +4,14 @@ import ( "fmt" "io" "os" + "path/filepath" ) // Backend is the interface that specifies the methods that a backend must -// implement +// implement. type Backend interface { Write(*Record) error - SetFormatter(*Formatter) + SetFormatter(Formatter) SetLevel(Level) Level() Level Reopen() error @@ -23,86 +24,86 @@ type Backend interface { // FileBackend is a backend that writes to a file. type FileBackend struct { + formatter Formatter l io.Writer - formatter *Formatter - level Level filepath string + level Level } // NewStdoutBackend creates a new backend to write the logs on the standard -// output -func NewStdoutBackend() (b *FileBackend) { - b = &FileBackend{ +// output. +func NewStdoutBackend() *FileBackend { + return &FileBackend{ l: os.Stdout, - formatter: &defaultFormatter, + formatter: defaultFormatter, } - return } -// NewStderrBackend creates a new backend to write the logs on the error output -func NewStderrBackend() (b *FileBackend) { - b = &FileBackend{ +// NewStderrBackend creates a new backend to write the logs on the error output. +func NewStderrBackend() *FileBackend { + return &FileBackend{ l: os.Stderr, - formatter: &defaultFormatter, + formatter: defaultFormatter, } - return } -// NewFileBackend creates a new backend to write the logs in a given file +// NewFileBackend creates a new backend to write the logs in a given file. func NewFileBackend(filename string) (*FileBackend, error) { - fd, err := os.OpenFile(filename, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644) //nolint: gosec + fd, err := os.OpenFile(filepath.Clean(filename), + os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0o600) if err != nil { - return nil, fmt.Errorf("Cannot open log file %s: %w", filename, err) + return nil, fmt.Errorf("cannot open log file %s: %w", filename, err) } b := &FileBackend{ l: fd, - formatter: &defaultFormatter, + formatter: defaultFormatter, filepath: filename, } return b, nil } -// NewIoBackend creates a new backend to write the logs in a given io.Writer -func NewIoBackend(buf io.Writer) (b *FileBackend) { +// NewIoBackend creates a new backend to write the logs in a given io.Writer. +func NewIoBackend(buf io.Writer) *FileBackend { return &FileBackend{ l: buf, - formatter: &defaultFormatter, + formatter: defaultFormatter, } } func (b FileBackend) Write(r *Record) error { - text := (*b.formatter)(r) + text := b.formatter(r) _, err := io.WriteString(b.l, text) - return err + + return fmt.Errorf("cannot write logs: %w", err) } -// SetLevel changes the log level of the backend +// SetLevel changes the log level of the backend. func (b *FileBackend) SetLevel(l Level) { b.level = l } -// Level returns the log level set for this backend +// Level returns the log level set for this backend. func (b *FileBackend) Level() Level { return b.level } -// SetFormatter defines the formatter for this backend -func (b *FileBackend) SetFormatter(f *Formatter) { +// SetFormatter defines the formatter for this backend. +func (b *FileBackend) SetFormatter(f Formatter) { b.formatter = f } // Reopen closes and reopens the file it writes to. It should be used after log -// rotation +// rotation. func (b *FileBackend) Reopen() error { if err := b.Close(); err != nil { return err } - fd, err := os.OpenFile(b.filepath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0644) //nolint: gosec + fd, err := os.OpenFile(b.filepath, os.O_WRONLY|os.O_APPEND|os.O_CREATE, 0o600) if err != nil { - return fmt.Errorf("Cannot open log file %s: %w", b.filepath, err) + return fmt.Errorf("cannot open log file %s: %w", b.filepath, err) } b.l = fd @@ -110,7 +111,7 @@ func (b *FileBackend) Reopen() error { return nil } -// Close closes the underlying file used by the backend +// Close closes the underlying file used by the backend. func (b *FileBackend) Close() error { if b.filepath == "" { return nil @@ -118,7 +119,7 @@ func (b *FileBackend) Close() error { if c, ok := b.l.(io.Closer); ok { if err := c.Close(); err != nil { - return err + return fmt.Errorf("cannot close log file: %w", err) } } @@ -129,36 +130,36 @@ func (b *FileBackend) Close() error { // Noop Backend // -// NoopBackend does nothing and discards all log entries without writing them anywhere +// NoopBackend does nothing and discards all log entries without writing them anywhere. type NoopBackend struct{} -// NewNoopBackend creates a noop backend -func NewNoopBackend() (Backend, error) { +// NewNoopBackend creates a noop backend. +func NewNoopBackend() (*NoopBackend, error) { return &NoopBackend{}, nil } -// Write is a noop -func (nb *NoopBackend) Write(r *Record) error { +// Write is a noop. +func (*NoopBackend) Write(_ *Record) error { return nil } -// SetFormatter is a noop -func (nb *NoopBackend) SetFormatter(f *Formatter) {} +// SetFormatter is a noop. +func (*NoopBackend) SetFormatter(_ *Formatter) {} -// SetLevel is a noop -func (nb *NoopBackend) SetLevel(level Level) {} +// SetLevel is a noop. +func (*NoopBackend) SetLevel(_ Level) {} -// Level always returns DefeultLevel -func (nb *NoopBackend) Level() Level { +// Level always returns DefeultLevel. +func (*NoopBackend) Level() Level { return DefaultLevel } -// Reopen is a noop -func (nb *NoopBackend) Reopen() error { +// Reopen is a noop. +func (*NoopBackend) Reopen() error { return nil } -// Close is a noop -func (nb *NoopBackend) Close() error { +// Close is a noop. +func (*NoopBackend) Close() error { return nil } diff --git a/backend_syslog_linux.go b/backend_syslog_linux.go index e0f62f1..ad23339 100644 --- a/backend_syslog_linux.go +++ b/backend_syslog_linux.go @@ -1,88 +1,108 @@ +//go:build !windows && !nacl && !plan9 // +build !windows,!nacl,!plan9 package logging import ( + "errors" "fmt" "log/syslog" "strings" ) +var errUnknownFacility = errors.New("unknown facility") + // // Syslog Backend // -// SyslogBackend writes the logs to a syslog system +// SyslogBackend writes the logs to a syslog system. type SyslogBackend struct { w *syslog.Writer - formatter *Formatter + formatter Formatter level Level } // NewSyslogBackend initializes a new connection to a syslog server with the // given facility. // tag can contain an identifier for the log stream. It defaults to os.Arg[0]. -func NewSyslogBackend(facilityName string, tag string) (Backend, error) { +func NewSyslogBackend(facilityName, tag string) (*SyslogBackend, error) { f, err := facility(facilityName) if err != nil { return nil, err } + w, err := syslog.New(f, tag) if err != nil { - return nil, err + return nil, fmt.Errorf("cannot initialize syslog: %w", err) } + sb := &SyslogBackend{ w: w, - formatter: &basicFormatter, + formatter: basicFormatter, } + return sb, nil } -// Write sends an entry to the syslog server -func (sb *SyslogBackend) Write(r *Record) (err error) { - text := (*sb.formatter)(r) +// Write sends an entry to the syslog server. +func (sb *SyslogBackend) Write(r *Record) error { + var err error + + text := sb.formatter(r) + switch r.Level { - case Debug: + case Trace, Debug: err = sb.w.Debug(text) case Info: err = sb.w.Info(text) + case Notice: + err = sb.w.Notice(text) case Warning: err = sb.w.Warning(text) case Error: err = sb.w.Err(text) case Critical: err = sb.w.Crit(text) + case Alert: + err = sb.w.Alert(text) case Fatal: err = sb.w.Emerg(text) } - return err + + return fmt.Errorf("cannot log to syslog: %w", err) } -// SetFormatter defines the formatter for this backend -func (sb *SyslogBackend) SetFormatter(f *Formatter) { +// SetFormatter defines the formatter for this backend. +func (sb *SyslogBackend) SetFormatter(f Formatter) { sb.formatter = f } -// SetLevel changes the log level of the backend +// SetLevel changes the log level of the backend. func (sb *SyslogBackend) SetLevel(level Level) { sb.level = level } -// Level returns the log level set for this backend +// Level returns the log level set for this backend. func (sb *SyslogBackend) Level() Level { return sb.level } -// Reopen is a no-op -func (sb *SyslogBackend) Reopen() error { +// Reopen is a no-op. +func (*SyslogBackend) Reopen() error { return nil } -// Close closes the connection to the syslog daemon +// Close closes the connection to the syslog daemon. func (sb *SyslogBackend) Close() error { - return sb.w.Close() + if err := sb.w.Close(); err != nil { + return fmt.Errorf("cannot close syslog: %w", err) + } + + return nil } +//nolint:gochecknoglobals // global var is used by design var facilities = map[string]syslog.Priority{ "kern": syslog.LOG_KERN, "user": syslog.LOG_USER, @@ -109,7 +129,7 @@ var facilities = map[string]syslog.Priority{ func facility(name string) (syslog.Priority, error) { p, ok := facilities[strings.ToLower(name)] if !ok { - return 0, fmt.Errorf("Facility '%s' does not exist", name) + return 0, fmt.Errorf("facility '%s' does not exist: %w", name, errUnknownFacility) } return p, nil diff --git a/logger.go b/logger.go index 0f24b48..2123741 100644 --- a/logger.go +++ b/logger.go @@ -7,37 +7,39 @@ import ( "sync" ) +const exitCodeFatal = 100 + // Logger is a facility that writes logs to one or more backands (files, // stdout/stderr, syslog, etc.) which can be configured independently // // Loggers are concurrent-safe. type Logger struct { - sync.Mutex - + mutex sync.Mutex name string backends []Backend } // NewLogger initializes a new Logger with no backend and with the default log level. -func NewLogger(name string) (l *Logger) { - l = &Logger{ +func NewLogger(name string) *Logger { + l := &Logger{ name: name, } - return + + return l } // AddBackend add a new Backend to the logger. All set backends are kept. func (l *Logger) AddBackend(b Backend) { - l.Lock() - defer l.Unlock() + l.mutex.Lock() + defer l.mutex.Unlock() l.backends = append(l.backends, b) } // SetBackend sets the backend list to the logger. Any existing backend will be lost. func (l *Logger) SetBackend(b ...Backend) { - l.Lock() - defer l.Unlock() + l.mutex.Lock() + defer l.mutex.Unlock() l.backends = b } @@ -50,11 +52,11 @@ func (l *Logger) SetLevel(level Level) { } type buffer struct { - level Level logger *Logger + level Level } -func (b *buffer) Write(p []byte) (n int, err error) { +func (b *buffer) Write(p []byte) (int, error) { b.logger.Log(b.level, string(p)) return len(p), nil } @@ -70,82 +72,119 @@ func (l *Logger) AsStdLog(level Level) *log.Logger { } // Log sends a record containing the message `m` to the registered backends -// whose level is at least `level` +// whose level is at least `level`. func (l *Logger) Log(level Level, m string) { - l.Lock() - defer l.Unlock() + l.mutex.Lock() + defer l.mutex.Unlock() r := NewRecord(l.name, level, m) for _, backend := range l.backends { if r.Level >= backend.Level() { - _ = backend.Write(r) + if err := backend.Write(r); err != nil { + //revive:disable-next-line:unhandled-error stop error handling recursion! + fmt.Fprintf(os.Stderr, "Cannot write logs: %v", err) + } } } } -// Debug logs a message with the Debug level +// Trace logs a message with the Trace level. +func (l *Logger) Trace(text string) { + l.Log(Trace, text) +} + +// Tracef formats the message with given args and logs the result with the +// Trace level. +func (l *Logger) Tracef(text string, args ...interface{}) { + l.Trace(fmt.Sprintf(text, args...)) +} + +// Debug logs a message with the Debug level. func (l *Logger) Debug(text string) { l.Log(Debug, text) } // Debugf formats the message with given args and logs the result with the -// Debug level +// Debug level. func (l *Logger) Debugf(text string, args ...interface{}) { l.Debug(fmt.Sprintf(text, args...)) } -// Info logs a message with the Info level +// Info logs a message with the Info level. func (l *Logger) Info(text string) { l.Log(Info, text) } // Infof formats the message with given args and logs the result with the -// Info level +// Info level. func (l *Logger) Infof(text string, args ...interface{}) { l.Info(fmt.Sprintf(text, args...)) } -// Warning logs a message with the Warning level +// Notice logs a message with the Notice level. +func (l *Logger) Notice(text string) { + l.Log(Notice, text) +} + +// Noticef formats the message with given args and logs the result with the +// Notice level. +func (l *Logger) Noticef(text string, args ...interface{}) { + l.Notice(fmt.Sprintf(text, args...)) +} + +// Warning logs a message with the Warning level. func (l *Logger) Warning(text string) { l.Log(Warning, text) } // Warningf formats the message with given args and logs the result with the -// Warning level +// Warning level. func (l *Logger) Warningf(text string, args ...interface{}) { l.Warning(fmt.Sprintf(text, args...)) } -// Error logs a message with the Error level +// Error logs a message with the Error level. func (l *Logger) Error(text string) { l.Log(Error, text) } // Errorf formats the message with given args and logs the result with the -// Error level +// Error level. func (l *Logger) Errorf(text string, args ...interface{}) { l.Error(fmt.Sprintf(text, args...)) } -// Critical logs a message with the Critical level +// Critical logs a message with the Critical level. func (l *Logger) Critical(text string) { l.Log(Critical, text) } -// Criticalf formats the message with given args and logs the result with the -// Critical level +// Criticalf formats the message with given args and logs the result with the. +// Critical level. func (l *Logger) Criticalf(text string, args ...interface{}) { l.Critical(fmt.Sprintf(text, args...)) } -// Fatal logs a message with the Fatal level +// Alert logs a message with the Alert level. +func (l *Logger) Alert(text string) { + l.Log(Alert, text) +} + +// Alertf formats the message with given args and logs the result with the. +// Alert level. +func (l *Logger) Alertf(text string, args ...interface{}) { + l.Alert(fmt.Sprintf(text, args...)) +} + +// Fatal logs a message with the Fatal level. func (l *Logger) Fatal(text string) { l.Log(Debug, text) - os.Exit(100) + + os.Exit(exitCodeFatal) //nolint:revive // This is wanted if fatal is called } // Fatalf formats the message with given args and logs the result with the -// Fatal level +// Fatal level. func (l *Logger) Fatalf(text string, args ...interface{}) { l.Fatal(fmt.Sprintf(text, args...)) } diff --git a/logging.go b/logging.go index 7e43ce6..f89bf0f 100644 --- a/logging.go +++ b/logging.go @@ -12,40 +12,53 @@ package logging defines the following builtin backends: A backend can safely be used by multiple loggers. -It is the caller's responsability to call Close on backends when they are not +It is the caller's responsibility to call Close on backends when they are not used anymore to free their resources. */ package logging import ( + "errors" "fmt" "strings" "sync" ) +//nolint:gochecknoglobals // designed this way var ( loggers map[string]*Logger lock sync.Mutex + + errInvalidLogLevel = errors.New("invalid log level") ) -// Level is the type of log levels +// Level is the type of log levels. type Level byte -//nolint: golint +//revive:disable:exported const ( - Debug Level = iota + Trace Level = iota + Debug Info + Notice Warning Error Critical + Alert Fatal DefaultLevel = Info ) -var levelNames = [6]string{"DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL", "FATAL"} +//revive:enable:exported -// Name returns the name of the log level +//nolint:gochecknoglobals // designed this way +var levelNames = [...]string{ + "TRACE", "DEBUG", "INFO", "NOTICE", "WARNING", + "ERROR", "CRITICAL", "ALERT", "FATAL", +} + +// Name returns the name of the log level. func (l Level) Name() string { return levelNames[l] } @@ -58,7 +71,8 @@ func LevelByName(l string) (Level, error) { return Level(pos), nil } } - return Debug, fmt.Errorf("Invalid log level %s", l) + + return Debug, fmt.Errorf("unknown log level %q: %w", l, errInvalidLogLevel) } // Formatter is the types of the functions that can be used to format a log @@ -66,14 +80,15 @@ func LevelByName(l string) (Level, error) { type Formatter func(*Record) string // GetLogger returns a logger given its name. if the logger does not exist, it -// initializes one with the defaults (it logs to stdout with level debug) -func GetLogger(name string) (l *Logger) { +// initializes one with the defaults (it logs to stdout with level INFO). +func GetLogger(name string) *Logger { lock.Lock() defer lock.Unlock() if name == "" { name = "default" } + l, ok := loggers[name] if !ok { l = NewLogger(name) @@ -82,21 +97,23 @@ func GetLogger(name string) (l *Logger) { l.SetLevel(DefaultLevel) loggers[name] = l } + return l } -var defaultFormatter Formatter = func(r *Record) string { +func defaultFormatter(r *Record) string { return fmt.Sprintf("%s [%-8s] %s: %s\n", r.Timestamp.Format("2006/01/02 15:04:05"), r.Level.Name(), r.Logger, strings.TrimSpace(r.Message)) } -var basicFormatter Formatter = func(r *Record) string { +func basicFormatter(r *Record) string { return fmt.Sprintf("%s: %s", r.Logger, strings.TrimSpace(r.Message)) } +//nolint:gochecknoinits // init is used by design func init() { - loggers = make(map[string]*Logger, 3) + loggers = map[string]*Logger{} logger := NewLogger("default") backend := NewStdoutBackend() diff --git a/logging_test.go b/logging_test.go index 1921e0e..ce9c6d2 100644 --- a/logging_test.go +++ b/logging_test.go @@ -3,11 +3,14 @@ package logging import "testing" func Test_LevelByName(t *testing.T) { + t.Parallel() + for _, levelName := range levelNames { l, e := LevelByName(levelName) if e != nil { t.Errorf("level %s not recognized", levelName) } + if l.Name() != levelName { t.Errorf("expected '%s', got '%s'", levelName, l.Name()) } diff --git a/record.go b/record.go index d0b9e77..297fdcb 100644 --- a/record.go +++ b/record.go @@ -5,7 +5,7 @@ import ( ) // Record contains the data to be logged. It is passed to a formatter to -// generate the logged message +// generate the logged message. type Record struct { Logger string Timestamp time.Time @@ -13,13 +13,12 @@ type Record struct { Message string } -// NewRecord creates a new record, setting its timestamp to time.Now() -func NewRecord(name string, l Level, m string) (r *Record) { - r = &Record{ +// NewRecord creates a new record, setting its timestamp to time.Now(). +func NewRecord(name string, l Level, m string) *Record { + return &Record{ Logger: name, Level: l, Message: m, Timestamp: time.Now(), } - return }