Add frontend functional tests for testrules (#43)

* Add frontend functional tests for testrules

- All functional tests for testrules fronend has been
  implemented.
- Fix minor frontend framework to support firefox download
- Fix minor frontend js and html code for uploading to support easier selenium testing

Author: erik-edling

.gitignore

@@ -16,4 +16,5 @@ log/
 target/
 
 # Others
-derby.log
+derby.log
+EIBackendInstancesInformation.json

pom.xml

@@ -89,12 +89,12 @@
     <dependency>
       <groupId>org.seleniumhq.selenium</groupId>
       <artifactId>selenium-firefox-driver</artifactId>
-      <version>3.12.0</version>
+      <version>3.9.1</version>
     </dependency>
     <dependency>
       <groupId>org.seleniumhq.selenium</groupId>
       <artifactId>selenium-server</artifactId>
-      <version>3.12.0</version>
+      <version>3.9.1</version>
     </dependency>
     <!-- https://mvnrepository.com/artifact/org.mock-server/mockserver-client-java -->
     <dependency>

src/functionaltest/java/com/ericsson/ei/config/SeleniumConfig.java

@@ -1,21 +1,30 @@
 package com.ericsson.ei.config;
 
 import com.ericsson.ei.frontend.exception.OSNotSupportedException;
+import com.google.common.io.Files;
 
-import java.util.concurrent.TimeUnit;
+import java.io.File;
 
 import org.apache.commons.lang3.SystemUtils;
 import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.firefox.FirefoxOptions;
+import org.openqa.selenium.firefox.FirefoxProfile;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class SeleniumConfig {
 
     private static final Logger log = LoggerFactory.getLogger(SeleniumConfig.class);
+    private static File tempDownloadDirectory = Files.createTempDir();
 
     public static FirefoxDriver getFirefoxDriver() throws OSNotSupportedException {
         FirefoxDriver driver;
+        FirefoxProfile firefoxProfile = new FirefoxProfile();
+
+        firefoxProfile.setPreference("browser.download.folderList",2);
+        firefoxProfile.setPreference("browser.download.dir", tempDownloadDirectory.getPath());
+        firefoxProfile.setPreference("browser.helperApps.neverAsk.saveToDisk", "application/json");
+
         if (SystemUtils.IS_OS_LINUX) {
             System.setProperty("webdriver.gecko.driver", "src/functionaltest/resources/geckodriver");
         } else if (SystemUtils.IS_OS_WINDOWS) {
@@ -24,13 +33,18 @@ public static FirefoxDriver getFirefoxDriver() throws OSNotSupportedException {
             log.error("OS currently not supported.");
             throw new OSNotSupportedException();
         }
-        FirefoxOptions firefoxOptions = new FirefoxOptions().setHeadless(true);
+        FirefoxOptions firefoxOptions = new FirefoxOptions()
+                .setHeadless(true)
+                .setProfile(firefoxProfile);
 
         driver = new FirefoxDriver(firefoxOptions);
-        driver.manage().timeouts().implicitlyWait(30, TimeUnit.SECONDS);
         return driver;
     }
 
+    public static File getTempDownloadDirectory() {
+        return tempDownloadDirectory;
+    }
+
     public static String getBaseUrl(int randomServerPort) {
         String baseUrl = "http://localhost:" + randomServerPort;
         return baseUrl;

src/functionaltest/java/com/ericsson/ei/frontend/SeleniumBaseClass.java

@@ -2,6 +2,7 @@
 
 import static org.junit.Assert.fail;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -10,13 +11,14 @@
 import com.ericsson.ei.config.SeleniumConfig;
 
 import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.tomcat.util.http.fileupload.FileUtils;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Ignore;
 import org.junit.runner.RunWith;
 import org.mockito.InjectMocks;
 import org.mockito.MockitoAnnotations;
-import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
@@ -41,7 +43,7 @@ public class SeleniumBaseClass {
     @Autowired
     WebController webController;
 
-    protected WebDriver driver;
+    protected FirefoxDriver driver;
     protected String baseUrl;
 
     private StringBuffer verificationErrors = new StringBuffer();
@@ -50,20 +52,24 @@ public class SeleniumBaseClass {
     public void setUp() throws Exception {
         MockitoAnnotations.initMocks(this);
         webController.setFrontendServicePort(randomServerPort);
+
         driver = SeleniumConfig.getFirefoxDriver();
         baseUrl = SeleniumConfig.getBaseUrl(randomServerPort);
     }
 
     @After
     public void tearDown() throws Exception {
+        File tempDownloadDirectory = SeleniumConfig.getTempDownloadDirectory();
+        FileUtils.deleteDirectory(tempDownloadDirectory);
+
         driver.quit();
         String verificationErrorString = verificationErrors.toString();
         if (!verificationErrorString.equals("")) {
             fail(verificationErrorString);
         }
     }
 
-    protected String getResponseObjectFromFile(String filepath) throws IOException {
-        return new String(Files.readAllBytes(Paths.get(filepath)), StandardCharsets.UTF_8);
+    protected String getJSONStringFromFile(String filepath) throws IOException {
+        return new String(Files.readAllBytes(Paths.get(filepath)), StandardCharsets.UTF_8).replaceAll("[\\r\\n ]", "");
     }
 }

src/functionaltest/java/com/ericsson/ei/frontend/TemplateTestCase.java

@@ -1,6 +1,7 @@
 package com.ericsson.ei.frontend;
 
 import org.junit.*;
+import org.openqa.selenium.support.ui.WebDriverWait;
 
 import static org.junit.Assert.*;
 
@@ -18,13 +19,14 @@ public void testTemplateTestCase() throws Exception {
         assertEquals("Eiffel Intelligence", indexPageObject.getTitle());
 
         //The lines below contains selenium interaction with mocking
-        String response = this.getResponseObjectFromFile(
+        String response = this.getJSONStringFromFile(
                 "src/functionaltest/resources/responses/SubscriptionObjects.json");
+        new WebDriverWait(driver, 10).until((webdriver) -> indexPageObject.presenceOfReloadButton());
         indexPageObject.clickReloadButton(response);
 
         //Click on test rules page button and verify that it is opened
         TestRulesPage testRulesPage = indexPageObject.clickTestRulesPage();
-        assertEquals("Test Rules", testRulesPage.getTestRulesHeader());
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfTestRulesHeader());
     }
 
 }

src/functionaltest/java/com/ericsson/ei/frontend/TestRulesFunctionality.java

@@ -0,0 +1,98 @@
+package com.ericsson.ei.frontend;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.Test;
+import org.openqa.selenium.support.ui.WebDriverWait;
+
+import com.ericsson.ei.config.SeleniumConfig;
+import com.ericsson.ei.frontend.pageobjects.IndexPage;
+import com.ericsson.ei.frontend.pageobjects.TestRulesPage;
+
+public class TestRulesFunctionality extends SeleniumBaseClass {
+
+    private static final String DOWNLOADEDRULESTEMPLATEFILEPATH = String.join(
+            File.separator, SeleniumConfig.getTempDownloadDirectory().getPath(), "rulesTemplate.json");
+
+    private static final String RULESTEMPLATEFILEPATH = String.join(
+            File.separator, "src", "functionaltest", "resources", "responses", "RulesTemplateObject.json");
+    private static final String DOWNLOADEDRULESFILEPATH = String.join(File.separator, SeleniumConfig.getTempDownloadDirectory().getPath(), "rules.json");
+
+    private static final String DOWNLOADEDEVENTSTEMPLATEFILEPATH = String.join(
+            File.separator, SeleniumConfig.getTempDownloadDirectory().getPath(), "eventsTemplate.json");
+    private static final String EVENTSTEMPLATEFILEPATH = String.join(
+            File.separator, "src", "functionaltest", "resources", "responses", "EventsTemplateObject.json");
+
+    private static final String AGGREGATEDOBJECTFILEPATH = String.join(
+            File.separator, "src", "functionaltest", "resources", "responses", "AggregatedObjectResponse.json");
+    @Test
+    public void testJourneyToFindAggregatedObjectButton() throws Exception {
+        // Load index page and wait for it to load
+        IndexPage indexPageObject = new IndexPage(mockedHttpClient, driver, baseUrl);
+        indexPageObject.loadPage();
+        TimeUnit.SECONDS.sleep(3);
+
+        // Verify that we can navigate to test rules page
+        TestRulesPage testRulesPage = indexPageObject.clickTestRulesPage();
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfTestRulesHeader());
+
+        // Verify that "download rules template" button works
+        String mockedResponse = this.getJSONStringFromFile(RULESTEMPLATEFILEPATH);
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfClickDownloadRulesTemplateButton());
+        testRulesPage.clickDownloadRulesTemplate(mockedResponse);
+        new WebDriverWait(driver, 10).until((webdriver) -> Files.exists(Paths.get(DOWNLOADEDRULESTEMPLATEFILEPATH)));
+        String downloadedRulesTemplate = this.getJSONStringFromFile(DOWNLOADEDRULESTEMPLATEFILEPATH);
+        assertEquals(mockedResponse, downloadedRulesTemplate);
+
+        // Verify that uploading the downloaded template file works.
+        testRulesPage.uploadRulesTemplate(DOWNLOADEDRULESTEMPLATEFILEPATH);
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfRuleNumber(2));
+        String firstRule = testRulesPage.getFirstRuleText();
+        assertEquals(true, downloadedRulesTemplate.contains(firstRule));
+
+        // Verify that it is possible to download rules
+        testRulesPage.clickDownloadRulesButton();
+        new WebDriverWait(driver, 10).until((webdriver) -> Files.exists(Paths.get(DOWNLOADEDRULESFILEPATH)));
+        String downloadedRules = this.getJSONStringFromFile(DOWNLOADEDRULESFILEPATH);
+        assertEquals(downloadedRulesTemplate, downloadedRules);
+
+        // Verify that add rule button works
+        testRulesPage.clickAddRuleButton();
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfRuleNumber(3));
+
+        // Verify that removing a rule works
+        testRulesPage.clickRemoveRuleNumber(3);
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfRuleNumber(3) == false);
+
+        // Verify that "download events template" button works
+        String downloadEventsTemplateMockedResponse = this.getJSONStringFromFile(EVENTSTEMPLATEFILEPATH);
+        testRulesPage.clickDownloadEventsTemplate(downloadEventsTemplateMockedResponse);
+        new WebDriverWait(driver, 10).until((webdriver) -> Files.exists(Paths.get(DOWNLOADEDEVENTSTEMPLATEFILEPATH)));
+        String downloadedEventsTemplate = this.getJSONStringFromFile(DOWNLOADEDEVENTSTEMPLATEFILEPATH);
+        assertEquals(downloadEventsTemplateMockedResponse, downloadedEventsTemplate);
+
+        // Verify that uploading the downloaded template file works.
+        testRulesPage.uploadEventsTemplate(DOWNLOADEDEVENTSTEMPLATEFILEPATH);
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfEventNumber(2));
+        String firstEvent = testRulesPage.getFirstEventText();
+        assertEquals(true, downloadedEventsTemplate.contains(firstEvent));
+
+        // Verify that add rule button works
+        testRulesPage.clickAddEventButton();
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfEventNumber(3));
+
+        // Verify that removing a rule works
+        testRulesPage.clickRemoveEventNumber(3);
+        new WebDriverWait(driver, 10).until((webdriver) -> testRulesPage.presenceOfEventNumber(3) == false);
+
+        // Verify that find aggregated object button works
+        String findAggregatedObjectResponse = this.getJSONStringFromFile(AGGREGATEDOBJECTFILEPATH);
+        testRulesPage.clickFindAggregatedObject(findAggregatedObjectResponse);
+        assertEquals(findAggregatedObjectResponse, testRulesPage.getAggregatedResultData());
+    }
+}

src/functionaltest/java/com/ericsson/ei/frontend/pageobjects/IndexPage.java

@@ -6,13 +6,14 @@
 import org.apache.http.impl.client.CloseableHttpClient;
 import org.mockito.Mockito;
 import org.openqa.selenium.By;
-import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.NoSuchElementException;
 import org.openqa.selenium.WebElement;
+import org.openqa.selenium.firefox.FirefoxDriver;
 
 import java.io.IOException;
 
 public class IndexPage extends PageBaseClass {
-    public IndexPage(CloseableHttpClient mockedHttpClient, WebDriver driver,
+    public IndexPage(CloseableHttpClient mockedHttpClient, FirefoxDriver driver,
             String baseUrl) throws ClientProtocolException, IOException {
         super(mockedHttpClient, driver, baseUrl);
     }
@@ -44,4 +45,13 @@ public void clickReloadButton(String responseData) throws ClientProtocolExceptio
         WebElement reloadButton = driver.findElement(By.className("table_reload"));
         reloadButton.click();
     }
+
+    public Object presenceOfReloadButton() {
+        try {
+            driver.findElement(By.className("table_reload"));
+            return true;
+        } catch (NoSuchElementException e){
+            return false;
+        }
+    }
 }

src/functionaltest/java/com/ericsson/ei/frontend/pageobjects/PageBaseClass.java

@@ -15,7 +15,7 @@
 import org.apache.http.message.BasicStatusLine;
 import org.mockito.Mockito;
 import org.openqa.selenium.JavascriptExecutor;
-import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.firefox.FirefoxDriver;
 import org.openqa.selenium.support.PageFactory;
 import org.openqa.selenium.support.ui.ExpectedCondition;
 import org.openqa.selenium.support.ui.WebDriverWait;
@@ -24,11 +24,11 @@ public class PageBaseClass {
     CloseableHttpClient mockedHttpClient;
     CloseableHttpResponse mockedHttpResponse;
 
-    protected WebDriver driver;
+    protected FirefoxDriver driver;
     protected String baseUrl;
 
     public PageBaseClass(CloseableHttpClient mockedHttpClient,
-            WebDriver driver, String baseUrl) throws ClientProtocolException, IOException {
+            FirefoxDriver driver, String baseUrl) throws ClientProtocolException, IOException {
         super();
         this.mockedHttpClient = mockedHttpClient;
         this.driver = driver;