Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use httptest server for running healthcheck tests #4461

Merged
merged 3 commits into from
Oct 3, 2023
Merged

Use httptest server for running healthcheck tests #4461

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f78b1aa
Use httptest server for running healthcheck tests
jjngx Oct 3, 2023
e1dc2ff
Simplify healthcheck tests
jjngx Oct 3, 2023
c742e11
Merge branch 'main' into test/helper
jjngx Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 96 additions & 78 deletions internal/healthcheck/healthcheck_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,36 @@
package healthcheck_test

import (
"context"
"encoding/json"
"errors"
"log"
"net"
"net/http"
"net/http/httptest"
"testing"

"github.com/go-chi/chi/v5"
"github.com/google/go-cmp/cmp"
"github.com/nginxinc/kubernetes-ingress/internal/healthcheck"
"github.com/nginxinc/nginx-plus-go-client/client"
)

// newTestHealthServer is a helper func responsible for creating,
// starting and shutting down healthcheck server for each test.
func newTestHealthServer(t *testing.T) *healthcheck.HealthServer {
t.Helper()

l, err := net.Listen("tcp", ":0") //nolint:gosec
if err != nil {
t.Fatal(err)
}
defer l.Close() //nolint:errcheck

addr := l.Addr().String()
hs, err := healthcheck.NewHealthServer(addr, nil, nil, nil)
if err != nil {
t.Fatal(err)
}

go func() {
err := hs.ListenAndServe()
if !errors.Is(err, http.ErrServerClosed) {
log.Fatal(err)
}
}()

t.Cleanup(func() {
err := hs.Shutdown(context.Background())
if err != nil {
t.Fatal(err)
}
})
return hs
// testHandler creates http handler for testing HealthServer.
func testHandler(hs *healthcheck.HealthServer) http.Handler {
mux := chi.NewRouter()
mux.Get("/probe/{hostname}", hs.UpstreamStats)
mux.Get("/probe/ts/{name}", hs.StreamStats)
return mux
}

func TestHealthCheckServer_Returns404OnMissingHostname(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXAllUp
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXAllUp,
}

resp, err := http.Get(hs.URL + "probe/") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -64,11 +42,15 @@ func TestHealthCheckServer_Returns404OnMissingHostname(t *testing.T) {
}

func TestHealthCheckServer_ReturnsCorrectStatsForHostnameOnAllPeersUp(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXAllUp
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXAllUp,
}

resp, err := http.Get(hs.URL + "probe/bar.tea.com") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/bar.tea.com") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -93,11 +75,15 @@ func TestHealthCheckServer_ReturnsCorrectStatsForHostnameOnAllPeersUp(t *testing
}

func TestHealthCheckServer_ReturnsCorrectStatsForHostnameOnAllPeersDown(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXAllUnhealthy
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXAllUnhealthy,
}

resp, err := http.Get(hs.URL + "probe/bar.tea.com") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/bar.tea.com") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -123,11 +109,15 @@ func TestHealthCheckServer_ReturnsCorrectStatsForHostnameOnAllPeersDown(t *testi
}

func TestHealthCheckServer_ReturnsCorrectStatsForValidHostnameOnPartOfPeersDown(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXPartiallyUp
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXPartiallyUp,
}

resp, err := http.Get(hs.URL + "probe/bar.tea.com") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/bar.tea.com") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -153,11 +143,15 @@ func TestHealthCheckServer_ReturnsCorrectStatsForValidHostnameOnPartOfPeersDown(
}

func TestHealthCheckServer_RespondsWith404OnNotExistingHostname(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXNotExistingHost
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXNotExistingHost,
}

resp, err := http.Get(hs.URL + "probe/foo.mocha.com") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/foo.mocha.com") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -169,11 +163,15 @@ func TestHealthCheckServer_RespondsWith404OnNotExistingHostname(t *testing.T) {
}

func TestHealthCheckServer_RespondsWith500OnErrorFromNGINXAPI(t *testing.T) {
hs := newTestHealthServer(t)
hs.UpstreamsForHost = getUpstreamsForHost
hs.NginxUpstreams = getUpstreamsFromNGINXErrorFromAPI
hs := healthcheck.HealthServer{
UpstreamsForHost: getUpstreamsForHost,
NginxUpstreams: getUpstreamsFromNGINXErrorFromAPI,
}

resp, err := http.Get(hs.URL + "probe/foo.tea.com") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/foo.tea.com") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -185,11 +183,15 @@ func TestHealthCheckServer_RespondsWith500OnErrorFromNGINXAPI(t *testing.T) {
}

func TestHealthCheckServer_Returns404OnMissingTransportServerActionName(t *testing.T) {
hs := newTestHealthServer(t)
hs.StreamUpstreamsForName = streamUpstreamsForName
hs.NginxStreamUpstreams = streamUpstreamsFromNGINXAllUp
hs := healthcheck.HealthServer{
StreamUpstreamsForName: streamUpstreamsForName,
NginxStreamUpstreams: streamUpstreamsFromNGINXAllUp,
}

resp, err := http.Get(hs.URL + "probe/ts/") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/ts/") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -201,11 +203,15 @@ func TestHealthCheckServer_Returns404OnMissingTransportServerActionName(t *testi
}

func TestHealthCheckServer_Returns404OnBogusTransportServerActionName(t *testing.T) {
hs := newTestHealthServer(t)
hs.StreamUpstreamsForName = streamUpstreamsForName
hs.NginxStreamUpstreams = streamUpstreamsFromNGINXAllUp
hs := healthcheck.HealthServer{
StreamUpstreamsForName: streamUpstreamsForName,
NginxStreamUpstreams: streamUpstreamsFromNGINXAllUp,
}

resp, err := http.Get(hs.URL + "probe/ts/bogusname") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/ts/bogusname") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -217,11 +223,15 @@ func TestHealthCheckServer_Returns404OnBogusTransportServerActionName(t *testing
}

func TestHealthCheckServer_ReturnsCorrectTransportServerStatsForNameOnAllPeersUp(t *testing.T) {
hs := newTestHealthServer(t)
hs.StreamUpstreamsForName = streamUpstreamsForName
hs.NginxStreamUpstreams = streamUpstreamsFromNGINXAllUp
hs := healthcheck.HealthServer{
StreamUpstreamsForName: streamUpstreamsForName,
NginxStreamUpstreams: streamUpstreamsFromNGINXAllUp,
}

resp, err := http.Get(hs.URL + "probe/ts/foo-app") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/ts/foo-app") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -246,11 +256,15 @@ func TestHealthCheckServer_ReturnsCorrectTransportServerStatsForNameOnAllPeersUp
}

func TestHealthCheckServer_ReturnsCorrectTransportServerStatsForNameOnSomePeersUpSomeDown(t *testing.T) {
hs := newTestHealthServer(t)
hs.StreamUpstreamsForName = streamUpstreamsForName
hs.NginxStreamUpstreams = streamUpstreamsFromNGINXPartiallyUp
hs := healthcheck.HealthServer{
StreamUpstreamsForName: streamUpstreamsForName,
NginxStreamUpstreams: streamUpstreamsFromNGINXPartiallyUp,
}

resp, err := http.Get(hs.URL + "probe/ts/foo-app") //nolint:noctx
ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := ts.Client().Get(ts.URL + "/probe/ts/foo-app") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand All @@ -275,11 +289,15 @@ func TestHealthCheckServer_ReturnsCorrectTransportServerStatsForNameOnSomePeersU
}

func TestHealthCheckServer_ReturnsCorrectTransportServerStatsForNameOnAllPeersDown(t *testing.T) {
hs := newTestHealthServer(t)
hs.StreamUpstreamsForName = streamUpstreamsForName
hs.NginxStreamUpstreams = streamUpstreamsFromNGINXAllPeersDown
hs := healthcheck.HealthServer{
StreamUpstreamsForName: streamUpstreamsForName,
NginxStreamUpstreams: streamUpstreamsFromNGINXAllPeersDown,
}

ts := httptest.NewServer(testHandler(&hs))
defer ts.Close()

resp, err := http.Get(hs.URL + "probe/ts/foo-app") //nolint:noctx
resp, err := ts.Client().Get(ts.URL + "/probe/ts/foo-app") //nolint:noctx
if err != nil {
t.Fatal(err)
}
Expand Down
Loading