Add more complex queries in the aggregated object tests (#158)

* Add more query aggregated object tests

- Added more complex tests for aggregated object.
- Removed GET for /query endpoint
- Fix query controller  tests

Author: erik-edling

src/functionaltests/java/com/ericsson/ei/query/QueryAggregatedObjectsTestSteps.java

@@ -4,6 +4,9 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
 import org.apache.commons.io.FileUtils;
 import org.junit.Ignore;
 import org.slf4j.Logger;
@@ -16,11 +19,7 @@
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.web.server.LocalServerPort;
 import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
-import org.springframework.test.web.servlet.MockMvc;
-import org.springframework.test.web.servlet.MvcResult;
-import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 
 import cucumber.api.java.en.And;
 import cucumber.api.java.en.Given;
@@ -38,10 +37,10 @@ public class QueryAggregatedObjectsTestSteps extends FunctionalTestBase {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(QueryAggregatedObjectsTestSteps.class);
 
-
     private static final String AGGREGATED_OBJ_JSON_PATH = "src/test/resources/AggregatedDocument.json";
     private static final String MISSED_NOTIFICATION_JSON_PATH = "src/test/resources/MissedNotification.json";
-
+    private static final String QUERY_1_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject1.json";
+    private static final String QUERY_2_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject2.json";
 
     @LocalServerPort
     private int applicationPort;
@@ -154,37 +153,46 @@ public void perform_invalid_query_on_created_aggregated_object() throws Throwabl
                 expectedResponse, responseAsString);
     }
 
-    @And("^Perform valid freestyle query on created Aggregated object$")
-    public void perform_valid_freestyle_query_on_created_aggregated_object() throws Throwable {
+    @Then("^Perform several valid freestyle queries on created Aggregated objects$")
+    public void perform_several_valid_freestyle_queries_on_created_Aggregated_objects() throws Throwable {
+
         final String expectedAggrId = "6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43";
         final String entryPoint = "/query";
-        final String queryAggrObj = "{\"criteria\" :{\"aggregatedObject.id\" : \"" + expectedAggrId + "\", \"aggregatedObject.gav.groupId\" : \"com.mycompany.myproduct\"}}";
 
-        LOGGER.debug("Freestyle querying for the AggregatedObject with criteria: " + queryAggrObj);
+        String query1 = FileUtils.readFileToString(new File(QUERY_1_FILE_NAME), "UTF-8");
+        String query2 = FileUtils.readFileToString(new File(QUERY_2_FILE_NAME), "UTF-8");
 
-        HttpRequest getRequest = new HttpRequest(HttpMethod.GET);
-        response = getRequest.setPort(applicationPort)
-                .setHost(hostName)
-                .addHeader("content-type", "application/json")
-                .addHeader("Accept", "application/json")
-                .setEndpoint(entryPoint)
-                .addParam("request", queryAggrObj)
-                .performRequest();
+        List<String> queries = new ArrayList<>();
+        queries.add(query1);
+        queries.add(query2);
 
-        LOGGER.debug("Response of /query RestApi, Status Code: " + response.getStatusCodeValue() +
-                           "\nResponse: " + response.getBody().toString());
+        for(String query: queries) {
+            LOGGER.debug("Freestyle querying for the AggregatedObject with criteria: " + query);
 
-        JsonNode jsonNodeResult = objMapper.readValue(response.getBody().toString(), JsonNode.class);
-        JsonNode aggrObjResponse = objMapper.readValue(jsonNodeResult.get(0).get("aggregatedObject").toString(), JsonNode.class);
+            HttpRequest postRequest = new HttpRequest(HttpMethod.POST);
+            response = postRequest.setPort(applicationPort)
+                    .setHost(hostName)
+                    .addHeader("content-type", "application/json")
+                    .addHeader("Accept", "application/json")
+                    .setEndpoint(entryPoint)
+                    .addParam("request", query)
+                    .performRequest();
 
-        String actualAggrObjId = aggrObjResponse.get("id").asText();
-        LOGGER.debug("AggregatedObject id from Response: " + actualAggrObjId);
+            LOGGER.debug("Response of /query RestApi, Status Code: " + response.getStatusCodeValue() +
+                               "\nResponse: " + response.getBody().toString());
 
+            JsonNode jsonNodeResult = objMapper.readValue(response.getBody().toString(), JsonNode.class);
+            JsonNode aggrObjResponse = objMapper.readValue(jsonNodeResult.get(0).get("aggregatedObject").toString(), JsonNode.class);
 
-        assertEquals(HttpStatus.OK.toString(), Integer.toString(response.getStatusCodeValue()));
-        assertEquals("Failed to compare actual Aggregated Object Id:\n" + actualAggrObjId
-                + "\nwith expected Aggregated Object Id:\n" + expectedAggrId,
-                expectedAggrId, actualAggrObjId);
+            String actualAggrObjId = aggrObjResponse.get("id").asText();
+            LOGGER.debug("AggregatedObject id from Response: " + actualAggrObjId);
+
+
+            assertEquals(HttpStatus.OK.toString(), Integer.toString(response.getStatusCodeValue()));
+            assertEquals("Failed to compare actual Aggregated Object Id:\n" + actualAggrObjId
+                    + "\nwith expected Aggregated Object Id:\n" + expectedAggrId,
+                    expectedAggrId, actualAggrObjId);
+        }
     }
 
     @And("^Perform an invalid freesyle query on Aggregated object$")
@@ -196,7 +204,7 @@ public void perform_invalid_freestyle_query_on_created_aggregated_object() throw
 
         LOGGER.debug("Trying an invalid query on /query RestApi with invalid criteria query: " + queryAggrObj);
 
-        HttpRequest getRequest = new HttpRequest(HttpMethod.GET);
+        HttpRequest getRequest = new HttpRequest(HttpMethod.POST);
         response = getRequest.setPort(applicationPort)
                 .setHost(hostName)
                 .addHeader("content-type", "application/json")
@@ -309,4 +317,4 @@ private boolean createDocumentInMongoDb(String databaseName, String collectionNa
         return mongoDBHandler.insertDocument(databaseName, collectionName, objToBeInserted);
     }
 
-}
+}

src/functionaltests/resources/features/queryAggregatedObjects.feature

@@ -7,8 +7,7 @@ Feature: QueryAggregatedObjectsTestSteps
     And Missed Notification object is created
     Then Perform valid query on created Aggregated object
     And Perform an invalid query on same Aggregated object
-    And Perform valid freestyle query on created Aggregated object
+    And Perform several valid freestyle queries on created Aggregated objects
     And Perform an invalid freesyle query on Aggregated object
     And Perform a query for missed notification
     And Check missed notification has been returned
-    

src/functionaltests/resources/queryAggregatedObject1.json

@@ -0,0 +1,12 @@
+{
+  "criteria": {
+    "$or": [
+      {
+        "aggregatedObject.testCaseExecutions.outcome.id":"TC5"
+      }, {
+        "aggregatedObject.testCaseExecutions.outcome.id":"TC6"
+      }
+    ],
+    "aggregatedObject.gav.groupId":"com.mycompany.myproduct"
+  }
+}

src/functionaltests/resources/queryAggregatedObject2.json

@@ -0,0 +1,13 @@
+{
+  "criteria": {
+    "aggregatedObject.testCaseExecutions": {
+      "$elemMatch": {
+        "outcome.conclusion": "SUCCESSFUL",
+        "outcome.id": "TC5"
+      }
+    }
+  },
+  "options": {
+    "aggregatedObject.gav.groupId": "com.mycompany.myproduct"
+  }
+}

src/main/java/com/ericsson/ei/controller/QueryAggregatedObjectController.java

@@ -1,7 +1,6 @@
 
 package com.ericsson.ei.controller;
 
-import com.ericsson.ei.controller.model.QueryResponse;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;

src/main/java/com/ericsson/ei/controller/QueryController.java

@@ -18,15 +18,6 @@
 public interface QueryController {
 
 
-    /**
-     * The REST GET method is used to query Aggregated Objects with the criterias requested, which are present as query parameters in the request URL.
-     * 
-     */
-    @RequestMapping(value = "", method = RequestMethod.GET)
-    public ResponseEntity<?> getQuery(
-        @RequestParam
-        String request);
-
     /**
      * The REST POST method is used to query Aggregated Objects with the criterias requested, which are present in the request body of the request URL.
      * 

src/main/java/com/ericsson/ei/controller/QueryControllerImpl.java

@@ -57,19 +57,4 @@ public ResponseEntity<?> updateQuery(@RequestParam(value = "request") String req
             return new ResponseEntity<>(errorMessage, HttpStatus.INTERNAL_SERVER_ERROR);
         }
     }
-
-    @Override
-    @CrossOrigin
-    @ApiOperation(value = "")
-    public ResponseEntity<?> getQuery(@RequestParam(value = "request") final String request) {
-        try {
-            JSONArray result = processQueryParams.filterQueryParam(request);
-            LOGGER.debug("Final Output : " + result.toString());
-            return new ResponseEntity<>(result.toString(), HttpStatus.OK);
-        } catch (Exception e) {
-            String errorMessage = "Failed to extract data from the Aggregated Object using freestyle query. Error message:\n" + e.getMessage();
-            LOGGER.error(errorMessage, e);
-            return new ResponseEntity<>(errorMessage, HttpStatus.INTERNAL_SERVER_ERROR);
-        }
-    }
 }

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

@@ -60,6 +60,7 @@ public JSONArray filterFormParam(JsonNode request) {
         if (options == null || options.toString().equals("{}")) {
             resultAggregatedObject = processAggregatedObject.processQueryAggregatedObject(criteria.toString(), databaseName, aggregationCollectionName);
         } else {
+            LOGGER.debug("The options is : " + options.toString());
             String result = "{ \"$and\" : [ " + criteria.toString() + "," + options.toString() + " ] }";
             resultAggregatedObject = processAggregatedObject.processQueryAggregatedObject(result, databaseName, aggregationCollectionName);
         }

src/main/resources/public/raml/query.raml

@@ -13,18 +13,3 @@ post:
     200:
       body:
         application/json:
-get:
-  description: The REST GET method is used to query Aggregated Objects with the
-               criterias requested, which are present as query parameters in the request
-               URL.
-  queryParameters:
-    request:
-      displayName: request
-      type: string
-      description: Query to MongoDB
-      example: request=testCaseExecutions.testCase.verdict:PASSED
-      required: true
-  responses:
-    200:
-      body:
-        application/json:

src/test/java/com/ericsson/ei/controller/TestQueryControllerImpl.java

@@ -40,20 +40,16 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.mockito.Matchers.any;
-import static org.mockito.Matchers.anyString;
 import static org.mockito.Mockito.when;
-import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 @RunWith(SpringJUnit4ClassRunner.class)
 @SpringBootTest(classes = {
-        App.class, 
+        App.class,
         EmbeddedMongoAutoConfiguration.class // <--- Don't forget THIS
     })
 @AutoConfigureMockMvc
 public class TestQueryControllerImpl {
     private static final String inputPath = "src/test/resources/AggregatedObject.json";
-    private static final String REQUEST = "testCaseExecutions.testCase.verdict:PASSED,testCaseExecutions.testCase.id:TC5,id:6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43";
     private static final String QUERY = "{\"criteria\" :{\"testCaseExecutions.testCase.verdict\":\"PASSED\", \"testCaseExecutions.testCase.id\":\"TC5\" }, \"options\" :{ \"id\": \"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\"} }";
     private static String input;
 
@@ -62,7 +58,7 @@ public class TestQueryControllerImpl {
 
     @Autowired
     private MockMvc mockMvc;
-    
+
     @BeforeClass
     public static void init() {
         int port = SocketUtils.findAvailableTcpPort();
@@ -83,16 +79,4 @@ public void filterFormParamTest() throws Exception {
                 .andReturn();
         assertEquals(inputObj.toString(), result.getResponse().getContentAsString());
     }
-
-    @Test
-    public void filterQueryParamTest() throws Exception {
-        JSONArray inputObj = new JSONArray("[" + input + "]");
-        when(unitUnderTest.filterQueryParam(anyString())).thenReturn(inputObj);
-        MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/query")
-                .param("request", REQUEST))
-                .andExpect(status().isOk())
-                .andDo(print())
-                .andReturn();
-        assertEquals(inputObj.toString(), result.getResponse().getContentAsString());
-    }
 }