client_test.go

  1// SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
  2//
  3// SPDX-License-Identifier: LicenseRef-MutuaL-1.2
  4
  5package cooked
  6
  7import (
  8	"context"
  9	"encoding/json"
 10	"net/http"
 11	"net/http/httptest"
 12	"net/url"
 13	"testing"
 14)
 15
 16func TestReadShoppingListACIDAuthenticationLogin3StoresCookies(t *testing.T) {
 17	var sawSessionCookie bool
 18	client, closeServer := newTestClient(t, shoppingListTestHandler(t, &sawSessionCookie))
 19	defer closeServer()
 20
 21	shoppingList, err := client.ReadShoppingList(context.Background())
 22	if err != nil {
 23		t.Fatalf("ReadShoppingList() error = %v", err)
 24	}
 25
 26	if !sawSessionCookie {
 27		t.Fatal("shopping-list request did not receive session cookie")
 28	}
 29	if len(shoppingList.Aisles) != 1 || shoppingList.Aisles[0].ProductGroups[0].Name != "Pasta" {
 30		t.Fatalf("shopping list = %#v, want one Pasta item", shoppingList)
 31	}
 32}
 33
 34func TestListRecipesACIDRecipesRead1ListsSavedRecipes(t *testing.T) {
 35	client, closeServer := newTestClient(t, listRecipesTestHandler(t))
 36	defer closeServer()
 37
 38	recipes, err := client.ListRecipes(context.Background(), 2, 5)
 39	if err != nil {
 40		t.Fatalf("ListRecipes() error = %v", err)
 41	}
 42
 43	if len(recipes) != 1 {
 44		t.Fatalf("recipes length = %d, want 1", len(recipes))
 45	}
 46	if recipes[0].ID != "recipe-1" || recipes[0].Title != "Pasta" {
 47		t.Fatalf("recipe = %#v, want recipe-1 Pasta", recipes[0])
 48	}
 49}
 50
 51func TestSearchRecipesACIDRecipesRead2SearchesSavedRecipes(t *testing.T) {
 52	client, closeServer := newTestClient(t, searchRecipesTestHandler(t))
 53	defer closeServer()
 54
 55	recipes, err := client.SearchRecipes(context.Background(), "pasta & tomato", 3)
 56	if err != nil {
 57		t.Fatalf("SearchRecipes() error = %v", err)
 58	}
 59
 60	if len(recipes) != 1 {
 61		t.Fatalf("recipes length = %d, want 1", len(recipes))
 62	}
 63	if recipes[0].ID != "recipe-1" || recipes[0].Title != "Pasta" {
 64		t.Fatalf("recipe = %#v, want recipe-1 Pasta", recipes[0])
 65	}
 66}
 67
 68func TestReadRecipeMetadataACIDRecipesRead6ReadsMetadata(t *testing.T) {
 69	client, closeServer := newTestClient(t, recipeMetadataTestHandler(t))
 70	defer closeServer()
 71
 72	metadata, err := client.ReadRecipeMetadata(context.Background(), "recipe/with space")
 73	if err != nil {
 74		t.Fatalf("ReadRecipeMetadata() error = %v", err)
 75	}
 76
 77	if metadata.Title != "Pasta with Tomato Sauce" {
 78		t.Fatalf("metadata title = %q, want Pasta with Tomato Sauce", metadata.Title)
 79	}
 80	if len(metadata.ImageURLs) != 1 || metadata.ImageURLs[0] != "https://example.invalid/pasta.jpg" {
 81		t.Fatalf("metadata image URLs = %#v, want one pasta image", metadata.ImageURLs)
 82	}
 83	if metadata.Owner != "returned-user" || !metadata.EditPermission {
 84		t.Fatalf("metadata owner/edit = %q/%v, want returned-user/true", metadata.Owner, metadata.EditPermission)
 85	}
 86}
 87
 88func TestReadRecipeContentACIDRecipesRead7And8ReadsContentAndPortions(t *testing.T) {
 89	client, closeServer := newTestClient(t, recipeContentTestHandler(t))
 90	defer closeServer()
 91
 92	content, err := client.ReadRecipeContent(context.Background(), "recipe/with space")
 93	if err != nil {
 94		t.Fatalf("ReadRecipeContent() error = %v", err)
 95	}
 96
 97	if content.Content != "# Pasta\n\n- 200g pasta\n\n1. Boil pasta." {
 98		t.Fatalf("content = %q, want recipe markdown", content.Content)
 99	}
100	if content.Portions != 2 {
101		t.Fatalf("portions = %d, want 2", content.Portions)
102	}
103}
104
105func TestPreviewRecipeTextACIDRecipesPreviewText1To4PreviewsWithoutSaving(t *testing.T) {
106	var previewCalls int
107	client, closeServer := newTestClient(t, previewRecipeTextTestHandler(t, &previewCalls))
108	defer closeServer()
109
110	preview, err := client.PreviewRecipeText(context.Background(), "Pasta", "Boil pasta.")
111	if err != nil {
112		t.Fatalf("PreviewRecipeText() error = %v", err)
113	}
114
115	if previewCalls != 1 {
116		t.Fatalf("preview calls = %d, want 1", previewCalls)
117	}
118	if preview.Title != "Pasta with Tomato Sauce" {
119		t.Fatalf("preview title = %q, want Pasta with Tomato Sauce", preview.Title)
120	}
121	if preview.Markdown != "# Pasta\n\n1. Boil pasta." {
122		t.Fatalf("preview markdown = %q, want recipe markdown", preview.Markdown)
123	}
124	if preview.Portions != 2 {
125		t.Fatalf("preview portions = %d, want 2", preview.Portions)
126	}
127}
128
129func TestUserPathEscapesAuthenticatedUsername(t *testing.T) {
130	client := &Client{authenticatedUsername: "user/name"}
131
132	got := client.userPath("/api/user/{username}/shopping-list")
133	if got != "/api/user/user%2Fname/shopping-list" {
134		t.Fatalf("userPath() = %q, want escaped username", got)
135	}
136}
137
138func TestNewRequestPreservesEscapedUserPathWithQuery(t *testing.T) {
139	baseURL, err := url.Parse("https://example.invalid")
140	if err != nil {
141		t.Fatalf("parse base URL: %v", err)
142	}
143	client := &Client{baseURL: baseURL}
144
145	request, err := client.newRequest(
146		context.Background(),
147		http.MethodGet,
148		"/api/user/user%2Fname/recipes?page=2&page-count=5",
149		nil,
150	)
151	if err != nil {
152		t.Fatalf("newRequest() error = %v", err)
153	}
154
155	if request.URL.String() != "https://example.invalid/api/user/user%2Fname/recipes?page=2&page-count=5" {
156		t.Fatalf("request URL = %q, want escaped username preserved", request.URL.String())
157	}
158}
159
160func newTestClient(t *testing.T, handler http.HandlerFunc) (*Client, func()) {
161	t.Helper()
162
163	server := httptest.NewServer(handler)
164	baseURL, err := url.Parse(server.URL)
165	if err != nil {
166		server.Close()
167		t.Fatalf("parse server URL: %v", err)
168	}
169	client, err := NewClient(baseURL, "configured-user", "configured-password")
170	if err != nil {
171		server.Close()
172		t.Fatalf("NewClient() error = %v", err)
173	}
174
175	return client, server.Close
176}
177
178func shoppingListTestHandler(t *testing.T, sawSessionCookie *bool) http.HandlerFunc {
179	t.Helper()
180
181	return func(w http.ResponseWriter, r *http.Request) {
182		switch r.URL.Path {
183		case "/api/public/login":
184			requireLoginRequest(t, r)
185			writeLoginResponse(t, w)
186		case "/api/user/returned-user/shopping-list":
187			requireSessionCookie(t, r)
188			*sawSessionCookie = true
189			writeShoppingListResponse(t, w)
190		default:
191			t.Fatalf("unexpected path %s", r.URL.Path)
192		}
193	}
194}
195
196func listRecipesTestHandler(t *testing.T) http.HandlerFunc {
197	t.Helper()
198
199	return func(w http.ResponseWriter, r *http.Request) {
200		switch r.URL.Path {
201		case "/api/public/login":
202			writeLoginResponse(t, w)
203		case "/api/user/returned-user/recipes":
204			requireQueryValue(t, r, "page", "2")
205			requireQueryValue(t, r, "page-count", "5")
206			writeRecipeListResponse(t, w)
207		default:
208			t.Fatalf("unexpected path %s", r.URL.Path)
209		}
210	}
211}
212
213func searchRecipesTestHandler(t *testing.T) http.HandlerFunc {
214	t.Helper()
215
216	return func(w http.ResponseWriter, r *http.Request) {
217		switch r.URL.Path {
218		case "/api/public/login":
219			writeLoginResponse(t, w)
220		case "/api/user/returned-user/recipes/search":
221			requireMethod(t, r, http.MethodGet, "search")
222			requireQueryValue(t, r, "q", "pasta & tomato")
223			requireQueryValue(t, r, "page", "3")
224			writeRecipeListResponse(t, w)
225		default:
226			t.Fatalf("unexpected path %s", r.URL.Path)
227		}
228	}
229}
230
231func recipeMetadataTestHandler(t *testing.T) http.HandlerFunc {
232	t.Helper()
233
234	return func(w http.ResponseWriter, r *http.Request) {
235		switch r.URL.EscapedPath() {
236		case "/api/public/login":
237			writeLoginResponse(t, w)
238		case "/api/recipe/recipe%2Fwith%20space/metadata":
239			requireMethod(t, r, http.MethodGet, "metadata")
240			requireSessionCookie(t, r)
241			writeRecipeMetadataResponse(t, w)
242		default:
243			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
244		}
245	}
246}
247
248func recipeContentTestHandler(t *testing.T) http.HandlerFunc {
249	t.Helper()
250
251	return func(w http.ResponseWriter, r *http.Request) {
252		switch r.URL.EscapedPath() {
253		case "/api/public/login":
254			writeLoginResponse(t, w)
255		case "/api/recipe/recipe%2Fwith%20space/content":
256			requireMethod(t, r, http.MethodGet, "content")
257			requireSessionCookie(t, r)
258			writeJSON(t, w, RecipeContent{Content: "# Pasta\n\n- 200g pasta\n\n1. Boil pasta.", Portions: 2})
259		default:
260			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
261		}
262	}
263}
264
265func previewRecipeTextTestHandler(t *testing.T, previewCalls *int) http.HandlerFunc {
266	t.Helper()
267
268	return func(w http.ResponseWriter, r *http.Request) {
269		switch r.URL.Path {
270		case "/api/public/login":
271			writeLoginResponse(t, w)
272		case "/api/new/from-text/preview":
273			requireMethod(t, r, http.MethodPost, "preview")
274			requireSessionCookie(t, r)
275			requirePreviewRecipeTextRequest(t, r)
276			(*previewCalls)++
277			writeJSON(t, w, RecipeTextPreview{
278				Title:    "Pasta with Tomato Sauce",
279				Markdown: "# Pasta\n\n1. Boil pasta.",
280				Portions: 2,
281			})
282		default:
283			t.Fatalf("unexpected path %s", r.URL.Path)
284		}
285	}
286}
287
288func requirePreviewRecipeTextRequest(t *testing.T, r *http.Request) {
289	t.Helper()
290
291	var request previewRecipeTextRequest
292	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
293		t.Fatalf("decode preview request: %v", err)
294	}
295	if request.RecipeName != "Pasta" || request.RecipeText != "Boil pasta." {
296		t.Fatalf("preview request = %#v, want configured title/text", request)
297	}
298}
299
300func requireLoginRequest(t *testing.T, r *http.Request) {
301	t.Helper()
302	requireMethod(t, r, http.MethodPost, "login")
303
304	var request loginRequest
305	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
306		t.Fatalf("decode login request: %v", err)
307	}
308	if request.Username != "configured-user" || request.Password != "configured-password" {
309		t.Fatalf("login request = %#v, want configured credentials", request)
310	}
311}
312
313func requireMethod(t *testing.T, r *http.Request, want string, label string) {
314	t.Helper()
315
316	if r.Method != want {
317		t.Fatalf("%s method = %s, want %s", label, r.Method, want)
318	}
319}
320
321func requireSessionCookie(t *testing.T, r *http.Request) {
322	t.Helper()
323
324	cookie, err := r.Cookie("cooked_session")
325	if err != nil {
326		t.Fatalf("missing session cookie: %v", err)
327	}
328	if cookie.Value != "session-value" {
329		t.Fatalf("session cookie = %q, want session-value", cookie.Value)
330	}
331}
332
333func requireQueryValue(t *testing.T, r *http.Request, name string, want string) {
334	t.Helper()
335
336	if got := r.URL.Query().Get(name); got != want {
337		t.Fatalf("%s query = %q, want %q", name, got, want)
338	}
339}
340
341func writeLoginResponse(t *testing.T, w http.ResponseWriter) {
342	t.Helper()
343
344	http.SetCookie(w, &http.Cookie{Name: "cooked_session", Value: "session-value", Path: "/"})
345	writeJSON(t, w, loginResponse{Username: "returned-user"})
346}
347
348func writeShoppingListResponse(t *testing.T, w http.ResponseWriter) {
349	t.Helper()
350
351	writeJSON(t, w, shoppingListResponse{
352		ShoppingList: ShoppingList{
353			Aisles: []Aisle{{
354				ID:   "pantry",
355				Name: "Pantry",
356				ProductGroups: []ProductGroup{{
357					ID:       "pasta",
358					Name:     "Pasta",
359					Quantity: "200g",
360				}},
361			}},
362		},
363		Recipes: []string{"recipe-id"},
364	})
365}
366
367func writeRecipeListResponse(t *testing.T, w http.ResponseWriter) {
368	t.Helper()
369
370	writeJSON(t, w, recipeListResponse{
371		Recipes: []RecipeCard{{
372			ID:           "recipe-1",
373			Title:        "Pasta",
374			ThumbnailURL: "https://example.invalid/thumb.jpg",
375		}},
376	})
377}
378
379func writeRecipeMetadataResponse(t *testing.T, w http.ResponseWriter) {
380	t.Helper()
381
382	w.Header().Set("Content-Type", "application/json")
383	if _, err := w.Write([]byte(`{
384		"title": "Pasta with Tomato Sauce",
385		"image-urls": ["https://example.invalid/pasta.jpg"],
386		"owner": "returned-user",
387		"edit-permission": true
388	}`)); err != nil {
389		t.Fatalf("write metadata response: %v", err)
390	}
391}
392
393func writeJSON[T loginResponse | shoppingListResponse | recipeListResponse | RecipeContent | RecipeTextPreview](
394	t *testing.T,
395	w http.ResponseWriter,
396	value T,
397) {
398	t.Helper()
399
400	w.Header().Set("Content-Type", "application/json")
401	if err := json.NewEncoder(w).Encode(value); err != nil {
402		t.Fatalf("write JSON: %v", err)
403	}
404}