kami_17_test.go

// +build go1.7

package kami_test

import (
	"context"
	"net/http"
	"net/http/httptest"
	"testing"
	"time"

	"github.com/zenazn/goji/web/mutil"

	"github.com/guregu/kami"
)

func TestKami(t *testing.T) {
	kami.Reset()
	kami.Cancel = true

	done := make(chan struct{})

	expect := func(ctx context.Context, i int) context.Context {
		if prev := ctx.Value(i - 1).(int); prev != i-1 {
			t.Error("missing", i)
		}
		if curr := ctx.Value(i); curr != nil {
			t.Error("pre-existing", i)
		}
		return context.WithValue(ctx, i, i)
	}
	expectEqual := func(one, two context.Context, i int) {
		if one != two {
			t.Error(i, "mismatched contexes", one, "\n≠\n", two)
		}
	}

	kami.Use("/", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 1)
		ctx = context.WithValue(ctx, 1, 1)
		ctx = context.WithValue(ctx, "handler", new(bool))
		ctx = context.WithValue(ctx, "done", new(bool))
		ctx = context.WithValue(ctx, "recovered", new(bool))
		go func() {
			<-ctx.Done()
			close(done)
		}()
		return ctx
	})
	kami.Use("/a/", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 2)
		ctx = expect(ctx, 2)
		return ctx
	})
	kami.Use("/a/", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 3)
		ctx = expect(ctx, 3)
		return ctx
	})
	kami.Use("/a/b", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 4)
		ctx = expect(ctx, 4)
		return ctx
	})
	kami.Use("/a/*files", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 5)
		ctx = expect(ctx, 5)
		return ctx
	})
	kami.Use("/a/*files", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 6)
		ctx = expect(ctx, 6)
		return ctx
	})
	kami.Get("/a/b", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		expectEqual(ctx, r.Context(), 6)
		if prev := ctx.Value(6).(int); prev != 6 {
			t.Error("handler: missing", 6)
		}
		*(ctx.Value("handler").(*bool)) = true

		w.WriteHeader(http.StatusTeapot)
	})
	kami.After("/a/*files", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 8)
		ctx = expect(ctx, 8)
		if !*(ctx.Value("handler").(*bool)) {
			t.Error("ran before handler")
		}
		return ctx
	})
	kami.After("/a/*files", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 7)
		ctx = expect(ctx, 7)
		if !*(ctx.Value("handler").(*bool)) {
			t.Error("ran before handler")
		}
		return ctx
	})
	kami.After("/a/b", kami.Afterware(func(ctx context.Context, w mutil.WriterProxy, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 9)
		ctx = expect(ctx, 9)
		return ctx
	}))
	kami.After("/a/", func(ctx context.Context, w mutil.WriterProxy, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 11)
		ctx = expect(ctx, 11)
		return ctx
	})
	kami.After("/a/", func(ctx context.Context, w mutil.WriterProxy, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 10)
		ctx = expect(ctx, 10)
		return ctx
	})
	kami.After("/", func(ctx context.Context, w mutil.WriterProxy, r *http.Request) context.Context {
		expectEqual(ctx, r.Context(), 12)
		if status := w.Status(); status != http.StatusTeapot {
			t.Error("wrong status", status)
		}

		ctx = expect(ctx, 12)
		*(ctx.Value("done").(*bool)) = true
		panic("🍣")
		return nil
	})
	kami.PanicHandler = func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		expectEqual(ctx, r.Context(), 13)
		if got := kami.Exception(ctx); got.(string) != "🍣" {
			t.Error("panic handler: expected sushi, got", got)
		}
		if !*(ctx.Value("done").(*bool)) {
			t.Error("didn't finish")
		}
		*(ctx.Value("recovered").(*bool)) = true
	}
	kami.LogHandler = func(ctx context.Context, w mutil.WriterProxy, r *http.Request) {
		expectEqual(ctx, r.Context(), 14)
		if !*(ctx.Value("recovered").(*bool)) {
			t.Error("didn't recover")
		}
	}

	expectResponseCode(t, "GET", "/a/b", http.StatusTeapot)
	select {
	case <-done:
		// ok
	case <-time.After(10 * time.Second):
		panic("didn't cancel")
	}
}

func TestLoggerAndPanic(t *testing.T) {
	kami.Reset()
	// test logger with panic
	status := 0
	kami.LogHandler = func(ctx context.Context, w mutil.WriterProxy, r *http.Request) {
		status = w.Status()
	}
	kami.PanicHandler = kami.HandlerFunc(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		err := kami.Exception(ctx)
		if err != "test panic" {
			t.Error("unexpected exception:", err)
		}
		w.WriteHeader(http.StatusServiceUnavailable)
	})
	kami.Post("/test", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		panic("test panic")
	})
	kami.Put("/ok", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	expectResponseCode(t, "POST", "/test", http.StatusServiceUnavailable)
	if status != http.StatusServiceUnavailable {
		t.Error("log handler received wrong status code", status, "≠", http.StatusServiceUnavailable)
	}

	// test loggers without panics
	expectResponseCode(t, "PUT", "/ok", http.StatusOK)
	if status != http.StatusOK {
		t.Error("log handler received wrong status code", status, "≠", http.StatusOK)
	}
}

func TestPanickingLogger(t *testing.T) {
	kami.Reset()
	kami.LogHandler = func(ctx context.Context, w mutil.WriterProxy, r *http.Request) {
		t.Log("log handler")
		panic("test panic")
	}
	kami.PanicHandler = kami.HandlerFunc(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		t.Log("panic handler")
		err := kami.Exception(ctx)
		if err != "test panic" {
			t.Error("unexpected exception:", err)
		}
		w.WriteHeader(http.StatusServiceUnavailable)
	})
	kami.Options("/test", noop)

	expectResponseCode(t, "OPTIONS", "/test", http.StatusServiceUnavailable)
}

func TestNotFound(t *testing.T) {
	kami.Reset()
	kami.Use("/missing/", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		return context.WithValue(ctx, "ok", true)
	})
	kami.NotFound(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		ok, _ := ctx.Value("ok").(bool)
		if !ok {
			w.WriteHeader(http.StatusInternalServerError)
			return
		}
		w.WriteHeader(http.StatusTeapot)
	})

	expectResponseCode(t, "GET", "/missing/hello", http.StatusTeapot)
}

func TestNotFoundDefault(t *testing.T) {
	kami.Reset()

	expectResponseCode(t, "GET", "/missing/hello", http.StatusNotFound)
}

func TestMethodNotAllowed(t *testing.T) {
	kami.Reset()
	kami.Use("/test", func(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
		return context.WithValue(ctx, "ok", true)
	})
	kami.Post("/test", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		panic("test panic")
	})

	kami.MethodNotAllowed(func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		ok, _ := ctx.Value("ok").(bool)
		if !ok {
			w.WriteHeader(http.StatusInternalServerError)
			return
		}
		w.WriteHeader(http.StatusTeapot)
	})

	expectResponseCode(t, "GET", "/test", http.StatusTeapot)
}

func TestEnableMethodNotAllowed(t *testing.T) {
	kami.Reset()
	kami.Post("/test", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		panic("test panic")
	})

	// Handling enabled by default
	expectResponseCode(t, "GET", "/test", http.StatusMethodNotAllowed)

	// Not found deals with it when handling disabled
	kami.EnableMethodNotAllowed(false)
	expectResponseCode(t, "GET", "/test", http.StatusNotFound)

	// And MethodNotAllowed status when handling enabled
	kami.EnableMethodNotAllowed(true)
	expectResponseCode(t, "GET", "/test", http.StatusMethodNotAllowed)
}

func TestMethodNotAllowedDefault(t *testing.T) {
	kami.Reset()
	kami.Post("/test", func(ctx context.Context, w http.ResponseWriter, r *http.Request) {
		panic("test panic")
	})

	expectResponseCode(t, "GET", "/test", http.StatusMethodNotAllowed)
}

func noop(ctx context.Context, w http.ResponseWriter, r *http.Request) {}

func noopMW(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context {
	return ctx
}

func expectResponseCode(t *testing.T, method, path string, expected int) {
	resp := httptest.NewRecorder()
	req, err := http.NewRequest(method, path, nil)
	if err != nil {
		t.Fatal(err)
	}

	kami.Handler().ServeHTTP(resp, req)

	if resp.Code != expected {
		t.Error("should return HTTP", http.StatusText(expected)+":", resp.Code, "≠", expected)
	}
}