added test cases and go vet fixes renaming packages and file names to…

… lower case

actuator.go

@@ -5,9 +5,9 @@ import (
 	"github.com/valyala/fasthttp"
 	"net/http"
 
-	fastHTTPControllers "github.com/sinhashubham95/go-actuator/controllers/fastHTTP"
+	fastHTTPControllers "github.com/sinhashubham95/go-actuator/controllers/fasthttp"
 	ginControllers "github.com/sinhashubham95/go-actuator/controllers/gin"
-	netHTTPControllers "github.com/sinhashubham95/go-actuator/controllers/netHTTP"
+	netHTTPControllers "github.com/sinhashubham95/go-actuator/controllers/nethttp"
 	"github.com/sinhashubham95/go-actuator/models"
 )
 

controllers/fastHTTP/env.go → controllers/fasthttp/env.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/httpTrace.go → controllers/fasthttp/httptrace.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/info.go → controllers/fasthttp/info.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/metrics.go → controllers/fasthttp/metrics.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/ping.go → controllers/fasthttp/ping.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/route.go → controllers/fasthttp/route.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/sinhashubham95/go-actuator/models"

controllers/fastHTTP/shutdown.go → controllers/fasthttp/shutdown.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/fastHTTP/threadDump.go → controllers/fasthttp/threaddump.go

@@ -1,4 +1,4 @@
-package fastHTTP
+package fasthttp
 
 import (
 	"github.com/valyala/fasthttp"

controllers/gin/commons_test.go

@@ -0,0 +1,22 @@
+package gin_test
+
+import (
+	"github.com/gin-gonic/gin"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+)
+
+func setupRouterAndGetResponse(t *testing.T, endpoint string, handler gin.HandlerFunc) *httptest.ResponseRecorder {
+	router := gin.Default()
+	router.GET(endpoint, handler)
+
+	request, err := http.NewRequest(http.MethodGet, endpoint, nil)
+	assert.NoError(t, err)
+
+	w := httptest.NewRecorder()
+	router.ServeHTTP(w, request)
+
+	return w
+}

controllers/gin/env_test.go

@@ -0,0 +1,15 @@
+package gin_test
+
+import (
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"testing"
+
+	"github.com/sinhashubham95/go-actuator/commons"
+	ginControllers "github.com/sinhashubham95/go-actuator/controllers/gin"
+)
+
+func TestHandleEnv(t *testing.T) {
+	w := setupRouterAndGetResponse(t, commons.EnvEndpoint, ginControllers.HandleEnv)
+	assert.Equal(t, http.StatusOK, w.Code)
+}

controllers/netHTTP/env.go → controllers/nethttp/env.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/httpTrace.go → controllers/nethttp/httptrace.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/info.go → controllers/nethttp/info.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/metrics.go → controllers/nethttp/metrics.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/ping.go → controllers/nethttp/ping.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/route.go → controllers/nethttp/route.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/shutdown.go → controllers/nethttp/shutdown.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

controllers/netHTTP/threadDump.go → controllers/nethttp/threaddump.go

@@ -1,4 +1,4 @@
-package netHTTP
+package nethttp
 
 import (
 	"net/http"

core/info_test.go

@@ -0,0 +1,15 @@
+package core_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/commons"
+	"github.com/sinhashubham95/go-actuator/core"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestGetInfo(t *testing.T) {
+	info := core.GetInfo()
+	assert.NotEmpty(t, info[commons.Application])
+	assert.NotEmpty(t, info[commons.Git])
+	assert.NotEmpty(t, info[commons.Runtime])
+}

core/metrics_test.go

@@ -0,0 +1,11 @@
+package core_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/core"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestGetMetrics(t *testing.T) {
+	assert.NotNil(t, core.GetMetrics())
+}

core/shutdown_test.go

@@ -0,0 +1,15 @@
+package core_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/core"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestShutdown(t *testing.T) {
+	defer func() {
+		r := recover()
+		assert.NotNil(t, r)
+	}()
+	core.Shutdown()
+}

core/threaddump_test.go

@@ -0,0 +1,13 @@
+package core_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/core"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestGetThreadDump(t *testing.T) {
+	dump, err := core.GetThreadDump()
+	assert.NoError(t, err)
+	assert.NotEmpty(t, string(dump))
+}

flags/flags_test.go

@@ -0,0 +1,24 @@
+package flags_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/commons"
+	"github.com/sinhashubham95/go-actuator/flags"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestEnv(t *testing.T) {
+	assert.Equal(t, commons.EnvDefaultValue, flags.Env())
+}
+
+func TestName(t *testing.T) {
+	assert.Equal(t, commons.NameDefaultValue, flags.Name())
+}
+
+func TestPort(t *testing.T) {
+	assert.Equal(t, commons.PortDefaultValue, flags.Port())
+}
+
+func TestVersion(t *testing.T) {
+	assert.Equal(t, commons.VersionDefaultValue, flags.Version())
+}

models/config.go

@@ -26,7 +26,7 @@ func (config *Config) Validate() {
 	}
 	for _, endpoint := range config.Endpoints {
 		if !IsValidEndpoint(endpoint) {
-			panic(errors.New(fmt.Sprintf("Invalid endpoint %d provided.", endpoint)))
+			panic(errors.New(fmt.Sprintf("invalid endpoint %d provided", endpoint)))
 		}
 	}
 }

models/configs_test.go

@@ -0,0 +1,45 @@
+package models_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/commons"
+	"github.com/sinhashubham95/go-actuator/models"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestConfigValidateInvalidPrefix(t *testing.T) {
+	defer func() {
+		if r := recover(); r != nil {
+			if err, ok := r.(error); ok {
+				assert.Error(t, err)
+				assert.Equal(t, "invalid prefix provided", err.Error())
+			}
+		}
+	}()
+	config := &models.Config{
+		Prefix: "postgres://user:abc{[email protected]:5432/db?sslmode=require",
+	}
+	config.Validate()
+}
+
+func TestConfigValidateInvalidEndpoints(t *testing.T) {
+	defer func() {
+		if r := recover(); r != nil {
+			if err, ok := r.(error); ok {
+				assert.Error(t, err)
+				assert.Equal(t, "invalid endpoint 999 provided", err.Error())
+			}
+		}
+	}()
+	config := &models.Config{
+		Endpoints: []int{999},
+	}
+	config.Validate()
+}
+
+func TestConfigDefault(t *testing.T) {
+	config := &models.Config{}
+	config.Default()
+	assert.Equal(t, commons.DefaultActuatorPrefix, config.Prefix)
+	assert.Equal(t, models.Endpoints, config.Endpoints)
+}

models/endpoints_test.go

@@ -0,0 +1,17 @@
+package models_test
+
+import (
+	"github.com/sinhashubham95/go-actuator/models"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestIsValidEndpoint(t *testing.T) {
+	assert.True(t, models.IsValidEndpoint(models.Env))
+	assert.True(t, models.IsValidEndpoint(models.HTTPTrace))
+	assert.True(t, models.IsValidEndpoint(models.Info))
+	assert.True(t, models.IsValidEndpoint(models.Metrics))
+	assert.True(t, models.IsValidEndpoint(models.Ping))
+	assert.True(t, models.IsValidEndpoint(models.Shutdown))
+	assert.True(t, models.IsValidEndpoint(models.ThreadDump))
+}