Merge pull request #5 from trendyol-data-eng-summer-intern-2019/dev

Dev

Author: yasinuygun

pom.xml

@@ -11,7 +11,7 @@
     <groupId>com.trendyol</groupId>
     <artifactId>recom-engine-web-service</artifactId>
     <version>0.0.1-SNAPSHOT</version>
-    <name>recom-engine</name>
+    <name>recom-engine-web-service</name>
     <description>Demo project for Spring Boot</description>
 
     <properties>
@@ -42,6 +42,12 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-mongodb</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>testcontainers</artifactId>
+            <version>1.11.3</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/trendyol/recomengine/webservice/controller/ReviewController.java

@@ -9,6 +9,8 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import javax.validation.Valid;
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.Pattern;
 
 /**
  * Handles POST requests that contain user reviews, validates the data that comes from requests and sends them to Kafka.
@@ -33,7 +35,13 @@ public class ReviewController {
      * @see ReviewWithoutUserId
      */
     @PostMapping(value = "/users/{userId}/reviews")
-    public Object createReview(@Valid @RequestBody ReviewWithoutUserId requestBody, @PathVariable String userId) {
+    public Object createReview(@Valid @RequestBody ReviewWithoutUserId requestBody,
+                               @PathVariable
+                               @Valid
+                               @NotBlank
+                               @Pattern(regexp = "^[a-zA-Z0-9]+$"
+                                       , message = "userId must only contain alphanumeric characters.")
+                                       String userId) {
         Review review = new Review(userId, requestBody);
 
         String dataToSendToKafka = String.format("%s,%s,%.1f,%d", userId, requestBody.getProductId(),

src/main/java/com/trendyol/recomengine/webservice/model/Review.java

@@ -1,6 +1,7 @@
 package com.trendyol.recomengine.webservice.model;
 
 import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.Pattern;
 import java.sql.Timestamp;
 
 /**
@@ -9,6 +10,7 @@
 public class Review extends ReviewWithoutUserId {
 
     @NotBlank
+    @Pattern(regexp = "^[a-zA-Z0-9]+$", message = "userId must only contain alphanumeric characters.")
     private final String userId;
 
     /**

src/main/java/com/trendyol/recomengine/webservice/model/ReviewWithoutUserId.java

@@ -1,9 +1,6 @@
 package com.trendyol.recomengine.webservice.model;
 
-import javax.validation.constraints.DecimalMin;
-import javax.validation.constraints.Max;
-import javax.validation.constraints.NotBlank;
-import javax.validation.constraints.NotNull;
+import javax.validation.constraints.*;
 import java.sql.Timestamp;
 
 /**
@@ -12,6 +9,7 @@
 public class ReviewWithoutUserId {
 
     @NotBlank
+    @Pattern(regexp = "^[a-zA-Z0-9]+$", message = "productId must only contain alphanumeric characters.")
     private final String productId;
 
     @DecimalMin(value = "0.5")

src/main/java/com/trendyol/recomengine/webservice/repository/RecommendationRepository.java

@@ -2,12 +2,14 @@
 
 import com.trendyol.recomengine.webservice.model.Recommendation;
 import org.springframework.data.mongodb.repository.MongoRepository;
+import org.springframework.stereotype.Repository;
 
 /**
  * Used to fetch recommendations of a specific user from MongoDB. Extends interface MongoRepository that is needed to
  * configure the Spring Boot application to retrieve data from MongoDB. Required confifgurations are made in the
  * application.yml file.
  */
+@Repository
 public interface RecommendationRepository extends MongoRepository<Recommendation, String> {
 
     /**

src/main/resources/application.yml

@@ -3,13 +3,13 @@ server:
 spring:
   data:
     mongodb:
-      host: localhost
+      host: mongo1
       port: 27017
       database: recom-engine
   kafka:
     template:
       default-topic: reviews
     producer:
-      bootstrap-servers: localhost:9092
+      bootstrap-servers: kafka1:19092
       key-serializer: org.apache.kafka.common.serialization.StringSerializer
       value-serializer: org.apache.kafka.common.serialization.StringSerializer

src/test/java/com/trendyol/recomengine/webservice/controller/BaseMongoIntegrationTest.java

@@ -0,0 +1,44 @@
+package com.trendyol.recomengine.webservice.controller;
+
+import org.junit.runner.RunWith;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.util.TestPropertyValues;
+import org.springframework.context.ApplicationContextInitializer;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.context.event.ContextClosedEvent;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.testcontainers.containers.GenericContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE)
+@ActiveProfiles("test")
+@ContextConfiguration(initializers = BaseMongoIntegrationTest.Initializer.class)
+public abstract class BaseMongoIntegrationTest {
+    private static final int MONGO_PORT = 27017;
+
+    private static GenericContainer mongoContainer = new GenericContainer("mongo:latest")
+            .withExposedPorts(MONGO_PORT)
+            .waitingFor(Wait.forListeningPort());
+
+    static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
+        @Override
+        public void initialize(ConfigurableApplicationContext applicationContext) {
+            mongoContainer.start();
+
+            TestPropertyValues.of("spring.data.mongodb.uri=mongodb://localhost:" + mongoContainer.getMappedPort(MONGO_PORT))
+                    .applyTo(applicationContext);
+
+            applicationContext.addApplicationListener(
+                    applicationEvent -> {
+                        if (applicationEvent instanceof ContextClosedEvent) {
+                            mongoContainer.stop();
+                        }
+                    }
+            );
+        }
+    }
+}
+

src/test/java/com/trendyol/recomengine/webservice/controller/RecommendationControllerIntegrationTests.java

@@ -0,0 +1,25 @@
+package com.trendyol.recomengine.webservice.controller;
+
+import com.trendyol.recomengine.webservice.model.Recommendation;
+import com.trendyol.recomengine.webservice.repository.RecommendationRepository;
+import com.trendyol.recomengine.webservice.service.RecommendationService;
+import org.junit.Assert;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+public class RecommendationControllerIntegrationTests extends BaseMongoIntegrationTest {
+    @Autowired
+    private RecommendationRepository recommendationRepository;
+    @Autowired
+    private RecommendationService recommendationService;
+
+    @Test
+    public void getRecommendationShouldReturnTheRelevantUsersRecommendation() {
+        String userId = "3";
+        String[] recommendations = new String[]{"1", "2", "3", "4", "5", "6", "7", "8", "9", "10"};
+
+        Recommendation recommendation = new Recommendation(userId, recommendations);
+        recommendationRepository.save(recommendation);
+        Assert.assertEquals(recommendationService.getRecommendations(userId).get_id(), userId);
+    }
+}

src/test/java/com/trendyol/recomengine/webservice/controller/RecommendationControllerTests.java renamed to src/test/java/com/trendyol/recomengine/webservice/controller/RecommendationControllerUnitTests.java

@@ -22,7 +22,7 @@
 @RunWith(SpringRunner.class)
 @SpringBootTest
 @AutoConfigureMockMvc
-public class RecommendationControllerTests {
+public class RecommendationControllerUnitTests {
 
     @Autowired
     private MockMvc mockMvc;

src/test/java/com/trendyol/recomengine/webservice/controller/ReviewControllerTests.java renamed to src/test/java/com/trendyol/recomengine/webservice/controller/ReviewControllerUnitTests.java

@@ -13,12 +13,10 @@
 import org.springframework.test.context.junit4.SpringRunner;
 import org.springframework.test.web.servlet.MockMvc;
 
-import java.io.Serializable;
 import java.sql.Timestamp;
 import java.text.SimpleDateFormat;
 import java.util.TimeZone;
 
-import static org.mockito.BDDMockito.given;
 import static org.springframework.test.web.servlet.ResultMatcher.matchAll;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
 import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
@@ -27,14 +25,22 @@
 @RunWith(SpringRunner.class)
 @SpringBootTest
 @AutoConfigureMockMvc
-public class ReviewControllerTests {
+public class ReviewControllerUnitTests {
 
     @Autowired
     private MockMvc mockMvc;
 
     @MockBean
     private KafkaTemplate<String, String> kafkaTemplate;
 
+    public static String asJsonString(final Object obj) {
+        try {
+            return new ObjectMapper().writeValueAsString(obj);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
     @Test
     public void createReviewShouldReturnTheGivenReviewBack() throws Exception {
         String userId = "3";
@@ -101,14 +107,6 @@ public void createReviewShouldReturnBadRequestSinceAllFieldsDoNotExist() throws
                 .andExpect(status().isBadRequest());
     }
 
-    public static String asJsonString(final Object obj) {
-        try {
-            return new ObjectMapper().writeValueAsString(obj);
-        } catch (Exception e) {
-            throw new RuntimeException(e);
-        }
-    }
-
     private String getTimeStringFormatted(Timestamp time) {
         String timeStringFormatted;
         SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");