Merge pull request #35 from hellofresh/feature/gh-actions-pipeline

PT-6767 Added GitHub Actions pipeline

Author: vgarvardt

.github/workflows/testing.yml

@@ -0,0 +1,115 @@
+name: Testing
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  release:
+    types:
+      - created
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v2-beta
+        with:
+          go-version: ^1.14
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Check code quality
+        run: |
+          go install -i golang.org/x/lint/golint
+          make code-quality
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs: [lint]
+
+    services:
+      postgres:
+        image: postgres:9.6-alpine
+        ports:
+          - "5432"
+        env:
+          POSTGRES_USER: test
+          POSTGRES_PASSWORD: test
+          POSTGRES_DB: test
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      rabbit:
+        image: rabbitmq:3.6-management-alpine
+        ports:
+          - "5672"
+          - "15672"
+
+      redis:
+        image: redis:3.2-alpine
+        ports:
+          - "6379"
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      mongo:
+        image: mongo:3
+        ports:
+          - "27017"
+
+      mysql:
+        image: mysql:5.7
+        ports:
+          - "3306"
+        env:
+          MYSQL_ROOT_PASSWORD: test
+          MYSQL_DATABASE: test
+          MYSQL_USER: test
+          MYSQL_PASSWORD: test
+        options: >-
+          --health-cmd "mysqladmin ping -h 127.0.0.1 -u $$MYSQL_USER --password=$$MYSQL_PASSWORD"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      http:
+        image: pierreprinetti/apimock:latest
+        ports:
+          - "8080"
+        env:
+          HOST: ":8080"
+
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v2-beta
+        with:
+          go-version: ^1.14
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Run tests
+        if: success()
+        run: go test -cover ./... -coverprofile=coverage.txt -covermode=atomic
+        env:
+          HEALTH_GO_PG_DSN: postgres://test:test@localhost:${{ job.services.postgres.ports[5432] }}/test?sslmode=disable
+          HEALTH_GO_MQ_DSN: amqp://guest:guest@localhost:${{ job.services.rabbit.ports[5672] }}/
+          HEALTH_GO_MQ_URL: http://guest:guest@localhost:${{ job.services.rabbit.ports[15672] }}/
+          HEALTH_GO_RD_DSN: redis://localhost:${{ job.services.redis.ports[6379] }}/
+          HEALTH_GO_MG_DSN: mongodb://localhost:${{ job.services.mongo.ports[27017] }}/
+          HEALTH_GO_MS_DSN: test:test@tcp(localhost:${{ job.services.mysql.ports[3306] }})/test?charset=utf8
+          HEALTH_GO_HTTP_URL: http://localhost:${{ job.services.http.ports[8080] }}/status
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        if: success()
+        with:
+          file: ./coverage.txt
+          fail_ci_if_error: false

.gitignore

@@ -1 +1,2 @@
 vendor/
+coverage.txt

.travis.yml

@@ -1,17 +1,16 @@
 OK_COLOR=\033[32;01m
 NO_COLOR=\033[0m
 
-all: deps lint test
-
-lint:
-	@echo "$(OK_COLOR)==> Linting... $(NO_COLOR)"
-	@go vet ./...
+all: deps test
 
 deps:
 	@echo "$(OK_COLOR)==> Installing dependencies $(NO_COLOR)"
+	@go install -i golang.org/x/lint/golint
 	@go mod vendor
 
-test:
+code-quality: lint format vet
+
+test: code-quality
 	@echo "$(OK_COLOR)==> Running tests against container deps $(NO_COLOR)"
 	@docker-compose up -d
 	@sleep 3 && \
@@ -22,6 +21,18 @@ test:
 		HEALTH_GO_MG_DSN="mongodb://`docker-compose port mongo 27017`/" \
 		HEALTH_GO_MS_DSN="test:test@tcp(`docker-compose port mysql 3306`)/test?charset=utf8" \
 		HEALTH_GO_HTTP_URL="http://`docker-compose port http 8080`/status" \
-		go test -cover ./...
+		go test -cover ./... -coverprofile=coverage.txt -covermode=atomic
+
+lint:
+	@echo "$(OK_COLOR)==> Checking code style with 'golint' tool$(NO_COLOR)"
+	@go list ./... | xargs -n 1 golint -set_exit_status
+
+format:
+	@echo "$(OK_COLOR)==> Checking code formating with 'gofmt' tool$(NO_COLOR)"
+	@gofmt -l -s checks | grep ".*\.go"; if [ "$$?" = "0" ]; then exit 1; fi
+
+vet:
+	@echo "$(OK_COLOR)==> Checking code correctness with 'go vet' tool$(NO_COLOR)"
+	@go vet ./...
 
-.PHONY: all deps test lint
+.PHONY: all deps test code-quality lint format vet

Makefile

@@ -1,7 +1,7 @@
 # health-go
-[![Build Status](https://travis-ci.com/hellofresh/health-go.svg?branch=master)](https://travis-ci.com/hellofresh/health-go)
 [![Go Report Card](https://goreportcard.com/badge/github.com/hellofresh/health-go)](https://goreportcard.com/report/github.com/hellofresh/health-go)
 [![Go Doc](https://godoc.org/github.com/hellofresh/health-go?status.svg)](https://godoc.org/github.com/hellofresh/health-go)
+[![Coverage Status](https://codecov.io/gh/hellofresh/health-go/branch/master/graph/badge.svg)](https://codecov.io/gh/hellofresh/health-go)
 
 * Exposes an HTTP handler that retrieves health status of the application
 * Implements some generic checkers for the following services:

README.md

@@ -9,13 +9,26 @@ import (
 	"go.mongodb.org/mongo-driver/mongo/readpref"
 )
 
+const (
+	defaultTimeoutConnect    = 5 * time.Second
+	defaultTimeoutDisconnect = 5 * time.Second
+	defaultTimeoutPing       = 5 * time.Second
+)
+
 // Config is the MongoDB checker configuration settings container.
 type Config struct {
 	// DSN is the MongoDB instance connection DSN. Required.
 	DSN string
 	// LogFunc is the callback function for errors logging during check.
 	// If not set logging is skipped.
 	LogFunc func(err error, details string, extra ...interface{})
+
+	// TimeoutConnect defines timeout for establishing mongo connection, if not set - default value is used
+	TimeoutConnect time.Duration
+	// TimeoutDisconnect defines timeout for closing connection, if not set - default value is used
+	TimeoutDisconnect time.Duration
+	// TimeoutDisconnect defines timeout for making ping request, if not set - default value is used
+	TimeoutPing time.Duration
 }
 
 // New creates new MongoDB health check that verifies the following:
@@ -26,6 +39,18 @@ func New(config Config) func() error {
 		config.LogFunc = func(err error, details string, extra ...interface{}) {}
 	}
 
+	if config.TimeoutConnect == 0 {
+		config.TimeoutConnect = defaultTimeoutConnect
+	}
+
+	if config.TimeoutDisconnect == 0 {
+		config.TimeoutDisconnect = defaultTimeoutDisconnect
+	}
+
+	if config.TimeoutPing == 0 {
+		config.TimeoutPing = defaultTimeoutPing
+	}
+
 	return func() error {
 		var ctx context.Context
 		var cancel context.CancelFunc
@@ -36,7 +61,7 @@ func New(config Config) func() error {
 			return err
 		}
 
-		ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
+		ctx, cancel = context.WithTimeout(context.Background(), config.TimeoutConnect)
 		defer cancel()
 		err = client.Connect(ctx)
 
@@ -46,14 +71,14 @@ func New(config Config) func() error {
 		}
 
 		defer func() {
-			ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
+			ctx, cancel = context.WithTimeout(context.Background(), config.TimeoutDisconnect)
 			defer cancel()
 			if err := client.Disconnect(ctx); err != nil {
 				config.LogFunc(err, "MongoDB health check failed on closing connection")
 			}
 		}()
 
-		ctx, cancel = context.WithTimeout(context.Background(), 5*time.Second)
+		ctx, cancel = context.WithTimeout(context.Background(), config.TimeoutPing)
 		defer cancel()
 		err = client.Ping(ctx, readpref.Primary())
 

checks/mongo/check.go

@@ -3,7 +3,7 @@ package mysql
 import (
 	"database/sql"
 
-	_ "github.com/go-sql-driver/mysql"
+	_ "github.com/go-sql-driver/mysql" // import mysql driver
 )
 
 // Config is the MySQL checker configuration settings container.

checks/mysql/check.go

@@ -3,25 +3,20 @@ package mysql
 import (
 	"database/sql"
 	"os"
+	"sync"
 	"testing"
 	"time"
 
+	_ "github.com/go-sql-driver/mysql"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 const mysqlDSNEnv = "HEALTH_GO_MS_DSN"
 
-func getDSN(t *testing.T) string {
-	if mysqlDSN, ok := os.LookupEnv(mysqlDSNEnv); ok {
-		return mysqlDSN
-	}
-
-	t.Fatalf("required env variable missing: %s", mysqlDSNEnv)
-	return ""
-}
-
 func TestNew(t *testing.T) {
+	initDB(t)
+
 	check := New(Config{
 		DSN: getDSN(t),
 	})
@@ -31,6 +26,8 @@ func TestNew(t *testing.T) {
 }
 
 func TestEnsureConnectionIsClosed(t *testing.T) {
+	initDB(t)
+
 	mysqlDSN := getDSN(t)
 
 	db, err := sql.Open("mysql", mysqlDSN)
@@ -66,3 +63,38 @@ func TestEnsureConnectionIsClosed(t *testing.T) {
 
 	assert.Equal(t, initialConnections, currentConnections)
 }
+
+func getDSN(t *testing.T) string {
+	t.Helper()
+
+	mysqlDSN, ok := os.LookupEnv(mysqlDSNEnv)
+	require.True(t, ok)
+
+	return mysqlDSN
+}
+
+var dbInit sync.Once
+
+func initDB(t *testing.T) {
+	t.Helper()
+
+	dbInit.Do(func() {
+		db, err := sql.Open("mysql", getDSN(t))
+		require.NoError(t, err)
+
+		defer func() {
+			err := db.Close()
+			assert.NoError(t, err)
+		}()
+
+		_, err = db.Exec(`
+CREATE TABLE IF NOT EXISTS test (
+  id           INT NOT NULL AUTO_INCREMENT PRIMARY KEY ,
+  secret       VARCHAR(256) NOT NULL,
+  extra        VARCHAR(256) NOT NULL,
+  redirect_uri VARCHAR(256) NOT NULL
+);
+`)
+		require.NoError(t, err)
+	})
+}

checks/mysql/check_test.go

@@ -3,7 +3,7 @@ package postgres
 import (
 	"database/sql"
 
-	_ "github.com/lib/pq"
+	_ "github.com/lib/pq" // import pg driver
 )
 
 // Config is the PostgreSQL checker configuration settings container.