BENCH-231 Refactored CategoryServiceTest to use builder & remove magic values

AndyFlintAnswerDigital · AndyFlintAnswerDigital · commit e127a020cf0f · 2022-11-28T12:19:30.000Z
diff --git a/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java b/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java
@@ -4,30 +4,21 @@
 import com.answerdigital.answerking.request.AddCategoryRequest;
 import com.answerdigital.answerking.request.UpdateCategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
+import com.answerdigital.answerking.util.DateTimeUtility;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import org.mapstruct.MappingTarget;
-import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.temporal.ChronoUnit;
-import java.time.ZoneOffset;
 import java.util.stream.Collectors;
 
 @Mapper(componentModel = "spring",
-        imports = {DateTimeFormatter.class, ZoneOffset.class, ZonedDateTime.class, ChronoUnit.class, Collectors.class})
+        imports = {DateTimeUtility.class, Collectors.class})
 public interface CategoryMapper {
 
-    @Mapping(target = "createdOn", expression = "java( ZonedDateTime.now(ZoneOffset.UTC)" +
-                                                    ".truncatedTo( ChronoUnit.SECONDS )" +
-                                                    ".format( DateTimeFormatter.ofPattern( \"yyyy-MM-dd HH:mm:ss\" ) ) )")
-    @Mapping(target = "lastUpdated", expression = "java( ZonedDateTime.now(ZoneOffset.UTC)" +
-                                                        ".truncatedTo( ChronoUnit.SECONDS )" +
-                                                        ".format( DateTimeFormatter.ofPattern( \"yyyy-MM-dd HH:mm:ss\" ) ) )")
+    @Mapping(target = "createdOn", expression = "java(DateTimeUtility.getDateTimeAsString())")
+    @Mapping(target = "lastUpdated", expression = "java(DateTimeUtility.getDateTimeAsString())")
     Category addRequestToCategory(AddCategoryRequest addCategoryRequest);
 
-    @Mapping(target = "lastUpdated", expression = "java( ZonedDateTime.now(ZoneOffset.UTC)" +
-                                                    ".truncatedTo( ChronoUnit.SECONDS )" +
-                                                    ".format( DateTimeFormatter.ofPattern( \"yyyy-MM-dd HH:mm:ss\" ) ) )")
+    @Mapping(target = "lastUpdated", expression = "java(DateTimeUtility.getDateTimeAsString())")
     Category updateRequestToCategory(@MappingTarget Category category, UpdateCategoryRequest updateCategoryRequest);
 
     @Mapping(target = "productIds",
diff --git a/src/main/java/com/answerdigital/answerking/model/Category.java b/src/main/java/com/answerdigital/answerking/model/Category.java
@@ -19,14 +19,12 @@
 import javax.persistence.ManyToMany;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
-import java.time.ZoneOffset;
-import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.temporal.ChronoUnit;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.Set;
 
+import static com.answerdigital.answerking.util.DateTimeUtility.getDateTimeAsString;
+
 @Entity
 @Getter
 @Setter
@@ -68,9 +66,7 @@ public Category(final String name, final String description) {
         this.name = name;
         this.description = description;
         this.retired = false;
-        this.createdOn = ZonedDateTime.now(ZoneOffset.UTC)
-                                      .truncatedTo( ChronoUnit.SECONDS )
-                                      .format( DateTimeFormatter.ofPattern( "yyyy-MM-dd HH:mm::ss" ) );
+        this.createdOn = getDateTimeAsString();
         this.lastUpdated = this.createdOn;
     }
 
diff --git a/src/main/java/com/answerdigital/answerking/util/DateTimeUtility.java b/src/main/java/com/answerdigital/answerking/util/DateTimeUtility.java
@@ -0,0 +1,17 @@
+package com.answerdigital.answerking.util;
+
+import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.temporal.ChronoUnit;
+
+public final class DateTimeUtility {
+
+    private DateTimeUtility() {}
+
+    public static String getDateTimeAsString() {
+        return ZonedDateTime.now(ZoneOffset.UTC)
+                .truncatedTo(ChronoUnit.SECONDS)
+                .format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
+    }
+}
diff --git a/src/test/java/com/answerdigital/answerking/builder/AddCategoryRequestTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/AddCategoryRequestTestBuilder.java
@@ -0,0 +1,23 @@
+package com.answerdigital.answerking.builder;
+
+import com.answerdigital.answerking.request.AddCategoryRequest;
+
+public class AddCategoryRequestTestBuilder {
+
+    private String name = "Burgers";
+    private String description = "A selection of delicious burgers.";
+
+    public AddCategoryRequestTestBuilder withName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public AddCategoryRequestTestBuilder withDescription(String description) {
+        this.description = description;
+        return this;
+    }
+
+    public AddCategoryRequest build() {
+        return new AddCategoryRequest(name, description);
+    }
+}
diff --git a/src/test/java/com/answerdigital/answerking/builder/CategoryTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/CategoryTestBuilder.java
@@ -0,0 +1,67 @@
+package com.answerdigital.answerking.builder;
+
+import com.answerdigital.answerking.model.Category;
+import com.answerdigital.answerking.model.Product;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import static com.answerdigital.answerking.util.DateTimeUtility.getDateTimeAsString;
+
+public class CategoryTestBuilder {
+
+    private Long id = 1L;
+    private String name = "Burgers";
+    private String description = "A selection of delicious burgers.";
+    private String createdOn = getDateTimeAsString();
+    private String lastUpdated = getDateTimeAsString();;
+    private boolean retired = false;
+    private Set<Product> products = new HashSet<>();
+
+    public CategoryTestBuilder withId(Long id) {
+        this.id = id;
+        return this;
+    }
+
+    public CategoryTestBuilder withName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public CategoryTestBuilder withDescription(String description) {
+        this.description = description;
+        return this;
+    }
+
+    public CategoryTestBuilder withCreatedOn(String createdOn) {
+        this.createdOn = createdOn;
+        return this;
+    }
+
+    public CategoryTestBuilder withLastUpdated(String lastUpdated) {
+        this.lastUpdated = lastUpdated;
+        return this;
+    }
+
+    public CategoryTestBuilder withRetired(boolean retired) {
+        this.retired = retired;
+        return this;
+    }
+
+    public CategoryTestBuilder withProducts(Set<Product> products) {
+        this.products = products;
+        return this;
+    }
+
+    // creates a HashSet of one product, to remove boilerplate
+    public CategoryTestBuilder withProduct(Product product) {
+        Set<Product> products = new HashSet<>();
+        products.add(product);
+        this.products = products;
+        return this;
+    }
+
+    public Category build() {
+        return new Category(id, name, description, createdOn, lastUpdated, retired, products);
+    }
+}
diff --git a/src/test/java/com/answerdigital/answerking/builder/ProductTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/ProductTestBuilder.java
@@ -0,0 +1,59 @@
+package com.answerdigital.answerking.builder;
+
+import com.answerdigital.answerking.model.Category;
+import com.answerdigital.answerking.model.LineItem;
+import com.answerdigital.answerking.model.Product;
+
+import java.math.BigDecimal;
+import java.util.HashSet;
+import java.util.Set;
+
+public class ProductTestBuilder {
+
+    private Long id = 1L;
+    private String name = "Cheeseburger";
+    private String description = "A beef patty with cheddar cheese.";
+    private BigDecimal price = BigDecimal.valueOf(5.00D);
+    private boolean retired = false;
+    private Set<Category> categories = new HashSet<>();
+    private Set<LineItem> lineItems = new HashSet<>();
+    
+    public ProductTestBuilder withId(Long id) {
+        this.id = id;
+        return this;
+    }
+
+    public ProductTestBuilder withName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public ProductTestBuilder withDescription(String description) {
+        this.description = description;
+        return this;
+    }
+
+    public ProductTestBuilder withPrice(BigDecimal price) {
+        this.price = price;
+        return this;
+    }
+
+    public ProductTestBuilder withRetired(boolean retired) {
+        this.retired = retired;
+        return this;
+    }
+
+    public ProductTestBuilder withCategories(Set<Category> categories) {
+        this.categories = categories;
+        return this;
+    }
+
+    public ProductTestBuilder withLineItems(Set<LineItem> lineItems) {
+        this.lineItems = lineItems;
+        return this;
+    }
+
+    public Product build() {
+        return new Product(id, name, description, price, retired, categories, lineItems);
+    }
+}
diff --git a/src/test/java/com/answerdigital/answerking/builder/UpdateCategoryRequestTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/UpdateCategoryRequestTestBuilder.java
@@ -0,0 +1,23 @@
+package com.answerdigital.answerking.builder;
+
+import com.answerdigital.answerking.request.UpdateCategoryRequest;
+
+public class UpdateCategoryRequestTestBuilder {
+
+    private String name = "Pizzas";
+    private String description = "Italian style stone baked pizzas.";
+
+    public UpdateCategoryRequestTestBuilder withName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public UpdateCategoryRequestTestBuilder withDescription(String description) {
+        this.description = description;
+        return this;
+    }
+
+    public UpdateCategoryRequest build() {
+        return new UpdateCategoryRequest(name, description);
+    }
+}
diff --git a/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java b/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java
@@ -16,11 +16,7 @@
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 import org.springframework.test.web.servlet.MockMvc;
 
-import java.time.ZoneId;
-import java.time.ZonedDateTime;
-import java.time.format.DateTimeFormatter;
-import java.time.temporal.ChronoUnit;
-
+import static com.answerdigital.answerking.util.DateTimeUtility.getDateTimeAsString;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -67,9 +63,7 @@ void removeProductFromCategoryTest() throws Exception {
     void addCategoryTest() throws Exception {
         ObjectMapper mapper = new ObjectMapper();
 
-        final String testDate = ZonedDateTime.now( ZoneId.of( "Etc/UTC" ) )
-                                             .truncatedTo( ChronoUnit.SECONDS )
-                                             .format( DateTimeFormatter.ofPattern( "yyyy-MM-dd HH:mm:ss" ) );
+        final String testDate = getDateTimeAsString();
         final var addCategoryRequest =  new AddCategoryRequest("random name", "random description");
         final var categoryResponse = CategoryResponse.builder()
                                                      .name(addCategoryRequest.name())
@@ -130,9 +124,7 @@ void updateCategoryTest() throws Exception {
         final var category = new Category(newRandomName, newRandomDesc);
         final var categoryId = 112L;
         final var  updateCategoryRequestJson = "{\"name\": \"random name\",\"description\": \"random description\"}";
-        String testDate = ZonedDateTime.now( ZoneId.of( "Etc/UTC" ) )
-                                       .truncatedTo( ChronoUnit.SECONDS )
-                                       .format( DateTimeFormatter.ofPattern( "yyyy-MM-dd HH:mm:ss" ) );
+        String testDate = getDateTimeAsString();
 
         doReturn(category).when(categoryService).updateCategory(updateCategoryRequest, categoryId);
         final var response = mvc.perform(put("/categories/{categoryId}", categoryId)
diff --git a/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java b/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java
