service/src/test/java/org/apache/fineract/cn/customer/TestIdentificationCards.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.fineract.cn.customer;

import org.apache.commons.lang3.RandomStringUtils;
import org.apache.fineract.cn.customer.api.v1.CustomerEventConstants;
import org.apache.fineract.cn.customer.api.v1.client.IdentificationCardNotFoundException;
import org.apache.fineract.cn.customer.api.v1.client.ScanAlreadyExistsException;
import org.apache.fineract.cn.customer.api.v1.client.ScanNotFoundException;
import org.apache.fineract.cn.customer.api.v1.domain.Customer;
import org.apache.fineract.cn.customer.api.v1.domain.IdentificationCard;
import org.apache.fineract.cn.customer.api.v1.domain.IdentificationCardScan;
import org.apache.fineract.cn.customer.api.v1.events.ScanEvent;
import org.apache.fineract.cn.customer.util.CustomerGenerator;
import org.apache.fineract.cn.customer.util.IdentificationCardGenerator;
import org.apache.fineract.cn.customer.util.ScanGenerator;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.restdocs.JUnitRestDocumentation;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import java.util.List;
import java.util.stream.Stream;

import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.documentationConfiguration;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.delete;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.get;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.post;
import static org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.put;
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessRequest;
import static org.springframework.restdocs.operation.preprocess.Preprocessors.preprocessResponse;
import static org.springframework.restdocs.operation.preprocess.Preprocessors.prettyPrint;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

public class TestIdentificationCards extends AbstractCustomerTest {

  @Rule
  public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation("src/doc/generated-snippets/test-identification-cards");

  @Autowired
  private WebApplicationContext context;

  private MockMvc mockMvc;

  final String path = "/customer/v1";

  @Before
  public void setUp(){

    this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context)
            .apply(documentationConfiguration(this.restDocumentation))
            .alwaysDo(document("{method-name}", preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint())))
            .build();
  }

  @Test
  public void shouldFetchIdentificationCards() throws Exception {
    final String customerIdentifier = this.createCustomer();

    Stream.of(
            IdentificationCardGenerator.createRandomIdentificationCard(),
            IdentificationCardGenerator.createRandomIdentificationCard(),
            IdentificationCardGenerator.createRandomIdentificationCard()
    ).forEach(identificationCard -> {
      this.customerManager.createIdentificationCard(customerIdentifier, identificationCard);
      try {
        this.eventRecorder.wait(CustomerEventConstants.POST_IDENTIFICATION_CARD, identificationCard.getNumber());
      } catch (final InterruptedException ex) {
        Assert.fail(ex.getMessage());
      }
    });

    final List<IdentificationCard> result = this.customerManager.fetchIdentificationCards(customerIdentifier);

    Assert.assertTrue(result.size() == 3);

    try
    {
      this.mockMvc.perform(get(path + "/customers/" + customerIdentifier + "/identifications")
              .accept(MediaType.ALL))
              .andExpect(status().isNotFound());
    } catch (Exception exception){ exception.printStackTrace(); }
  }

  @Test
  public void shouldCreateIdentificationCard() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    final IdentificationCard identificationCard = this.customerManager.findIdentificationCard(customerIdentifier, identificationCardNumber);

    Assert.assertNotNull(identificationCard);

    Assert.assertEquals(identificationCard.getCreatedBy(), TEST_USER);

    this.mockMvc.perform(post(path + "/customers/" + customerIdentifier + "/identifications")
            .contentType(MediaType.APPLICATION_JSON_VALUE)
            .accept(MediaType.APPLICATION_JSON_VALUE))
            .andExpect(status().is4xxClientError());
  }

  @Test
  public void shouldUpdateIdentificationCard() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    final IdentificationCard identificationCard = this.customerManager.findIdentificationCard(customerIdentifier, identificationCardNumber);

    final IdentificationCard updatedIdentificationCard = IdentificationCardGenerator.createRandomIdentificationCard();

    updatedIdentificationCard.setNumber(identificationCardNumber);

    this.customerManager.updateIdentificationCard(customerIdentifier, updatedIdentificationCard.getNumber(), updatedIdentificationCard);

    this.eventRecorder.wait(CustomerEventConstants.PUT_IDENTIFICATION_CARD, updatedIdentificationCard.getNumber());

    final IdentificationCard changedIdentificationCard = this.customerManager.findIdentificationCard(customerIdentifier, identificationCard.getNumber());

    Assert.assertEquals(updatedIdentificationCard.getType(), changedIdentificationCard.getType());
    Assert.assertEquals(updatedIdentificationCard.getIssuer(), changedIdentificationCard.getIssuer());
    Assert.assertEquals(updatedIdentificationCard.getNumber(), changedIdentificationCard.getNumber());
    Assert.assertEquals(TEST_USER, changedIdentificationCard.getLastModifiedBy());

    this.mockMvc.perform(put(path + "/customers/" + customerIdentifier
            + "/identifications/" + identificationCardNumber ).accept(MediaType.APPLICATION_JSON_VALUE)
            .contentType(MediaType.APPLICATION_JSON_VALUE))
            .andExpect(status().is4xxClientError());
  }

  @Test(expected = IdentificationCardNotFoundException.class)
  public void shouldDeleteIdentificationCard() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    this.customerManager.deleteIdentificationCard(customerIdentifier, identificationCardNumber);

    this.eventRecorder.wait(CustomerEventConstants.DELETE_IDENTIFICATION_CARD, identificationCardNumber);

    this.customerManager.findIdentificationCard(customerIdentifier, identificationCardNumber);

    this.mockMvc.perform(delete(path + "/customers/" + customerIdentifier
            + "/identifications/" + identificationCardNumber)
            .contentType(MediaType.IMAGE_PNG_VALUE)
            .accept(MediaType.ALL_VALUE))
            .andExpect(status().isAccepted());
  }

  @Test(expected = IdentificationCardNotFoundException.class)
  public void shouldDeleteIdentificationCardWithScan() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    IdentificationCardScan scanIdentifier = this.createScan(customerIdentifier, identificationCardNumber);

    this.customerManager.deleteIdentificationCard(customerIdentifier, identificationCardNumber);

    this.eventRecorder.wait(CustomerEventConstants.DELETE_IDENTIFICATION_CARD, identificationCardNumber);

    this.customerManager.findIdentificationCard(customerIdentifier, identificationCardNumber);

    this.mockMvc.perform(delete(path + "/customers/" + customerIdentifier + "/identifications/"
            + identificationCardNumber + "/scans/" + scanIdentifier)
            .accept(MediaType.ALL_VALUE)
            .contentType(MediaType.IMAGE_PNG_VALUE))
            .andExpect(status().isOk());
  }

  @Test
  public void shouldFetchScans() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    this.createScan(customerIdentifier, identificationCardNumber);
    this.createScan(customerIdentifier, identificationCardNumber);
    this.createScan(customerIdentifier, identificationCardNumber);

    final List<IdentificationCardScan> result = this.customerManager.fetchIdentificationCardScans(customerIdentifier, identificationCardNumber);

    Assert.assertTrue(result.size() == 3);

    this.mockMvc.perform(get(path + "/customers/" + customerIdentifier
            + "/identifications/" + identificationCardNumber + "/scans").accept(MediaType.ALL_VALUE))
            .andExpect(status().isNotFound());
  }

  @Test
  public void shouldFindScan() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumberOne = this.createIdentificationCard(customerIdentifier);
    final String identificationCardNumberTwo = this.createIdentificationCard(customerIdentifier);
    this.createScan(customerIdentifier, identificationCardNumberOne, "sameIdentifier");
    final IdentificationCardScan createdScan = this.createScan(customerIdentifier, identificationCardNumberTwo, "sameIdentifier");

    final IdentificationCardScan scan = this.customerManager.findIdentificationCardScan(customerIdentifier, identificationCardNumberTwo, createdScan.getIdentifier());

    Assert.assertNotNull(scan);

    Assert.assertEquals(scan.getIdentifier(), createdScan.getIdentifier());
    Assert.assertEquals(scan.getDescription(), createdScan.getDescription());

    this.mockMvc.perform(get(path + "/customers/" + customerIdentifier
            + "/identifications/" + identificationCardNumberOne + "/scans/" + scan.getIdentifier())
            .accept(MediaType.ALL_VALUE))
            .andExpect(status().isNotFound());
  }

  @Test
  public void shouldFindScanWithImage() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    final IdentificationCardScan scan = ScanGenerator.createRandomScan(null);

    final byte[] imageInBytes = RandomStringUtils.randomAlphanumeric(20).getBytes();

    final MockMultipartFile image = new MockMultipartFile("image", "test.png", MediaType.IMAGE_PNG_VALUE, imageInBytes);

    this.customerManager.postIdentificationCardScan(customerIdentifier, identificationCardNumber, scan.getIdentifier(), scan.getDescription(), image);

    this.eventRecorder.wait(CustomerEventConstants.POST_IDENTIFICATION_CARD_SCAN, new ScanEvent(identificationCardNumber, scan.getIdentifier()));

    final byte[] persistedImageInBytes = this.customerManager.fetchIdentificationCardScanImage(customerIdentifier, identificationCardNumber, scan.getIdentifier());

    Assert.assertArrayEquals(imageInBytes, persistedImageInBytes);

    this.mockMvc.perform(get(path + "/customers/" + customerIdentifier + "/identifications/"
            + identificationCardNumber + "/scans/" + scan.getIdentifier() + "/image")
            .accept(MediaType.ALL_VALUE))
            .andExpect(status().isNotFound());
  }

  @Test(expected = ScanAlreadyExistsException.class)
  public void shouldThrowIfScanAlreadyExists() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    final IdentificationCardScan scan = this.createScan(customerIdentifier, identificationCardNumber);

    final MockMultipartFile image = new MockMultipartFile("image", "test.png", MediaType.IMAGE_PNG_VALUE, RandomStringUtils.randomAlphanumeric(20).getBytes());

    this.customerManager.postIdentificationCardScan(customerIdentifier, identificationCardNumber, scan.getIdentifier(), scan.getDescription(), image);
  }

  @Test(expected = ScanNotFoundException.class)
  public void shouldDeleteScan() throws Exception {
    final String customerIdentifier = this.createCustomer();

    final String identificationCardNumber = this.createIdentificationCard(customerIdentifier);

    final IdentificationCardScan createdScan = this.createScan(customerIdentifier, identificationCardNumber);

    this.customerManager.deleteScan(customerIdentifier, identificationCardNumber, createdScan.getIdentifier());

    this.eventRecorder.wait(CustomerEventConstants.DELETE_IDENTIFICATION_CARD_SCAN, new ScanEvent(identificationCardNumber, createdScan.getIdentifier()));

    this.customerManager.findIdentificationCardScan(customerIdentifier, identificationCardNumber, createdScan.getIdentifier());

    this.mockMvc.perform(delete(path + "/customers/" + customerIdentifier + "/identifications/"
            + identificationCardNumber + "/scans/" + createdScan.getIdentifier())
            .accept(MediaType.ALL_VALUE)
            .contentType(MediaType.IMAGE_PNG_VALUE))
            .andExpect(status().isOk());
  }

  private String createCustomer() throws Exception {
    final Customer customer = CustomerGenerator.createRandomCustomer();

    this.customerManager.createCustomer(customer);

    this.eventRecorder.wait(CustomerEventConstants.POST_CUSTOMER, customer.getIdentifier());

    return customer.getIdentifier();
  }

  private String createIdentificationCard(final String customerIdentifier) throws Exception {
    final IdentificationCard identificationCard = IdentificationCardGenerator.createRandomIdentificationCard();

    this.customerManager.createIdentificationCard(customerIdentifier, identificationCard);

    this.eventRecorder.wait(CustomerEventConstants.POST_IDENTIFICATION_CARD, identificationCard.getNumber());

    return identificationCard.getNumber();
  }

  private IdentificationCardScan createScan(final String customerIdentifier, final String cardNumber) throws Exception {
    final IdentificationCardScan scan = ScanGenerator.createRandomScan(null);

    this.postIdentificationCardScan(customerIdentifier, cardNumber, scan);

    return scan;
  }

  private IdentificationCardScan createScan(final String customerIdentifier, final String cardNumber, final String identifier) throws Exception {
    final IdentificationCardScan scan = ScanGenerator.createRandomScan(identifier);

    this.postIdentificationCardScan(customerIdentifier, cardNumber, scan);

    return scan;
  }

  private void postIdentificationCardScan(final String customerIdentifier, final String cardNumber, final IdentificationCardScan scan) throws InterruptedException {
    final MockMultipartFile image = new MockMultipartFile("image", "test.png", MediaType.IMAGE_PNG_VALUE, RandomStringUtils.randomAlphanumeric(20).getBytes());

    this.customerManager.postIdentificationCardScan(customerIdentifier, cardNumber, scan.getIdentifier(), scan.getDescription(), image);

    this.eventRecorder.wait(CustomerEventConstants.POST_IDENTIFICATION_CARD_SCAN, new ScanEvent(cardNumber, scan.getIdentifier()));
  }

}