test(lint): refactor logs and add linting rules #8573
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: golangci-lint | |
| on: | |
| push: | |
| tags: | |
| - v* | |
| branches: | |
| - main | |
| pull_request: | |
| permissions: | |
| contents: read | |
| # Optional: allow read access to pull request. Use with `only-new-issues` option. | |
| # pull-requests: read | |
| jobs: | |
| golangci: | |
| name: lint | |
| runs-on: ubuntu-latest-8-cores | |
| steps: | |
| - uses: actions/setup-go@v4 | |
| with: | |
| cache: false | |
| go-version: '1.20' | |
| - uses: actions/checkout@v4 | |
| - name: Run linter with GH action | |
| uses: golangci/golangci-lint-action@v3 | |
| with: | |
| # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version | |
| version: v1.54.2 | |
| # Optional: working directory, useful for monorepos | |
| # working-directory: somedir | |
| # Optional: golangci-lint command line arguments. | |
| # args: --issues-exit-code=0 | |
| args: --config ./golangcilint.yaml --enable-all --build-tags debug,needprivileges,sync,scrub,search,userprefs,metrics,containers_image_openpgp,lint,mgmt,imagetrust ./cmd/... ./pkg/... | |
| # Optional: show only new issues if it's a pull request. The default value is `false`. | |
| # only-new-issues: true | |
| # Optional: if set to true then the action don't cache or restore ~/go/pkg. | |
| # skip-pkg-cache: true | |
| # skip-pkg-cache: false | |
| # Optional: if set to true then the action don't cache or restore ~/.cache/go-build. | |
| # skip-build-cache: true | |
| - name: Run linter from make target | |
| run: | | |
| make check | |
| - name: Run log linter | |
| run: | | |
| set +e | |
| # log messages should never start upper-cased | |
| function lintLogStartingWithUpperCase { | |
| grep --with-filename -n "Msg[f]\?(\"[A-Z]" $1 | grep -v -E "Msg[f]?\(\"HTTP|OpenID|OAuth|TLS" | tr -s [:space:] | |
| } | |
| # log messages should not start with component "component:" | |
| function lintLogStartingWithComponent { | |
| grep --with-filename -n "(errors.New|Msg[f]?)\("[a-zA-Z-]+:" $1 | tr -s [:space:] | |
| } | |
| files=$(find . -name '*.go' | grep -v '_test.go') | |
| for file in $files | |
| do | |
| lintLogStartingWithUpperCase "$file" | |
| lintLogStartingWithComponent "$file" | |
| done | |
| if [ $? -eq 0 ]; then | |
| exit 1 | |
| fi | |
| exit 0 |