Merge pull request #614 from codecentric/add-events-to-habit-service

Add events to habit service
codecentric · Jan 3, 2024 · 9c36212 · 9c36212
2 parents d1384da + cf56aa9
commit 9c36212
Show file tree

Hide file tree

Showing 47 changed files with 693 additions and 432 deletions.
diff --git a/infrastructure/docker/docker-compose.yml b/infrastructure/docker/docker-compose.yml
@@ -71,6 +71,7 @@ services:
       - habit-db
     environment:
       DB_HOST: habit-db
+      KAFKA_BOOTSTRAP_SERVERS: kafka:11001
     networks:
       - habitcentric-net
   habit-db:
@@ -124,8 +125,8 @@ services:
       - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:11001,EXTERNAL://localhost:11003
       - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@kafka:11002
       - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
-      - KAFKA_CLIENT_USERS=track,kafka-ui
-      - KAFKA_CLIENT_PASSWORDS=track,kafka-ui
+      - KAFKA_CLIENT_USERS=habit,track,kafka-ui
+      - KAFKA_CLIENT_PASSWORDS=habit,track,kafka-ui
     networks:
       - habitcentric-net
   kafka-ui:

diff --git a/infrastructure/istio/config/23-mtls-authz-policies.yaml b/infrastructure/istio/config/23-mtls-authz-policies.yaml
@@ -64,6 +64,7 @@ spec:
     - from:
         - source:
             principals:
+              - cluster.local/ns/hc-habit/sa/habit
               - cluster.local/ns/hc-track/sa/track
 ---
 apiVersion: security.istio.io/v1beta1

diff --git a/infrastructure/kubernetes/helmfile.d/values/habit-values.yaml.gotmpl b/infrastructure/kubernetes/helmfile.d/values/habit-values.yaml.gotmpl
@@ -18,8 +18,10 @@ image:
 
 ## habitcentric habit service configuration
 
-{{- if (eq .Environment.Name "traefik-mesh") }}
 extraEnv:
+  - name: KAFKA_BOOTSTRAP_SERVERS
+    value: kafka.hc-kafka.svc.cluster.local:9092
+{{- if (eq .Environment.Name "traefik-mesh") }}
   - name: MANAGEMENT_ZIPKIN_TRACING_ENDPOINT
     value: http://jaeger-collector.traefik-mesh.svc.cluster.local:9411
 {{- end }}

diff --git a/infrastructure/kubernetes/helmfile.d/values/kafka-values.yaml.gotmpl b/infrastructure/kubernetes/helmfile.d/values/kafka-values.yaml.gotmpl
@@ -10,8 +10,10 @@ sasl:
     password: "kafka"
   client:
     users:
+      - "habit"
       - "track"
     passwords:
+      - "habit"
       - "track"
 
 externalAccess:

diff --git a/services/habit/build.gradle b/services/habit/build.gradle
@@ -83,7 +83,19 @@ ext {
 ext['junit-jupiter.version'] = versions.junitJupiter
 ext['jna.version'] = versions.jna // Required for Docker on ARM
 
+dependencyManagement {
+    imports {
+        mavenBom 'org.springframework.modulith:spring-modulith-bom:1.1.0'
+    }
+}
+
 dependencies {
+    // Spring Modulith
+    implementation "org.springframework.modulith:spring-modulith-starter-core"
+    implementation "org.springframework.modulith:spring-modulith-starter-jpa"
+    implementation "org.springframework.modulith:spring-modulith-events-kafka"
+    intTestImplementation "org.springframework.modulith:spring-modulith-starter-test"
+
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'org.springframework.boot:spring-boot-starter-validation'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'

diff --git a/services/habit/docker-compose.yml b/services/habit/docker-compose.yml
@@ -8,3 +8,31 @@ services:
     environment:
       POSTGRESQL_PASSWORD: postgres
       POSTGRESQL_PORT_NUMBER: 10001
+
+  kafka:
+    image: 'bitnami/kafka:latest'
+    ports:
+      - "11003:11003"
+    environment:
+      - KAFKA_CFG_NODE_ID=0
+      - KAFKA_CFG_PROCESS_ROLES=controller,broker
+      - KAFKA_CFG_LISTENERS=PLAINTEXT://:11001,CONTROLLER://:11002,EXTERNAL://:11003
+      - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:SASL_PLAINTEXT,EXTERNAL:SASL_PLAINTEXT
+      - KAFKA_CFG_ADVERTISED_LISTENERS=PLAINTEXT://kafka:11001,EXTERNAL://localhost:11003
+      - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@kafka:11002
+      - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
+      - KAFKA_CLIENT_USERS=habit,kafka-ui
+      - KAFKA_CLIENT_PASSWORDS=habit,kafka-ui
+
+  kafka-ui:
+    container_name: kafka-ui
+    image: provectuslabs/kafka-ui:latest
+    ports:
+      - "11004:11004"
+    environment:
+      SERVER_PORT: 11004
+      DYNAMIC_CONFIG_ENABLED: 'true'
+      KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS: kafka:11001
+      KAFKA_CLUSTERS_0_PROPERTIES_SECURITY_PROTOCOL: SASL_PLAINTEXT
+      KAFKA_CLUSTERS_0_PROPERTIES_SASL_MECHANISM: PLAIN
+      KAFKA_CLUSTERS_0_PROPERTIES_SASL_JAAS_CONFIG: 'org.apache.kafka.common.security.plain.PlainLoginModule required username="kafka-ui" password="kafka-ui";'
diff --git a/services/habit/habit-requests.http b/services/habit/habit-requests.http
@@ -16,3 +16,8 @@ Content-Type: application/json
     "frequency": "MONTHLY"
   }
 }
+
+### Delete habit
+# Retrieve the ID by fetching the habits first
+DELETE http://localhost:9001/habits/8ffa23a1-e91b-45a3-9060-3b0f53c0c6f3
+X-User-Id: default
diff --git a/services/habit/pacts/hc-ui-hc-habit.json b/services/habit/pacts/hc-ui-hc-habit.json
@@ -23,23 +23,20 @@
         },
         "body": [
           {
-            "id": 1,
             "name": "Jogging",
             "schedule": {
               "repetitions": 2,
               "frequency": "WEEKLY"
             }
           },
           {
-            "id": 101,
             "name": "Meditate",
             "schedule": {
               "repetitions": 1,
               "frequency": "DAILY"
             }
           },
           {
-            "id": 51,
             "name": "Play guitar",
             "schedule": {
               "repetitions": 5,
@@ -49,13 +46,13 @@
         ],
         "matchingRules": {
           "$.body[0].id": {
-            "match": "type"
+            "match": "uuid"
           },
           "$.body[1].id": {
-            "match": "type"
+            "match": "uuid"
           },
           "$.body[2].id": {
-            "match": "type"
+            "match": "uuid"
           }
         }
       }
@@ -84,10 +81,10 @@
     },
     {
       "description": "request to delete the habit with id '123'",
-      "providerState": "habit with id '123' exists",
+      "providerState": "habit with id 'd712645f-cd4f-40c4-b171-bb2ea72d180d' exists",
       "request": {
         "method": "DELETE",
-        "path": "/habits/123"
+        "path": "/habits/d712645f-cd4f-40c4-b171-bb2ea72d180d"
       },
       "response": {
         "status": 200,
@@ -101,4 +98,4 @@
       "version": "2.0.0"
     }
   }
-}
+}
diff --git a/services/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitControllerIntTest.java b/services/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitControllerIntTest.java
@@ -2,14 +2,14 @@
 
 import static de.codecentric.hc.habit.habits.Habit.Schedule.Frequency.DAILY;
 import static de.codecentric.hc.habit.habits.Habit.Schedule.Frequency.WEEKLY;
+import static de.codecentric.hc.habit.testing.CustomMatchers.isValidUuid;
 import static io.restassured.RestAssured.given;
 import static io.restassured.RestAssured.when;
 import static io.restassured.http.ContentType.JSON;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hamcrest.Matchers.contains;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.everyItem;
-import static org.hamcrest.Matchers.greaterThan;
 import static org.hamcrest.Matchers.isEmptyOrNullString;
 import static org.springframework.http.HttpStatus.BAD_REQUEST;
 import static org.springframework.http.HttpStatus.CREATED;
@@ -23,6 +23,7 @@
 import de.codecentric.hc.habit.testing.RestAssuredTest;
 import io.restassured.http.Header;
 import java.sql.SQLException;
+import java.util.UUID;
 import java.util.stream.Stream;
 import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.AfterEach;
@@ -61,7 +62,7 @@ public void getHabits() throws InterruptedException {
         .then()
         .statusCode(200)
         .body("name", contains(expected))
-        .body("id", everyItem(greaterThan(0)));
+        .body("id", everyItem(isValidUuid()));
   }
 
   @Test
@@ -79,7 +80,7 @@ public void getHabitsOrderedByNameAscending() throws InterruptedException {
         .then()
         .statusCode(200)
         .body("name", contains(expected))
-        .body("id", everyItem(greaterThan(0)));
+        .body("id", everyItem(isValidUuid()));
   }
 
   @Test
@@ -246,19 +247,20 @@ public void deleteHabit() {
 
   @Test
   public void deleteHabitNotFound() {
+    UUID habitId = UUID.randomUUID();
     given()
         .header(DEFAULT_USER_ID_HEADER)
         .when()
-        .delete("/habits/{id}", 999)
+        .delete("/habits/{id}", habitId)
         .then()
         .statusCode(NOT_FOUND.value())
-        .body("message", equalTo("Habit '999' could not be found."));
+        .body("message", equalTo(String.format("Habit '%s' could not be found.", habitId)));
   }
 
   @Test
   public void deleteHabitWithoutAuthShouldFail() {
     when()
-        .delete("/habits/{id}", 123)
+        .delete("/habits/{id}", UUID.randomUUID())
         .then()
         .statusCode(
             INTERNAL_SERVER_ERROR.value()) // TODO: HTTP 400 or 401 would be more appropriate

diff --git a/...ices/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitControllerJwtIntTest.java b/...ices/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitControllerJwtIntTest.java
@@ -2,6 +2,7 @@
 
 import static de.codecentric.hc.habit.habits.Habit.Schedule.Frequency.DAILY;
 import static de.codecentric.hc.habit.habits.Habit.Schedule.Frequency.WEEKLY;
+import static de.codecentric.hc.habit.testing.CustomMatchers.isValidUuid;
 import static io.restassured.RestAssured.given;
 import static io.restassured.http.ContentType.JSON;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -13,6 +14,7 @@
 import de.codecentric.hc.habit.testing.RestAssuredTest;
 import io.restassured.http.Header;
 import java.sql.SQLException;
+import java.util.UUID;
 import java.util.stream.Stream;
 import org.apache.commons.lang3.StringUtils;
 import org.junit.jupiter.api.AfterEach;
@@ -57,7 +59,7 @@ public void getHabits() throws InterruptedException {
         .then()
         .statusCode(OK.value())
         .body("name", contains(expected))
-        .body("id", everyItem(greaterThan(0)));
+        .body("id", everyItem(isValidUuid()));
   }
 
   @Test
@@ -75,7 +77,7 @@ public void getHabitsOrderedByNameAscending() throws InterruptedException {
         .then()
         .statusCode(OK.value())
         .body("name", contains(expected))
-        .body("id", everyItem(greaterThan(0)));
+        .body("id", everyItem(isValidUuid()));
   }
 
   @Test
@@ -238,13 +240,14 @@ public void deleteHabit() {
 
   @Test
   public void deleteHabitNotFound() {
+    UUID habitId = UUID.randomUUID();
     given()
         .header(DEFAULT_AUTHORIZATION_HEADER)
         .when()
-        .delete("/habits/{id}", 999)
+        .delete("/habits/{id}", habitId)
         .then()
         .statusCode(NOT_FOUND.value())
-        .body("message", equalTo("Habit '999' could not be found."));
+        .body("message", equalTo(String.format("Habit '%s' could not be found.", habitId)));
   }
 
   private String insertHabit(String name) {

diff --git a/...ces/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitModuleIntegrationTest.java b/...ces/habit/src/intTest/java/de/codecentric/hc/habit/habits/HabitModuleIntegrationTest.java
@@ -0,0 +1,67 @@
+package de.codecentric.hc.habit.habits;
+
+import static de.codecentric.hc.habit.habits.Habit.Schedule.Frequency.WEEKLY;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import de.codecentric.hc.habit.auth.UserIdArgumentResolver;
+import de.codecentric.hc.habit.habits.Habit.ModificationRequest;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.modulith.test.ApplicationModuleTest;
+import org.springframework.modulith.test.Scenario;
+import org.springframework.test.context.ActiveProfiles;
+
+@ActiveProfiles("intTest")
+@ApplicationModuleTest
+@MockBean(UserIdArgumentResolver.class)
+public class HabitModuleIntegrationTest {
+
+  @Autowired private HabitController habitController;
+  @Autowired private HabitRepository habitRepository;
+
+  @AfterEach
+  void tearDown() {
+    habitRepository.deleteAll();
+  }
+
+  @Test
+  void shouldPublishHabitCreatedEventWhenHabitIsCreated(Scenario scenario) {
+    ModificationRequest createJoggingHabitRequest =
+        ModificationRequest.builder()
+            .name("Jogging")
+            .schedule(Habit.Schedule.builder().frequency(WEEKLY).repetitions(3).build())
+            .build();
+
+    scenario
+        .stimulate(() -> habitController.createHabit(createJoggingHabitRequest, "userId"))
+        .andWaitForEventOfType(Habit.HabitCreated.class)
+        .toArriveAndVerify(
+            event -> {
+              assertThat(event.name()).isEqualTo("Jogging");
+              assertThat(event.frequency()).isEqualTo(WEEKLY);
+              assertThat(event.repetitions()).isEqualTo(3);
+            });
+  }
+
+  @Test
+  void shouldPublishHabitDeletedEventWhenHabitIsDeleted(Scenario scenario) {
+    Habit habit =
+        Habit.from(
+            ModificationRequest.builder()
+                .name("Jogging")
+                .schedule(Habit.Schedule.builder().frequency(WEEKLY).repetitions(3).build())
+                .build(),
+            "userId");
+    habitRepository.save(habit);
+
+    scenario
+        .stimulate(() -> habitController.deleteHabit(habit.getId().toString(), "userId"))
+        .andWaitForEventOfType(Habit.HabitDeleted.class)
+        .toArriveAndVerify(
+            event -> {
+              assertThat(event.habitId()).isEqualTo(habit.getId());
+            });
+  }
+}
diff --git a/...rc/intTest/java/de/codecentric/hc/habit/provider/verification/UiPactVerificationTest.java b/...rc/intTest/java/de/codecentric/hc/habit/provider/verification/UiPactVerificationTest.java
@@ -7,6 +7,7 @@
 import au.com.dius.pact.provider.junitsupport.State;
 import au.com.dius.pact.provider.junitsupport.loader.PactFolder;
 import de.codecentric.hc.habit.habits.Habit.Schedule.Frequency;
+import java.util.UUID;
 import org.apache.hc.core5.http.HttpRequest;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
@@ -56,13 +57,22 @@ public void cleanUp() {
 
   @State("habits 'Jogging', 'Meditate' and 'Play guitar' exist")
   public void createHabitsJoggingAndMeditateAndPlayGuitar() {
-    jdbcTemplate.update(INSERT_STATEMENT, 1, "Jogging", 2, Frequency.WEEKLY.name(), USER_ID);
-    jdbcTemplate.update(INSERT_STATEMENT, 51, "Play guitar", 5, Frequency.MONTHLY.name(), USER_ID);
-    jdbcTemplate.update(INSERT_STATEMENT, 101, "Meditate", 1, Frequency.DAILY.name(), USER_ID);
+    jdbcTemplate.update(
+        INSERT_STATEMENT, UUID.randomUUID(), "Jogging", 2, Frequency.WEEKLY.name(), USER_ID);
+    jdbcTemplate.update(
+        INSERT_STATEMENT, UUID.randomUUID(), "Play guitar", 5, Frequency.MONTHLY.name(), USER_ID);
+    jdbcTemplate.update(
+        INSERT_STATEMENT, UUID.randomUUID(), "Meditate", 1, Frequency.DAILY.name(), USER_ID);
   }
 
-  @State("habit with id '123' exists")
+  @State("habit with id 'd712645f-cd4f-40c4-b171-bb2ea72d180d' exists")
   public void createHabit123() {
-    jdbcTemplate.update(INSERT_STATEMENT, 123, "Habit name", 1, Frequency.DAILY.name(), USER_ID);
+    jdbcTemplate.update(
+        INSERT_STATEMENT,
+        UUID.fromString("d712645f-cd4f-40c4-b171-bb2ea72d180d"),
+        "Habit name",
+        1,
+        Frequency.DAILY.name(),
+        USER_ID);
   }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,8 +10,10 @@ sasl: @@
         password: "kafka"
       client:
         users:
+          - "habit"
           - "track"
         passwords:
+          - "habit"
           - "track"
     externalAccess:
@@ Expand Down @@