Add configuration documentation and JMESPath examples (#286)

Add configuration documentation. Add section about JMESPath expressions in documentation. Improved javadoc, extracted method in ProcessQueryParams, renamed methods. Set which rules to in functional tests.

Author: e-pettersson-ericsson

README.md

@@ -57,7 +57,7 @@ Visit [Eiffel Community](https://eiffel-community.github.io) to get started and
     - [**Email notification**](wiki/markdown/subscription-with-email-notification.md)
     - [**Step by Step Subscription Notification**](wiki/markdown/step-by-step-subscription-notification.md)
 1. [**Understanding rules**](wiki/markdown/rules.md)
-    - [**Introduction**](wiki/markdown/rules.md#Introduction)
+    - [**What is JMESPath?**](wiki/markdown/rules.md#What-is-JMESPath?)
     - [**Rule set up**](wiki/markdown/rules.md#Rule-set-up)
     - [**MergeResolverRules**](wiki/markdown/merge-resolver-rules.md)
     - [**History Rules**](wiki/markdown/history-rules.md)

src/functionaltests/java/com/ericsson/ei/utils/TestConfigs.java

@@ -24,7 +24,7 @@ public class TestConfigs {
 
     protected static Map<Integer, AMQPBrokerManager> amqpBrokerMap = new HashMap<>();
 
-    AMQPBrokerManager createAmqpBroker() throws Exception {
+    protected AMQPBrokerManager createAmqpBroker() throws Exception {
         // Generates a random port for amqpBroker and starts up a new broker
         int port = SocketUtils.findAvailableTcpPort();
 
@@ -47,7 +47,7 @@ AMQPBrokerManager createAmqpBroker() throws Exception {
         return amqpBroker;
     }
 
-    void startUpMongoClient() throws IOException {
+    protected void startUpMongoClient() throws IOException {
         try {
             MongodForTestsFactory testsFactory = MongodForTestsFactory.with(Version.V3_4_1);
             mongoClient = testsFactory.newMongo();
@@ -59,7 +59,7 @@ void startUpMongoClient() throws IOException {
         }
     }
 
-    void setAuthorization() {
+    protected void setAuthorization() {
         String password = StringUtils.newStringUtf8(Base64.encodeBase64("password".getBytes()));
         System.setProperty("ldap.enabled", "true");
         System.setProperty("ldap.url", "ldap://ldap.forumsys.com:389/dc=example,dc=com");
@@ -69,6 +69,10 @@ void setAuthorization() {
         System.setProperty("ldap.user.filter", "uid={0}");
     }
 
+    protected void setRules() {
+        System.setProperty("rules", " /rules/ArtifactRules-Eiffel-Agen-Version.json");
+    }
+
     public static AMQPBrokerManager getBroker(int port) {
         return amqpBrokerMap.get(port);
     }

src/functionaltests/java/com/ericsson/ei/utils/TestContextInitializer.java

@@ -15,6 +15,8 @@ public class TestContextInitializer extends TestConfigs
     @Override
     public void initialize(ConfigurableApplicationContext ac) {
 
+        setRules();
+
         try {
             createAmqpBroker();
             startUpMongoClient();

src/functionaltests/resources/queryAggregatedObject7.json

@@ -1,24 +1,24 @@
 {
-    "criteria": {   
+    "criteria": {
          "$where" : "function() {
              var searchKey = 'id';
-             var value = 'JIRA-1234';        
+             var value = 'JIRA-1234';
              return searchInObj(obj);
-             function searchInObj(obj){                            
-                 for (var k in obj){           
-                     if (obj[k] == value && k == searchKey) {                     
-                         return true;                        
+             function searchInObj(obj){
+                 for (var k in obj){
+                     if (obj[k] == value && k == searchKey) {
+                         return true;
                      }
-          
-                     if (isObject(obj[k]) && obj[k] !== null) {              
+
+                     if (isObject(obj[k]) && obj[k] !== null) {
                          if (searchInObj(obj[k])) {
                              return true;
                          }
-                     }          
-                 }                         
+                     }
+                 }
                  return false;
-             }   
-         }"     
+             }
+         }"
     },
-    "filter": "{id: aggregatedObject.id, artifactGav:aggregatedObject.gav, confidenceLevels:aggregatedObject.confidenceLevels[?value=='SUCCESS'].{name: name, value: value}}"
+    "filter": "{id:aggregatedObject.id, artifactIdentity:aggregatedObject.identity, confidenceLevels:aggregatedObject.confidenceLevels[?value=='SUCCESS'].{name: name, value: value}}"
 }

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

@@ -34,8 +34,8 @@
 import io.swagger.annotations.ApiOperation;
 
 /**
- * This class represents the REST end-points for the query service. It can take
- * both query parameters and form parameters as criterias.
+ * This class represents the REST end-points for the query service. Criteria is
+ * required to have in the request body, while options and filter are optional.
  */
 @Component
 @CrossOrigin
@@ -64,7 +64,7 @@ public ResponseEntity<?> createQuery(@RequestBody final QueryBody body) {
                 filter = body.getFilter();
             }
 
-            JSONArray result = processQueryParams.filterFormParam(criteria, options, filter);
+            JSONArray result = processQueryParams.runQuery(criteria, options, filter);
             if(!result.toString().equalsIgnoreCase(emptyResponseContent)) {
                 httpStatus = HttpStatus.OK;
             } else {

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

@@ -17,8 +17,6 @@
 import java.util.Iterator;
 import java.util.List;
 
-import javax.annotation.PostConstruct;
-
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.slf4j.Logger;
@@ -32,8 +30,8 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 /**
- * This class represents the mechanism to extract the aggregated data on the
- * basis of the ID from the aggregatedObject.
+ * This class represents the mechanism to extract the aggregated object, which
+ * matches the given search criteria, from the database.
  */
 @Component
 public class ProcessAggregatedObject {
@@ -47,71 +45,72 @@ public class ProcessAggregatedObject {
     private String aggregationDataBaseName;
 
     @Autowired
-    private MongoDBHandler handler;
+    private MongoDBHandler mongoDBHandler;
 
     /**
-     * The method is responsible to extract the aggregated data on the basis of the
-     * ID from the aggregatedObject.
+     * The method is responsible to extract the aggregated data given the
+     * ID from the aggregated object.
      *
      * @param id
      * @return ArrayList
      */
     public ArrayList<String> processQueryAggregatedObject(String id) {
         ObjectMapper mapper = new ObjectMapper();
         String query = "{\"_id\": \"" + id + "\"}";
-
-        LOGGER.debug("The condition is : " + query);
         JsonNode jsonCondition = null;
+
         try {
             jsonCondition = mapper.readTree(query);
         } catch (Exception e) {
             LOGGER.error(e.getMessage(), e);
         }
-        LOGGER.debug("The Json condition is : " + jsonCondition);
-        ArrayList<String> response = handler.find(aggregationDataBaseName, aggregationCollectionName,
+        LOGGER.debug("The JSON condition is: {}", jsonCondition);
+        ArrayList<String> response = mongoDBHandler.find(aggregationDataBaseName, aggregationCollectionName,
                 jsonCondition.toString());
         return response;
     }
 
     /**
-     * The method is responsible to extract the aggregated data on the basis of the
-     * ID from the aggregatedObject.
+     * The method is responsible to extract the aggregated data given the
+     * templateName from the aggregated object.
      *
      * @param templateName
      * @return ArrayList
      */
     public ArrayList<String> getAggregatedObjectByTemplateName(String templateName) {
         String condition = "{\"aggregatedObject.id\": /.*" + templateName + "/}";
-        LOGGER.debug("The Json condition is : " + condition);
-        return handler.find(aggregationDataBaseName, aggregationCollectionName, condition);
+        LOGGER.debug("The JSON condition is: {}", condition);
+        return mongoDBHandler.find(aggregationDataBaseName, aggregationCollectionName, condition);
     }
 
     /**
-     * The method is responsible for the delete the aggregated object using template
-     * name suffix
+     * This method is responsible for deleting the aggregated object with given
+     * template name suffix
      *
      * @param templateName
      * @return boolean
      */
     public boolean deleteAggregatedObject(String templateName) {
         String condition = "{\"aggregatedObject.id\": /.*" + templateName + "/}";
-        LOGGER.debug("The Json condition for delete aggregated object is : " + condition);
-        return handler.dropDocument(aggregationDataBaseName, aggregationCollectionName, condition);
+        LOGGER.debug("The JSON condition for deleting aggregated object is: {}", condition);
+        return mongoDBHandler.dropDocument(aggregationDataBaseName, aggregationCollectionName, condition);
     }
 
     /**
-     * This method is responsible for fetching all the aggregatedObjects from the
-     * Aggregation database and return it as JSONArray.
+     * This method is responsible for fetching all the aggregated objects from the
+     * aggregation database based on the given query and returns the result as a
+     * JSONArray.
      *
-     * @param request
+     * @param query
+     *     A String containing search criteria to use
      * @param AggregationDataBaseName
      * @param AggregationCollectionName
      * @return JSONArray
      */
-    public JSONArray processQueryAggregatedObject(String request, String AggregationDataBaseName,
+    public JSONArray processQueryAggregatedObject(String query, String AggregationDataBaseName,
             String AggregationCollectionName) {
-        List<String> allDocuments = handler.find(AggregationDataBaseName, AggregationCollectionName, request);
-        LOGGER.debug("Number of document returned from AggregatedObject collection is : " + allDocuments.size());
+        List<String> allDocuments = mongoDBHandler.find(AggregationDataBaseName, AggregationCollectionName, query);
+        LOGGER.debug("Number of documents returned from {} collection is : {}", AggregationCollectionName, allDocuments.size());
         Iterator<String> allDocumentsItr = allDocuments.iterator();
         JSONArray jsonArray = new JSONArray();
         JSONObject doc = null;
@@ -127,9 +126,4 @@ public JSONArray processQueryAggregatedObject(String request, String Aggregation
         return jsonArray;
     }
 
-    @PostConstruct
-    public void init() {
-        LOGGER.debug("The Aggregated Database is : " + aggregationDataBaseName + "\nThe Aggregated Collection is : "
-                + aggregationCollectionName);
-    }
 }