chore: bump go version to 1.17, replace golint with staticcheck (#222)

* ci(coverage): include coverage report

* chore: bump minimum go version to 1.17

* ci(staticcheck): fix linting issues

* ci(goimports): reorder imports

* chore(mockery): bump version to support go 1.18

* docs: Update contributing to mention conventional commits

Co-authored-by: Carsten Dietrich <carsten.dietrich@omnevo.net>

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: [ '1.16', '1.*' ]
+        go: [ '1.17', '1.*' ]
     name: Tests
     steps:
       - uses: actions/checkout@v2
@@ -25,6 +25,42 @@ jobs:
         run: go get -v -t -d ./...
       - name: Test
         run: CGO_ENABLED=1 go test -race ./...
+  coverage:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: [ '1.*' ]
+    name: Coverage Report
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go }}
+      - name: Get dependencies
+        run: go get -v -t -d ./...
+      - name: Test
+        run: |
+          CGO_ENABLED=1 go run gotest.tools/gotestsum@v1.7.0 --junitfile test.xml --format testname -- -coverprofile coverage.txt -race ./...
+          go run github.com/boumenot/gocover-cobertura@v1.2.0 -ignore-gen-files -by-files < coverage.txt > coverage.xml
+      - name: Code Coverage Summary Report
+        uses: irongut/CodeCoverageSummary@v1.2.0
+        with:
+          filename: coverage.xml
+          badge: true
+          fail_below_min: false
+          format: markdown
+          hide_branch_rate: true
+          hide_complexity: true
+          indicators: true
+          output: both
+          thresholds: '50 75'
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          recreate: true
+          path: code-coverage-results.md
   static-checks:
     runs-on: ubuntu-latest
     strategy:
@@ -45,13 +81,17 @@ jobs:
         run: |
           fmt=$(gofmt -l .)
           test -z $fmt || (echo "please run gofmt" ; echo $fmt ; exit 1)
-      - name: Go Lint
-        run: go run golang.org/x/lint/golint@6edffad -set_exit_status $(go list ./...)
+      - name: Go Staticcheck
+        run: go run honnef.co/go/tools/cmd/staticcheck@latest ./...
       - name: Spelling
         run: go run github.com/client9/misspell/cmd/misspell@v0.3.4 -error .
       - name: Ineffective assignments
         run: go run github.com/gordonklaus/ineffassign@4cc7213 .
+      - name: Goimports
+        run: |
+          go run golang.org/x/tools/cmd/goimports@latest -w .
+          git diff --quiet || (echo 'goimports requires code cleanup:' ; git diff ; exit 1)
       - name: Go Generate
         run: |
           go generate ./...
-          git diff --quiet || (echo 'generated go files are not up-to-date, check go generate, go.sum and go.mod' ; git diff ; exit 1)
+          git diff --quiet || (echo 'generated go files are not up-to-date, check go generate, go.sum and go.mod:' ; git diff ; exit 1)

.gitignore

@@ -3,6 +3,8 @@
 .idea
 .temp
 coverage
+coverage.txt
+coverage.xml
 context_local.yml
 
 docs/docs/3. Core Packages

CONTRIBUTING.md

@@ -6,21 +6,23 @@ You can contribute by opening an Issue or with Pull request.
 
 
 # Suggested Pull Request workflow
+## Contributing
 
-## committing
-
-Please contribute by opening pull requests in github.
+Please contribute by opening pull requests in GitHub.
 This allows us to review, and optionally squash changes to an atomic change.
 
 We have also put together a list of [Coding conventions](docs/1.%20Flamingo%20Basics/8.%20Coding%20Conventions.md)
 
 ## Commit messages
 
-A commit message should always start with the affected modules, such as:
+We adhere to conventional commits please refer to the specs for more details: https://www.conventionalcommits.org/en/v1.0.0/
 
-`framework/dingo: add command line flags`
-or
-`core/pugtemplate/pugjs: update parser`
+If possible include the affected module / part of flamingo:
 
-A commit message is supposed to tell what has changed.
+`feat(framework/dingo): add command line flags`
+
+`fix(core/pugtemplate/pugjs): fix parsing of utf8 characters`
 
+`chore: update dpendecy xyz`
+
+A commit message is supposed to tell what has changed.

core/locale/application/date_time_service_test.go

@@ -1,10 +1,10 @@
 package application
 
 import (
-	"flamingo.me/flamingo/v3/core/locale/domain"
 	"testing"
 	"time"
 
+	"flamingo.me/flamingo/v3/core/locale/domain"
 	"flamingo.me/flamingo/v3/framework/flamingo"
 	"github.com/stretchr/testify/assert"
 )

core/locale/application/label_service_test.go

@@ -1,12 +1,13 @@
 package application
 
 import (
+	"testing"
+
 	"flamingo.me/flamingo/v3/core/locale/domain"
 	"flamingo.me/flamingo/v3/core/locale/infrastructure/fake"
 	"flamingo.me/flamingo/v3/framework/config"
 	"flamingo.me/flamingo/v3/framework/flamingo"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestLabelService_NewLabel(t *testing.T) {

core/locale/application/price_service_test.go

@@ -1,12 +1,13 @@
 package application
 
 import (
+	"testing"
+
 	"flamingo.me/flamingo/v3/core/locale/domain"
 	"flamingo.me/flamingo/v3/core/locale/infrastructure/fake"
 	"flamingo.me/flamingo/v3/framework/config"
 	"github.com/leekchan/accounting"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestPriceService_GetConfigForCurrency(t *testing.T) {

core/locale/interfaces/controllers/translation_controller_test.go

@@ -2,13 +2,14 @@ package controllers
 
 import (
 	"context"
+	"testing"
+
 	"flamingo.me/flamingo/v3/core/locale/application"
 	"flamingo.me/flamingo/v3/core/locale/domain"
 	"flamingo.me/flamingo/v3/core/locale/infrastructure/fake"
 	"flamingo.me/flamingo/v3/framework/config"
 	"flamingo.me/flamingo/v3/framework/web"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestTranslationController_GetAllTranslations(t *testing.T) {

core/oauth/application/authmanager.go

@@ -65,7 +65,7 @@ type (
 // RoundTrip implements RoundTripper interface and adds logging
 func (f *loggingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
 	if req == nil {
-		return nil, errors.New("No request given")
+		return nil, errors.New("no request given")
 	}
 	b, err := httputil.DumpRequest(req, true)
 	log.Println()
@@ -432,8 +432,7 @@ func (am *AuthManager) StoreTokenDetails(ctx context.Context, session *web.Sessi
 		tokenExtras.Add(extra, parsed)
 	}
 
-	var token oauth2.Token
-	token = *oauth2Token
+	token := *oauth2Token
 	session.Store(keyToken, token)
 	session.Store(keyRawIDToken, rawToken)
 	session.Store(keyTokenExtras, tokenExtras)

core/oauth/interfaces/callback_controller.go

@@ -74,7 +74,7 @@ func (cc *CallbackController) Get(ctx context.Context, request *web.Request) web
 		}
 
 		stats.Record(ctx, loginFailedCount.M(1))
-		return cc.responder.ServerError(errors.New("Invalid State"))
+		return cc.responder.ServerError(errors.New("invalid state"))
 	}
 
 	// cleanup previous token information

core/security/application/doc.go

@@ -1,3 +1,3 @@
 package application
 
-//go:generate go run github.com/vektra/mockery/v2@v2.9.4 --name=SecurityService --case=underscore
+//go:generate go run github.com/vektra/mockery/v2@v2.12.2 --name=SecurityService --case=underscore

core/security/application/role/doc.go

@@ -1,3 +1,3 @@
 package role
 
-//go:generate go run github.com/vektra/mockery/v2@v2.9.4 --all --case=underscore
+//go:generate go run github.com/vektra/mockery/v2@v2.12.2 --all --case=underscore

core/security/application/voter/doc.go

@@ -1,3 +1,3 @@
 package voter
 
-//go:generate go run github.com/vektra/mockery/v2@v2.9.4 --all --case=underscore
+//go:generate go run github.com/vektra/mockery/v2@v2.12.2 --all --case=underscore

core/security/domain/doc.go

@@ -1,3 +1,3 @@
 package domain
 
-//go:generate go run github.com/vektra/mockery/v2@v2.9.4 --all --case=underscore
+//go:generate go run github.com/vektra/mockery/v2@v2.12.2 --all --case=underscore