BENCH-181 list of categories added to Product Response

Author: AudriusPutys

src/main/java/com/answerdigital/answerking/controller/ProductController.java

@@ -3,6 +3,7 @@
 import com.answerdigital.answerking.exception.util.ErrorResponse;
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.request.ProductRequest;
+import com.answerdigital.answerking.response.ProductResponse;
 import com.answerdigital.answerking.service.ProductService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -45,8 +46,8 @@ public ProductController(final ProductService productService) {
             content = { @Content(mediaType = "application/json", schema = @Schema(implementation = Product.class)) })
     })
     @GetMapping
-    public ResponseEntity<List<Product>> getAllProducts() {
-        final List<Product> products = productService.findAll();
+    public ResponseEntity<List<ProductResponse>> getAllProducts() {
+        final List<ProductResponse> products = productService.findAll();
         return new ResponseEntity<>(products, products.isEmpty() ? HttpStatus.NO_CONTENT : HttpStatus.OK);
     }
 
@@ -59,8 +60,8 @@ public ResponseEntity<List<Product>> getAllProducts() {
                                     schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @GetMapping(path = "/{id}")
-    public ResponseEntity<Product> getProductById(@Valid @PathVariable @NotNull final Long id) {
-        return new ResponseEntity<>(productService.findById(id), HttpStatus.OK);
+    public ResponseEntity<ProductResponse> getProductById(@Valid @PathVariable @NotNull final Long id) {
+        return new ResponseEntity<>(productService.findByIdResponse(id), HttpStatus.OK);
     }
 
     @Operation(summary = "Create a new product.")
@@ -72,7 +73,7 @@ public ResponseEntity<Product> getProductById(@Valid @PathVariable @NotNull fina
                                     schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PostMapping
-    public ResponseEntity<Product> addProduct(@Valid @RequestBody final ProductRequest productRequest) {
+    public ResponseEntity<ProductResponse> addProduct(@Valid @RequestBody final ProductRequest productRequest) {
         return new ResponseEntity<>(productService.addNewProduct(productRequest), HttpStatus.CREATED);
     }
 
@@ -88,7 +89,7 @@ public ResponseEntity<Product> addProduct(@Valid @RequestBody final ProductReque
                                     schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PutMapping("/{id}")
-    public ResponseEntity<Product> updateProduct(@PathVariable @NotNull final Long id,
+    public ResponseEntity<ProductResponse> updateProduct(@PathVariable @NotNull final Long id,
                                               @Valid @RequestBody final ProductRequest productRequest) {
         return new ResponseEntity<>(productService.updateProduct(id, productRequest), HttpStatus.OK);
     }
@@ -105,7 +106,7 @@ public ResponseEntity<Product> updateProduct(@PathVariable @NotNull final Long i
                                     schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @DeleteMapping("/{id}")
-    public ResponseEntity<Product> retireProduct(@PathVariable @NotNull final Long id) {
+    public ResponseEntity<ProductResponse> retireProduct(@PathVariable @NotNull final Long id) {
         return new ResponseEntity<>(productService.retireProduct(id), HttpStatus.OK);
     }
 }

src/main/java/com/answerdigital/answerking/mapper/ProductMapper.java

@@ -2,14 +2,24 @@
 
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.request.ProductRequest;
+import com.answerdigital.answerking.response.ProductResponse;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import org.mapstruct.MappingTarget;
 
-@Mapper(componentModel = "spring")
+import java.util.Collections;
+import java.util.stream.Collectors;
+
+@Mapper(componentModel = "spring",
+        imports = {Collectors.class, Collections.class})
 public interface ProductMapper {
     @Mapping(target = "retired", constant = "false")
+    @Mapping(target = "categories", expression = "java(Collections.EMPTY_SET)")
     Product addRequestToProduct(ProductRequest productRequest);
 
     Product updateRequestToProduct(@MappingTarget Product product, ProductRequest productRequest);
+
+    @Mapping(target = "categories",
+            expression = "java(product.getCategories().stream().map(category -> category.getId()).collect(Collectors.toList()) )")
+    ProductResponse convertProductEntityToProductResponse(Product product);
 }

src/main/java/com/answerdigital/answerking/model/Product.java

@@ -48,11 +48,10 @@ public class Product {
     @Column(precision = 12, scale = 2)
     private BigDecimal price;
 
-    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
     private boolean retired;
 
     @JsonIgnore
-    @ManyToMany(fetch = FetchType.LAZY, mappedBy = "products")
+    @ManyToMany(fetch = FetchType.EAGER, mappedBy = "products")
     private Set<Category> categories = new HashSet<>();
 
     @OneToMany(mappedBy = "product", cascade = CascadeType.ALL)

src/main/java/com/answerdigital/answerking/response/ProductResponse.java

@@ -0,0 +1,30 @@
+package com.answerdigital.answerking.response;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+
+import java.math.BigDecimal;
+import java.util.List;
+
+@Data
+@Builder
+@NoArgsConstructor
+@AllArgsConstructor
+public class ProductResponse {
+
+    private Long id;
+
+    private String name;
+
+    private String description;
+
+    private BigDecimal price;
+
+    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
+    private List<Long> categories;
+
+    private boolean retired;
+}

src/main/java/com/answerdigital/answerking/service/ProductService.java

@@ -7,10 +7,13 @@
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.ProductRepository;
 import com.answerdigital.answerking.request.ProductRequest;
+import com.answerdigital.answerking.response.ProductResponse;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
+
 import java.util.List;
+import java.util.stream.Collectors;
 
 @Service
 public class ProductService {
@@ -24,25 +27,37 @@ public ProductService(final ProductRepository productRepository) {
         this.productRepository = productRepository;
     }
 
-    public Product addNewProduct(final ProductRequest productRequest) {
+    public ProductResponse addNewProduct(final ProductRequest productRequest) {
         if (productRepository.existsByName(productRequest.name())) {
             throw new NameUnavailableException(String.format("A Product named '%s' already exists", productRequest.name()));
         }
 
         final Product newProduct = productMapper.addRequestToProduct(productRequest);
-        return productRepository.save(newProduct);
+        final Product savedProduct = productRepository.save(newProduct);
+        return productMapper.convertProductEntityToProductResponse(savedProduct);
     }
 
     public Product findById(final Long productId) {
         return productRepository.findById(productId)
                 .orElseThrow(() -> new NotFoundException(String.format("Product with ID %d does not exist.", productId)));
     }
 
-    public List<Product> findAll() {
-        return productRepository.findAll();
+    public ProductResponse findByIdResponse(final Long productId) {
+        final Product product = productRepository.findById(productId)
+                .orElseThrow(() -> new NotFoundException(String.format("Product with ID %d does not exist.", productId)));
+
+        return productMapper.convertProductEntityToProductResponse(product);
+    }
+
+    public List<ProductResponse> findAll() {
+        final List<Product> productsList = productRepository.findAll();
+        return productsList
+                .stream()
+                .map(productMapper::convertProductEntityToProductResponse)
+                .collect(Collectors.toList());
     }
 
-    public Product updateProduct(final Long productId, final ProductRequest productRequest) {
+    public ProductResponse updateProduct(final Long productId, final ProductRequest productRequest) {
         productRepository.findById(productId)
                 .orElseThrow(() -> new NotFoundException(String.format("Product with ID %d does not exist.", productId)));
 
@@ -51,15 +66,17 @@ public Product updateProduct(final Long productId, final ProductRequest productR
         }
 
         final Product updatedProduct = productMapper.updateRequestToProduct(findById(productId), productRequest);
-        return productRepository.save(updatedProduct);
+        final Product savedProduct = productRepository.save(updatedProduct);
+        return productMapper.convertProductEntityToProductResponse(savedProduct);
     }
 
-    public Product retireProduct(final Long productId) {
+    public ProductResponse retireProduct(final Long productId) {
         final Product product = findById(productId);
         if (product.isRetired()) {
             throw new RetirementException(String.format("The product with ID %d is already retired", productId));
         }
         product.setRetired(true);
-        return productRepository.save(product);
+        final Product savedProduct = productRepository.save(product);
+        return productMapper.convertProductEntityToProductResponse(savedProduct);
     }
 }

src/test/java/com/answerdigital/answerking/controller/ProductControllerTest.java

@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.controller;
 
-import com.answerdigital.answerking.model.Product;
+import com.answerdigital.answerking.response.ProductResponse;
 import com.answerdigital.answerking.service.ProductService;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.BeforeEach;
@@ -20,12 +20,14 @@
 import org.springframework.test.web.servlet.ResultActions;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
 import java.math.BigDecimal;
+import java.util.ArrayList;
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.BDDMockito.given;
@@ -49,16 +51,17 @@ class ProductControllerTest {
     @Autowired
     private MockMvc mvc;
 
-    private Product product;
+    private ProductResponse product;
 
     @BeforeEach
     public void generateProduct() {
-        product = Product.builder()
+        product = ProductResponse.builder()
                 .id(55L)
                 .name("test")
                 .description("testDes")
                 .price(BigDecimal.valueOf(2.99))
                 .retired(false)
+                .categories(new ArrayList<>())
                 .build();
     }
 
@@ -92,7 +95,7 @@ void getAllProductsReturnNoContentIfEmpty() throws Exception {
     @Test
     void getProductByIdReturnsOkStatusIfExist() throws Exception {
         //given
-        when(productService.findById(55L)).thenReturn(product);
+        when(productService.findByIdResponse(55L)).thenReturn(product);
         //when
         ResultActions actualPerformResult = mvc.perform(get("/products/{id}", 55L)).andExpect(status().isOk());
         ObjectMapper mapper = new ObjectMapper();

src/test/java/com/answerdigital/answerking/service/ProductServiceTest.java

@@ -6,6 +6,7 @@
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.ProductRepository;
 import com.answerdigital.answerking.request.ProductRequest;
+import com.answerdigital.answerking.response.ProductResponse;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -14,12 +15,14 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 
 import java.math.BigDecimal;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Optional;
 
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.anyLong;
@@ -46,6 +49,7 @@ public void generateProduct() {
                 .description("testDes")
                 .price(BigDecimal.valueOf(2.99))
                 .retired(false)
+                .categories(new HashSet<>())
                 .build();
         productRequest = ProductRequest.builder()
                 .name("test")
@@ -60,7 +64,7 @@ void addNewProductReturnsProductObjectSuccessfully() {
         when(productRepository.save(any())).thenReturn(product);
         when(productRepository.existsByName(any())).thenReturn(false);
         //when
-        Product actualAddNewProductResult = productService.addNewProduct(
+        ProductResponse actualAddNewProductResult = productService.addNewProduct(
                 productRequest);
         //then
         assertEquals(product.getName(), actualAddNewProductResult.getName());
@@ -105,7 +109,7 @@ void getAllProductsReturnListOfProductObjects() {
         //given
         when(productRepository.findAll()).thenReturn(List.of(product));
         //when
-        List<Product> actualResult = productService.findAll();
+        List<ProductResponse> actualResult = productService.findAll();
         //then
         assertFalse(actualResult.isEmpty());
         assertEquals(actualResult.get(0).getName(), product.getName());
@@ -120,7 +124,7 @@ void updateProductReturnsProductObjectSuccessfully() {
         when(productRepository.findById(anyLong())).thenReturn(Optional.ofNullable(product));
 
         //when
-        Product actualAddNewProductResult = productService.updateProduct(12L,
+        ProductResponse actualAddNewProductResult = productService.updateProduct(12L,
                 productRequest);
 
         //then
@@ -159,7 +163,7 @@ void testRetireProduct() {
                 .thenReturn(product);
 
         // then
-        assertEquals(product, productService.retireProduct(PRODUCT_ID));
+        assertNotEquals(product.isRetired(), productService.retireProduct(PRODUCT_ID).isRetired());
         verify(productRepository).findById(anyLong());
         verify(productRepository).save(any(Product.class));
     }