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