Merge pull request jmprathab#267 from jucron/issue-255--Payment_test_…

…data

Issue jmprathab#255: Implementation of Payment Test Data

service/src/test/java/com/myhome/services/unit/PaymentSDJpaServiceTest.java

@@ -0,0 +1,196 @@
+package com.myhome.services.unit;
+
+import com.myhome.controllers.dto.PaymentDto;
+import com.myhome.controllers.dto.UserDto;
+import com.myhome.controllers.dto.mapper.PaymentMapper;
+import com.myhome.domain.HouseMember;
+import com.myhome.domain.Payment;
+import com.myhome.domain.User;
+import com.myhome.model.HouseMemberDto;
+import com.myhome.repositories.HouseMemberRepository;
+import com.myhome.repositories.PaymentRepository;
+import com.myhome.repositories.UserRepository;
+import com.myhome.services.springdatajpa.PaymentSDJpaService;
+import helpers.TestUtils;
+import io.jsonwebtoken.lang.Assert;
+import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.Set;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.springframework.data.domain.Example;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+import org.springframework.data.domain.Pageable;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyIterable;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.BDDMockito.given;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+class PaymentSDJpaServiceTest {
+
+  private final BigDecimal TEST_PAYMENT_CHARGE = new BigDecimal(1000);
+  private final String TEST_PAYMENT_TYPE = "test-type";
+  private final String TEST_PAYMENT_DESCRIPTION = "test-description";
+  private final boolean TEST_PAYMENT_RECURRING = true;
+  private final LocalDate TEST_PAYMENT_DUEDATE = LocalDate.now();
+  private final UserDto TEST_PAYMENT_USER = null; //this package is private/inaccessible
+  private final HouseMemberDto TEST_PAYMENT_MEMBER = new HouseMemberDto();
+
+  @Mock
+  private PaymentRepository paymentRepository;
+  @Mock
+  private UserRepository adminRepository;
+  @Mock
+  private PaymentMapper paymentMapper;
+  @Mock
+  private HouseMemberRepository houseMemberRepository;
+  @Captor
+  ArgumentCaptor<Example> exampleCaptor;
+
+  @InjectMocks
+  private PaymentSDJpaService paymentSDJpaService;
+
+  @BeforeEach
+  private void init() {
+    MockitoAnnotations.initMocks(this);
+  }
+
+  @Test
+  void schedulePayment() {
+    //given
+    PaymentDto basePaymentDto = TestUtils.PaymentHelpers.getTestPaymentDto(TEST_PAYMENT_CHARGE,TEST_PAYMENT_TYPE,TEST_PAYMENT_DESCRIPTION,TEST_PAYMENT_RECURRING,TEST_PAYMENT_DUEDATE,TEST_PAYMENT_USER,TEST_PAYMENT_MEMBER);
+    Payment basePayment = new Payment();
+
+    given(paymentMapper.paymentDtoToPayment(any(PaymentDto.class))).willReturn(basePayment);
+    given(paymentMapper.paymentToPaymentDto(any(Payment.class))).willReturn(basePaymentDto);
+
+    //when
+    PaymentDto testPaymentScheduled = paymentSDJpaService.schedulePayment(basePaymentDto);
+
+    //then
+    verify(adminRepository).save(any()); //Logic: User gets associated with payment and persisted
+    verify(paymentRepository).save(any(Payment.class)); //Logic: Payment is persisted
+    Assert.notNull(testPaymentScheduled.getPaymentId()); //Logic: generation of payment ID
+    assertEquals(basePaymentDto,testPaymentScheduled); //Completion: method returns what is expected
+  }
+
+  @Test
+  void getPaymentDetails() {
+    //when
+    PaymentDto basePaymentDto = TestUtils.PaymentHelpers.getTestPaymentDto(TEST_PAYMENT_CHARGE,TEST_PAYMENT_TYPE,TEST_PAYMENT_DESCRIPTION,TEST_PAYMENT_RECURRING,TEST_PAYMENT_DUEDATE,TEST_PAYMENT_USER,TEST_PAYMENT_MEMBER);
+    Optional<PaymentDto> optionalOfTestPaymentDto = Optional.of(basePaymentDto);
+    Payment basePayment = new Payment();
+
+    given(paymentRepository.findByPaymentId(anyString())).willReturn(Optional.of(basePayment));
+    given(paymentMapper.paymentToPaymentDto(any(Payment.class))).willReturn(basePaymentDto);
+
+    //when
+    Optional<PaymentDto> testPaymentDetails = paymentSDJpaService.getPaymentDetails("any-id");
+
+    //then
+    verify(paymentRepository).findByPaymentId(anyString()); //Logic: fetching data
+    assertTrue(testPaymentDetails.isPresent()); //Logic: element is present
+    assertEquals(optionalOfTestPaymentDto,testPaymentDetails); //Completion: method returns what is expected
+  }
+
+  @Test
+  void getHouseMember() {
+    //given
+    HouseMember baseHouseMember = TestUtils.HouseMemberHelpers.getTestHouseMember();
+    Optional<HouseMember> baseHouseMemberOptional = Optional.of(baseHouseMember);
+
+    given(houseMemberRepository.findByMemberId(anyString())).willReturn(
+        Optional.of(baseHouseMember));
+
+    //when
+    Optional<HouseMember> testHouseMember = paymentSDJpaService.getHouseMember("any-id");
+
+    //then
+    verify(houseMemberRepository).findByMemberId(anyString()); //Logic: fetching data
+    assertTrue(testHouseMember.isPresent()); //Completion: element is present
+    assertEquals(baseHouseMemberOptional,testHouseMember); //Completion: method returns what is expected
+  }
+
+  @Test
+  void getPaymentsByMember() {
+    //given
+    String memberId1 = "memberId-test-1";
+    String memberId2 = "memberId-test-2";
+    Payment paymentExample1 = TestUtils.PaymentHelpers.getTestPaymentNullFields();
+    paymentExample1.setMember(new HouseMember().withMemberId(memberId1));
+    Payment paymentExample2 = TestUtils.PaymentHelpers.getTestPaymentNullFields();
+    paymentExample2.setMember(new HouseMember().withMemberId(memberId2));
+
+    Set<Payment> expectedReturn1 = new HashSet<>(); expectedReturn1.add(paymentExample1);
+    given(paymentRepository.findAll(any(Example.class))).willReturn(Collections.singletonList((paymentExample1)));
+
+    //when
+    Set<Payment> testPaymentByMember1 = paymentSDJpaService.getPaymentsByMember(memberId1);
+    verify(paymentRepository).findAll(exampleCaptor.capture()); //verify and capture first execution
+    Example<Payment> capturedParameter1 = exampleCaptor.getValue(); //Capturing the 'paymentExample' created by the method
+    Payment capturedPaymentExample1 = capturedParameter1.getProbe();
+
+    Set<Payment> testPaymentByMember2 = paymentSDJpaService.getPaymentsByMember(memberId2);
+    verify(paymentRepository,times(2)).findAll(exampleCaptor.capture()); //verify and capture second execution
+    Example<Payment> capturedParameter2 = exampleCaptor.getValue(); // Capturing the 'paymentExample' created by the method
+    Payment capturedPaymentExample2 = capturedParameter2.getProbe();
+
+    //then
+    verify(paymentRepository,times(2)).findAll(any(Example.class)); //Logic: two executions of method
+    assertEquals(memberId1,capturedPaymentExample1.getMember().getMemberId()); //Logic: memberId from captured element is the same passed on as parameter in method
+    assertEquals(memberId2,capturedPaymentExample2.getMember().getMemberId()); //Logic: memberId from captured element is the same passed on as parameter in method
+    assertEquals(paymentExample1,capturedPaymentExample1); //Logic: fields in captured element should be as expected
+    assertEquals(paymentExample2,capturedPaymentExample2); //Logic: fields in captured element should be as expected
+    assertEquals(expectedReturn1,testPaymentByMember1); //Completion: method returns what is expected
+  }
+
+  @Test
+  void getPaymentsByAdmin() {
+    //given
+    String userId1 = "userId-test-1";
+    String userId2 = "userId-test-2";
+    Payment paymentExample1 = TestUtils.PaymentHelpers.getTestPaymentNullFields();
+    paymentExample1.setAdmin(new User().withUserId(userId1));
+    Payment paymentExample2 = TestUtils.PaymentHelpers.getTestPaymentNullFields();
+    paymentExample2.setAdmin(new User().withUserId(userId2));
+
+    Pageable pageable = Mockito.mock(Pageable.class);
+
+    Page<Payment> expectedReturn1 = new PageImpl<Payment>(Collections.singletonList(paymentExample1));
+    given(paymentRepository.findAll(any(Example.class),any(Pageable.class))).willReturn(expectedReturn1);
+
+    //when
+    Page<Payment> testPaymentByAdmin1 = paymentSDJpaService.getPaymentsByAdmin(userId1,pageable);
+    verify(paymentRepository).findAll((Example<Payment>) exampleCaptor.capture(), any(Pageable.class)); //verify and capture first execution
+    Example<Payment> capturedParameter1 = exampleCaptor.getValue(); //Capturing the 'paymentExample' created by method
+    Payment capturedPaymentExample1 = capturedParameter1.getProbe();
+
+    Page<Payment> testPaymentByAdmin2 = paymentSDJpaService.getPaymentsByAdmin(userId2,pageable);
+    verify(paymentRepository,times(2)).findAll((Example<Payment>) exampleCaptor.capture(), any(Pageable.class)); //verify and capture first execution
+    Example<Payment> capturedParameter2 = exampleCaptor.getValue(); // Capturing the 'paymentExample' created by method
+    Payment capturedPaymentExample2 = capturedParameter2.getProbe();
+
+    //then
+    verify(paymentRepository,times(2)).findAll(any(Example.class),any(Pageable.class)); //Logic: two executions of method
+    assertEquals(userId1,capturedPaymentExample1.getAdmin().getUserId()); //Logic: userId from captured element is the same passed on as parameter in method
+    assertEquals(userId2,capturedPaymentExample2.getAdmin().getUserId()); //Logic: userId from captured element is the same passed on as parameter in method
+    assertEquals(paymentExample1,capturedPaymentExample1); //Logic: fields in captured element should be as expected
+    assertEquals(paymentExample2,capturedPaymentExample2); //Logic: fields in captured element should be as expected
+    assertEquals(expectedReturn1,testPaymentByAdmin1); //Completion: method returns what is expected
+  }
+}

service/src/test/java/helpers/TestUtils.java

@@ -3,25 +3,31 @@
 import com.myhome.configuration.properties.mail.EmailTemplateLocalizationProperties;
 import com.myhome.configuration.properties.mail.EmailTemplateProperties;
 import com.myhome.configuration.properties.mail.MailProperties;
+import com.myhome.controllers.dto.PaymentDto;
+import com.myhome.controllers.dto.UserDto;
 import com.myhome.domain.Amenity;
 import com.myhome.domain.Community;
 import com.myhome.domain.CommunityHouse;
 import com.myhome.domain.HouseMember;
+import com.myhome.domain.Payment;
 import com.myhome.domain.User;
-
-import javax.imageio.ImageIO;
+import com.myhome.model.HouseMemberDto;
 import java.awt.image.BufferedImage;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.math.BigDecimal;
+import java.time.LocalDate;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import javax.imageio.ImageIO;
 
-import static helpers.TestUtils.General.generateUniqueId;
 import static helpers.TestUtils.CommunityHouseHelpers.getTestHouses;
+import static helpers.TestUtils.General.generateUniqueId;
 import static helpers.TestUtils.UserHelpers.getTestUsers;
 
 public class TestUtils {
@@ -77,6 +83,11 @@ public static Set<HouseMember> getTestHouseMembers(int count) {
           .limit(count)
           .collect(Collectors.toSet());
     }
+    public static HouseMember getTestHouseMember() {
+      return new HouseMember()
+              .withMemberId(generateUniqueId())
+              .withName("default-house-member-name");
+    }
   }
 
   public static class CommunityHelpers {
@@ -200,5 +211,31 @@ public static EmailTemplateLocalizationProperties getTestLocalizationMailPropert
     }
   }
 
-
+  public static class PaymentHelpers {
+
+    public static PaymentDto getTestPaymentDto(BigDecimal charge, String type, String description, boolean recurring, LocalDate dueDate, UserDto admin, HouseMemberDto member) {
+
+      return PaymentDto.builder()
+          .charge(charge)
+          .type(type)
+          .description(description)
+          .recurring(recurring)
+          .dueDate(dueDate.toString())
+          .admin(admin)
+          .member(member)
+          .build();
+    }
+    public static Payment getTestPaymentNullFields() {
+      //Only 'recurring' field will be not null, but false
+      return new Payment(
+          null,
+          null,
+          null,
+          null,
+          false,
+          null,
+          null,
+          null);
+    }
+  }
 }