Introduce mongo query interface (#377)

* Fix bug

JsonNode.toString() will return a string including quotes which
will break the code

* Add first version of conditions class

* Refactor to satic methods

* Add javadoc and improve code

* Update MongoDBHandler to use MongoQuery instead of string

* Update code to use MongoQuery

* Add subscriptionName condition

* Remove unused code/test and add TODO

* Move mongo classes to own package

* Create a MongoQueryBuilder

* Add lock condition

* Add or query and append possiblity

- Add a buildOr on MongoQueryBuilder to build or querys
- Possibility to append MongoConditions to a MongoQueryBuilder

* Change to allways use MongoQuery for queries

* Use MongoQuery and builder in ObjectHandler

* Use MongoQuery

* Remove todo

* Fix bug and improve tests

* Change id to _id

* Add test and rename test methods

* Add posibility to stop worklist worker

* Update MongoDB to give more error messages

* Fix tests

* Remove previously added upcheck

* Change to correct condition

* Fix codacy issues

* Fix Codacy issue

* Simplify error logging

* Add final and fix javadoc

* Add wait for events to appear in database

* Fix review comments

Author: m-linner-ericsson

src/functionaltests/java/com/ericsson/ei/notifications/trigger/SubscriptionNotificationSteps.java

@@ -32,7 +32,8 @@
 
 import com.dumbster.smtp.SimpleSmtpServer;
 import com.dumbster.smtp.SmtpMessage;
-import com.ericsson.ei.handlers.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.ei.utils.FunctionalTestBase;
 import com.ericsson.ei.utils.HttpRequest;
 import com.fasterxml.jackson.databind.JsonNode;
@@ -208,7 +209,7 @@ public void missed_notification_db_should_contain_x_objects(int maxObjectsInDB)
         int minWaitTime = 5;
         int maxWaittime = 20;
 
-        String condition = "{}";
+        final MongoCondition condition = MongoCondition.emptyCondition();
         int missedNotifications = getDbSizeForCondition(minWaitTime, maxWaittime, maxObjectsInDB, condition);
 
         assertEquals(missedNotifications, maxObjectsInDB);
@@ -435,14 +436,15 @@ private String replaceTagsInNotificationMeta(String text) {
      * @return
      * @throws InterruptedException
      */
-    private int getDbSizeForCondition(int minWaitTime, int maxWaitTime, int expectedSize, String condition)
+    private int getDbSizeForCondition(int minWaitTime, int maxWaitTime, int expectedSize, MongoCondition condition)
             throws InterruptedException {
         TimeUnit.SECONDS.sleep(minWaitTime);
         long maxTime = System.currentTimeMillis() + maxWaitTime;
         List<String> queryResult = null;
 
         while (System.currentTimeMillis() < maxTime) {
-            queryResult = mongoDBHandler.find(failedNotificationDatabase, failedNotificationCollection, condition);
+            queryResult = mongoDBHandler.find(failedNotificationDatabase,
+                    failedNotificationCollection, condition);
 
             if (queryResult.size() == expectedSize) {
                 return queryResult.size();

src/functionaltests/java/com/ericsson/ei/notifications/ttl/TestTTLSteps.java

@@ -26,7 +26,8 @@
 import org.springframework.util.SocketUtils;
 
 import com.ericsson.ei.exception.AuthenticationException;
-import com.ericsson.ei.handlers.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.ei.notifications.InformSubscriber;
 import com.ericsson.ei.utils.FunctionalTestBase;
 import com.ericsson.ei.utils.HttpRequest;
@@ -137,8 +138,9 @@ public void verify_request_has_been_made() throws JSONException {
 
     @Then("^Check failed notification is in database$")
     public void check_failed_notification_is_in_database() {
-        String condition = "{\"subscriptionName\" : \"" + SUBSCRIPTION_NAME + "\"}";
-        List<String> result = mongoDBHandler.find(failedNotificationDatabase, failedNotificationCollection, condition);
+        final MongoCondition condition = MongoCondition.subscriptionNameCondition(SUBSCRIPTION_NAME);
+        List<String> result = mongoDBHandler.find(failedNotificationDatabase,
+                failedNotificationCollection, condition);
 
         assertEquals(1, result.size());
         assertEquals("Could not find a missed notification matching the condition: " + condition,
@@ -184,7 +186,7 @@ public void aggregated_object_is_created() throws Throwable {
     public void a_failed_notification_is_created() throws Throwable {
         // verifying that missed notification is created and present in db
         int expectedSize = 1;
-        String condition = "{\"subscriptionName\" : \"" + SUBSCRIPTION_NAME_3 + "\"}";
+        final MongoCondition condition = MongoCondition.subscriptionNameCondition(SUBSCRIPTION_NAME_3);
 
         LOGGER.debug("Checking presence of failed notification in db");
         int notificationExistSize = getNotificationForExpectedSize(expectedSize, condition);
@@ -194,7 +196,7 @@ public void a_failed_notification_is_created() throws Throwable {
     @Then("^Notification document should be deleted from the database$")
     public void the_Notification_document_should_be_deleted_from_the_database() throws Throwable {
         int expectedSize = 0;
-        String condition = "{\"subscriptionName\" : \"" + SUBSCRIPTION_NAME_3 + "\"}";
+        final MongoCondition condition = MongoCondition.subscriptionNameCondition(SUBSCRIPTION_NAME_3);
         LOGGER.debug("Checking deletion of notification document in db");
 
         int notificationExistSize = getNotificationForExpectedSize(expectedSize, condition);
@@ -235,12 +237,13 @@ protected List<String> getEventNamesToSend() {
         return eventNames;
     }
 
-    private int getNotificationForExpectedSize(int expectedSize, String condition) {
+    private int getNotificationForExpectedSize(int expectedSize, MongoCondition condition) {
         long maxTime = System.currentTimeMillis() + MAX_WAIT_TIME;
         List<String> notificationExist = null;
 
         while (System.currentTimeMillis() < maxTime) {
-            notificationExist = mongoDBHandler.find(failedNotificationDatabase, failedNotificationCollection,
+            notificationExist = mongoDBHandler.find(failedNotificationDatabase,
+                    failedNotificationCollection,
                     condition);
 
             if (notificationExist.size() == expectedSize) {

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

@@ -19,7 +19,8 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.test.context.TestPropertySource;
 
-import com.ericsson.ei.handlers.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.ei.utils.FunctionalTestBase;
 import com.ericsson.ei.utils.HttpRequest;
 import com.ericsson.ei.utils.HttpRequest.HttpMethod;
@@ -98,8 +99,9 @@ public QueryAggregatedObjectsTestSteps() {
 
     @Given("^Aggregated object is created$")
     public void aggregated_object_is_created() throws Throwable {
+        final MongoCondition condition = MongoCondition.idCondition("6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43");
         List<String> aggregatedObject = mongoDBHandler.find(eiDatabaseName, aggrCollectionName,
-                "{\"_id\": \"6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43\"}");
+                condition);
 
         boolean aggregatedObjectExists = aggregatedObject.size() > 0;
         if (!aggregatedObjectExists) {
@@ -252,9 +254,10 @@ public void perform_a_query_for_missed_notification() throws Throwable {
         final String expectedTestCaseStartedEventId = "cb9d64b0-a6e9-4419-8b5d-a650c27c59ca";
 
         LOGGER.debug("Check if FailedNotification and " + subscriptionName + " exist in Database");
-        final String queryRequest = "{\"subscriptionName\":\"" + subscriptionName + "\"}";
+        final MongoCondition queryRequest = MongoCondition.subscriptionNameCondition(subscriptionName);
         String subscriptionNameCheck = objMapper.readValue(
-                mongoDBHandler.find(failedNotificationDatabaseName, failedNotificationCollectionName, queryRequest)
+                mongoDBHandler.find(failedNotificationDatabaseName,
+                        failedNotificationCollectionName, queryRequest)
                               .get(0),
                 JsonNode.class).get("subscriptionName").asText();
         assertEquals("Expected subscriptionName in missed notification in Database is not as expected.",

src/functionaltests/java/com/ericsson/ei/subscriptions/repeatHandler/SubscriptionRepeatHandlerSteps.java

@@ -21,7 +21,8 @@
 import org.springframework.test.context.TestPropertySource;
 
 import com.ericsson.ei.controller.model.Subscription;
-import com.ericsson.ei.handlers.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.ei.services.ISubscriptionService;
 import com.ericsson.ei.subscription.RunSubscription;
 import com.ericsson.ei.utils.FunctionalTestBase;
@@ -57,7 +58,7 @@ public class SubscriptionRepeatHandlerSteps extends FunctionalTestBase {
     private String subscriptionStrWithOneMatch;
     private String subscriptionStrWithTwoMatch;
     private String aggregatedObject;
-    private String subscriptionIdMatchedAggrIdObjQuery;
+    private MongoCondition subscriptionIdMatchedAggrIdObjQuery;
     private ObjectMapper mapper = new ObjectMapper();
 
     @Value("${aggregated.collection.name}")
@@ -134,15 +135,16 @@ public void check_in_MongoDB_RepeatFlagHandler_collections_that_the_subscription
         List<String> resultRepeatFlagHandler = mongoDBHandler.find(dataBaseName, repeatFlagHandlerCollection,
                 subscriptionIdMatchedAggrIdObjQuery);
         assertEquals("[]", resultRepeatFlagHandler.toString());
-        String condition = "{\"_id\": \"" + AGGREGATED_OBJECT_ID + "\"}";
+        final MongoCondition condition = MongoCondition.idCondition(AGGREGATED_OBJECT_ID);
         assertTrue(mongoDBHandler.dropDocument(dataBaseName, collectionName, condition));
     }
 
     @When("^In MongoDb RepeatFlagHandler collection the subscription has matched the AggrObjectId at least two times$")
     public void in_MongoDb_RepeatFlagHandler_collection_the_subscription_has_matched_the_AggrObjectId_at_least_two_times()
             throws IOException {
         processSubscription(subscriptionStrWithTwoMatch, subscriptionWithTwoMatch);
-        List<String> resultRepeatFlagHandler = mongoDBHandler.find(dataBaseName, repeatFlagHandlerCollection,
+        List<String> resultRepeatFlagHandler = mongoDBHandler.find(dataBaseName,
+                repeatFlagHandlerCollection,
                 subscriptionIdMatchedAggrIdObjQuery);
         assertEquals(1, resultRepeatFlagHandler.size());
         assertEquals("\"" + AGGREGATED_OBJECT_ID + "\"", getAggregatedObjectId(resultRepeatFlagHandler, 0));
@@ -186,6 +188,7 @@ private void processSubscription(String subscriptionStrValue, JSONObject subscri
         Iterator<JsonNode> requirementIterator = requirementNode.elements();
         assertTrue(runSubscription.runSubscriptionOnObject(aggregatedObject, requirementIterator, subscriptionJson,
                 AGGREGATED_OBJECT_ID));
-        subscriptionIdMatchedAggrIdObjQuery = "{ \"subscriptionId\" : \"" + expectedSubscriptionName + "\"}";
+        subscriptionIdMatchedAggrIdObjQuery = MongoCondition.subscriptionCondition(
+                expectedSubscriptionName);
     }
 }

src/integrationtests/java/com/ericsson/ei/integrationtests/notification/FailedNotificationRunnerIT.java

@@ -11,6 +11,8 @@
         "com.ericsson.ei.integrationtests.notification" }, plugin = { "pretty",
                 "html:target/cucumber-reports/FailedNotificationRunnerIT" })
 public class FailedNotificationRunnerIT {
+    public static final String FAILED_NOTIFICATION_COLLECTION = "failed_notification";
+
     @BeforeClass
     public static void before() {
         System.setProperty("aggregated.collection.name", "aggregated_failed_notification");
@@ -19,7 +21,7 @@ public static void before() {
         System.setProperty("event_object_map.collection.name", "event_object_map_failed_notification");
         System.setProperty("subscription.collection.repeatFlagHandlerName",
                 "subscription_repeat_handler_failed_notification");
-        System.setProperty("failed.notification.collection-name", "missed_notification_failed_notification");
+        System.setProperty("failed.notification.collection-name", FAILED_NOTIFICATION_COLLECTION);
         System.setProperty("sessions.collection.name", "sessions_failed_notification");
 
         System.setProperty("rules.path", "/rules/ArtifactRules-Eiffel-Agen-Version.json");

src/integrationtests/java/com/ericsson/ei/integrationtests/notification/FailedNotificationStepsIT.java

@@ -1,18 +1,21 @@
 package com.ericsson.ei.integrationtests.notification;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
 
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.TimeUnit;
 
 import org.apache.http.client.ClientProtocolException;
 import org.json.JSONObject;
 import org.junit.Ignore;
 import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootContextLoader;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ContextConfiguration;
@@ -22,6 +25,8 @@
 import org.springframework.test.context.support.DependencyInjectionTestExecutionListener;
 
 import com.ericsson.ei.App;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.eiffelcommons.subscriptionobject.MailSubscriptionObject;
 import com.ericsson.eiffelcommons.subscriptionobject.RestPostSubscriptionObject;
 import com.ericsson.eiffelcommons.subscriptionobject.SubscriptionObject;
@@ -43,13 +48,19 @@
 @TestExecutionListeners(listeners = { DependencyInjectionTestExecutionListener.class })
 @TestPropertySource(properties = { "spring.mail.port: 9999" })
 public class FailedNotificationStepsIT extends IntegrationTestBase {
+    private static final int SECONDS_1 = 1000;
+    private static final String FAILED_NOTIFICATION_DATABASE = "FailedNotification";
+    private static final int SECONDS_30 = 30000;
     private String rulesFilePath;
     private String eventsFilePath;
     private ObjectMapper objectMapper = new ObjectMapper();
     private int extraEventsCount = 0;
 
     private SubscriptionObject subscriptionObject;
 
+    @Autowired
+    private MongoDBHandler mongoDBHandler;
+
     @Given("^the rules \"([^\"]*)\"$")
     public void rules(String rulesFilePath) throws Throwable {
         this.rulesFilePath = rulesFilePath;
@@ -117,14 +128,29 @@ public void subscriptionIsUploaded()
 
     @Then("^failed notification of type \"([^\"]*)\" should exist for subscription \"([^\"]*)\"$")
     public void failedNotificationShouldExist(String searchValue, String subscriptionName) throws Throwable {
+        waitForDatabaseEntry(subscriptionName);
+
         HttpRequest request = new HttpRequest(HttpMethod.GET);
         request.setBaseUrl("http://" + eiHost + ":" + port)
                 .setEndpoint("/failed-notifications")
                .addParam("subscriptionName", subscriptionName);
-
         ResponseEntity response = request.performRequest();
-        String message = objectMapper.readTree(response.getBody()).get("queryResponseEntity").get("message").toString();
-        assertEquals(true, message.contains(searchValue));
+
+        String body = response.getBody();
+        assertNotEquals("Performed request but body was empty", "", body);
+        String message = "";
+
+        // There was a lot errors in this area so I added more logging
+        try {
+            JsonNode messageNode = objectMapper.readTree(body).get("queryResponseEntity").get("message");
+            assertNotEquals("No failed notifications found for " + subscriptionName, null,
+                    messageNode);
+            message = messageNode.toString();
+        } catch (NullPointerException e) {
+            throw new IllegalArgumentException("Tried to parse json of "+ body);
+        }
+
+        assertEquals("Did not contain a failed notification", true, message.contains(searchValue));
     }
 
     @Override
@@ -155,4 +181,18 @@ protected List<String> getEventNamesToSend() throws IOException {
         eventNames.add("event_EiffelTestCaseTriggeredEvent_3");
         return eventNames;
     }
+
+    private void waitForDatabaseEntry(String subscriptionName) throws InterruptedException {
+        final MongoCondition condition = MongoCondition.subscriptionNameCondition(subscriptionName);
+
+        long stopTime = System.currentTimeMillis() + SECONDS_30;
+        ArrayList<String> find = new ArrayList<>(0);
+        do {
+            TimeUnit.MILLISECONDS.sleep(SECONDS_1);
+            find = mongoDBHandler.find(FAILED_NOTIFICATION_DATABASE,
+                    FailedNotificationRunnerIT.FAILED_NOTIFICATION_COLLECTION, condition);
+        } while (find.isEmpty() && stopTime > System.currentTimeMillis());
+    }
+
+
 }

src/integrationtests/java/util/IntegrationTestBase.java

@@ -35,7 +35,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.test.context.support.AbstractTestExecutionListener;
 
-import com.ericsson.ei.handlers.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoDBHandler;
 import com.ericsson.ei.utils.HttpRequest;
 import com.ericsson.ei.utils.HttpRequest.HttpMethod;
 import com.fasterxml.jackson.databind.JsonNode;

src/main/java/com/ericsson/ei/handlers/EventToObjectMapHandler.java

@@ -26,6 +26,9 @@
 import org.springframework.stereotype.Component;
 
 import com.ericsson.ei.jmespath.JmesPathInterface;
+import com.ericsson.ei.mongo.MongoCondition;
+import com.ericsson.ei.mongo.MongoDBHandler;
+import com.ericsson.ei.mongo.MongoStringQuery;
 import com.ericsson.ei.rules.RulesObject;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JsonNode;
@@ -83,15 +86,15 @@ public ArrayList<String> getObjectsForEventId(String eventId) {
 
     public void updateEventToObjectMapInMemoryDB(RulesObject rulesObject, String event, String objectId) {
         String eventId = getEventId(rulesObject, event);
-        String condition = "{\"_id\" : \"" + eventId + "\"}";
+        final MongoCondition condition = MongoCondition.idCondition(eventId);
         ArrayList<String> list =  getEventToObjectList(eventId);
         boolean firstTime = list.isEmpty();
         list = updateList(list, eventId, objectId);
         ObjectMapper mapper = new ObjectMapper();
         JsonNode entry = null;
 
         try {
-            entry = new ObjectMapper().readValue(condition, JsonNode.class);
+            entry = new ObjectMapper().readValue(condition.toString(), JsonNode.class);
             ArrayNode jsonNode = mapper.convertValue(list, ArrayNode.class);
             ((ObjectNode) entry).set(listPropertyName, mapper.readTree(jsonNode.toString()));
             String mapStr = entry.toString();
@@ -119,7 +122,7 @@ public ArrayList<String> updateList(ArrayList<String> list, String eventId, Stri
 
     public ArrayList<String> getEventToObjectList(String eventId) {
         ArrayList<String> list = new ArrayList<String>();
-        String condition = "{\"_id\" : \"" + eventId + "\"}";
+        final MongoCondition condition = MongoCondition.idCondition(eventId);
         ArrayList<String> documents = mongodbhandler.find(databaseName, collectionName, condition);
         if (!documents.isEmpty()) {
             String mapStr = documents.get(0);
@@ -142,13 +145,14 @@ public ArrayList<String> getEventToObjectList(String eventId) {
      * @return boolean
      */
     public boolean deleteEventObjectMap(String templateName) {
-        String condition = "{\"objects\": { \"$in\" : [/.*" + templateName + "/]} }";
-        LOGGER.info("The JSON condition for deleting aggregated object is : {}", condition);
-        return mongodbhandler.dropDocument(databaseName, collectionName, condition);
+        String queryString = "{\"objects\": { \"$in\" : [/.*" + templateName + "/]} }";
+        MongoStringQuery query = new MongoStringQuery(queryString);
+        LOGGER.info("The JSON query for deleting aggregated object is : {}", query);
+        return mongodbhandler.dropDocument(databaseName, collectionName, query);
     }
 
     public boolean isEventInEventObjectMap(String eventId) {
-        String condition = "{\"_id\" : \"" + eventId + "\"}";
+        final MongoCondition condition = MongoCondition.idCondition(eventId);
         List<String> documents = mongodbhandler.find(databaseName, collectionName, condition);
         return !documents.isEmpty();
     }

src/main/java/com/ericsson/ei/handlers/MatchIdRulesHandler.java

@@ -21,6 +21,8 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import com.ericsson.ei.mongo.MongoQuery;
+import com.ericsson.ei.mongo.MongoStringQuery;
 import com.ericsson.ei.rules.RulesObject;
 
 @Component
@@ -31,7 +33,8 @@ public class MatchIdRulesHandler {
 
     public List<String> fetchObjectsById(RulesObject ruleObject, String id) {
         String matchIdString = ruleObject.getMatchIdRules();
-        String fetchQuery = replaceIdInRules(matchIdString, id);
+        String fetchQueryString = replaceIdInRules(matchIdString, id);
+        MongoQuery fetchQuery = new MongoStringQuery(fetchQueryString);
         List<String> objects = objHandler.findObjectsByCondition(fetchQuery);
         return objects;
     }