Result filter (#170)

* Implemented a new JMESPath extension that takes one object and a key (key can be a whole path, partial path, or only simple key). It search through the object and finds all values that has this key. Then it returns a value or a list of values. Added extra query parameter to filterFormParam. The new parameter calls filter and it is a string that is send to JMESPath function. filterFormParam can now return a JSONArray with elements that contains key: objectId and value: value or list of found values. Added four functional tests for filterFormParam and six for JMESPath extension.

Author: J-Binieda-ericsson

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

@@ -37,10 +37,14 @@ 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 AGGREGATED_OBJ_JSON_PATH = "src/test/resources/AggregatedDocumentInternalCompositionLatest.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";
+    private static final String QUERY_3_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject3.json";
+    private static final String QUERY_4_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject4.json";
+    private static final String QUERY_5_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject5.json";
+    private static final String QUERY_6_FILE_NAME = "src/functionaltests/resources/queryAggregatedObject6.json";
 
     @LocalServerPort
     private int applicationPort;
@@ -300,6 +304,86 @@ public void check_missed_notification_has_been_returned() throws Throwable {
                 expectedResponse, responseAsString);
     }
 
+    @And("^Perform a query on created Aggregated object with filter$")
+    public void perform_valid_query_and_filter_on_aggregated_object() throws Throwable {
+        final String expectedResponse = "[{\"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\":\"\\\"33d05e6f-9bd9-4138-83b6-e20cc74680a3\\\"\"}]";
+        final String entryPoint = "/query";
+
+        String query1 = FileUtils.readFileToString(new File(QUERY_3_FILE_NAME), "UTF-8");
+
+        List<String> queries = new ArrayList<>();
+        queries.add(query1);
+
+        for (String query : queries) {
+            LOGGER.debug("Freestyle querying for the AggregatedObject with criteria: " + query);
+            HttpRequest postRequest = new HttpRequest(HttpMethod.POST);
+            response = postRequest.setPort(applicationPort)
+                    .setHost(hostName)
+                    .addHeader("content-type", "application/json")
+                    .addHeader("Accept", "application/json")
+                    .setEndpoint(entryPoint)
+                    .setBody(query)
+                    .performRequest();
+
+            LOGGER.debug(
+                    "Response of /query RestApi, Status Code: " + response.getStatusCodeValue() + "\nResponse: " + response.getBody().toString());
+
+            String responseAsString = response.getBody().toString();
+            int reponseStatusCode = response.getStatusCodeValue();
+
+            assertEquals(HttpStatus.OK.toString(), Integer.toString(reponseStatusCode));
+            assertEquals("Failed to compare actual response:\n" + responseAsString + "\nwith expected response:\n" + expectedResponse,
+                    expectedResponse, responseAsString);
+        }
+    }
+
+    @And("^Perform a query and filter with part of path$")
+    public void perform__query_and_filter_with_part_of_path() throws Throwable {
+        final String expectedResponse = "[{\"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\":\"\\\"[1481875921843, 1481875988767, 1481875921763, 1481875944272, 5005, 1481875891763, 2000]\\\"\"}]";
+        final String expectedResponse2 = "[{\"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\":\"\\\"null\\\"\"}]";
+        final String expectedResponse3 = "[{\"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\":\"\\\"[33d05e6f-9bd9-4138-83b6-e20cc74680a3, 33d05e6f-9bd9-4138-83b6-e20cc74681b5]\\\"\"}]";
+        final String entryPoint = "/query";
+
+        List<String> expectedResponses = new ArrayList<String>();
+        expectedResponses.add(expectedResponse);
+        expectedResponses.add(expectedResponse2);
+        expectedResponses.add(expectedResponse3);
+
+        String query1 = FileUtils.readFileToString(new File(QUERY_4_FILE_NAME), "UTF-8");
+        String query2 = FileUtils.readFileToString(new File(QUERY_5_FILE_NAME), "UTF-8");
+        String query3 = FileUtils.readFileToString(new File(QUERY_6_FILE_NAME), "UTF-8");
+
+        List<String> queries = new ArrayList<>();
+        queries.add(query1);
+        queries.add(query2);
+        queries.add(query3);
+
+        int pos = 0;
+        for (String query : queries) {
+            LOGGER.debug("Freestyle querying for the AggregatedObject with criteria: " + query);
+            HttpRequest postRequest = new HttpRequest(HttpMethod.POST);
+            response = postRequest.setPort(applicationPort)
+                    .setHost(hostName)
+                    .addHeader("content-type", "application/json")
+                    .addHeader("Accept", "application/json")
+                    .setEndpoint(entryPoint)
+                    .setBody(query)
+                    .performRequest();
+
+            LOGGER.debug(
+                    "Response of /query RestApi, Status Code: " + response.getStatusCodeValue() + "\nResponse: " + response.getBody().toString());
+
+            String responseAsString = response.getBody().toString();
+            int reponseStatusCode = response.getStatusCodeValue();
+
+            assertEquals(HttpStatus.OK.toString(), Integer.toString(reponseStatusCode));
+            assertEquals("Failed to compare actual response:\n" + responseAsString + "\nwith expected response:\n" + expectedResponses.get(pos),
+                    expectedResponses.get(pos), responseAsString);
+
+            pos++;
+        }
+    }
+
     /**
      * Method that creates a document in MongoDb database.
      *

src/functionaltests/resources/features/queryAggregatedObjects.feature

@@ -11,3 +11,5 @@ Feature: QueryAggregatedObjectsTestSteps
     And Perform an invalid freesyle query on Aggregated object
     And Perform a query for missed notification
     And Check missed notification has been returned
+    And Perform a query on created Aggregated object with filter
+    And Perform a query and filter with part of path

src/functionaltests/resources/queryAggregatedObject3.json

@@ -0,0 +1,14 @@
+{
+  "criteria": {
+    "aggregatedObject.testCaseExecutions": {
+      "$elemMatch": {
+        "outcome.conclusion": "SUCCESSFUL",
+        "outcome.id": "TC5"
+      }
+    }
+  },
+  "options": {
+    "aggregatedObject.gav.groupId": "com.mycompany.myproduct"
+  },
+  "filter" : "incomplete_path_filter(@, 'aggregatedObject.publications[0].eventId')"
+}

src/functionaltests/resources/queryAggregatedObject4.json

@@ -0,0 +1,14 @@
+{
+  "criteria": {
+    "aggregatedObject.testCaseExecutions": {
+      "$elemMatch": {
+        "outcome.conclusion": "SUCCESSFUL",
+        "outcome.id": "TC5"
+      }
+    }
+  },
+  "options": {
+    "aggregatedObject.gav.groupId": "com.mycompany.myproduct"
+  },
+  "filter" : "incomplete_path_filter(@, 'time')"
+}

src/functionaltests/resources/queryAggregatedObject5.json

@@ -0,0 +1,8 @@
+{
+  "criteria": {
+     "aggregatedObject.gav.groupId":"com.mycompany.myproduct",
+     "aggregatedObject.gav.artifactId":"sub-system",
+     "aggregatedObject.gav.version":"1.1.0"
+	},
+  "filter" : "incomplete_path_filter(@, 'svnIdentifier')"
+}

src/functionaltests/resources/queryAggregatedObject6.json

@@ -0,0 +1,14 @@
+{
+  "criteria": {
+    "aggregatedObject.testCaseExecutions": {
+      "$elemMatch": {
+        "outcome.conclusion": "SUCCESSFUL",
+        "outcome.id": "TC5"
+      }
+    }
+  },
+  "options": {
+    "aggregatedObject.gav.groupId": "com.mycompany.myproduct"
+  },
+  "filter" : "incomplete_path_filter(@, 'aggregatedObject.publications.eventId')"
+}

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

@@ -52,11 +52,15 @@ public ResponseEntity<?> updateQuery(@RequestBody final QueryBody body) {
         try {
             JSONObject criteria = new JSONObject(body.getCriteria().getAdditionalProperties());
             JSONObject options = null;
+            String filter = "";
             if (body.getOptions() != null) {
                 options = new JSONObject(body.getOptions().getAdditionalProperties());
             }
+            if (body.getFilter() != null) {
+                filter = body.getFilter();
+            }
 
-            JSONArray result = processQueryParams.filterFormParam(criteria, options);
+            JSONArray result = processQueryParams.filterFormParam(criteria, options, filter);
             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();

src/main/java/com/ericsson/ei/controller/model/QueryBody.java

@@ -16,14 +16,17 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonPropertyOrder({
     "criteria",
-    "options"
+    "options",
+    "filter"
 })
 public class QueryBody {
 
     @JsonProperty("criteria")
     private Criteria criteria;
     @JsonProperty("options")
     private Options options;
+    @JsonProperty("filter")
+    private String filter;
     @JsonIgnore
     private Map<String, Object> additionalProperties = new HashMap<String, Object>();
 
@@ -47,6 +50,16 @@ public void setOptions(Options options) {
         this.options = options;
     }
 
+    @JsonProperty("filter")
+    public String getFilter() {
+        return filter;
+    }
+
+    @JsonProperty("filter")
+    public void setFilter(String filter) {
+        this.filter = filter;
+    }
+
     @Override
     public String toString() {
         return ToStringBuilder.reflectionToString(this);
@@ -64,7 +77,7 @@ public void setAdditionalProperty(String name, Object value) {
 
     @Override
     public int hashCode() {
-        return new HashCodeBuilder().append(criteria).append(options).append(additionalProperties).toHashCode();
+        return new HashCodeBuilder().append(criteria).append(options).append(filter).append(additionalProperties).toHashCode();
     }
 
     @Override
@@ -76,7 +89,7 @@ public boolean equals(Object other) {
             return false;
         }
         QueryBody rhs = ((QueryBody) other);
-        return new EqualsBuilder().append(criteria, rhs.criteria).append(options, rhs.options).append(additionalProperties, rhs.additionalProperties).isEquals();
+        return new EqualsBuilder().append(criteria, rhs.criteria).append(options, rhs.options).append(filter, rhs.filter).append(additionalProperties, rhs.additionalProperties).isEquals();
     }
 
 }