diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml deleted file mode 100644 index 9388d6c..0000000 --- a/.github/workflows/codecov.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: "Code Coverage" - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - coverage: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - uses: actions/setup-go@v5 - with: - go-version: '1.19' - - name: Run test coverage - run: go test -race -coverprofile=coverage.out -covermode=atomic ./... - - uses: codecov/codecov-action@v3 - with: - files: coverage.out diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml deleted file mode 100644 index e8e4feb..0000000 --- a/.github/workflows/codeql-analysis.yml +++ /dev/null @@ -1,67 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -# -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# -name: "CodeQL" - -on: - push: - branches: [ main ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ main ] - schedule: - - cron: '42 20 * * 3' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - permissions: - actions: read - contents: read - security-events: write - - strategy: - fail-fast: false - matrix: - language: [ 'go' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] - # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support - - steps: - - name: Checkout repository - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v3 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - # If the Autobuild fails above, remove it and uncomment the following three lines. - # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. - # - run: | - # echo "Run, Build Application using script" - # ./location_of_script_within_repo/buildscript.sh - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@cdcdbb579706841c47f7063dda365e292e5cad7a # pin@v2 diff --git a/.github/workflows/gochecks.yml b/.github/workflows/gochecks.yml deleted file mode 100644 index 7744139..0000000 --- a/.github/workflows/gochecks.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: go-checks - -on: - push: - branches: [ main ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ main ] - -jobs: - check: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@master - - name: Setup Go environment - uses: actions/setup-go@v5 - with: - go-version: '1.21' - check-latest: true - - name: Run golangci-lint - uses: golangci/golangci-lint-action@v4 diff --git a/.github/workflows/include.yml b/.github/workflows/include.yml new file mode 100644 index 0000000..9040f9e --- /dev/null +++ b/.github/workflows/include.yml @@ -0,0 +1,20 @@ +# Same as full workflow (eg from fortio/multicurl) but without the goreleaser step +name: "Shared library fortio workflows" + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + call-gochecks: + uses: fortio/workflows/.github/workflows/gochecks.yml@main + call-codecov: + uses: fortio/workflows/.github/workflows/codecov.yml@main + call-codeql: + uses: fortio/workflows/.github/workflows/codeql-analysis.yml@main + permissions: + actions: read + contents: read + security-events: write diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6c3cdf3 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.golangci.yml diff --git a/.golangci.yml b/.golangci.yml deleted file mode 100644 index 7bea3c5..0000000 --- a/.golangci.yml +++ /dev/null @@ -1,176 +0,0 @@ -# Config for golanglint-ci - -# output configuration options - -# all available settings of specific linters -linters-settings: - gocritic: - disabled-checks: - - ifElseChain - dupl: - # tokens count to trigger issue, 150 by default - threshold: 100 - exhaustive: - # indicates that switch statements are to be considered exhaustive if a - # 'default' case is present, even if all enum members aren't listed in the - # switch - default-signifies-exhaustive: false - funlen: - lines: 140 - statements: 70 - gocognit: - # minimal code complexity to report, 30 by default (but we recommend 10-20) - min-complexity: 42 - nestif: - # minimal complexity of if statements to report, 5 by default - min-complexity: 4 - gocyclo: - # minimal code complexity to report, 30 by default (but we recommend 10-20) - min-complexity: 30 - godot: - # check all top-level comments, not only declarations - check-all: false - govet: - # report about shadowed variables - check-shadowing: true - # settings per analyzer - settings: - printf: # analyzer name, run `go tool vet help` to see all analyzers - funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer - - (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 - - (github.com/golangci/golangci-lint/pkg/logutils.Log).Printf - - (github.com/golangci/golangci-lint/pkg/logutils.Log).FErrf - enable-all: true - disable-all: false - depguard: - rules: - main: - # List of allowed packages. - allow: - - $gostd - - fortio.org/log - - fortio.org/struct2env - lll: - # max line length, lines longer will be reported. Default is 120. - # '\t' is counted as 1 character by default, and can be changed with the tab-width option - line-length: 132 - # tab width in spaces. Default to 1. - tab-width: 1 - misspell: - # Correct spellings using locale preferences for US or UK. - # Default is to use a neutral variety of English. - # Setting locale to US will correct the British spelling of 'colour' to 'color'. - locale: US - ignore-words: - - fortio - nakedret: - # make an issue if func has more lines of code than this setting and it has naked returns; default is 30 - max-func-lines: 30 - nolintlint: - require-specific: true - whitespace: - multi-if: false # Enforces newlines (or comments) after every multi-line if statement - multi-func: false # Enforces newlines (or comments) after every multi-line function signature - gofumpt: - # Choose whether or not to use the extra rules that are disabled - # by default - extra-rules: false - - -linters: - disable: - # bad ones: - - musttag - # Deprecated ones: - - scopelint - - golint - - interfacer - - maligned - - varcheck - - structcheck - - nosnakecase - - deadcode - # Weird/bad ones: - - wsl - - nlreturn - - gochecknoinits - - gochecknoglobals - - gomnd - - testpackage - - wrapcheck - - exhaustivestruct - - tagliatelle - - nonamedreturns - - varnamelen - - exhaustruct # seems like a good idea at first but actually a pain and go does have zero values for a reason. -# TODO consider putting these back, when they stop being bugged (ifshort, wastedassign,...) - - paralleltest - - thelper - - forbidigo - - ifshort - - wastedassign - - cyclop - - forcetypeassert - - ireturn - enable-all: true - disable-all: false - # Must not use fast: true in newer golangci-lint or it'll just skip a bunch of linter instead of doing caching like before (!) - fast: false - - -issues: - # 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: - - gocyclo - - errcheck - - dupl - - gosec - - gochecknoinits - - gochecknoglobals - - forcetypeassert - - nosnakecase - - noctx - - # Exclude lll issues for long lines with go:generate - - linters: - - lll - source: "^//go:generate " - - linters: - - goerr113 - text: "do not define dynamic errors" - - linters: - - govet - text: "fieldalignment:" - - linters: - - godox - text: "TODO" - - linters: - - nosnakecase - text: "grpc_|_SERVING|O_" - - # Maximum issues count per one linter. Set to 0 to disable. Default is 50. - max-issues-per-linter: 0 - - # Maximum count of issues with the same text. Set to 0 to disable. Default is 3. - max-same-issues: 0 - -severity: - # Default value is empty string. - # 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-severity: error - - # The default value is false. - # If set to true severity-rules regular expressions become case sensitive. - case-sensitive: false diff --git a/Makefile b/Makefile index 917a10e..7affc5c 100644 --- a/Makefile +++ b/Makefile @@ -17,4 +17,12 @@ line: screenshot: line example @echo -.PHONY: all test example screenshot line + +lint: .golangci.yml + golangci-lint run + +.golangci.yml: Makefile + curl -fsS -o .golangci.yml https://raw.githubusercontent.com/fortio/workflows/main/golangci.yml + + +.PHONY: all test example screenshot line lint diff --git a/logger.go b/logger.go index 3809491..1489f60 100644 --- a/logger.go +++ b/logger.go @@ -442,31 +442,33 @@ func logUnconditionalf(logFileAndLine bool, lvl Level, format string, rest ...in if logFileAndLine { //nolint:nestif _, file, line, _ := runtime.Caller(3) file = file[strings.LastIndex(file, "/")+1:] - if Color { + switch { + case Color: jsonWrite(fmt.Sprintf("%s%s%s %s:%d%s%s%s%s\n", colorTimestamp(), colorGID(), ColorLevelToStr(lvl), file, line, prefix, LevelToColor[lvl], fmt.Sprintf(format, rest...), Colors.Reset)) - } else if Config.JSON { + case Config.JSON: jsonWrite(fmt.Sprintf("{%s\"level\":%s,%s\"file\":%q,\"line\":%d,\"msg\":%q}\n", jsonTimestamp(), LevelToJSON[lvl], jsonGID(), file, line, fmt.Sprintf(format, rest...))) - } else { + default: if lvl != NoLevel { lvl1Char = "[" + LevelToStrA[lvl][0:1] + "]" } log.Print(lvl1Char, " ", file, ":", line, prefix, fmt.Sprintf(format, rest...)) } } else { - if Color { + switch { + case Color: jsonWrite(fmt.Sprintf("%s%s%s%s%s%s%s\n", colorTimestamp(), colorGID(), ColorLevelToStr(lvl), prefix, LevelToColor[lvl], fmt.Sprintf(format, rest...), Colors.Reset)) - } else if Config.JSON { + case Config.JSON: if len(rest) != 0 { format = fmt.Sprintf(format, rest...) } jsonWrite(fmt.Sprintf("{%s\"level\":%s,%s\"msg\":%q}\n", jsonTimestamp(), LevelToJSON[lvl], jsonGID(), format)) - } else { + default: if lvl != NoLevel { lvl1Char = "[" + LevelToStrA[lvl][0:1] + "]" } @@ -684,11 +686,12 @@ func s(lvl Level, logFileAndLine bool, json bool, msg string, attrs ...KeyVal) { } buf := strings.Builder{} var format string - if Color { + switch { + case Color: format = Colors.Reset + ", " + Colors.Blue + "%s" + Colors.Reset + "=" + LevelToColor[lvl] + "%v" - } else if json { + case json: format = ",%q:%s" - } else { + default: format = ", %s=%s" } for _, attr := range attrs { @@ -705,27 +708,29 @@ func s(lvl Level, logFileAndLine bool, json bool, msg string, attrs ...KeyVal) { } else { lvl1Char = "[" + LevelToStrA[lvl][0:1] + "]" } - if logFileAndLine { //nolint:nestif + if logFileAndLine { _, file, line, _ := runtime.Caller(2) file = file[strings.LastIndex(file, "/")+1:] - if Color { + switch { + case Color: jsonWrite(fmt.Sprintf("%s%s%s %s:%d%s%s%s%s%s\n", colorTimestamp(), colorGID(), ColorLevelToStr(lvl), file, line, prefix, LevelToColor[lvl], msg, buf.String(), Colors.Reset)) - } else if json { + case json: jsonWrite(fmt.Sprintf("{%s\"level\":%s,%s\"file\":%q,\"line\":%d,\"msg\":%q%s}\n", jsonTimestamp(), LevelToJSON[lvl], jsonGID(), file, line, msg, buf.String())) - } else { + default: log.Print(lvl1Char, " ", file, ":", line, prefix, msg, buf.String()) } } else { - if Color { + switch { + case Color: jsonWrite(fmt.Sprintf("%s%s%s%s%s%s%s%s\n", colorTimestamp(), colorGID(), ColorLevelToStr(lvl), prefix, LevelToColor[lvl], msg, buf.String(), Colors.Reset)) - } else if json { + case json: jsonWrite(fmt.Sprintf("{%s\"level\":%s,\"msg\":%q%s}\n", jsonTimestamp(), LevelToJSON[lvl], msg, buf.String())) - } else { + default: log.Print(lvl1Char, prefix, msg, buf.String()) } }