~bigbes/sr-ht-ecore

ref: cb7f3bb02407e6da196c57928d28e4ae3298a9b3 sr-ht-ecore/chimw/chimw_test.go -rw-r--r-- 6.3 KiB
cb7f3bb0 — Eugene Blikh chimw: the chi-shaped helpers of the custom services 9 days ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package chimw

import (
	"io"
	"net/http"
	"net/http/httptest"
	"strconv"
	"strings"
	"testing"

	"github.com/go-chi/chi/v5"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"sourcecraft.dev/bigbes/sr-ht-ecore/pages"
)

// refusal is what a renderer was asked for, so a test can assert on the call
// rather than on prose rendered by a template this package does not own.
type refusal struct {
	status  int
	message string
	method  string
}

// recordRefusals returns an ErrorRenderer of the donors' shape, plus the slice
// it appends every call to.
func recordRefusals() (ErrorRenderer, *[]refusal) {
	var calls []refusal
	render := func(w http.ResponseWriter, r *http.Request, status int, message string) {
		calls = append(calls, refusal{status: status, message: message, method: r.Method})
		w.WriteHeader(status)
		_, _ = io.WriteString(w, message)
	}
	return render, &calls
}

func TestGetHeadServesAHeadThroughTheGetHandler(t *testing.T) {
	r := chi.NewRouter()

	var seen []string
	GetHead(r, "/page", func(w http.ResponseWriter, r *http.Request) {
		seen = append(seen, r.Method)
		_, _ = io.WriteString(w, "body")
	})

	for _, method := range []string{http.MethodGet, http.MethodHead} {
		rec := httptest.NewRecorder()
		r.ServeHTTP(rec, httptest.NewRequest(method, "/page", nil))
		require.Equal(t, http.StatusOK, rec.Code, "%s /page", method)
	}

	// The point of registering the pair rather than reaching for chi's
	// middleware.GetHead: the handler sees the method that arrived.
	assert.Equal(t, []string{http.MethodGet, http.MethodHead}, seen)
}

func TestGetHeadAnswersAHeadWithTheHeadersOfItsGetAndNoBody(t *testing.T) {
	r := chi.NewRouter()
	GetHead(r, "/page", func(w http.ResponseWriter, _ *http.Request) {
		w.Header().Set("Content-Type", "text/plain; charset=utf-8")
		_, _ = io.WriteString(w, "a body of some length")
	})

	// A real server, because dropping the body of a HEAD is net/http's job and
	// a recorder does not do it.
	srv := httptest.NewServer(r)
	t.Cleanup(srv.Close)

	get, err := http.Get(srv.URL + "/page")
	require.NoError(t, err)
	t.Cleanup(func() { _ = get.Body.Close() })
	getBody, err := io.ReadAll(get.Body)
	require.NoError(t, err)

	head, err := http.Head(srv.URL + "/page")
	require.NoError(t, err)
	t.Cleanup(func() { _ = head.Body.Close() })
	headBody, err := io.ReadAll(head.Body)
	require.NoError(t, err)

	assert.Equal(t, get.StatusCode, head.StatusCode)
	assert.Equal(t, get.Header.Get("Content-Type"), head.Header.Get("Content-Type"))
	assert.Empty(t, headBody)
	// The length a HEAD promises is the one a GET delivers, counted by net/http
	// off the writes it then discards.
	assert.Equal(t, strconv.Itoa(len(getBody)), head.Header.Get("Content-Length"))
}

func TestGetHeadRegistersHeadInTheRoutingTree(t *testing.T) {
	r := chi.NewRouter()
	GetHead(r, "/page", func(http.ResponseWriter, *http.Request) {})
	r.Post("/page", func(http.ResponseWriter, *http.Request) {})

	// This is the question chi's middleware.GetHead leaves the tree unable to
	// answer, and the one the donors' every-GET-has-a-HEAD-twin test asks.
	methods := map[string]bool{}
	require.NoError(t, chi.Walk(r, func(method, route string, _ http.Handler, _ ...func(http.Handler) http.Handler) error {
		if route == "/page" {
			methods[method] = true
		}
		return nil
	}))
	assert.True(t, methods[http.MethodGet], "GET is registered")
	assert.True(t, methods[http.MethodHead], "HEAD is registered")
}

func TestGetHeadLeavesEveryOtherMethodUnregistered(t *testing.T) {
	r := chi.NewRouter()
	GetHead(r, "/page", func(http.ResponseWriter, *http.Request) {})

	rec := httptest.NewRecorder()
	r.ServeHTTP(rec, httptest.NewRequest(http.MethodPost, "/page", nil))
	assert.Equal(t, http.StatusMethodNotAllowed, rec.Code)
}

func TestRenderRefusalsAnswersAnUnroutedPathThroughTheRenderer(t *testing.T) {
	render, calls := recordRefusals()

	r := chi.NewRouter()
	RenderRefusals(r, render)
	GetHead(r, "/page", func(http.ResponseWriter, *http.Request) {})

	rec := httptest.NewRecorder()
	r.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/nowhere", nil))

	assert.Equal(t, http.StatusNotFound, rec.Code)
	assert.Equal(t, pages.NotFoundMessage, rec.Body.String())
	require.Len(t, *calls, 1)
	assert.Equal(t, refusal{
		status:  http.StatusNotFound,
		message: pages.NotFoundMessage,
		method:  http.MethodGet,
	}, (*calls)[0])
}

func TestRenderRefusalsAnswersAnUnallowedMethodThroughTheRenderer(t *testing.T) {
	render, calls := recordRefusals()

	r := chi.NewRouter()
	RenderRefusals(r, render)
	GetHead(r, "/page", func(http.ResponseWriter, *http.Request) {})

	rec := httptest.NewRecorder()
	r.ServeHTTP(rec, httptest.NewRequest(http.MethodPost, "/page", nil))

	assert.Equal(t, http.StatusMethodNotAllowed, rec.Code)
	assert.Equal(t, pages.MethodMessage, rec.Body.String())
	require.Len(t, *calls, 1)
	assert.Equal(t, refusal{
		status:  http.StatusMethodNotAllowed,
		message: pages.MethodMessage,
		method:  http.MethodPost,
	}, (*calls)[0])
}

func TestRenderRefusalsIsInheritedBySubRouters(t *testing.T) {
	render, calls := recordRefusals()

	r := chi.NewRouter()
	RenderRefusals(r, render)
	r.Route("/repo", func(r chi.Router) {
		GetHead(r, "/", func(http.ResponseWriter, *http.Request) {})
	})

	rec := httptest.NewRecorder()
	r.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/repo/nowhere", nil))

	assert.Equal(t, http.StatusNotFound, rec.Code)
	require.Len(t, *calls, 1)
}

func TestRenderRefusalsRequiresARenderCallback(t *testing.T) {
	assert.PanicsWithValue(t, "chimw: RenderRefusals needs a render callback", func() {
		RenderRefusals(chi.NewRouter(), nil)
	})
}

// TestRenderRefusalsTakesAMethodValueOfTheDonorsShape pins the seam down: the
// services pass their existing renderError by name, with no closure per call
// site, and that only keeps working while ErrorRenderer has that signature.
func TestRenderRefusalsTakesAMethodValueOfTheDonorsShape(t *testing.T) {
	var s server
	r := chi.NewRouter()
	RenderRefusals(r, s.renderError)

	rec := httptest.NewRecorder()
	r.ServeHTTP(rec, httptest.NewRequest(http.MethodGet, "/nowhere", nil))

	assert.Equal(t, http.StatusNotFound, rec.Code)
	assert.True(t, strings.HasPrefix(rec.Body.String(), "page:"), "body %q", rec.Body.String())
}

type server struct{}

func (s *server) renderError(w http.ResponseWriter, _ *http.Request, status int, message string) {
	w.WriteHeader(status)
	_, _ = io.WriteString(w, "page: "+message)
}