Added some Unit & Integration tests...

Author: sean-huni

README.md

@@ -1,34 +1,32 @@
-# mytaxi backend applicant test
+# MyTaxiAPI
 
-## Task Description
-You should be able to start the example application by executing com.mytaxi.MytaxiServerApplicantTestApplication, which starts a webserver on port 8080 (http://localhost:8080) and serves SwaggerUI where can inspect and try existing endpoints.
+## Description
+MyTaxiApi, which starts a webserver on port 8080 (http://localhost:8080) and serves SwaggerUI where can inspect and try existing endpoints.
 
 The project is based on a small web service which uses the following technologies:
 
 * Java 1.8
 * Spring MVC with Spring Boot
 * Database H2 (In-Memory)
 * Maven
-* Intellij as IDE is preferred but not mandatory. We do provide code formatter for intellij and eclipse in the etc folder.
+* Intellij as IDE is preferred but not mandatory.
 
 
-You should be aware of the following conventions while you are working on this exercise:
+NOTE:
 
  * All new entities should have an ID with type of Long and a date_created with type of ZonedDateTime.
  * The architecture of the web service is built with the following components:
- 	* DataTransferObjects: Objects which are used for outside communication via the API
+   * DataTransferObjects: Objects which are used for outside communication via the API
    * Controller: Implements the processing logic of the web service, parsing of parameters and validation of in- and outputs.
    * Service: Implements the business logic and handles the access to the DataAccessObjects.
    * DataAccessObjects: Interface for the database. Inserts, updates, deletes and reads objects from the database.
    * DomainObjects: Functional Objects which might be persisted in the database.
- * TestDrivenDevelopment is a good choice, but it's up to you how you are testing your code.
-
-You should commit into your local git repository and include the commit history into the final result.
+ * TDD/BDD are good choices.
 
 ---
 
 
-## Task 1
+## Objective 1
  * Write a new Controller for maintaining cars (CRUD).
    * Decide on your own how the methods should look like.
    * Entity Car: Should have at least the following characteristics: license_plate, seat_count, convertible, averageRating, engine_type (electric, gas, ...)
@@ -41,13 +39,13 @@ You should commit into your local git repository and include the commit history
 ---
 
 
-## Task 2
+## Objective 2
 First come first serve: A car can be selected by exactly one ONLINE Driver. If a second driver tries to select a already used car you should throw a CarAlreadyInUseException.
 
 ---
 
 
-## Task 3
+## Objective 3
 Imagine a driver management frontend that is used internally by mytaxi employees to create and edit driver related data. For a new search functionality, we need an endpoint to search for drivers. It should be possible to search for drivers by their attributes (username, online_status) as well as car characteristics (license plate, averageRating, etc).
 
 * implement a new endpoint for searching or extend an existing one
@@ -57,18 +55,9 @@ Imagine a driver management frontend that is used internally by mytaxi employees
 ---
 
 
-## Task 4 (optional)
-This task is _voluntarily_, if you can't get enough of hacking tech challenges, implement security.
-Secure the API so that authentication is needed to access it. The details are up to you.
-
-Please include instructions how to authenticate/login, so that we can test the endpoints you implemented!
+## Objective 4
+The API is secured (with Spring Security) such that authentication is needed to access it.
 
 ---
 
-
-Good luck!
-❤️ mytaxi
-
-
-
-_NOTE: Please make sure to not submit any personal data with your tests result. Personal data is for example your name, your birth date, email address etc._
+❤️ MyTaxiAPI

pom.xml

@@ -29,6 +29,7 @@
         <java.version>1.8</java.version>
         <io.springfox.springfox.version>2.8.0</io.springfox.springfox.version>
         <org.springframework.security.version>5.0.5.RELEASE</org.springframework.security.version>
+        <junit.jupiter.version>5.3.1</junit.jupiter.version>
     </properties>
 
     <dependencies>
@@ -81,6 +82,32 @@
             <artifactId>jaxb-api</artifactId>
             <version>2.2.11</version>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+            <version>2.8.5</version>
+        </dependency>
+
     </dependencies>
 
     <build>
@@ -91,6 +118,4 @@
             </plugin>
         </plugins>
     </build>
-
-
 </project>

src/main/java/com/mytaxi/MytaxiServerApplicantTestApplication.java src/main/java/com/mytaxi/MyTaxiApiApp.java

@@ -24,10 +24,10 @@
  */
 @EnableSwagger2
 @SpringBootApplication
-public class MytaxiServerApplicantTestApplication extends WebMvcConfigurerAdapter {
+public class MyTaxiApiApp extends WebMvcConfigurerAdapter {
 
     public static void main(String[] args) {
-        SpringApplication.run(MytaxiServerApplicantTestApplication.class, args);
+        SpringApplication.run(MyTaxiApiApp.class, args);
     }
 
 

src/main/java/com/mytaxi/aop/security/LoginAttempts.java

@@ -43,7 +43,7 @@ public void logBefore(Authentication authentication) {
 
     @AfterReturning(value = "com.mytaxi.aop.security.LoginAttempts.doAuthenticate()", returning = "authentication")
     public void logAfter(Authentication authentication) {
-        String username = (String) authentication.getPrincipal();
+        String username = String.valueOf(authentication.getPrincipal());
 
         if (authentication.isAuthenticated()) {
             loginAttemptService.loginSucceeded(username);

src/main/java/com/mytaxi/config/WebSecurityConfig.java

@@ -81,7 +81,7 @@ protected void configure(HttpSecurity httpSecurity) throws Exception {
                 .and()
                 .logout()
                 .logoutUrl(URL_LOGOUT)
-                .logoutSuccessUrl("/login")
+                .logoutSuccessUrl("/")
                 .deleteCookies(COOKIES_SESSION).clearAuthentication(true)
                 .and()
                 .rememberMe().rememberMeCookieName(COOKIE_REMEMBER_ME).tokenValiditySeconds(1200)

src/main/java/com/mytaxi/controller/CarController.java

@@ -1,17 +1,18 @@
 package com.mytaxi.controller;
 
 import com.mytaxi.datatransferobject.CarDTO;
+import com.mytaxi.datatransferobject.SelectDTO;
 import com.mytaxi.domainvalue.CarStatus;
-import com.mytaxi.domainvalue.Selection;
 import com.mytaxi.exception.*;
-import com.mytaxi.service.persistence.car.CarService;
+import com.mytaxi.service.car.CarService;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.web.bind.annotation.*;
 
+import javax.validation.Valid;
 import java.util.List;
 
 /**
@@ -37,7 +38,7 @@ public CarController(final CarService carService) {
 
     @GetMapping
     public List<CarDTO> findCarsByStatus(@RequestParam(required = false) CarStatus carStatus) throws EntityNotFoundException {
-        LOGGER.info("findCarsByStatus: " + carStatus);
+        LOGGER.debug("findCarsByStatus: {}", carStatus);
         if (null == carStatus) {
             return carService.findAllCars();
         }
@@ -46,24 +47,27 @@ public List<CarDTO> findCarsByStatus(@RequestParam(required = false) CarStatus c
 
     @GetMapping("/{licenceNo}")
     public CarDTO findCarByLicenceNo(@PathVariable String licenceNo) throws EntityNotFoundException {
+        LOGGER.debug("licenceNo: {}", licenceNo);
         return carService.findCarByLicenceNo(licenceNo);
     }
 
-    @PutMapping("/select/{licenceNo}/{driverId}")
+    @PutMapping("/select")
     @ResponseStatus(HttpStatus.CREATED)
-    public void toggleCarByLicenceNo(@PathVariable Long driverId,
-                                     @RequestParam Selection selection,
-                                     @PathVariable String licenceNo) throws EntityNotFoundException,
-            CarAlreadyInUseException, CarAlreadySelectedException, CarAlreadyDeselectedException, DriverNotOnlineException, CarUnavailableException, DeselectionNotAllowedException, NoCarSelectionException {
-        carService.toggleCar(driverId, licenceNo, selection);
+    public void toggleCarByLicenceNo(@RequestBody @Valid SelectDTO selectDTO) throws EntityNotFoundException,
+            CarAlreadyInUseException, CarAlreadySelectedException, CarAlreadyDeselectedException,
+            DriverNotOnlineException, CarUnavailableException, DeselectionNotAllowedException, NoCarSelectionException {
+        LOGGER.debug("Updating toggleCarByLicenceNo >>> \ndriverId: {} \nlicenceNo: {} \nselectionState: {}",
+                selectDTO.getDriverId(), selectDTO.getLicenceNo(), selectDTO.getSelectionState());
+        carService.toggleCar(selectDTO.getDriverId(), selectDTO.getLicenceNo(), selectDTO.getSelectionState());
     }
 
 
     @GetMapping("/find-cars")
-    public List<CarDTO> carDTOList(@RequestParam String licenceNo,
-                                   @RequestParam String make,
-                                   @RequestParam String model,
-                                   @RequestParam Integer seatCount) {
+    public List<CarDTO> carDTOList(@RequestParam(required = false) String licenceNo,
+                                   @RequestParam(required = false) String make,
+                                   @RequestParam(required = false) String model,
+                                   @RequestParam(required = false) Integer seatCount) {
+        LOGGER.debug("toggleCarByLicenceNo >>> \nlicenceNo: {} \nmake: {} \nmodel: {} \nseatCount: {}", licenceNo, make, model, seatCount);
         return carService.findCarCharacteristics(licenceNo, make, model, seatCount);
     }
 

src/main/java/com/mytaxi/controller/DriverController.java

@@ -6,7 +6,7 @@
 import com.mytaxi.domainvalue.OnlineStatus;
 import com.mytaxi.exception.ConstraintsViolationException;
 import com.mytaxi.exception.EntityNotFoundException;
-import com.mytaxi.service.persistence.driver.DriverService;
+import com.mytaxi.service.driver.DriverService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.access.prepost.PreAuthorize;

src/main/java/com/mytaxi/controller/ErrorPageCtrl.java

@@ -1,10 +1,15 @@
 package com.mytaxi.controller;
 
+import javassist.NotFoundException;
 import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.http.HttpStatus;
 import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.servlet.ModelAndView;
+import springfox.documentation.annotations.ApiIgnore;
 
 /**
  * PROJECT   : server-applicant-test-18
@@ -15,11 +20,13 @@
  * E-MAIL    : kudzai@bcs.org
  * CELL      : +27-64-906-8809
  */
-
+@ApiIgnore
 @Controller
 public class ErrorPageCtrl implements ErrorController {
     private static final String ERROR_PATH = "/error";
 
+    @ExceptionHandler(NotFoundException.class)
+    @ResponseStatus(HttpStatus.NOT_FOUND)
     @GetMapping(value = ERROR_PATH)
     public @ResponseBody
     ModelAndView handleError() {

src/main/java/com/mytaxi/datatransferobject/SelectDTO.java

@@ -0,0 +1,61 @@
+package com.mytaxi.datatransferobject;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.mytaxi.domainvalue.SelectionState;
+
+import javax.validation.constraints.NotNull;
+
+/**
+ * PROJECT   : server-applicant-test-18
+ * PACKAGE   : com.mytaxi.datatransferobject
+ * USER      : sean
+ * DATE      : 12-Fri-Oct-2018
+ * TIME      : 22:27
+ * E-MAIL    : kudzai@bcs.org
+ * CELL      : +27-64-906-8809
+ */
+@JsonInclude(JsonInclude.Include.NON_NULL)
+//@JsonDeserialize(as = SelectDTO.class)
+public class SelectDTO {
+
+    @NotNull(message = "Driver-ID can not be null!")
+    private Long driverId;
+    @NotNull(message = "Selection-State can not be null!")
+    private SelectionState selectionState;
+    @NotNull(message = "Licence-No can not be null!")
+    private String licenceNo;
+
+    public SelectDTO() {
+        super();
+    }
+
+    public SelectDTO(@NotNull(message = "Driver-ID can not be null!") Long driverId, @NotNull(message = "Selection-State can not be null!") SelectionState selectionState, @NotNull(message = "Licence-No can not be null!") String licenceNo) {
+        this.driverId = driverId;
+        this.selectionState = selectionState;
+        this.licenceNo = licenceNo;
+    }
+
+    public Long getDriverId() {
+        return driverId;
+    }
+
+    public void setDriverId(Long driverId) {
+        this.driverId = driverId;
+    }
+
+    public SelectionState getSelectionState() {
+        return selectionState;
+    }
+
+    public void setSelectionState(SelectionState selectionState) {
+        this.selectionState = selectionState;
+    }
+
+    public String getLicenceNo() {
+        return licenceNo;
+    }
+
+    public void setLicenceNo(String licenceNo) {
+        this.licenceNo = licenceNo;
+    }
+}

src/main/java/com/mytaxi/domainvalue/Selection.java src/main/java/com/mytaxi/domainvalue/SelectionState.java

@@ -9,6 +9,6 @@
  * E-MAIL    : kudzai@bcs.org
  * CELL      : +27-64-906-8809
  */
-public enum Selection {
+public enum SelectionState {
     SELECT, DESELECT
 }

src/main/java/com/mytaxi/engine/CarSelection.java

@@ -0,0 +1,21 @@
+package com.mytaxi.engine;
+
+import com.mytaxi.domainobject.DriverDO;
+import com.mytaxi.domainobject.car.CarStateDO;
+import com.mytaxi.exception.*;
+
+/**
+ * PROJECT   : server-applicant-test-18
+ * PACKAGE   : com.mytaxi.engine
+ * USER      : sean
+ * DATE      : 12-Fri-Oct-2018
+ * TIME      : 13:24
+ * E-MAIL    : kudzai@bcs.org
+ * CELL      : +27-64-906-8809
+ */
+public interface CarSelection {
+    void selectCar(DriverDO driverDO, CarStateDO carStateDO) throws CarAlreadySelectedException, CarAlreadyInUseException,
+            DriverNotOnlineException, CarUnavailableException, NoCarSelectionException;
+
+    void deselectCar(DriverDO driverDO, CarStateDO carStateDO) throws DeselectionNotAllowedException;
+}

src/main/java/com/mytaxi/engine/CarSelectionRules.java

@@ -0,0 +1,19 @@
+package com.mytaxi.engine;
+
+import com.mytaxi.domainobject.DriverDO;
+import com.mytaxi.domainobject.car.CarStateDO;
+import com.mytaxi.exception.*;
+
+/**
+ * PROJECT   : server-applicant-test-18
+ * PACKAGE   : com.mytaxi.engine
+ * USER      : sean
+ * DATE      : 12-Fri-Oct-2018
+ * TIME      : 13:23
+ * E-MAIL    : kudzai@bcs.org
+ * CELL      : +27-64-906-8809
+ */
+public interface CarSelectionRules {
+    void validateCarSelectionRules(DriverDO driverDO, CarStateDO carStateDO) throws CarAlreadySelectedException, CarAlreadyInUseException,
+            DriverNotOnlineException, CarUnavailableException, NoCarSelectionException;
+}