Merge pull request #127 from AET-DevOps26/feat/recipe-editing-ct

Add recipe editing to the web client

Author: jschoedl

.gitattributes

@@ -16,3 +16,6 @@ services/spring-api/.openapi-generator-ignore linguist-generated=true
 
 # openapi-typescript output
 web-client/src/api.ts linguist-generated=true
+
+# Pact contract (generated by the web-client consumer test, verified by spring-api)
+web-client/pacts/** linguist-generated=true

.github/workflows/build-help-service.yml

@@ -4,6 +4,7 @@ on:
   push:
     paths:
       - 'services/py-help-service/**'
+      - 'api/openapi-internal.yaml'
       - '.github/workflows/build-help-service.yml'
   workflow_dispatch:
   workflow_call:

.github/workflows/build-recipe-service.yml

@@ -4,6 +4,7 @@ on:
   push:
     paths:
       - 'services/py-recipe-service/**'
+      - 'api/openapi-internal.yaml'
       - '.github/workflows/build-recipe-service.yml'
   workflow_dispatch:
   workflow_call:

.github/workflows/build-spring-api.yml

@@ -4,6 +4,7 @@ on:
   push:
     paths:
       - 'services/spring-api/**'
+      - 'web-client/pacts/**'
       - '.github/workflows/build-spring-api.yml'
   workflow_dispatch:
   workflow_call:

services/py-help-service/dev-requirements.txt

@@ -3,4 +3,5 @@ pytest
 pytest-cov
 httpx
 pytest-asyncio
-pytest-env
+pytest-env
+schemathesis==4.22.3

services/py-help-service/tests/test_contract.py

@@ -0,0 +1,49 @@
+"""OpenAPI contract-conformance test for py-help-service using Schemathesis.
+
+Verifies that the service's live responses conform to the internal contract in
+`api/openapi-internal.yaml`.
+"""
+
+import pathlib
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+import schemathesis
+
+from main import app, get_llm, verify_internal_hmac, LocalHelpResponse
+
+_CONTRACT = (
+	pathlib.Path(__file__).resolve().parents[3] / "api" / "openapi-internal.yaml"
+)
+app.openapi_schema = schemathesis.openapi.from_path(_CONTRACT).raw_schema
+
+# /ai/recipes belongs to py-recipe-service
+schema = schemathesis.openapi.from_asgi("/openapi.json", app).exclude(
+	path="/ai/recipes"
+)
+
+# Happy path only. Auth rejection (missing/invalid HMAC headers) is covered in test_help_service.py.
+schema.config.generation.update(modes=[schemathesis.GenerationMode.POSITIVE])
+schema.config.phases.update(phases=["examples", "fuzzing"])
+
+
+@pytest.fixture(autouse=True)
+def _stub_provider_dependencies():
+	app.dependency_overrides[verify_internal_hmac] = lambda: None
+
+	conforming = LocalHelpResponse(
+		response="Add a pinch of salt to balance the flavour."
+	)
+	structured_runnable = AsyncMock()
+	structured_runnable.ainvoke.return_value = conforming
+	llm = MagicMock()
+	llm.with_structured_output.return_value = structured_runnable
+	app.dependency_overrides[get_llm] = lambda: llm
+
+	yield
+	app.dependency_overrides.clear()
+
+
+@schema.parametrize()
+def test_openapi_conformance(case):
+	case.call_and_validate()

services/py-recipe-service/dev-requirements.txt

@@ -3,4 +3,5 @@ pytest
 pytest-cov
 httpx
 pytest-asyncio
-pytest-env
+pytest-env
+schemathesis==4.22.3

services/py-recipe-service/tests/test_contract.py

@@ -0,0 +1,55 @@
+"""OpenAPI contract-conformance test for py-recipe-service using Schemathesis.
+
+Verifies that the service's live responses conform to the internal contract in
+`api/openapi-internal.yaml`.
+"""
+
+import pathlib
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+import schemathesis
+
+from main import app, get_llm, verify_internal_hmac, RecipeListWrapper, LocalRecipeInput
+
+_CONTRACT = (
+	pathlib.Path(__file__).resolve().parents[3] / "api" / "openapi-internal.yaml"
+)
+app.openapi_schema = schemathesis.openapi.from_path(_CONTRACT).raw_schema
+
+# /ai/help belongs to py-help-service
+schema = schemathesis.openapi.from_asgi("/openapi.json", app).exclude(path="/ai/help")
+
+# Happy path only. Auth rejection (missing/invalid HMAC headers) is covered in test_recipe_service.py.
+schema.config.generation.update(modes=[schemathesis.GenerationMode.POSITIVE])
+schema.config.phases.update(phases=["examples", "fuzzing"])
+
+
+@pytest.fixture(autouse=True)
+def _stub_provider_dependencies():
+	app.dependency_overrides[verify_internal_hmac] = lambda: None
+
+	conforming = RecipeListWrapper(
+		recipes=[
+			LocalRecipeInput(
+				title="Test Recipe",
+				ingredients=[{"quantity": 1.0, "unit": "cup", "name": "Flour"}],
+				instructions=["Mix.", "Bake."],
+				portions=2.0,
+				nutrients={"calories": 200, "protein": 5, "fat": 3, "carbs": 35},
+			)
+		]
+	)
+	structured_runnable = AsyncMock()
+	structured_runnable.ainvoke.return_value = conforming
+	llm = MagicMock()
+	llm.with_structured_output.return_value = structured_runnable
+	app.dependency_overrides[get_llm] = lambda: llm
+
+	yield
+	app.dependency_overrides.clear()
+
+
+@schema.parametrize()
+def test_openapi_conformance(case):
+	case.call_and_validate()

services/spring-api/build.gradle.kts

@@ -104,6 +104,9 @@ dependencies {
 	testImplementation("org.springframework.boot:spring-boot-webmvc-test")
 	testImplementation("org.springframework.security:spring-security-test")
 
+	// Pact provider-side contract verification (web-client -> spring-api)
+	testImplementation("au.com.dius.pact.provider:junit5:4.6.17")
+
 	// Retrofit
 	implementation("com.squareup.retrofit2:retrofit:2.11.0")
 	implementation("com.squareup.retrofit2:converter-jackson:2.11.0")

services/spring-api/src/test/kotlin/org/openapitools/api/RecipesApiTest.kt

@@ -239,6 +239,40 @@ class RecipesApiTest : ApiTestBase() {
 			.andExpect(jsonPath("$.nutrients.calories").value(400))
 	}
 
+	@Test
+	fun `recipes put - full payload replaces every field`() {
+		val token = register()
+		val id = postRecipe(token)
+		mockMvc
+			.perform(
+				put("/api/v1/recipes/$id")
+					.header("Authorization", "Bearer $token")
+					.contentType(MediaType.APPLICATION_JSON)
+					.content(
+						"""
+						{
+							"title": "Deluxe Pasta",
+							"ingredients": [
+								{"quantity": 250, "unit": "g", "name": "spaghetti"},
+								{"quantity": 3, "unit": "cloves", "name": "garlic"}
+							],
+							"instructions": ["Boil", "Fry garlic", "Combine"],
+							"portions": 1.5,
+							"nutrients": {"calories": 620, "protein": 18, "fat": 9, "carbs": 95}
+						}
+						""".trimIndent(),
+					),
+			).andExpect(status().isOk)
+			.andExpect(jsonPath("$.id").value(id))
+			.andExpect(jsonPath("$.title").value("Deluxe Pasta"))
+			.andExpect(jsonPath("$.portions").value(1.5))
+			.andExpect(jsonPath("$.ingredients.length()").value(2))
+			.andExpect(jsonPath("$.ingredients[1].name").value("garlic"))
+			.andExpect(jsonPath("$.instructions.length()").value(3))
+			.andExpect(jsonPath("$.instructions[2]").value("Combine"))
+			.andExpect(jsonPath("$.nutrients.carbs").value(95))
+	}
+
 	@Test
 	fun `recipes put - not found returns 404`() {
 		val token = register()