Minor upates (#2)

* wip

* add clarifications

* Coverage changes

* Coverage changes

Author: xbucks

.gitignore

@@ -479,4 +479,5 @@ MigrationBackup/
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
 
-# End of https://www.toptal.com/developers/gitignore/api/go,intellij+iml,vs
+# End of https://www.toptal.com/developers/gitignore/api/go,intellij+iml,vs
+/.idea/sonarlint/

.idea/sonarlint/issuestore/index.pb

@@ -1,4 +1,4 @@
-FROM golang:1.18 as builder
+FROM golang:1.20 as builder
 LABEL stage=builder
 WORKDIR /usr/src/app
 
@@ -17,6 +17,9 @@ WORKDIR /app/
 ARG port
 COPY --from=builder /usr/src/app/app .
 COPY --from=builder /usr/src/app/config/*.yaml /app/config/
+## As of golang:1.20 this cerrtificate is included in the base image.
+## So, it is not needed to add this certificate manually or run any add ca-certificates commands.
+## This certificate is added to avoid any issues incase your application is making any HTTPS etc., connections
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 ENTRYPOINT ["./app"]
 EXPOSE $port

Dockerfile

@@ -33,6 +33,11 @@ docker-build:
 	docker build -t ${DOCKER_IMAGE_NAME} . \
 		--build-arg port=${port} \
 
+docker-build-debug:
+	$(info ---> Building Docker Image: ${DOCKER_IMAGE_NAME}, Exposed Port: ${port})
+	docker build --no-cache --progress plain -t ${DOCKER_IMAGE_NAME} . \
+		--build-arg port=${port} \
+
 ## docker-run: Run the API server as a docker container
 docker-run:
 	$(info ---> Running Docker Container: ${DOCKER_CONTAINER_NAME} in Environment: ${profile})
@@ -80,8 +85,11 @@ test:
 
 ## coverage: Measures code coverage
 coverage:
-	go test -coverprofile=coverage.out -covermode=atomic ./... && go tool cover -func=coverage.out
-	go test -race -coverprofile=coverage.out -covermode=atomic ./...
+	go test ./... -v -coverprofile coverage.out -covermode count
+	go tool cover -func=coverage.out
+
+coverage-html:
+	go tool cover -html=coverage.out
 
 .PHONY: help
 help: Makefile

Makefile

@@ -2,6 +2,7 @@ package db
 
 import (
 	"context"
+	"errors"
 	"sync"
 	"time"
 
@@ -12,7 +13,13 @@ import (
 	"go.mongodb.org/mongo-driver/mongo/options"
 )
 
-var connectOnce sync.Once
+var (
+	InvalidConnUrlErr = errors.New("failed to connect to DB, as the connection string is invalid")
+	ClientCreationErr = errors.New("failed to create new client to connect with db")
+	ClientInitErr     = errors.New("failed to initialize db client")
+	ConnectionLeak    = errors.New("unable to disconnect from db, potential connection leak")
+	connectOnce       sync.Once
+)
 
 // ConnectionTimeOut - Max time to establish DB connection // TODO: Move to config
 const ConnectionTimeOut = 10 * time.Second
@@ -40,7 +47,7 @@ func NewMongoManager(dbName string, connUrl string) (MongoManager, error) {
 	dbMgr := &connectionManager{}
 	var connErr error
 	connectOnce.Do(func() {
-		if c, err := newConnection(connUrl); err != nil {
+		if c, err := newClient(connUrl); err != nil {
 			connErr = err
 		} else {
 			db := c.Database(dbName)
@@ -57,21 +64,24 @@ func NewMongoManager(dbName string, connUrl string) (MongoManager, error) {
 	return dbMgr, connErr
 }
 
-// newConnection - Establishes connection using given connection url and returns mongo client
-func newConnection(connectionUrl string) (*mongo.Client, error) {
+// newClient - creates a new Mongo Client to connect to the specified url and initializes the Client
+func newClient(connectionUrl string) (*mongo.Client, error) {
+	if len(connectionUrl) == 0 {
+		return nil, InvalidConnUrlErr
+	}
 	clientOptions := options.Client().ApplyURI(connectionUrl)
 	client, err := mongo.NewClient(clientOptions)
 	if err != nil {
 		log.Error().Err(err).Msg("Connection Failed to Database")
-		return nil, err
+		return nil, ClientCreationErr
 	}
 
 	ctx, cancel := context.WithTimeout(context.Background(), ConnectionTimeOut)
 	defer cancel()
 	connErr := client.Connect(ctx)
 	if connErr != nil {
 		log.Error().Err(connErr).Msg("Connection Failed to Database")
-		return nil, err
+		return nil, ClientInitErr
 	}
 
 	return client, nil
@@ -96,7 +106,7 @@ func (c *connectionManager) Disconnect() error {
 	log.Info().Msg("Disconnecting from Database")
 	if err := c.client.Disconnect(context.Background()); err != nil {
 		log.Error().Err(err).Msg("unable to disconnect from DB")
-		return err
+		return ConnectionLeak
 	}
 	log.Info().Msg("Successfully disconnected from DB")
 	return nil

internal/db/connection.go

@@ -0,0 +1,36 @@
+package db
+
+import "testing"
+
+func TestNewConnection(t *testing.T) {
+	type newConnectionTestCase struct {
+		Description string
+		Input       string
+		ExpectedErr error
+	}
+
+	var testCases = []newConnectionTestCase{
+		{
+			Description: "expect error when connection url is empty",
+			Input:       "",
+			ExpectedErr: InvalidConnUrlErr,
+		},
+		{
+			Description: "expect client creation error when connection url is invalid",
+			Input:       "mongodb+srv://fuzzy-yogi:[email protected]/?retryWrites=true&w=majority",
+			ExpectedErr: ClientCreationErr,
+		},
+		{
+			Description: "expect client object",
+			Input:       "mongodb://test",
+			ExpectedErr: nil,
+		},
+	}
+
+	for i, tc := range testCases {
+		_, err := newClient(tc.Input)
+		if err != tc.ExpectedErr {
+			t.Errorf("TestNewConnection test case %d:%s failed: expected %v; got %v", i, tc.Description, tc.ExpectedErr, err)
+		}
+	}
+}