Merge pull request #16 from companieshouse/feature/Set_up_Integration_Tests_

Feature/set up integration tests

Author: KohareCH

pom.xml

@@ -121,12 +121,39 @@
             <artifactId>junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
-
         <dependency>
             <groupId>uk.gov.companieshouse</groupId>
             <artifactId>api-security-java</artifactId>
             <version>${api-security-java.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-core</artifactId>
+            <version>${io-cucumber.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-java</artifactId>
+            <version>${io-cucumber.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-junit</artifactId>
+            <version>${io-cucumber.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.cucumber</groupId>
+            <artifactId>cucumber-spring</artifactId>
+            <version>${io-cucumber.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.testcontainers</groupId>
+            <artifactId>mongodb</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/itest/java/uk/gov/companieshouse/pscdataapi/CucumberFeaturesRunnerITest.java

@@ -0,0 +1,16 @@
+package uk.gov.companieshouse.pscdataapi;
+
+import io.cucumber.junit.Cucumber;
+import io.cucumber.junit.CucumberOptions;
+import io.cucumber.spring.CucumberContextConfiguration;
+import org.junit.runner.RunWith;
+
+import uk.gov.companieshouse.pscdataapi.config.AbstractIntegrationTest;
+
+@RunWith(Cucumber.class)
+@CucumberOptions(features = "src/itest/resources/features",
+        plugin = {"pretty", "json:target/cucumber-report.json"})
+@CucumberContextConfiguration
+public class CucumberFeaturesRunnerITest extends AbstractIntegrationTest {
+
+}

src/itest/java/uk/gov/companieshouse/pscdataapi/config/AbstractIntegrationTest.java

@@ -0,0 +1,16 @@
+package uk.gov.companieshouse.pscdataapi.config;
+
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.annotation.DirtiesContext;
+import org.springframework.test.context.ActiveProfiles;
+
+/**
+ * Loads the application context.
+ * Best place to mock your downstream calls.
+ */
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
+@DirtiesContext
+@ActiveProfiles({"test"})
+public abstract class AbstractIntegrationTest extends AbstractMongoConfig {
+
+}

src/itest/java/uk/gov/companieshouse/pscdataapi/config/AbstractMongoConfig.java

@@ -0,0 +1,21 @@
+package uk.gov.companieshouse.pscdataapi.config;
+
+import org.springframework.test.context.DynamicPropertyRegistry;
+import org.springframework.test.context.DynamicPropertySource;
+import org.testcontainers.containers.MongoDBContainer;
+import org.testcontainers.utility.DockerImageName;
+
+/**
+ * Mongodb configuration runs on test container.
+ */
+public class AbstractMongoConfig {
+
+    public static final MongoDBContainer mongoDBContainer = new MongoDBContainer(
+            DockerImageName.parse("mongo:4"));
+
+    @DynamicPropertySource
+    public static void setProperties(DynamicPropertyRegistry registry) {
+        registry.add("spring.data.mongodb.uri", mongoDBContainer::getReplicaSetUrl);
+        mongoDBContainer.start();
+    }
+}

src/itest/java/uk/gov/companieshouse/pscdataapi/config/CucumberContext.java

@@ -0,0 +1,36 @@
+package uk.gov.companieshouse.pscdataapi.config;
+
+import java.util.HashMap;
+import java.util.Map;
+import org.springframework.http.ResponseEntity;
+
+/**
+ * Context to store the state.
+ */
+public enum CucumberContext {
+
+    CONTEXT;
+
+    private static final String RESPONSE = "RESPONSE";
+
+    private final ThreadLocal<Map<String, Object>> testContexts = ThreadLocal.withInitial(HashMap::new);
+
+    public ResponseEntity<?> getResponse() {
+        return get(RESPONSE);
+    }
+
+    public ResponseEntity<?> setResponse(ResponseEntity<?> response) {
+        return set(RESPONSE, response);
+    }
+
+    public <T> T get(String name) {
+        return (T) testContexts.get()
+                .get(name);
+    }
+
+    public <T> T set(String name, T object) {
+        testContexts.get()
+                .put(name, object);
+        return object;
+    }
+}

src/itest/java/uk/gov/companieshouse/pscdataapi/steps/PscDataSteps.java

@@ -0,0 +1,95 @@
+package uk.gov.companieshouse.pscdataapi.steps;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.cucumber.java.After;
+import io.cucumber.java.Before;
+import io.cucumber.java.en.Given;
+import io.cucumber.java.en.Then;
+import io.cucumber.java.en.When;
+import org.assertj.core.api.Assertions;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.web.client.TestRestTemplate;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.http.HttpEntity;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpMethod;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static uk.gov.companieshouse.pscdataapi.config.AbstractMongoConfig.mongoDBContainer;
+
+import uk.gov.companieshouse.pscdataapi.config.CucumberContext;
+import uk.gov.companieshouse.pscdataapi.util.FileReaderUtil;
+import uk.gov.companieshouse.pscdataapi.repository.CompanyPscRepository;
+
+import java.util.Collections;
+
+public class PscDataSteps {
+    private String contextId;
+
+    @Autowired
+    private ObjectMapper objectMapper;
+
+    @Autowired
+    private TestRestTemplate restTemplate;
+
+    @Autowired
+    private MongoTemplate mongoTemplate;
+
+    @Autowired
+    private CompanyPscRepository companyPscRepository;
+
+    private final String COMPANY_NUMBER = "34777772";
+
+    @Before
+    public void dbCleanUp(){
+        if (!mongoDBContainer.isRunning()) {
+            mongoDBContainer.start();
+        }
+        companyPscRepository.deleteAll();
+    }
+
+    @Given("Psc data api service is running")
+    public void theApplicationRunning() {
+        assertThat(restTemplate).isNotNull();
+    }
+
+    @When("I send a PUT request with payload {string} file with notification id {string}")
+    public void i_send_psc_statement_put_request_with_payload(String dataFile, String notificationId) {
+        String data = FileReaderUtil.readFile("src/itest/resources/json/input/" + dataFile + ".json");
+
+        HttpHeaders headers = new HttpHeaders();
+        headers.setContentType(MediaType.APPLICATION_JSON);
+        headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));
+
+        this.contextId = "5234234234";
+        CucumberContext.CONTEXT.set("contextId", this.contextId);
+        headers.set("x-request-id", this.contextId);
+        headers.set("ERIC-Identity", "TEST-IDENTITY");
+        headers.set("ERIC-Identity-Type", "key");
+        headers.set("ERIC-Authorised-Key-Roles", "*");
+
+        HttpEntity request = new HttpEntity(data, headers);
+        String uri = "/company/{company_number}/persons-with-significant-control/{notfication_id}/full_record";
+        ResponseEntity<Void> response = restTemplate.exchange(uri, HttpMethod.PUT, request, Void.class, COMPANY_NUMBER, notificationId);
+
+        CucumberContext.CONTEXT.set("statusCode", response.getStatusCodeValue());
+    }
+
+    @Then("a record exists with id {string}")
+    public void statement_exists(String statementId) {
+        Assertions.assertThat(companyPscRepository.existsById(statementId)).isTrue();
+    }
+
+    @Then("I should receive {int} status code")
+    public void i_should_receive_status_code(Integer statusCode) {
+        int expectedStatusCode = CucumberContext.CONTEXT.get("statusCode");
+        Assertions.assertThat(expectedStatusCode).isEqualTo(statusCode);
+    }
+
+    @After
+    public void dbStop(){
+        mongoDBContainer.stop();
+    }
+}

src/itest/java/uk/gov/companieshouse/pscdataapi/util/FileReaderUtil.java

@@ -0,0 +1,21 @@
+package uk.gov.companieshouse.pscdataapi.util;
+
+import org.springframework.util.FileCopyUtils;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+public class FileReaderUtil {
+
+    public static String readFile(String path) {
+        String data;
+        try {
+            data = FileCopyUtils.copyToString(new InputStreamReader(new FileInputStream(new File(path))));
+        } catch (IOException e) {
+            data = null;
+        }
+        return data;
+    }
+}

src/itest/resources/features/psc_data.feature

@@ -0,0 +1,12 @@
+Feature: Process Psc Data Requests
+
+  Scenario Outline: Processing psc data information successfully
+
+    Given Psc data api service is running
+    When I send a PUT request with payload "<data>" file with notification id "<notificationId>"
+    Then I should receive 201 status code
+    And a record exists with id "<notificationId>"
+
+    Examples:
+      | notificationId                 | data         |
+      | ZfTs9WeeqpXTqf6dc6FZ4C0H0ZZ    | psc_data_api |

src/itest/resources/json/input/psc_data_api.json

@@ -0,0 +1,61 @@
+{
+  "_id": "YfTs9WeeqpXTqf6dc6FZ4C0H0ZZ",
+  "internal_data": {
+    "created_at" : "2021-11-02T08:47:45",
+    "updated_at" :"2021-09-14T10:30:16.000Z",
+    "updated_by" :"CHIPS",
+    "delta_at" : "2023-11-20T08:47:45.378Z"
+  },
+  "external_data": {
+    "notification_id": "ZfTs9WeeqpXTqf6dc6FZ4C0H0ZZ",
+    "psc_id" : "ZfTs9WeeqpXTqf6dc6FZ4C0H0ZZ",
+    "sensitive_data": {
+      "usual_residential_address" : {
+        "address_line_1" : "ura_line1",
+        "address_line_2" : "ura_line2",
+        "care_of" : "ura_care_of",
+        "country" : "United Kingdom",
+        "locality" : "Cardiff",
+        "po_box" : "ura_po",
+        "postal_code" : "CF2 1B6",
+        "premises" : "URA",
+        "region" : "ura_region"
+      },
+      "residential_address_same_as_service_address": true,
+      "date_of_birth": {
+        "day": 21,
+        "year": 1995,
+        "month": 10
+      }
+    },
+    "data" : {
+      "service_address" : {
+        "address_line_1" : "sa_line1",
+        "address_line_2" : "sa_line2",
+        "care_of" : "sa_care_of",
+        "country" : "United Kingdom",
+        "locality" : "Cardiff",
+        "po_box" : "sa_po",
+        "postal_code" : "CF2 1B6",
+        "premises" : "SA",
+        "region" : "sa_region"
+      },
+      "natures_of_control": [
+        "part-right-to-share-surplus-assets-75-to-100-percent"
+      ],
+      "country_of_residence" : "United Kingdom",
+      "links" : [{
+        "self" : "/company/34777772/persons-with-significant-control/ZfTs9WeeqpXTqf6dc6FZ4C0H0ZZ"
+      }],
+      "nationality" : "British",
+      "kind" : "individual-person-with-significant-control",
+      "company_number": "34777772",
+      "name_elements": {
+        "title":"Mr.",
+        "surname" : "JONES",
+        "forename" : "PHIL",
+        "middlename" : "tom"
+      }
+    }
+  }
+}