spring-jpa: added custom exception & HQuery

Author: MarioCodes

spring/spring-data-jpa/app/src/main/java/es/msanchez/frameworks/java/spring/boot/dao/PersonDao.java

@@ -1,6 +1,17 @@
 package es.msanchez.frameworks.java.spring.boot.dao;
 
 import es.msanchez.frameworks.java.spring.boot.entity.Person;
+import org.springframework.data.jpa.repository.Query;
+import org.springframework.data.repository.query.Param;
+
+import java.util.List;
+import java.util.Optional;
 
 public interface PersonDao extends RawDao<Person> {
+
+    @Query("SELECT p FROM Person p WHERE p.name = :name")
+    Optional<Person> findOneByName(@Param("name") final String name);
+
+    List<Person> findAllByAge(final Integer age);
+
 }

spring/spring-data-jpa/app/src/main/java/es/msanchez/frameworks/java/spring/boot/exception/DataTransferException.java

@@ -0,0 +1,16 @@
+package es.msanchez.frameworks.java.spring.boot.exception;
+
+public class DataTransferException extends RuntimeException {
+
+    private static final long serialVersionUID = 967831159289792636L;
+
+    public DataTransferException(final String message) {
+        super(message);
+    }
+
+    public DataTransferException(final String message,
+                                 final Throwable cause) {
+        super(message, cause);
+    }
+
+}

spring/spring-data-jpa/app/src/main/java/es/msanchez/frameworks/java/spring/boot/rest/PersonRestResource.java

@@ -1,11 +1,12 @@
 package es.msanchez.frameworks.java.spring.boot.rest;
 
-import es.msanchez.frameworks.java.spring.boot.dao.PersonDao;
 import es.msanchez.frameworks.java.spring.boot.entity.Person;
+import es.msanchez.frameworks.java.spring.boot.exception.DataTransferException;
+import es.msanchez.frameworks.java.spring.boot.service.PersonService;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
@@ -14,21 +15,28 @@
 @RequestMapping("/person")
 public class PersonRestResource {
 
-    private final PersonDao personDao;
+    private final PersonService personService;
 
     @Autowired
-    public PersonRestResource(final PersonDao personDao) {
-        this.personDao = personDao;
+    public PersonRestResource(final PersonService personService) {
+        this.personService = personService;
     }
 
-    @PutMapping("create/{name}")
-    public String createPerson(@PathVariable("name") final String name) {
-        log.info("create person called w. name '{}'", name);
+    @GetMapping("create/{name}")
+    public void createPerson(@PathVariable("name") final String name) {
+        if (!this.personService.isValid(name)) {
+            log.error("The given name '{}' is not valid", name);
+            throw new DataTransferException("Tried to create a person with a wrong name.");
+        }
+
+        this.personService.save(this.create(name));
+        log.info("created person with name '{}'", name);
+    }
+
+    private Person create(final String name) {
         final Person person = new Person();
         person.setName(name);
-
-        this.personDao.save(person);
-        return "created";
+        return person;
     }
 
 }

spring/spring-data-jpa/app/src/main/java/es/msanchez/frameworks/java/spring/boot/service/PersonService.java

@@ -0,0 +1,29 @@
+package es.msanchez.frameworks.java.spring.boot.service;
+
+import es.msanchez.frameworks.java.spring.boot.dao.PersonDao;
+import es.msanchez.frameworks.java.spring.boot.entity.Person;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+
+import java.util.Optional;
+
+@Slf4j
+@Component
+public class PersonService {
+
+    private final PersonDao personDao;
+
+    public PersonService(final PersonDao personDao) {
+        this.personDao = personDao;
+    }
+
+    public boolean isValid(final String name) {
+        final Optional<Person> exists = this.personDao.findOneByName(name);
+        return !exists.isPresent();
+    }
+
+    public void save(final Person person) {
+        this.personDao.save(person);
+    }
+
+}

spring/spring-data-jpa/app/src/test/java/es/msanchez/frameworks/java/spring/boot/rest/PersonRestResourceTest.java

@@ -0,0 +1,61 @@
+package es.msanchez.frameworks.java.spring.boot.rest;
+
+import com.googlecode.catchexception.apis.BDDCatchException;
+import es.msanchez.frameworks.java.spring.boot.entity.Person;
+import es.msanchez.frameworks.java.spring.boot.exception.DataTransferException;
+import es.msanchez.frameworks.java.spring.boot.service.PersonService;
+import org.assertj.core.api.BDDAssertions;
+import org.mockito.BDDMockito;
+import org.mockito.Mockito;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+public class PersonRestResourceTest {
+
+    private PersonRestResource restResource;
+
+    private PersonService serviceMock;
+
+    @BeforeMethod
+    public void setUp() {
+        this.serviceMock = Mockito.mock(PersonService.class);
+
+        this.restResource = new PersonRestResource(this.serviceMock);
+    }
+
+    @Test
+    public void testCreatePerson() {
+        // @GIVEN
+        final String name = "mario";
+
+        final boolean isValid = true;
+        BDDMockito.given(this.serviceMock.isValid(name))
+                .willReturn(isValid);
+
+        // @WHEN
+        this.restResource.createPerson(name);
+
+        // @THEN
+        BDDMockito.verify(this.serviceMock).isValid(name);
+        BDDMockito.verify(this.serviceMock).save(Mockito.any(Person.class));
+    }
+
+    @Test
+    public void testCreatePersonCaseNameNotValid() {
+        // @GIVEN
+        final String name = "mario";
+
+        final boolean isValid = false;
+        BDDMockito.given(this.serviceMock.isValid(name))
+                .willReturn(isValid);
+
+        // @WHEN
+        BDDCatchException.when(this.restResource).createPerson(name);
+
+        // @THEN
+        BDDMockito.verify(this.serviceMock).isValid(name);
+        BDDMockito.verify(this.serviceMock, Mockito.never()).save(Mockito.any(Person.class));
+        BDDAssertions.assertThat(BDDCatchException.caughtException())
+                .isInstanceOf(DataTransferException.class);
+    }
+}

spring/spring-data-jpa/app/src/test/java/es/msanchez/frameworks/java/spring/boot/service/PersonServiceTest.java

@@ -0,0 +1,70 @@
+package es.msanchez.frameworks.java.spring.boot.service;
+
+import es.msanchez.frameworks.java.spring.boot.dao.PersonDao;
+import es.msanchez.frameworks.java.spring.boot.entity.Person;
+import org.assertj.core.api.BDDAssertions;
+import org.mockito.BDDMockito;
+import org.mockito.Mockito;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+
+import java.util.Optional;
+
+public class PersonServiceTest {
+
+    private PersonService service;
+
+    private PersonDao daoMock;
+
+    @BeforeMethod
+    public void setUp() {
+        this.daoMock = Mockito.mock(PersonDao.class);
+
+        this.service = new PersonService(this.daoMock);
+    }
+
+    @Test
+    public void testIsValidName() {
+        // @GIVEN
+        final String name = "mario";
+
+        BDDMockito.given(this.daoMock.findOneByName(name))
+                .willReturn(Optional.empty());
+
+        // @WHEN
+        final boolean isValid = this.service.isValid(name);
+
+        // @THEN
+        BDDMockito.verify(this.daoMock).findOneByName(name);
+        BDDAssertions.assertThat(isValid).isTrue();
+    }
+
+    @Test
+    public void testIsValidNameCaseFalse() {
+        // @GIVEN
+        final String name = "mario";
+
+        BDDMockito.given(this.daoMock.findOneByName(name))
+                .willReturn(Optional.of(new Person()));
+
+        // @WHEN
+        final boolean isValid = this.service.isValid(name);
+
+        // @THEN
+        BDDMockito.verify(this.daoMock).findOneByName(name);
+        BDDAssertions.assertThat(isValid).isFalse();
+    }
+
+    @Test
+    public void testSave() {
+        // @GIVEN
+        final Person person = new Person();
+        person.setName("mario");
+
+        // @WHEN
+        this.service.save(person);
+
+        // @THEN
+        BDDMockito.verify(this.daoMock).save(person);
+    }
+}