feat: initial testing and mockery setup

Author: seanb4t

.goreleaser.yaml

@@ -5,6 +5,7 @@ project_name: movie-service
 before:
   hooks:
     - go run github.com/99designs/gqlgen generate
+    - go run github.com/vektra/mockery/v2@v2.33.2
     - go mod tidy
     - go generate ./...
     -

.mockery.yaml

@@ -0,0 +1,4 @@
+# .mockery.yaml
+
+with-expecter: true
+packages: {}

go.mod

@@ -9,6 +9,7 @@ require (
 	github.com/gin-gonic/gin v1.9.1
 	github.com/prometheus/client_golang v1.16.0
 	github.com/rs/zerolog v1.30.0
+	github.com/stretchr/testify v1.8.4
 	github.com/vektah/gqlparser/v2 v2.5.8
 	go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin v0.42.0
 	go.opentelemetry.io/otel v1.17.0
@@ -23,6 +24,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
 	github.com/gin-contrib/sse v0.1.0 // indirect
 	github.com/go-logr/logr v1.2.4 // indirect
@@ -45,6 +47,7 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.42.0 // indirect
 	github.com/prometheus/procfs v0.10.1 // indirect

server.go

@@ -12,6 +12,7 @@ import (
 	"github.com/seanb4t/example-movie-service/graph"
 	"github.com/seanb4t/example-movie-service/internal"
 	"go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
+	"go.opentelemetry.io/otel/sdk/trace"
 )
 
 // Logger is the global logger
@@ -72,6 +73,12 @@ func main() {
 	log.Info().Msg("Starting server")
 
 	// Setup Gin
+	r := setupRouter(tracerProvider)
+	r.Run()
+}
+
+// setupRouter Creates and configures the main router
+func setupRouter(tracerProvider *trace.TracerProvider) *gin.Engine {
 	r := gin.New()
 	r.Use(gin.Recovery())
 	r.Use(requestid.New())
@@ -84,7 +91,8 @@ func main() {
 			return log.With().Ctx(ctx).Logger()
 		})))
 	r.POST("/query", graphqlHandler())
+	r.GET("/query", graphqlHandler())
 	r.GET("/", playgroundHandler())
 	r.GET("/metrics", gin.WrapH(promhttp.Handler()))
-	r.Run()
+	return r
 }

server_test.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"github.com/seanb4t/example-movie-service/internal"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"net/http/httptest"
+	"testing"
+)
+
+func TestDefaultRouteGoesToGraphiql(t *testing.T) {
+	tp, err := internal.InitTracer()
+	require.Nil(t, err, "err must be nil for tracer init")
+
+	router := setupRouter(tp)
+	require.NotNil(t, router, "router must not be nil")
+
+	w := httptest.NewRecorder()
+	req := httptest.NewRequest("GET", "/", nil)
+	router.ServeHTTP(w, req)
+
+	assert.Equal(t, 200, w.Code)
+	assert.Contains(t, w.Body.String(), "<title>GraphQL</title>")
+}
+
+func TestEmptyGetQueryFails(t *testing.T) {
+	tp, err := internal.InitTracer()
+	require.Nil(t, err, "err must be nil for tracer init")
+
+	router := setupRouter(tp)
+	require.NotNil(t, router, "router must not be nil")
+
+	w := httptest.NewRecorder()
+	req := httptest.NewRequest("GET", "/query", nil)
+	router.ServeHTTP(w, req)
+
+	assert.Equal(t, 422, w.Code)
+	assert.JSONEq(t, "{\"errors\":[{\"message\":\"no operation provided\",\"extensions\":{\"code\":\"GRAPHQL_VALIDATION_FAILED\"}}],\"data\":null}", w.Body.String())
+}
+
+func TestMetricsRoute(t *testing.T) {
+	tp, err := internal.InitTracer()
+	require.NoError(t, err, "err must be nil for tracer init")
+
+	router := setupRouter(tp)
+	require.NotNil(t, router, "router must not be nil")
+
+	w := httptest.NewRecorder()
+	req := httptest.NewRequest("GET", "/metrics", nil)
+	router.ServeHTTP(w, req)
+
+	assert.Equal(t, 200, w.Code)
+	assert.Regexp(t, "^# HELP go_gc_duration_seconds", w.Body.String())
+}