test: add unit tests for http server

Author: rayanebel

internal/server/http/handlers_test.go

@@ -0,0 +1,107 @@
+package http
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/kilnfi/cardano-validator-watcher/internal/metrics"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDefaultHandler(t *testing.T) {
+	t.Parallel()
+
+	t.Run("GoodPath_DefaultHandlerIsOk", func(t *testing.T) {
+		t.Parallel()
+
+		r := httptest.NewRequest(http.MethodGet, "/", nil)
+		w := httptest.NewRecorder()
+
+		server, err := New(
+			nil,
+		)
+
+		require.NoError(t, err)
+		server.router.ServeHTTP(w, r)
+		assert.Equal(t, http.StatusMovedPermanently, w.Code)
+	})
+
+	t.Run("GoodPath_DefaultHandlerShouldReturn404ForUnknownPath", func(t *testing.T) {
+		t.Parallel()
+
+		r := httptest.NewRequest(http.MethodGet, "/fake", nil)
+		w := httptest.NewRecorder()
+
+		server, err := New(
+			nil,
+		)
+
+		require.NoError(t, err)
+		server.router.ServeHTTP(w, r)
+		assert.Equal(t, http.StatusNotFound, w.Code)
+	})
+}
+
+func TestLiveProbe(t *testing.T) {
+	t.Parallel()
+
+	t.Run("GoodPath_LiveProbeIsReady", func(t *testing.T) {
+		t.Parallel()
+
+		r := httptest.NewRequest(http.MethodGet, "/livez", nil)
+		w := httptest.NewRecorder()
+
+		server, err := New(
+			nil,
+		)
+		require.NoError(t, err)
+		server.router.ServeHTTP(w, r)
+
+		assert.Equal(t, http.StatusOK, w.Code)
+	})
+}
+
+func TestReadyProbe(t *testing.T) {
+	t.Parallel()
+
+	t.Run("GoodPath_ReadyProbeIsReady", func(t *testing.T) {
+		t.Parallel()
+
+		r := httptest.NewRequest(http.MethodGet, "/readyz", nil)
+		w := httptest.NewRecorder()
+
+		server, err := New(
+			nil,
+		)
+		require.NoError(t, err)
+		server.router.ServeHTTP(w, r)
+
+		assert.Equal(t, http.StatusOK, w.Code)
+	})
+}
+
+func TestMetricsHandler(t *testing.T) {
+	t.Parallel()
+
+	t.Run("GoodPath_MetricsHandlerIsOk", func(t *testing.T) {
+		t.Parallel()
+
+		r := httptest.NewRequest(http.MethodGet, "/metrics", nil)
+		w := httptest.NewRecorder()
+
+		registry := prometheus.NewRegistry()
+		metrics := metrics.NewCollection()
+		metrics.MustRegister(registry)
+
+		server, err := New(
+			registry,
+		)
+
+		require.NoError(t, err)
+		server.router.ServeHTTP(w, r)
+		assert.Equal(t, http.StatusOK, w.Code)
+	})
+}

internal/server/http/options_test.go

@@ -0,0 +1,43 @@
+package http
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestWithHost(t *testing.T) {
+	t.Parallel()
+
+	opts := &options{}
+	err := WithHost("0.0.0.0")(opts)
+
+	require.NoError(t, err)
+	assert.Equal(t, "0.0.0.0", opts.host)
+}
+
+func TestWithPort(t *testing.T) {
+	t.Parallel()
+
+	opts := &options{}
+	err := WithPort(9090)(opts)
+
+	require.NoError(t, err)
+	assert.Equal(t, 9090, opts.port)
+}
+
+func TestWithTimeouts(t *testing.T) {
+	t.Parallel()
+
+	opts := &options{}
+	err := WithReadTimeout(15 * time.Second)(opts)
+	require.NoError(t, err)
+
+	err = WithWriteTimeout(30 * time.Second)(opts)
+	require.NoError(t, err)
+
+	assert.Equal(t, 15*time.Second, opts.readTimeout)
+	assert.Equal(t, 30*time.Second, opts.writeTimeout)
+}

internal/server/http/server_test.go

@@ -0,0 +1,79 @@
+package http
+
+import (
+	"context"
+	"net/http"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+var (
+	DefaultReadTimeout  = 15 * time.Second
+	DefaultWriteTimeout = 30 * time.Second
+	DefaultHost         = "0.0.0.0"
+	DefaultPort         = 8000
+)
+
+func TestNewServer(t *testing.T) {
+	t.Parallel()
+
+	t.Run("WithOptions", func(t *testing.T) {
+		t.Parallel()
+
+		server, err := New(
+			nil,
+			WithHost(DefaultHost),
+			WithPort(DefaultPort),
+			WithReadTimeout(DefaultReadTimeout),
+			WithWriteTimeout(DefaultWriteTimeout),
+		)
+
+		require.NoError(t, err)
+		assert.Equal(t, DefaultHost, server.options.host)
+		assert.Equal(t, DefaultPort, server.options.port)
+		assert.Equal(t, DefaultReadTimeout, server.options.readTimeout)
+		assert.Equal(t, DefaultWriteTimeout, server.options.writeTimeout)
+	})
+	t.Run("WithDefaultOptions", func(t *testing.T) {
+		t.Parallel()
+
+		server, err := New(
+			nil,
+			WithHost(ServerDefaultHost),
+			WithPort(ServerDefaultPort),
+			WithReadTimeout(ServerDefaultReadTimeout),
+			WithWriteTimeout(ServerDefaultWriteTimeout),
+		)
+		require.NoError(t, err)
+		assert.Equal(t, ServerDefaultHost, server.options.host)
+		assert.Equal(t, ServerDefaultPort, server.options.port)
+		assert.Equal(t, ServerDefaultReadTimeout, server.options.readTimeout)
+		assert.Equal(t, ServerDefaultWriteTimeout, server.options.writeTimeout)
+	})
+}
+
+func TestStartServer(t *testing.T) {
+	t.Parallel()
+	server, err := New(
+		nil,
+		WithHost(DefaultHost),
+		WithPort(DefaultPort),
+		WithReadTimeout(DefaultReadTimeout),
+		WithWriteTimeout(DefaultWriteTimeout),
+	)
+	require.NoError(t, err)
+
+	go func() {
+		ticker := time.NewTimer(time.Second * 30)
+		<-ticker.C
+		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		defer cancel()
+		_ = server.Stop(ctx)
+	}()
+
+	err = server.Start()
+	require.ErrorIs(t, err, http.ErrServerClosed)
+}