ADD: test for ProcessQueryParams (#152)

* ADD: test for ProcessQueryParams

* ADD: a few scenarios

Author: ned29

src/functionaltests/java/com/ericsson/ei/rules/RuleCheckSteps.java

@@ -4,11 +4,9 @@
 import com.ericsson.ei.utils.FunctionalTestBase;
 import com.ericsson.ei.utils.HttpRequest;
 import com.ericsson.ei.utils.HttpRequest.HttpMethod;
-
 import cucumber.api.java.en.Given;
 import cucumber.api.java.en.Then;
 import cucumber.api.java.en.When;
-
 import org.apache.commons.io.FileUtils;
 import org.json.JSONArray;
 import org.json.JSONObject;
@@ -18,7 +16,9 @@
 import org.springframework.boot.web.server.LocalServerPort;
 import org.springframework.http.ResponseEntity;
 import org.springframework.test.util.ReflectionTestUtils;
+
 import java.io.File;
+
 import static org.junit.Assert.assertEquals;
 import static org.skyscreamer.jsonassert.JSONAssert.assertEquals;
 
@@ -70,9 +70,9 @@ public void make_a_POST_request_to_the_REST_API_with_request_parameter(String en
     @When("^make a POST request to the REST API \"([^\"]*)\"$")
     public void make_a_POST_request_to_the_REST_API(String endpoint) throws Throwable {
         String requestBody = new JSONObject()
-            .put("listRulesJson", new JSONArray(rules))
-            .put("listEventsJson", new JSONArray(events))
-            .toString();
+                .put("listRulesJson", new JSONArray(rules))
+                .put("listEventsJson", new JSONArray(events))
+                .toString();
 
         HttpRequest postRequest = new HttpRequest(HttpMethod.POST);
         response = postRequest.setPort(applicationPort)
@@ -104,7 +104,7 @@ public void get_content(String contentFileName) throws Throwable {
             assertEquals(expectedObject, responseObject, true);
         }
     }
-    
+
     @Then("^get request from REST API \"([^\"]*)\" return response code of (\\d+) and status as \"([^\"]*)\"$")
     public void get_request_from_REST_API_return_response_code_of_and_status_as(String endpoint, int statusCode, String status) throws Throwable {
         String responseBody = new JSONObject().put("status", Boolean.valueOf(status)).toString();
@@ -115,7 +115,7 @@ public void get_request_from_REST_API_return_response_code_of_and_status_as(Stri
                 .addHeader("Accept", "application/json")
                 .setEndpoint(endpoint)
                 .performRequest();
-        
+
         assertEquals(statusCode, apiResponse.getStatusCodeValue());
         assertEquals(responseBody, apiResponse.getBody());
     }

src/functionaltests/java/com/ericsson/ei/subscriptions/trigger/SubscriptionTriggerSteps.java

@@ -168,7 +168,7 @@ public void check_rest_subscriptions_were_triggered() throws Throwable {
 
     /**
      * Assemble subscription names in a list.
-     * 
+     *
      * @param jsonDataAsString
      *            JSON string containing subscriptions
      * @throws Throwable
@@ -182,7 +182,7 @@ private void readSubscriptionNames(String jsonDataAsString) throws Throwable {
 
     /**
      * POST subscriptions to endpoint.
-     * 
+     *
      * @param jsonDataAsString
      *            JSON string containing subscriptions
      * @param endPoint
@@ -202,7 +202,7 @@ private void postSubscriptions(String jsonDataAsString, String endPoint) throws
 
     /**
      * Verify that subscriptions were successfully posted.
-     * 
+     *
      * @param endPoint
      *            endpoint to use in GET
      * @throws Exception
@@ -223,7 +223,7 @@ private void validateSubscriptionsSuccessfullyAdded(String endPoint) throws Exce
 
     /**
      * Checks that an enpoint got at least the number of calls as expected.
-     * 
+     *
      * @param endpoints
      *            List of endpoints to check.
      * @param expectedCalls
@@ -251,7 +251,7 @@ private boolean allEndpointsGotAtLeastXCalls(final List<String> endpoints, int e
 
     /**
      * Verify that request made to endpoint contains the correct information.
-     * 
+     *
      * @param endpoint
      *            endpoint to check
      * @return true if verification was successful, false otherwise
@@ -298,7 +298,7 @@ private void setupRestEndpoints() {
 
     /**
      * Setup and start SMTP mock server.
-     * 
+     *
      * @throws IOException
      */
     private void setupSMTPServer() throws IOException {
@@ -322,7 +322,7 @@ protected List<String> getEventNamesToSend() {
 
     /**
      * Replaces tags in the subscription JSON string with valid information.
-     * 
+     *
      * @param text
      *            JSON string containing replaceable tags
      * @return Processed content

src/functionaltests/resources/features/subscriptionTrigger.feature

@@ -26,4 +26,4 @@ Feature: Subscription trigger test
     When I send Eiffel events
     And Wait for EI to aggregate objects and trigger subscriptions
     Then Mail subscriptions were triggered 
-    And Rest subscriptions were triggered 
+    And Rest subscriptions were triggered

src/main/java/com/ericsson/ei/queryservice/ProcessAggregatedObject.java

@@ -58,10 +58,10 @@ public ArrayList<String> processQueryAggregatedObject(String id) {
         ObjectMapper mapper = new ObjectMapper();
         String query = "{\"aggregatedObject.id\": \"" + id + "\"}";
 
-        LOGGER.debug("The condition is : " + query.toString());
+        LOGGER.debug("The condition is : " + query);
         JsonNode jsonCondition = null;
         try {
-            jsonCondition = mapper.readTree(query.toString());
+            jsonCondition = mapper.readTree(query);
         } catch (Exception e) {
             LOGGER.error(e.getMessage(), e);
         }

src/main/java/com/ericsson/ei/queryservice/ProcessQueryParams.java

@@ -16,7 +16,6 @@
 import com.ericsson.ei.controller.QueryControllerImpl;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
-
 import org.json.JSONArray;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -35,7 +34,7 @@
 @Component
 public class ProcessQueryParams {
 
-    private static final Logger LOGGER = (Logger) LoggerFactory.getLogger(QueryControllerImpl.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(QueryControllerImpl.class);
 
     @Value("${aggregated.collection.name}")
     private String aggregationCollectionName;
@@ -54,13 +53,11 @@ public class ProcessQueryParams {
      * @return JSONArray
      * @throws IOException
      */
-    public JSONArray filterFormParam(JsonNode request) throws IOException {
+    public JSONArray filterFormParam(JsonNode request) {
         JsonNode criteria = request.get("criteria");
         JsonNode options = request.get("options");
-        LOGGER.debug("The criteria is : " + criteria.toString());
-        LOGGER.debug("The options is : " + options.toString());
         JSONArray resultAggregatedObject;
-        if (options.toString().equals("{}") || options.isNull()) {
+        if (options == null || options.toString().equals("{}")) {
             resultAggregatedObject = processAggregatedObject.processQueryAggregatedObject(criteria.toString(), databaseName, aggregationCollectionName);
         } else {
             String result = "{ \"$and\" : [ " + criteria.toString() + "," + options.toString() + " ] }";
@@ -80,11 +77,10 @@ public JSONArray filterFormParam(JsonNode request) throws IOException {
     public JSONArray filterQueryParam(String request) {
         LOGGER.debug("The query string is : " + request);
         ObjectMapper mapper = new ObjectMapper();
-        JsonNode criteriasJsonNode = null;
+        JsonNode criteriasJsonNode;
         try {
             criteriasJsonNode = mapper.readValue(request, JsonNode.class).get("criteria");
-        }
-        catch (IOException e) {
+        } catch (IOException e) {
             LOGGER.error("Failed to parse FreeStyle query critera field from request:\n" + request);
             return new JSONArray();
         }
@@ -95,6 +91,6 @@ public JSONArray filterQueryParam(String request) {
     @PostConstruct
     public void print() {
         LOGGER.debug("Aggregation Database : " + databaseName
-            + "\nAggregation Collection is : " + aggregationCollectionName);
+                + "\nAggregation Collection is : " + aggregationCollectionName);
     }
 }

src/test/java/com/ericsson/ei/queryservice/test/TestProcessQueryParams.java

@@ -0,0 +1,90 @@
+package com.ericsson.ei.queryservice.test;
+
+import com.ericsson.ei.App;
+import com.ericsson.ei.queryservice.ProcessAggregatedObject;
+import com.ericsson.ei.queryservice.ProcessQueryParams;
+import com.fasterxml.jackson.core.io.JsonEOFException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.qpid.util.FileUtils;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+import org.springframework.util.SocketUtils;
+
+import java.io.File;
+import java.io.IOException;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Mockito.when;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@SpringBootTest(classes = {
+        App.class,
+        EmbeddedMongoAutoConfiguration.class
+})
+public class TestProcessQueryParams {
+
+    private static final String inputPath = "src/test/resources/AggregatedObject.json";
+    private static final String REQUEST = "{\"criteria\":{\"testCaseExecutions.testCase.verdict\":\"PASSED\"}}";
+    private static final String QUERY_WITH_CRITERIA_AND_OPTIONS = "{\"criteria\" :{\"testCaseExecutions.testCase.verdict\":\"PASSED\", \"testCaseExecutions.testCase.id\":\"TC5\" }, \"options\" :{ \"id\": \"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\"} }";
+    private static final String QUERY_WITH_CRITERIA = "{\"criteria\" :{\"testCaseExecutions.testCase.verdict\":\"PASSED\", \"testCaseExecutions.testCase.id\":\"TC5\" }}";
+    private static final String QUERY_WITH_WRONG_FORMAT = "{\"criteria\" :{\"testCaseExecutions.testCase.verdict\":\"PASSED\", \"testCaseExecutions.testCase.id\":\"TC5\" }, \"options\" :{ \"id\": \"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\" }";
+    private static final String DATA_BASE_NAME = "eiffel_intelligence";
+    private static final String AGGREGATION_COLLECTION_NAME = "aggregated_objects";
+    private static JSONArray expected;
+    private ObjectMapper mapper = new ObjectMapper();
+
+    @Autowired
+    private ProcessQueryParams processQueryParams;
+
+    @MockBean
+    private ProcessAggregatedObject processAggregatedObject;
+
+    @BeforeClass
+    public static void setUp() throws JSONException {
+        String input = FileUtils.readFileAsString(new File(inputPath));
+        int port = SocketUtils.findAvailableTcpPort();
+        System.setProperty("spring.data.mongodb.port", "" + port);
+        expected = new JSONArray("[" + input + "]");
+    }
+
+    @Test
+    public void testFilterFormParam() throws IOException {
+        JsonNode criteria = mapper.readTree(QUERY_WITH_CRITERIA_AND_OPTIONS).get("criteria");
+        JsonNode options = mapper.readTree(QUERY_WITH_CRITERIA_AND_OPTIONS).get("options");
+        String request = "{ \"$and\" : [ " + criteria.toString() + "," + options.toString() + " ] }";
+        when(processAggregatedObject.processQueryAggregatedObject(request, DATA_BASE_NAME, AGGREGATION_COLLECTION_NAME)).thenReturn(expected);
+        JSONArray result = processQueryParams.filterFormParam(new ObjectMapper().readTree(QUERY_WITH_CRITERIA_AND_OPTIONS));
+        assertEquals(expected, result);
+    }
+
+    @Test
+    public void testFilterFormParamWithOnlyCriteria() throws IOException {
+        JsonNode criteria = mapper.readTree(QUERY_WITH_CRITERIA).get("criteria");
+        when(processAggregatedObject.processQueryAggregatedObject(criteria.toString(), DATA_BASE_NAME, AGGREGATION_COLLECTION_NAME)).thenReturn(expected);
+        JSONArray result = processQueryParams.filterFormParam(new ObjectMapper().readTree(QUERY_WITH_CRITERIA));
+        assertEquals(expected, result);
+    }
+
+    @Test(expected = JsonEOFException.class)
+    public void testFilterFormParamWithWrongFormat() throws IOException {
+        JSONArray result = processQueryParams.filterFormParam(new ObjectMapper().readTree(QUERY_WITH_WRONG_FORMAT));
+        assertEquals(expected, result);
+    }
+
+    @Test
+    public void testFilterQueryParam() throws IOException {
+        JsonNode criteria = mapper.readValue(REQUEST, JsonNode.class).get("criteria");
+        when(processAggregatedObject.processQueryAggregatedObject(criteria.toString(), DATA_BASE_NAME, AGGREGATION_COLLECTION_NAME)).thenReturn(expected);
+        JSONArray result = processQueryParams.filterQueryParam(REQUEST);
+        assertEquals(expected, result);
+    }
+}