test: upgrade to selenium v4

.github/workflows/maven-regression-test.yml → .github/workflows/maven-regression-test-rest.yml

@@ -1,4 +1,4 @@
-name: Maven Regression Test
+name: Maven Regression Test (REST)
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
     branches: [ "main" ]
 
 jobs:
-  regression_test_ENG:
+  test_ENG:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -19,8 +19,8 @@ jobs:
       - run: mvn clean
       - run: mvn verify -P regression-testing-rest -D base.url=http://eng.elimu.ai
 
-  regression_test_TGL:
-    needs: regression_test_ENG
+  test_TGL:
+    needs: test_ENG
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -32,8 +32,8 @@ jobs:
       - run: mvn clean
       - run: mvn verify -P regression-testing-rest -D base.url=http://tgl.elimu.ai
 
-  regression_test_HIN:
-    needs: regression_test_TGL
+  test_HIN:
+    needs: test_TGL
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.github/workflows/maven-regression-test-ui.yml

@@ -0,0 +1,46 @@
+name: Maven Regression Test (UI)
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test_ENG:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+          cache: maven
+      - run: mvn clean
+      - run: mvn verify -P regression-testing-ui -D headless=true -D base.url=http://eng.elimu.ai
+
+  test_TGL:
+    needs: test_ENG
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+          cache: maven
+      - run: mvn clean
+      - run: mvn verify -P regression-testing-ui -D headless=true -D base.url=http://tgl.elimu.ai
+
+  test_HIN:
+    needs: test_TGL
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 17
+          cache: maven
+      - run: mvn clean
+      - run: mvn verify -P regression-testing-ui -D headless=true -D base.url=http://hin.elimu.ai

INSTALL.md

@@ -39,24 +39,7 @@ Next, to access the application in your browser, go to [http://localhost:8080/we
 
 ## Test 🚨
 
-### Unit testing
-
-Run all tests:
-
-    mvn clean test
-
-Run individual tests:
-
-    mvn clean test -D test=WordDaoTest
-
-### Code coverage
-
-[![codecov](https://codecov.io/gh/elimu-ai/webapp/branch/main/graph/badge.svg?token=T1F9OTQVOH)](https://codecov.io/gh/elimu-ai/webapp)
-
-[![](https://codecov.io/gh/elimu-ai/webapp/branch/main/graphs/tree.svg?token=T1F9OTQVOH)](https://codecov.io/gh/elimu-ai/webapp)
-
-    mvn test
-    open target/site/jacoco/index.html
+See [`TEST.md`](./TEST.md)
 
 ## Test server
 

TEST.md

@@ -0,0 +1,83 @@
+## Test Instructions
+
+### Unit testing ☑️
+
+Run all tests:
+
+    mvn clean test
+
+Run individual tests:
+
+    mvn clean test -D test=WordDaoTest
+
+#### Code coverage 📊
+
+[![codecov](https://codecov.io/gh/elimu-ai/webapp/branch/main/graph/badge.svg?token=T1F9OTQVOH)](https://codecov.io/gh/elimu-ai/webapp)
+
+[![](https://codecov.io/gh/elimu-ai/webapp/branch/main/graphs/tree.svg?token=T1F9OTQVOH)](https://codecov.io/gh/elimu-ai/webapp)
+
+    mvn test
+    open target/site/jacoco/index.html
+
+### Regression testing
+
+#### REST API 
+
+First, launch the webapp on localhost:
+
+    mvn jetty:run
+
+Then, in another terminal window run all the regression tests against the REST API:
+
+    mvn verify -P regression-testing-rest
+
+> [!TIP]
+> If you want to run the tests against another URL, set the `base.url` system property:
+> 
+>     mvn verify -P regression-testing-rest -D base.url=https://eng.elimu.ai
+
+#### UI
+
+First, launch the webapp on localhost:
+
+    mvn jetty:run
+
+Then, in another terminal window run all the regression tests against the UI:
+
+    mvn verify -P regression-testing-ui
+
+> [!TIP]
+> If you want to run the tests against another URL, set the `base.url` system property:
+> 
+>     mvn verify -P regression-testing-ui -D base.url=https://eng.elimu.ai
+
+##### Headless 😶‍🌫️
+
+If you don't want the automated test software to open browser windows, you can disable that by setting the `headless` system property:
+
+    mvn verify -P regression-testing-ui -D headless=true
+
+![](https://private-user-images.githubusercontent.com/1451036/361187317-35e99a19-f42d-4934-a0ba-f3d1e06ed6f6.png)
+
+---
+
+<p align="center">
+  <img src="https://github.com/elimu-ai/webapp/blob/main/src/main/webapp/static/img/logo-text-256x78.png" />
+</p>
+<p align="center">
+  elimu.ai - Free open-source learning software for out-of-school children 🚀✨
+</p>
+<p align="center">
+  <a href="https://elimu.ai">Website 🌐</a>
+  &nbsp;•&nbsp;
+  <a href="https://github.com/elimu-ai/wiki#readme">Wiki 📃</a>
+  &nbsp;•&nbsp;
+  <a href="https://github.com/orgs/elimu-ai/projects?query=is%3Aopen">Projects 👩🏽‍💻</a>
+  &nbsp;•&nbsp;
+  <a href="https://github.com/elimu-ai/wiki/milestones">Milestones 🎯</a>
+  &nbsp;•&nbsp;
+  <a href="https://github.com/elimu-ai/wiki#open-source-community">Community 👋🏽</a>
+  &nbsp;•&nbsp;
+  <a href="https://www.drips.network/app/drip-lists/41305178594442616889778610143373288091511468151140966646158126636698">Support 💜</a>
+</p>
+

pom.xml

@@ -575,8 +575,8 @@
         </dependency>
         <dependency>
             <groupId>org.seleniumhq.selenium</groupId>
-            <artifactId>selenium-chrome-driver</artifactId>
-            <version>3.141.59</version>
+            <artifactId>selenium-java</artifactId>
+            <version>4.23.1</version>
         </dependency>
     </dependencies>
 </project>

src/test/java/selenium/DomainHelper.java

@@ -1,9 +1,5 @@
 package selenium;
 
-import ai.elimu.model.v2.enums.Language;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Properties;
 import org.apache.commons.lang.StringUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -13,27 +9,14 @@ public class DomainHelper {
     private static final Logger logger = LogManager.getLogger();
 
     public static String getBaseUrl() {
-        // Read property set on the command line: 
+        String baseUrl = "http://localhost:8080/webapp";
+
+        // Read "base.url" property set on the command line: 
         //    mvn clean verify -P regression-testing-rest -D base.url=https://eng.test.elimu.ai
         String baseUrlSystemProperty = System.getProperty("base.url");
         logger.info("baseUrlSystemProperty: \"" + baseUrlSystemProperty + "\"");
-
-        String baseUrl = baseUrlSystemProperty;
-
-        if (StringUtils.isBlank(baseUrl)) {
-            // Read property set in the "config.properties" file
-            // This will trigger if no "base.url" property is set on the command line
-            InputStream inputStream = DomainHelper.class.getClassLoader().getResourceAsStream("config.properties");
-            Properties properties = new Properties();
-            try {
-                properties.load(inputStream);
-                String contentLanguageProperty = properties.getProperty("content.language");
-                logger.info("contentLanguageProperty: \"" + contentLanguageProperty + "\"");
-                Language language = Language.valueOf(contentLanguageProperty);
-                baseUrl = "https://" + language.toString().toLowerCase() + ".test.elimu.ai";
-            } catch (IOException ex) {
-                logger.error(ex);
-            }
+        if (StringUtils.isNotBlank(baseUrlSystemProperty)) {
+            baseUrl = baseUrlSystemProperty;
         }
 
         logger.info("baseUrl: \"" + baseUrl + "\"");

src/test/java/selenium/ErrorHelper.java

@@ -7,6 +7,5 @@ public class ErrorHelper {
     public static void verifyNoScriptOrMarkupError(WebDriver driver) {
         JavaScriptHelper.verifyNoJavaScriptError(driver);
 //        MarkupValidationHelper.verifyNoMarkupError(driver.getPageSource());
-        // TODO: verify no missing translations in page source ("???...???")
     }
 }

src/test/java/selenium/web/WelcomePage.java

@@ -12,7 +12,7 @@ public class WelcomePage {
     public WelcomePage(WebDriver driver) {
         this.driver = driver;
 
-        driver.findElement(By.id("welcomePageTEST"));
+        driver.findElement(By.id("welcomePage"));
 
         ErrorHelper.verifyNoScriptOrMarkupError(driver);
     }

src/test/java/selenium/web/WelcomePageTest.java

@@ -2,10 +2,13 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
+import org.openqa.selenium.chrome.ChromeOptions;
+
 import selenium.DomainHelper;
 
 public class WelcomePageTest {
@@ -17,13 +20,29 @@ public class WelcomePageTest {
     @BeforeEach
     public void setUp() { 
         logger.info("setUp");
+
+        ChromeOptions chromeOptions = new ChromeOptions();
+
+        // Read "headless" property set on the command line: 
+        //    mvn clean verify -P regression-testing-ui -D headless=true -D base.url=https://eng.test.elimu.ai
+        String headlessSystemProperty = System.getProperty("headless");
+        logger.info("headlessSystemProperty: \"" + headlessSystemProperty + "\"");
+        if ("true".equals(headlessSystemProperty)) {
+            chromeOptions.addArguments("headless");
+        }
 
-        // See https://www.selenium.dev/documentation/en/webdriver/driver_requirements/#chromium-chrome
-        System.setProperty("webdriver.chrome.driver", "src/test/resources/selenium/chrome_80.0.3987.106/chromedriver_mac64/chromedriver");
-        driver = new ChromeDriver();
+        driver = new ChromeDriver(chromeOptions);
+
         driver.get(DomainHelper.getBaseUrl());
     }
 
+    @AfterEach
+    public void tearDown() {
+        logger.info("tearDown");
+
+        driver.quit();
+    }
+
     @Test
     public void testWelcomePage() {
         logger.info("testWelcomePage");