Improve reliability of integration tests (#400)

* Improve reliability of integration tests

Author: Anders Breid

src/integrationtests/java/com/ericsson/ei/integrationtests/flow/FlowStepsIT.java

@@ -14,6 +14,7 @@
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
+import org.apache.commons.lang3.StringUtils;
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.junit.Ignore;
@@ -239,19 +240,16 @@ public void jenkinsJobShouldBeDeleted() throws Throwable {
     public void mongodbShouldContainMails(int amountOfMails) throws Exception {
         long stopTime = System.currentTimeMillis() + 30000;
         Boolean mailHasBeenDelivered = false;
-        long createdDateInMillis = 0;
 
         while (mailHasBeenDelivered == false && stopTime > System.currentTimeMillis()) {
             JsonNode newestMailJson = getNewestMailFromDatabase();
 
             if (newestMailJson != null) {
-                JsonNode to = newestMailJson.get("to");
-                assertEquals("Sent mails " + to.size() + ". Expected " + amountOfMails,
-                        amountOfMails, to.size());
-
-                String createdDate = newestMailJson.get("created").get("$date").asText();
+                JsonNode recipients = newestMailJson.get("to");
+                assertEquals("Number of recipients for test email",
+                        amountOfMails, recipients.size());
 
-                createdDateInMillis = ZonedDateTime.parse(createdDate).toInstant().toEpochMilli();
+                long createdDateInMillis = getDateAsEpochMillis(newestMailJson);
                 mailHasBeenDelivered = createdDateInMillis >= startTime;
             }
 
@@ -350,6 +348,17 @@ private String extractValueForKeyInJobData(String key) {
         return value;
     }
 
+    private long getDateAsEpochMillis(JsonNode newestMailJson) {
+        long createdDateInMillis = 0;
+        String createdDate = newestMailJson.get("created").get("$date").asText();
+        if (StringUtils.isNumeric(createdDate)) {
+            createdDateInMillis = Long.parseLong(createdDate);
+        } else {
+            createdDateInMillis = ZonedDateTime.parse(createdDate).toInstant().toEpochMilli();
+        }
+        return createdDateInMillis;
+    }
+
     /**
      * Iterates the parameter array and returns the value if the key is found in given parameter
      * array.

src/integrationtests/java/util/IntegrationTestBase.java

@@ -13,6 +13,8 @@
 */
 package util;
 
+import static org.junit.Assert.fail;
+
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -44,12 +46,17 @@
 import com.mongodb.client.MongoCollection;
 import com.mongodb.client.MongoDatabase;
 
+import lombok.Setter;
+
 public abstract class IntegrationTestBase extends AbstractTestExecutionListener {
+    private static final int SECONDS_1 = 1000;
+    private static final int SECONDS_30 = 30000;
+    private static final int DEFAULT_DELAY_BETWEEN_SENDING_EVENTS = 350;
+    protected static final String MAILHOG_DATABASE_NAME = "mailhog";
+
     private static final Logger LOGGER = LoggerFactory.getLogger(IntegrationTestBase.class);
-    private static final String EIFFEL_INTELLIGENCE_DATABASE_NAME = "eiffel_intelligence";
 
     protected RabbitTemplate rabbitTemplate;
-    protected static final String MAILHOG_DATABASE_NAME = "mailhog";
     @Autowired
     protected MongoDBHandler mongoDBHandler;
     @Value("${ei.host:localhost}")
@@ -91,6 +98,13 @@ public abstract class IntegrationTestBase extends AbstractTestExecutionListener
     @Value("${sessions.collection.name}")
     private String sessionsCollectionName;
 
+    /*
+     * setFirstEventWaitTime: variable to set the wait time after publishing the first event. So any
+     * thread looking for the events don't do it before actually populating events in the database
+     */
+    @Setter
+    private int firstEventWaitTime = 0;
+
     private static ObjectMapper objectMapper = new ObjectMapper();
 
     @PostConstruct
@@ -100,30 +114,18 @@ public void init() {
     }
 
     private void cleanDatabases() {
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, aggregatedCollectionName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, waitlistCollectionName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, subscriptionCollectionName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, eventObjectMapCollectionName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, subscriptionCollectionRepatFlagHandlerName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, failedNotificationCollectionName);
-        mongoDBHandler.dropCollection(EIFFEL_INTELLIGENCE_DATABASE_NAME, sessionsCollectionName);
-    }
-
-    /*
-     * setFirstEventWaitTime: variable to set the wait time after publishing the
-     * first event. So any thread looking for the events don't do it before actually
-     * populating events in the database
-     */
-    private int firstEventWaitTime = 0;
-
-    public void setFirstEventWaitTime(int value) {
-        firstEventWaitTime = value;
+        mongoDBHandler.dropCollection(database, aggregatedCollectionName);
+        mongoDBHandler.dropCollection(database, waitlistCollectionName);
+        mongoDBHandler.dropCollection(database, subscriptionCollectionName);
+        mongoDBHandler.dropCollection(database, eventObjectMapCollectionName);
+        mongoDBHandler.dropCollection(database, subscriptionCollectionRepatFlagHandlerName);
+        mongoDBHandler.dropCollection(database, failedNotificationCollectionName);
+        mongoDBHandler.dropCollection(database, sessionsCollectionName);
     }
 
     /**
-     * Override this if you have more events that will be registered to event to
-     * object map but it is not visible in the test. For example from upstream or
-     * downstream from event repository
+     * Override this if you have more events that will be registered to event to object map but it
+     * is not visible in the test. For example from upstream or downstream from event repository
      *
      * @return
      */
@@ -153,13 +155,19 @@ protected void sendEventsAndConfirm() throws Exception {
                     TimeUnit.MILLISECONDS.sleep(firstEventWaitTime);
                     alreadyExecuted = true;
                 }
+                /**
+                 * Without a small delay between the sending of 2 events, one may risk to be lost in
+                 * an empty void if not received by EI
+                 */
+                TimeUnit.MILLISECONDS.sleep(DEFAULT_DELAY_BETWEEN_SENDING_EVENTS);
             }
 
-            // wait for all events to be processed
             waitForEventsToBeProcessed(eventsCount);
             checkResult(getCheckData());
         } catch (IOException e) {
-            LOGGER.error(e.getMessage(), e);
+            String message = String.format("Failed to send Eiffel messages. Reason: %s", e.getMessage());
+            LOGGER.error(message, e);
+            fail(message);
         }
     }
 
@@ -180,8 +188,7 @@ protected void sendEventsAndConfirm() throws Exception {
     protected abstract List<String> getEventNamesToSend() throws IOException;
 
     /**
-     * @return map, where key - _id of expected aggregated object value - expected
-     *         aggregated object
+     * @return map, where key - _id of expected aggregated object value - expected aggregated object
      *
      */
     protected abstract Map<String, JsonNode> getCheckData() throws IOException;
@@ -194,42 +201,45 @@ protected JsonNode getJSONFromFile(String filePath) throws IOException {
     /**
      * Wait for certain amount of events to be processed.
      *
-     * @param eventsCount - An int which indicated how many events that should be
-     *                    processed.
+     * @param eventsCount - An int which indicated how many events that should be processed.
      * @return
      * @throws InterruptedException
      */
     protected void waitForEventsToBeProcessed(int eventsCount) throws InterruptedException {
         // wait for all events to be processed
-        long stopTime = System.currentTimeMillis() + 60000;
+        long stopTime = System.currentTimeMillis() + SECONDS_30;
         long processedEvents = 0;
         while (processedEvents < eventsCount && stopTime > System.currentTimeMillis()) {
             processedEvents = countProcessedEvents(database, event_map);
             LOGGER.debug("Have gotten: " + processedEvents + " out of: " + eventsCount);
-            TimeUnit.MILLISECONDS.sleep(1000);
+            TimeUnit.MILLISECONDS.sleep(SECONDS_1);
+        }
+
+        if (processedEvents < eventsCount) {
+            fail(String.format(
+                    "EI did not process all sent events. Processed '%s' events out of '%s' sent.",
+                    processedEvents, eventsCount));
         }
     }
 
     /**
      * Counts documents that were processed
      *
-     * @param database   - A string with the database to use
-     * @param collection - A string with the collection to use
+     * @param database       - A string with the database to use
+     * @param collectionName - A string with the collection to use
      * @return amount of processed events
      */
-    private long countProcessedEvents(String database, String collection) {
-        MongoClient mongoClient = null;
-        mongoClient = mongoDBHandler.getMongoClient();
+    private long countProcessedEvents(String database, String collectionName) {
+        MongoClient mongoClient = mongoDBHandler.getMongoClient();
         MongoDatabase db = mongoClient.getDatabase(database);
-        MongoCollection table = db.getCollection(collection);
-        return table.count();
+        MongoCollection collection = db.getCollection(collectionName);
+        return collection.count();
     }
 
     /**
      * Retrieves the result from EI and checks if it equals the expected data
      *
-     * @param expectedData - A Map<String, JsonNode> which contains the expected
-     *                     data
+     * @param expectedData - A Map<String, JsonNode> which contains the expected data
      * @return
      * @throws URISyntaxException
      * @throws IOException
@@ -248,24 +258,22 @@ private void checkResult(final Map<String, JsonNode> expectedData)
             String id = (String) pair.getKey();
             expectedJSON = (JsonNode) pair.getValue();
 
-            long maxWaitTime = 300000;
-            long stopTime = System.currentTimeMillis() + maxWaitTime;
+            long stopTime = System.currentTimeMillis() + SECONDS_30;
             while (!foundMatch && stopTime > System.currentTimeMillis()) {
                 actualJSON = queryAggregatedObject(id);
 
                 /*
-                 * This is a workaround for expectedJSON.equals(acutalJSON) as that does not
-                 * work with strict equalization
+                 * This is a workaround for expectedJSON.equals(acutalJSON) as that does not work
+                 * with strict equalization
                  */
                 try {
                     JSONAssert.assertEquals(expectedJSON.toString(), actualJSON.toString(), false);
                     foundMatch = true;
                 } catch (AssertionError e) {
-                    TimeUnit.SECONDS.sleep(1);
+                    TimeUnit.MILLISECONDS.sleep(SECONDS_1);
                 }
             }
         }
-
         JSONAssert.assertEquals(expectedJSON.toString(), actualJSON.toString(), false);
     }
 

src/test/java/com/ericsson/ei/flowtests/FlowTest.java

@@ -71,7 +71,7 @@ public class FlowTest extends FlowTestBase {
     private static final String UPSTREAM_RESULT_FILE = "upStreamResultFile.json";
     private static final String UPSTREAM_INPUT_FILE = "upStreamInput.json";
     private static final String EVENTS_FILE_PATH = "src/test/resources/ArtifactFlowTestEvents.json";
-    private static final String AGGREGATED_OBJECT_FILE_PATH = "src/test/resources/AggregatedDocumentInternalCompositionLatestIT.json";
+    private static final String AGGREGATED_OBJECT_FILE_PATH = "src/test/resources/AggregatedDocumentInternalCompositionLatestUnitTest.json";
     private static final String AGGREGATED_OBJECT_ID = "aacc3c87-75e0-4b6d-88f5-b1a5d4e62b43";
 
     @Autowired