[METAL-2804] Use new cloudish sql mock (kloeckner-i#5)

Co-authored-by: Damian Peckett <damian.peckett@kloeckner.com>

Author: dpeckett

.github/workflows/build-and-test.yaml

@@ -17,7 +17,7 @@ jobs:
       - name: Check Code Style
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.30.0
+          version: v1.40.1
 
   build:
     runs-on: ubuntu-latest
@@ -51,6 +51,12 @@ jobs:
         uses: docker/setup-qemu-action@v1
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       - name: Download artifact
         uses: actions/download-artifact@v2
         with:
@@ -60,14 +66,14 @@ jobs:
         run: docker load --input /tmp/db-auth-gateway.tar
       - name: Start Google Cloud SQL Mock and Dependencies
         run: |
-          docker network create db-auth-gateway-test
-          docker run -d --network=db-auth-gateway-test --network-alias=postgres --name=postgres -e "POSTGRES_PASSWORD=mysecretpassword" postgres:13
-          docker run -d --network=db-auth-gateway-test --name=cloudsql_mock -p 127.0.0.1:3307:3307 -p 127.0.0.1:8080:8080 kloeckner-i/db-auth-gateway:${{ github.sha }} mock --db-address=postgres:5432 --instance=my-project:my-region:my-database
+          make start_mock
       - name: Test
         env:
           MOCK_ADDRESS: 127.0.0.1
         run: |
-          make test e2e
+          # Separated to ensure the reset_mock target is executed between stages.
+          make test
+          make e2e
       - name: Upload Test Logs
         uses: actions/upload-artifact@v2
         if: failure()

.golangci.yml

@@ -6,6 +6,9 @@ linters-settings:
     statements: 50
   nestif:
     min-complexity: 10
+  cyclop:
+    max-complexity: 20
+
 
 issues:
   exclude-rules:

Makefile

@@ -5,27 +5,33 @@ $(BIN): $(SRC)
 	@mkdir -p target
 	@go build -o $@ cmd/main.go
 
-test: $(SRC)
+test: $(SRC) reset_mock
 	@go test ./...
 
-e2e: $(SRC) $(BIN)
+e2e: $(SRC) $(BIN) reset_mock
 	@go test -tags=e2e ./test/...
 
 start_mock: $(SRC)
 	@-docker-compose down
 	@docker-compose build
 	@docker-compose up -d
 
+reset_mock:
+	@docker-compose stop mock
+	@docker-compose rm -f -v mock
+	@docker-compose up -d
+	@sleep 2
+
 lint: $(SRC)
 	@go mod tidy
 	@gofumpt -s -l -w $^
 	@gci -w $^
-	@golint ./...
-	@golangci-lint run --timeout 5m0s --enable-all -D gochecknoglobals -D gomnd ./...
+	@golangci-lint run --timeout 5m0s --enable-all \
+		-D gochecknoglobals -D exhaustivestruct -D wrapcheck -D interfacer -D maligned -D scopelint -D golint -D gomnd -D paralleltest ./...
 
 clean:
 	@-rm -Rf target/*
 	@go clean -testcache
 	@-docker-compose down
 
-.PHONY: test e2e start_mock lint clean
+.PHONY: test e2e start_mock reset_mock lint clean

README.md

@@ -69,7 +69,6 @@ PGPASSWORD=mysecretpassword psql -h localhost -p 5432 -d postgres postgres
 * GNU Make
 * [golangci-lint v1.30+](https://golangci-lint.run/usage/install/)
 * Additional Go tools:
-    * [golint](https://github.com/golang/lint)
     * [gofumpt](https://github.com/mvdan/gofumpt)
     * [gofumports](https://github.com/mvdan/gofumpt)
     * [gci](https://github.com/daixiang0/gci)

cmd/main.go

@@ -18,7 +18,6 @@ package main
 
 import (
 	"context"
-	"crypto/x509/pkix"
 	"net/http"
 	"os"
 	"os/signal"
@@ -28,8 +27,6 @@ import (
 	pkg "github.com/kloeckner-i/db-auth-gateway/internal"
 	"github.com/kloeckner-i/db-auth-gateway/internal/api"
 	"github.com/kloeckner-i/db-auth-gateway/internal/config"
-	"github.com/kloeckner-i/db-auth-gateway/internal/mock"
-	"github.com/kloeckner-i/db-auth-gateway/internal/pubkey"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
@@ -83,32 +80,7 @@ func execute() error {
 		return err
 	}
 
-	mockCmd := &cobra.Command{
-		Use:   "mock",
-		Short: "Run a local Google managed database mock (for testing)",
-		RunE:  startMock,
-	}
-
-	mockCmd.Flags().String("instance", "", "Fully qualified database instance to connect to (project:region:name)")
-	mockCmd.Flags().String("db-address", "", "Address of the database for which to proxy")
-	mockCmd.Flags().Int("api-port", 8080, "Port on which to serve the mocked sqladmin API")
-	mockCmd.Flags().Int("proxy-port", 3307, "Port on which to serve the database proxy")
-
-	if err := mockCmd.MarkFlagRequired("instance"); err != nil {
-		return err
-	}
-
-	if err := mockCmd.MarkFlagRequired("db-address"); err != nil {
-		return err
-	}
-
-	rootCmd.AddCommand(mockCmd)
-
-	if err := rootCmd.Execute(); err != nil {
-		return err
-	}
-
-	return nil
+	return rootCmd.Execute()
 }
 
 func startGateway(cmd *cobra.Command, args []string) error {
@@ -206,54 +178,3 @@ func startGateway(cmd *cobra.Command, args []string) error {
 
 	return gateway.Run(ctx)
 }
-
-func startMock(cmd *cobra.Command, args []string) error {
-	instance, err := cmd.Flags().GetString("instance")
-	if err != nil {
-		return err
-	}
-
-	dbAddress, err := cmd.Flags().GetString("db-address")
-	if err != nil {
-		return err
-	}
-
-	apiPort, err := cmd.Flags().GetInt("api-port")
-	if err != nil {
-		return err
-	}
-
-	proxyPort, err := cmd.Flags().GetInt("proxy-port")
-	if err != nil {
-		return err
-	}
-
-	authority, err := pubkey.NewAuthority(pkix.Name{
-		CommonName: "Mock CA",
-	}, time.Hour)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	dbProxy, err := mock.NewDatabaseProxy(authority, proxyPort, instance, dbAddress)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	sqlAdminAPI, err := mock.NewSQLAdminAPI(dbProxy, authority, apiPort)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	go func() {
-		if err := dbProxy.Run(); err != nil {
-			log.Fatal(err)
-		}
-	}()
-
-	if err := sqlAdminAPI.Run(); err != nil {
-		log.Fatal(err)
-	}
-
-	return nil
-}

docker-compose.yml

@@ -8,13 +8,11 @@ services:
       POSTGRES_PASSWORD: mysecretpassword
 
   mock:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    command:
-      - mock
-      - --db-address=postgres:5432
-      - --instance=my-project:my-region:my-database
+    image: ghcr.io/kloeckner-i/cloudish-sql:v1.0.0
     ports:
+      - "127.0.0.1:8080:8080"
       - "127.0.0.1:3307:3307"
-      - "127.0.0.1:8080:8080"
+    environment:
+      LOG_LEVEL: "DEBUG"
+    command:
+      - --db-address=postgres:5432

go.mod

@@ -4,7 +4,6 @@ go 1.15
 
 require (
 	cloud.google.com/go v0.78.0 // indirect
-	github.com/gorilla/mux v1.8.0
 	github.com/jackc/pgproto3/v2 v2.0.7 // indirect
 	github.com/jackc/pgx/v4 v4.11.0
 	github.com/magefile/mage v1.11.0 // indirect

go.sum

@@ -201,8 +201,6 @@ github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORR
 github.com/gorilla/context v1.1.1/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg=
 github.com/gorilla/mux v1.6.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs=
 github.com/gorilla/mux v1.7.3/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs=
-github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
-github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
 github.com/gorilla/websocket v0.0.0-20170926233335-4201258b820c/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
 github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
 github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=

internal/api/api.go

@@ -69,7 +69,7 @@ func NewClientFromCredentialFile(ctx context.Context, credentialFile, apiEndpoin
 	}
 
 	if credentialFile == DisabledCredentialFile {
-		opts = append(opts, option.WithHTTPClient(oauth2.NewClient(ctx, &disabledTokenSource{})))
+		opts = append(opts, option.WithHTTPClient(oauth2.NewClient(ctx, &DisabledTokenSource{})))
 	} else if cfg, err := goauth.JWTConfigFromJSON(credentialJSON, sqladmin.SqlserviceAdminScope); err == nil {
 		opts = append(opts, option.WithHTTPClient(cfg.Client(ctx)))
 	} else {
@@ -133,11 +133,11 @@ func (c *Client) CreateClientCertificate(instance string, pubKey crypto.PublicKe
 	return req.Do()
 }
 
-// disabledTokenSource is a mocked oauth token source for local testing.
-type disabledTokenSource struct{}
+// DisabledTokenSource is a mocked oauth token source for local testing.
+type DisabledTokenSource struct{}
 
 // Token issues a mocked bearer token for local testing.
-func (ts *disabledTokenSource) Token() (*oauth2.Token, error) {
+func (ts *DisabledTokenSource) Token() (*oauth2.Token, error) {
 	return &oauth2.Token{
 		AccessToken:  "let-me-in-pls",
 		TokenType:    "Bearer",

internal/config/config_test.go

@@ -19,15 +19,43 @@ package config_test
 import (
 	"context"
 	"crypto/x509"
+	"log"
+	"os"
 	"testing"
 	"time"
 
 	"github.com/kloeckner-i/db-auth-gateway/internal/api"
 	"github.com/kloeckner-i/db-auth-gateway/internal/config"
 	"github.com/kloeckner-i/db-auth-gateway/internal/util"
 	"github.com/stretchr/testify/assert"
+	"golang.org/x/oauth2"
+	"google.golang.org/api/option"
+	sqladmin "google.golang.org/api/sqladmin/v1beta4"
 )
 
+func TestMain(m *testing.M) {
+	ctx := context.Background()
+
+	opts := []option.ClientOption{
+		option.WithEndpoint("http://localhost:8080"),
+		option.WithHTTPClient(oauth2.NewClient(ctx, &api.DisabledTokenSource{})),
+	}
+
+	sqladminService, err := sqladmin.NewService(ctx, opts...)
+	if err != nil {
+		log.Fatal("error occurs during getting sqladminService", err)
+	}
+
+	_, err = sqladminService.Instances.Insert("my-project", &sqladmin.DatabaseInstance{
+		Name: "my-region~my-database",
+	}).Do()
+	if err != nil {
+		log.Fatal("error occurs during getting sqladminService", err)
+	}
+
+	os.Exit(m.Run())
+}
+
 func TestGetPrimaryAddress(t *testing.T) {
 	configProvider, err := newConfigProvider()
 	if err != nil {