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 TestSavePreparedRecipeACIDRecipesSave2And9And13SavesMarkdownAsDescription(t *testing.T) {
130	var saveCalls int
131	client, closeServer := newTestClient(t, savePreparedRecipeTestHandler(t, &saveCalls))
132	defer closeServer()
133
134	recipeID, err := client.SavePreparedRecipe(context.Background(), "Pasta", "# Pasta\n\n1. Boil pasta.", 2)
135	if err != nil {
136		t.Fatalf("SavePreparedRecipe() error = %v", err)
137	}
138
139	if saveCalls != 1 {
140		t.Fatalf("save calls = %d, want 1", saveCalls)
141	}
142	if recipeID != "recipe-1" {
143		t.Fatalf("recipe ID = %q, want recipe-1", recipeID)
144	}
145}
146
147func TestUpdateRecipeContentACIDRecipesSave8And9And13UpdatesExistingRecipe(t *testing.T) {
148	var updateCalls int
149	client, closeServer := newTestClient(t, updateRecipeContentTestHandler(t, &updateCalls))
150	defer closeServer()
151
152	err := client.UpdateRecipeContent(context.Background(), "recipe/with space", "# Pasta\n\n1. Boil pasta.", 4)
153	if err != nil {
154		t.Fatalf("UpdateRecipeContent() error = %v", err)
155	}
156
157	if updateCalls != 1 {
158		t.Fatalf("update calls = %d, want 1", updateCalls)
159	}
160}
161
162func TestUserPathEscapesAuthenticatedUsername(t *testing.T) {
163	client := &Client{authenticatedUsername: "user/name"}
164
165	got := client.userPath("/api/user/{username}/shopping-list")
166	if got != "/api/user/user%2Fname/shopping-list" {
167		t.Fatalf("userPath() = %q, want escaped username", got)
168	}
169}
170
171func TestNewRequestPreservesEscapedUserPathWithQuery(t *testing.T) {
172	baseURL, err := url.Parse("https://example.invalid")
173	if err != nil {
174		t.Fatalf("parse base URL: %v", err)
175	}
176	client := &Client{baseURL: baseURL}
177
178	request, err := client.newRequest(
179		context.Background(),
180		http.MethodGet,
181		"/api/user/user%2Fname/recipes?page=2&page-count=5",
182		nil,
183	)
184	if err != nil {
185		t.Fatalf("newRequest() error = %v", err)
186	}
187
188	if request.URL.String() != "https://example.invalid/api/user/user%2Fname/recipes?page=2&page-count=5" {
189		t.Fatalf("request URL = %q, want escaped username preserved", request.URL.String())
190	}
191}
192
193func newTestClient(t *testing.T, handler http.HandlerFunc) (*Client, func()) {
194	t.Helper()
195
196	server := httptest.NewServer(handler)
197	baseURL, err := url.Parse(server.URL)
198	if err != nil {
199		server.Close()
200		t.Fatalf("parse server URL: %v", err)
201	}
202	client, err := NewClient(baseURL, "configured-user", "configured-password")
203	if err != nil {
204		server.Close()
205		t.Fatalf("NewClient() error = %v", err)
206	}
207
208	return client, server.Close
209}
210
211func shoppingListTestHandler(t *testing.T, sawSessionCookie *bool) http.HandlerFunc {
212	t.Helper()
213
214	return func(w http.ResponseWriter, r *http.Request) {
215		switch r.URL.Path {
216		case "/api/public/login":
217			requireLoginRequest(t, r)
218			writeLoginResponse(t, w)
219		case "/api/user/returned-user/shopping-list":
220			requireSessionCookie(t, r)
221			*sawSessionCookie = true
222			writeShoppingListResponse(t, w)
223		default:
224			t.Fatalf("unexpected path %s", r.URL.Path)
225		}
226	}
227}
228
229func listRecipesTestHandler(t *testing.T) http.HandlerFunc {
230	t.Helper()
231
232	return func(w http.ResponseWriter, r *http.Request) {
233		switch r.URL.Path {
234		case "/api/public/login":
235			writeLoginResponse(t, w)
236		case "/api/user/returned-user/recipes":
237			requireQueryValue(t, r, "page", "2")
238			requireQueryValue(t, r, "page-count", "5")
239			writeRecipeListResponse(t, w)
240		default:
241			t.Fatalf("unexpected path %s", r.URL.Path)
242		}
243	}
244}
245
246func searchRecipesTestHandler(t *testing.T) http.HandlerFunc {
247	t.Helper()
248
249	return func(w http.ResponseWriter, r *http.Request) {
250		switch r.URL.Path {
251		case "/api/public/login":
252			writeLoginResponse(t, w)
253		case "/api/user/returned-user/recipes/search":
254			requireMethod(t, r, http.MethodGet, "search")
255			requireQueryValue(t, r, "q", "pasta & tomato")
256			requireQueryValue(t, r, "page", "3")
257			writeRecipeListResponse(t, w)
258		default:
259			t.Fatalf("unexpected path %s", r.URL.Path)
260		}
261	}
262}
263
264func recipeMetadataTestHandler(t *testing.T) http.HandlerFunc {
265	t.Helper()
266
267	return func(w http.ResponseWriter, r *http.Request) {
268		switch r.URL.EscapedPath() {
269		case "/api/public/login":
270			writeLoginResponse(t, w)
271		case "/api/recipe/recipe%2Fwith%20space/metadata":
272			requireMethod(t, r, http.MethodGet, "metadata")
273			requireSessionCookie(t, r)
274			writeRecipeMetadataResponse(t, w)
275		default:
276			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
277		}
278	}
279}
280
281func recipeContentTestHandler(t *testing.T) http.HandlerFunc {
282	t.Helper()
283
284	return func(w http.ResponseWriter, r *http.Request) {
285		switch r.URL.EscapedPath() {
286		case "/api/public/login":
287			writeLoginResponse(t, w)
288		case "/api/recipe/recipe%2Fwith%20space/content":
289			requireMethod(t, r, http.MethodGet, "content")
290			requireSessionCookie(t, r)
291			writeJSON(t, w, RecipeContent{Content: "# Pasta\n\n- 200g pasta\n\n1. Boil pasta.", Portions: 2})
292		default:
293			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
294		}
295	}
296}
297
298func previewRecipeTextTestHandler(t *testing.T, previewCalls *int) http.HandlerFunc {
299	t.Helper()
300
301	return func(w http.ResponseWriter, r *http.Request) {
302		switch r.URL.Path {
303		case "/api/public/login":
304			writeLoginResponse(t, w)
305		case "/api/new/from-text/preview":
306			requireMethod(t, r, http.MethodPost, "preview")
307			requireSessionCookie(t, r)
308			requirePreviewRecipeTextRequest(t, r)
309			(*previewCalls)++
310			writeJSON(t, w, RecipeTextPreview{
311				Title:    "Pasta with Tomato Sauce",
312				Markdown: "# Pasta\n\n1. Boil pasta.",
313				Portions: 2,
314			})
315		default:
316			t.Fatalf("unexpected path %s", r.URL.Path)
317		}
318	}
319}
320
321func savePreparedRecipeTestHandler(t *testing.T, saveCalls *int) http.HandlerFunc {
322	t.Helper()
323
324	return func(w http.ResponseWriter, r *http.Request) {
325		switch r.URL.Path {
326		case "/api/public/login":
327			writeLoginResponse(t, w)
328		case "/api/recipe/import/save":
329			requireMethod(t, r, http.MethodPost, "save prepared recipe")
330			requireSessionCookie(t, r)
331			requireSavePreparedRecipeRequest(t, r)
332			(*saveCalls)++
333			writeJSON(t, w, saveRecipeResponse{RecipeID: "recipe-1"})
334		default:
335			t.Fatalf("unexpected path %s", r.URL.Path)
336		}
337	}
338}
339
340func updateRecipeContentTestHandler(t *testing.T, updateCalls *int) http.HandlerFunc {
341	t.Helper()
342
343	return func(w http.ResponseWriter, r *http.Request) {
344		switch r.URL.EscapedPath() {
345		case "/api/public/login":
346			writeLoginResponse(t, w)
347		case "/api/recipe/recipe%2Fwith%20space/content":
348			requireMethod(t, r, http.MethodPost, "update recipe content")
349			requireSessionCookie(t, r)
350			requireUpdateRecipeContentRequest(t, r)
351			(*updateCalls)++
352			w.WriteHeader(http.StatusNoContent)
353		default:
354			t.Fatalf("unexpected path %s", r.URL.EscapedPath())
355		}
356	}
357}
358
359func requirePreviewRecipeTextRequest(t *testing.T, r *http.Request) {
360	t.Helper()
361
362	var request previewRecipeTextRequest
363	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
364		t.Fatalf("decode preview request: %v", err)
365	}
366	if request.RecipeName != "Pasta" || request.RecipeText != "Boil pasta." {
367		t.Fatalf("preview request = %#v, want configured title/text", request)
368	}
369}
370
371func requireSavePreparedRecipeRequest(t *testing.T, r *http.Request) {
372	t.Helper()
373
374	var request savePreparedRecipeRequest
375	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
376		t.Fatalf("decode save prepared recipe request: %v", err)
377	}
378	if request.Title != "Pasta" {
379		t.Fatalf("save title = %q, want Pasta", request.Title)
380	}
381	if request.Description != "# Pasta\n\n1. Boil pasta." {
382		t.Fatalf("save description = %q, want markdown", request.Description)
383	}
384	if request.Portions != 2 {
385		t.Fatalf("save portions = %d, want 2", request.Portions)
386	}
387}
388
389func requireUpdateRecipeContentRequest(t *testing.T, r *http.Request) {
390	t.Helper()
391
392	var request updateRecipeContentRequest
393	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
394		t.Fatalf("decode update recipe content request: %v", err)
395	}
396	if request.Description != "# Pasta\n\n1. Boil pasta." {
397		t.Fatalf("update description = %q, want markdown", request.Description)
398	}
399	if request.Portions != 4 {
400		t.Fatalf("update portions = %d, want 4", request.Portions)
401	}
402}
403
404func requireLoginRequest(t *testing.T, r *http.Request) {
405	t.Helper()
406	requireMethod(t, r, http.MethodPost, "login")
407
408	var request loginRequest
409	if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
410		t.Fatalf("decode login request: %v", err)
411	}
412	if request.Username != "configured-user" || request.Password != "configured-password" {
413		t.Fatalf("login request = %#v, want configured credentials", request)
414	}
415}
416
417func requireMethod(t *testing.T, r *http.Request, want string, label string) {
418	t.Helper()
419
420	if r.Method != want {
421		t.Fatalf("%s method = %s, want %s", label, r.Method, want)
422	}
423}
424
425func requireSessionCookie(t *testing.T, r *http.Request) {
426	t.Helper()
427
428	cookie, err := r.Cookie("cooked_session")
429	if err != nil {
430		t.Fatalf("missing session cookie: %v", err)
431	}
432	if cookie.Value != "session-value" {
433		t.Fatalf("session cookie = %q, want session-value", cookie.Value)
434	}
435}
436
437func requireQueryValue(t *testing.T, r *http.Request, name string, want string) {
438	t.Helper()
439
440	if got := r.URL.Query().Get(name); got != want {
441		t.Fatalf("%s query = %q, want %q", name, got, want)
442	}
443}
444
445func writeLoginResponse(t *testing.T, w http.ResponseWriter) {
446	t.Helper()
447
448	http.SetCookie(w, &http.Cookie{Name: "cooked_session", Value: "session-value", Path: "/"})
449	writeJSON(t, w, loginResponse{Username: "returned-user"})
450}
451
452func writeShoppingListResponse(t *testing.T, w http.ResponseWriter) {
453	t.Helper()
454
455	writeJSON(t, w, shoppingListResponse{
456		ShoppingList: ShoppingList{
457			Aisles: []Aisle{{
458				ID:   "pantry",
459				Name: "Pantry",
460				ProductGroups: []ProductGroup{{
461					ID:       "pasta",
462					Name:     "Pasta",
463					Quantity: "200g",
464				}},
465			}},
466		},
467		Recipes: []string{"recipe-id"},
468	})
469}
470
471func writeRecipeListResponse(t *testing.T, w http.ResponseWriter) {
472	t.Helper()
473
474	writeJSON(t, w, recipeListResponse{
475		Recipes: []RecipeCard{{
476			ID:           "recipe-1",
477			Title:        "Pasta",
478			ThumbnailURL: "https://example.invalid/thumb.jpg",
479		}},
480	})
481}
482
483func writeRecipeMetadataResponse(t *testing.T, w http.ResponseWriter) {
484	t.Helper()
485
486	w.Header().Set("Content-Type", "application/json")
487	if _, err := w.Write([]byte(`{
488		"title": "Pasta with Tomato Sauce",
489		"image-urls": ["https://example.invalid/pasta.jpg"],
490		"owner": "returned-user",
491		"edit-permission": true
492	}`)); err != nil {
493		t.Fatalf("write metadata response: %v", err)
494	}
495}
496
497func writeJSON[
498	T loginResponse | shoppingListResponse | recipeListResponse | RecipeContent | RecipeTextPreview | saveRecipeResponse,
499](
500	t *testing.T,
501	w http.ResponseWriter,
502	value T,
503) {
504	t.Helper()
505
506	w.Header().Set("Content-Type", "application/json")
507	if err := json.NewEncoder(w).Encode(value); err != nil {
508		t.Fatalf("write JSON: %v", err)
509	}
510}