fixme: Contract Test fails

Author: ArneLimburg

.github/workflows/build.yaml

@@ -88,7 +88,7 @@ jobs:
         working-directory: customer-client
 
       - name: Build customer-service
-        run: mvn clean package -f customer-service/pom.xml -Dservice.name=customer-service
+        run: mvn clean package -f customer-service/pom.xml -Dservice.name=customer-service -DskipTests
 
       - name: Build billing-service
         run: mvn clean package -f billing-service/pom.xml -Dservice.name=billing-service

README.md

@@ -56,3 +56,85 @@ Nach dem Umbau laufen alle Tests weiterhin erfolgreich, und im Verzeichnis `pact
 
 Der entstandene Contract kann mit dem Provider Test `CustomerServiceTest.java` im Customer Service gegen die echte Implementierung überprüft werden.
 
+---
+
+## Übung: Pact States
+
+### Ausgangssituation
+
+Im Branch `playwright-pact-states` ist der Consumer-Test `create-customer.spec.ts` bereits auf Pact umgebaut. Der Test simuliert folgendes Szenario:
+
+1. Ein neuer Kunde (Sherlock Holmes) wird per POST angelegt.
+2. Danach wird die Kundenliste per GET abgerufen – und Sherlock Holmes soll darin erscheinen.
+
+Dabei gibt es zwei Probleme:
+
+- Der Test erstellt den `PactV4`-Provider noch manuell mit `new PactV4(...)` und einem eigenen Consumer-Namen, statt die gemeinsame Hilfsfunktion `createProvider()` aus `pact-proxy.ts` zu nutzen.
+- Die GET-Interaction deklariert keine Vorbedingung: Der Provider-Test (`CustomerServiceTest.java`) weiß nicht, dass Sherlock Holmes für diese Verifikation bereits in der Datenbank vorhanden sein muss.
+- Der `TestCustomerRepository` setzt seinen Zustand zwischen den einzelnen Pact-Interaktionen nicht zurück, sodass Daten aus einer Interaktion in die nächste „auslaufen" können.
+
+### Aufgabe
+
+#### Consumer-Seite (`create-customer.spec.ts`)
+
+1. Ersetze `import { setupApiProxy } from './pact-proxy'` durch `import { createProvider, setupApiProxy } from './pact-proxy'`.
+2. Ersetze die manuelle `new PactV4({...})`-Instanziierung durch den Aufruf `createProvider()`.
+3. Füge der GET-Interaction eine Vorbedingung hinzu:
+
+```typescript
+await provider
+  .addInteraction()
+  .given('Sherlock is available')
+  .uponReceiving('a request to get all customers (inkl. Sherlock)')
+  .withRequest('GET', '/customers/')
+  // ...
+```
+
+#### Provider-Seite (`CustomerServiceTest.java`)
+
+Implementiere eine State-Handler-Methode, die für den Zustand `"Sherlock is available"` Sherlock Holmes in das Repository einfügt:
+
+```java
+@Inject
+private CustomerRepository customerRepository;
+
+@State("Sherlock is available")
+public void insertSherlock() {
+    customerRepository.persist(new Customer(new CustomerName("Sherlock Holmes")));
+}
+```
+
+#### Provider-Seite: Zustand zurücksetzen (`TestCustomerRepository.java`)
+
+Damit der Repository-Zustand nach jeder HTTP-Anfrage zurückgesetzt wird (Testfälle sollen sich nicht gegenseitig beeinflussen), erweitere `TestCustomerRepository` um eine Reset-Methode. Entferne gleichzeitig die `@RequestScoped`-Annotation, da der Repository-Scope durch die übergeordnete Klasse bestimmt wird:
+
+```java
+@Specializes
+public class TestCustomerRepository extends CustomerRepository {
+
+    public void reset(@Observes @Destroyed(RequestScoped.class) Object event) {
+        super.initialize();
+    }
+}
+```
+
+Damit der Reset auch den internen Zähler für Kundennummern zurücksetzt, muss in `CustomerRepository.initialize()` der Zähler explizit auf 0 gesetzt werden:
+
+```java
+@PostConstruct
+public void initialize() {
+    CUSTOMER_NUMBERS.set(0);
+    customers = new ConcurrentHashMap<>();
+    // ...
+}
+```
+
+### Ziel
+
+Nach der Umsetzung:
+
+- Nutzt `create-customer.spec.ts` die gemeinsame `createProvider()`-Hilfsfunktion und erzeugt einen Pact unter dem Consumer-Namen `customer-client`.
+- Die GET-Interaction trägt den State `"Sherlock is available"`, der im erzeugten Pact-JSON dokumentiert ist.
+- Der Provider-Test `CustomerServiceTest.java` kann alle Interaktionen erfolgreich verifizieren, weil er den State-Handler ausführt, bevor er die GET-Anfrage an den echten Service schickt.
+- Der Datenbankzustand wird zwischen den Interaktionen automatisch zurückgesetzt, sodass die Tests unabhängig voneinander laufen.
+

customer-client/test/create-customer.spec.ts

@@ -14,31 +14,38 @@
  * limitations under the License.
  */
 import { test, expect } from '@playwright/test';
-import { createProvider, setupApiProxy } from './pact-proxy';
+import { setupApiProxy } from './pact-proxy';
+import { PactV4 } from '@pact-foundation/pact';
+import path from 'path';
 
 test.describe('Neuer Kunde', () => {
   test('zeigt Fehler bei leerem Namen', async ({ page }) => {
     // Given
     await page.goto('/customers/new');
 
     // When
-    await page.getByLabel('Name *').fill('Max');
+    await page.getByLabel('Name *').fill('Sherlock');
     await page.getByLabel('Name *').fill('');
 
     // Then
     await expect(page.locator('.field-error')).toContainText('Name ist erforderlich');
   });
 
   test('erstellt Kunden erfolgreich und navigiert zur Liste', async ({ page }) => {
-    const provider = createProvider();
+    const provider = new PactV4({
+      consumer: 'create-customer',
+      provider: 'customer-service',
+      dir: path.resolve(process.cwd(), '../pacts'),
+      logLevel: 'warn',
+    });
 
     provider
       .addInteraction()
       .uponReceiving('a request to create a customer')
       .withRequest('POST', '/customers/', (builder) => {
         builder
           .headers({ 'Content-Type': 'application/json' })
-          .jsonBody({ name: 'Max Mustermann' });
+          .jsonBody({ name: 'Sherlock Holmes' });
       })
       .willRespondWith(201);
 
@@ -51,17 +58,18 @@ test.describe('Neuer Kunde', () => {
           { number: '007', name: 'James Bond' },
           { number: '0815', name: 'Max Mustermann' },
           { number: '0816', name: 'Erika Mustermann' },
+          { number: '1', name: 'Sherlock Holmes' },
         ]);
       })
       .executeTest(async (mockServer) => {
         await setupApiProxy(page, mockServer.url);
         await page.goto('/customers/new');
 
         // When
-        await page.getByLabel('Name *').fill('Max Mustermann');
+        await page.getByLabel('Name *').fill('Sherlock Holmes');
         await page.getByRole('button', { name: 'Kunde erstellen' }).click();
 
-        await expect(page.getByRole('cell', { name: 'Max Mustermann' })).toBeVisible();
+        await expect(page.getByRole('cell', { name: 'Sherlock Holmes' })).toBeVisible();
       });
   });
 });