Merge pull request #30 from slok/check

Add checks to CI and fix the checker error on the code

Author: slok

.github/workflows/ci.yml

@@ -1,18 +1,35 @@
 name: CI
+
 on: [push]
+
 jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v1
+        with:
+          go-version: 1.13
+      - name: Get golangci
+        run: |
+          # Add go binaries to GOPATH.
+          # FIX: https://github.com/actions/setup-go/issues/14
+          export PATH=${PATH}:`go env GOPATH`/bin
+          go get -u github.com/golangci/golangci-lint/...
+      - uses: actions/checkout@v1
+      - name: check
+        run: |
+          # Add go binaries to GOPATH.
+          # FIX: https://github.com/actions/setup-go/issues/14
+          export PATH=${PATH}:`go env GOPATH`/bin
+          make check
+
   test:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Go
-        uses: actions/setup-go@v1
+      - uses: actions/checkout@v1
+      - uses: actions/setup-go@v1
         with:
           go-version: 1.13
-        id: go
-
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v1
-
-      - name: Test
-        run: make ci
+      - run: make test

Makefile

@@ -2,6 +2,7 @@
 UNIT_TEST_CMD := go test `go list ./... | grep -v vendor` -race -v
 INTEGRATION_TEST_CMD := go test `go list ./... | grep -v vendor`  -race -v -tags='integration'
 BENCHMARK_CMD := go test `go list ./... | grep -v vendor` -benchmem -bench=.
+CHECK_CMD = golangci-lint run -E goimports
 DEPS_CMD := go mod tidy
 MOCKS_CMD := go generate ./internal/mocks
 
@@ -11,18 +12,21 @@ default: test
 .PHONY: unit-test
 unit-test:
 	$(UNIT_TEST_CMD)
+
 .PHONY: integration-test
 integration-test:
 	$(INTEGRATION_TEST_CMD)
+
 .PHONY: test
 test: integration-test
 
 .PHONY: benchmark
 benchmark:
 	$(BENCHMARK_CMD)
 
-.PHONY: ci
-ci: test
+.PHONY: check
+check: 
+	$(CHECK_CMD)
 
 .PHONY: deps
 deps:

middleware/example_test.go

@@ -22,15 +22,17 @@ func ExampleMiddleware_prometheusBackendMiddleware() {
 	// Create our handler.
 	myHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(http.StatusOK)
-		w.Write([]byte("hello world!"))
+		_, _ = w.Write([]byte("hello world!"))
 	})
 
 	// Wrap our handler with the middleware.
 	h := mdlw.Handler("", myHandler)
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Serve our handler.
 	log.Printf("listening at: %s", ":8080")

middleware/gin/example_test.go

@@ -31,7 +31,9 @@ func Example_ginMiddleware() {
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Serve our handler.
 	log.Printf("listening at: %s", ":8080")

middleware/gin/gin.go

@@ -47,6 +47,9 @@ func (w *ginResponseWriter) WriteHeader(statusCode int) {
 }
 
 func (w *ginResponseWriter) Write(p []byte) (int, error) {
-	w.middlewareRW.Write(p)
+	b, err := w.middlewareRW.Write(p)
+	if err != nil {
+		return b, err
+	}
 	return w.ResponseWriter.Write(p)
 }

middleware/gorestful/example_test.go

@@ -29,13 +29,15 @@ func Example_gorestfulMiddleware() {
 	// Add our handler,
 	ws := &gorestful.WebService{}
 	ws.Route(ws.GET("/").To(func(_ *gorestful.Request, resp *gorestful.Response) {
-		resp.WriteEntity("Hello world")
+		_ = resp.WriteEntity("Hello world")
 	}))
 	c.Add(ws)
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Serve our handler.
 	log.Printf("listening at: %s", ":8080")

middleware/gorestful/gorestful_test.go

@@ -17,7 +17,7 @@ import (
 
 func getTestHandler(statusCode int) gorestful.RouteFunction {
 	return gorestful.RouteFunction(func(_ *gorestful.Request, resp *gorestful.Response) {
-		resp.WriteHeaderAndEntity(statusCode, "Hello world")
+		_ = resp.WriteHeaderAndEntity(statusCode, "Hello world")
 	})
 }
 

middleware/httprouter/example_test.go

@@ -20,7 +20,7 @@ func Example_httprouterMiddlewareByHandler() {
 	myHandler := func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
 		id := p.ByName("id")
 		w.WriteHeader(http.StatusOK)
-		w.Write([]byte("hello world! " + id))
+		_, _ = w.Write([]byte("hello world! " + id))
 	}
 
 	// Create our router.
@@ -36,7 +36,9 @@ func Example_httprouterMiddlewareByHandler() {
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Serve our handler.
 	log.Printf("listening at: %s", ":8080")
@@ -52,7 +54,7 @@ func Example_httprouterMiddlewareOnRouter() {
 	myHandler := func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
 		id := p.ByName("id")
 		w.WriteHeader(http.StatusOK)
-		w.Write([]byte("hello world! " + id))
+		_, _ = w.Write([]byte("hello world! " + id))
 	}
 
 	// Create our router and add the middleware.
@@ -68,7 +70,9 @@ func Example_httprouterMiddlewareOnRouter() {
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Wrap the router with the middleware.
 	h := mdlw.Handler("", r)

middleware/middleware_test.go

@@ -14,7 +14,7 @@ import (
 func getFakeHandler(statusCode int, responseBody string) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(statusCode)
-		w.Write([]byte(responseBody))
+		_, _ = w.Write([]byte(responseBody))
 	})
 }
 

middleware/negroni/example_test.go

@@ -18,7 +18,7 @@ func Example_negroniMiddleware() {
 	// Create our handler.
 	myHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		w.WriteHeader(http.StatusOK)
-		w.Write([]byte("hello world!"))
+		_, _ = w.Write([]byte("hello world!"))
 	})
 
 	// Create our negroni instance.
@@ -36,7 +36,9 @@ func Example_negroniMiddleware() {
 
 	// Serve metrics from the default prometheus registry.
 	log.Printf("serving metrics at: %s", ":8081")
-	go http.ListenAndServe(":8081", promhttp.Handler())
+	go func() {
+		_ = http.ListenAndServe(":8081", promhttp.Handler())
+	}()
 
 	// Serve our handler.
 	log.Printf("listening at: %s", ":8080")