HPCC-31857 Develop an automated ECL Watch Test Suite

.github/workflows/build-docker.yml

@@ -176,13 +176,13 @@ jobs:
             ${{ github.workspace }}/HPCC-Platform/.github/workflows/timeoutcmd
           if-no-files-found: error
 
-      - name: Upload UI Test Files
+      - name: Upload ECL Watch UI Test Files
         if: ${{ inputs.upload-package == true }}
         uses: actions/upload-artifact@v3
         with:
-          name: ${{ inputs.asset-name }}-ui_test-files
+          name: ${{ inputs.asset-name }}-ecl_watch_ui_tests
           path: |
-            ${{ github.workspace }}/HPCC-Platform/esp/src/test-ui/**/*
+            ${{ github.workspace }}/HPCC-Platform/esp/src/test-ui/tests/**/*
           if-no-files-found: error
 
       - name: Upload Error Logs

.github/workflows/test-ui-gh_runner.yml

@@ -17,7 +17,10 @@ on:
         type: string
         description: 'Dependencies'
         required: false
-        default: 'bison flex build-essential binutils-dev curl lsb-release libcppunit-dev python3-dev default-jdk r-base-dev r-cran-rcpp r-cran-rinside r-cran-inline libtool autotools-dev automake git cmake xmlstarlet'
+        default: 'bison flex build-essential binutils-dev curl lsb-release libcppunit-dev python3-dev r-base-dev r-cran-rcpp r-cran-rinside r-cran-inline libtool autotools-dev automake git cmake xmlstarlet'
+
+env:
+  uploadArtifact: false
 
 jobs:
 
@@ -33,17 +36,17 @@ jobs:
       - name: Download UI Test Files
         uses: actions/download-artifact@v3
         with:
-          name: ${{ inputs.asset-name }}-ui_test-files
-          path: ${{ inputs.asset-name }}-ui_test-files
+          name: ${{ inputs.asset-name }}-ecl_watch_ui_tests
+          path: ${{ inputs.asset-name }}-ecl_watch_ui_tests
 
       - name: Check ECLWatch UI Test Directory
         id: check
         run: |
-          if [[ ! -d ${{ inputs.asset-name }}-ui_test-files ]]
+          if [[ ! -d ${{ inputs.asset-name }}-ecl_watch_ui_tests ]]
           then
-              echo "ECLWatch UI ${{ inputs.asset-name }}-ui_test-files directory missing."
+              echo "ECLWatch UI ${{ inputs.asset-name }}-ecl_watch_ui_tests directory missing."
           else
-              javaFilesCount=$(find ${{ inputs.asset-name }}-ui_test-files/ -iname '*.java' -type f -print | wc -l )
+              javaFilesCount=$(find ${{ inputs.asset-name }}-ecl_watch_ui_tests/ -iname '*.java' -type f -print | wc -l )
               echo "Number of test java files is $javaFilesCount"
               if [[ ${javaFilesCount} -eq 0 ]]
               then
@@ -66,7 +69,6 @@ jobs:
             unzip \
             xvfb \
             libxi6 \
-            default-jdk \
             gdb \
             ${{ inputs.dependencies }}
 
@@ -95,7 +97,7 @@ jobs:
           chmod +x ./${{ inputs.asset-name }}-support-files/*
           sudo cp ./${{ inputs.asset-name }}-support-files/* /opt/HPCCSystems/bin
 
-          chmod +x ./${{ inputs.asset-name }}-ui_test-files/*
+          chmod +x ./${{ inputs.asset-name }}-ecl_watch_ui_tests/*
 
       - name: Start HPCC-Platform
         shell: "bash"
@@ -134,36 +136,63 @@ jobs:
         if: steps.check.outputs.runtests
         shell: "bash"
         run: |
+          sudo apt remove -y openjdk-11-jdk
+          sudo apt autoremove -y
+          sudo apt update
+          sudo apt install -y openjdk-21-jdk
+          sudo update-alternatives --install /usr/bin/java java /usr/lib/jvm/java-21-openjdk-amd64/bin/java 1
+          sudo update-alternatives --install /usr/bin/javac javac /usr/lib/jvm/java-21-openjdk-amd64/bin/javac 1
+          sudo update-alternatives --set java /usr/lib/jvm/java-21-openjdk-amd64/bin/java
+          sudo update-alternatives --set javac /usr/lib/jvm/java-21-openjdk-amd64/bin/javac
+          export JAVA_HOME=/usr/lib/jvm/java-21-openjdk-amd64/bin/java
+          export PATH=$PATH:$JAVA_HOME/bin
+          echo $JAVA_HOME
+          echo $PATH
+          which "java"
+          which "javac"
+          java -version
+          javac -version
           wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
           sudo apt-get install -y ./google-chrome-stable_current_amd64.deb
-          wget https://chromedriver.storage.googleapis.com/2.41/chromedriver_linux64.zip
-          unzip chromedriver_linux64.zip
-          sudo mv chromedriver /usr/bin/chromedriver
+          wget https://storage.googleapis.com/chrome-for-testing-public/126.0.6478.126/linux64/chromedriver-linux64.zip
+          unzip chromedriver-linux64.zip -d chromedriver
+          sudo mv chromedriver/chromedriver-linux64/chromedriver /usr/bin/chromedriver
           sudo chown root:root /usr/bin/chromedriver
           sudo chmod +x /usr/bin/chromedriver
-          wget https://selenium-release.storage.googleapis.com/3.141/selenium-server-standalone-3.141.59.jar
-          wget http://www.java2s.com/Code/JarDownload/testng/testng-6.8.7.jar.zip
-          unzip testng-6.8.7.jar.zip
-
-      - name: Run Tests
-        timeout-minutes: 10 # generous, current runtime is ~1min, this should be increased if new tests are added
+          wget https://repo1.maven.org/maven2/org/testng/testng/7.7.1/testng-7.7.1.jar
+          wget https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-annotations/2.17.0/jackson-annotations-2.17.0.jar
+          wget https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/2.17.0/jackson-core-2.17.0.jar
+          wget https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-databind/2.17.0/jackson-databind-2.17.0.jar
+          wget https://repo1.maven.org/maven2/com/beust/jcommander/1.82/jcommander-1.82.jar
+          wget https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.22.0/selenium-java-4.22.0.zip
+          wget https://repo1.maven.org/maven2/org/slf4j/slf4j-api/1.7.30/slf4j-api-1.7.30.jar
+          wget https://repo1.maven.org/maven2/org/slf4j/slf4j-simple/1.7.30/slf4j-simple-1.7.30.jar
+          unzip selenium-java-4.22.0.zip -d selenium-libs
+
+      - name: Run ECL Watch UI Tests
+        timeout-minutes: 80 # generous, current runtime is ~38 minutes, this should be increased if new tests are added
         if: steps.check.outputs.runtests
         shell: "bash"
         run: |
-          export CLASSPATH=".:${{ github.workspace }}/selenium-server-standalone-3.141.59.jar:${{ github.workspace }}/testng-6.8.7.jar"
-          pushd ${{ inputs.asset-name }}-ui_test-files
-          ./run.sh tests http://localhost:8010 > eclWatchUiTest.log 2>&1
-          retCode=$?
-          echo "UI test done"
-          [[ $retCode -ne 0 ]] && exit 1
+          export CLASSPATH=".:${{ inputs.asset-name }}-ecl_watch_ui_tests:${{ github.workspace }}/selenium-libs/*:${{ github.workspace }}/testng-7.7.1.jar:${{ github.workspace }}/jackson-annotations-2.17.0.jar:${{ github.workspace }}/jackson-core-2.17.0.jar:${{ github.workspace }}/jackson-databind-2.17.0.jar:${{ github.workspace }}/jcommander-1.82.jar:${{ github.workspace }}/slf4j-api-1.7.30.jar:${{ github.workspace }}/slf4j-simple-1.7.30.jar"
+          pushd ${{ inputs.asset-name }}-ecl_watch_ui_tests
+          find . -iname '*.java' -type f -print -exec javac -Xlint:none {} \;
+          java framework.TestRunner -l detail -p /home/runner/HPCCSystems-regression/log/
+          echo "ECL Watch UI test done"
+          lines=$(wc -l < error_ecl_test.log)
+          [[ $lines -ne 0 ]] && exit 1
+          if [[ -f debug_ecl_test.log || -f detail_ecl_test.log || -f exception_ecl_test.log ]]
+          then 
+              echo "uploadArtifact=true" >> $GITHUB_ENV
+          fi
           popd
 
-      - name: eclwatch-ui-test-logs-artifact
-        if: ${{ failure() || cancelled() }}
+      - name: Upload ECL Watch UI Test Logs To Artifact
+        if: ${{ failure() || cancelled() || env.uploadArtifact == 'true' }}
         uses: actions/upload-artifact@v3
         with:
-          name: ${{ inputs.asset-name }}-ui_test-logs
+          name: ${{ inputs.asset-name }}-ecl_watch_ui_test_logs
           path: |
-            ${{ inputs.asset-name }}-ui_test-files/eclWatchUiTest.log
+            ${{ inputs.asset-name }}-ecl_watch_ui_tests/*.log
             /home/runner/HPCCSystems-regression/log/*.json
           if-no-files-found: error

esp/src/test-ui/tests/Activities.java

@@ -24,7 +24,7 @@ public static void main(String[] args) throws IOException, InterruptedException
         Capabilities caps = ((RemoteWebDriver) driver).getCapabilities();
 
         String browserName = caps.getBrowserName();
-        String browserVersion = caps.getVersion();
+        //String browserVersion = caps.getVersion();
         // System.out.println(browserName+" "+browserVersion);
 
         driver.get(args[0]);

esp/src/test-ui/tests/framework/README.md

@@ -0,0 +1,64 @@
+### Project: An Automated ECL Watch Test Suite
+
+This project's code begins with the TestRunner.java file. The main method in this class loads all the Java classes
+created for writing test cases for specific web pages of the ECL Watch UI and then runs the tests in those classes
+sequentially.
+
+The names of the Java classes that the TestRunner class needs to load should be listed in the config/TestClasses.java
+file. ActivitiesTest class should always be the first class to load in TestClasses.java, as it gets URLs for all other web pages.
+
+Each Java class created to write tests for specific web pages should have at least one method annotated with @Test. The
+code for each class starts to run from this method.
+
+#### Important Note: ChromeDriver Version Compatibility
+
+If the Chrome browser version updates in the future, it's crucial to ensure that the corresponding ChromeDriver version is also updated. Failure to do so may cause tests to fail due to compatibility issues between the browser and driver. Always verify and update ChromeDriver to the latest version whenever running tests to maintain compatibility and ensure smooth test execution.
+
+#### CLI Arguments for TestRunner.java
+
+While running the test suite, you can pass arguments in this way -> "-l log_level -p path".
+- "log_level" is of two types "debug" and "detail"
+- "debug" means generate error and exception log file with a debug log file.
+- "detail" means generate error and exception log file with a detailed debug file.
+- If no -l and log_level is passed in the argument, only error and exception log will be generated
+- "path" is the path of the folder where the json files are
+- The code will log an error if the '-p' and 'path' arguments are not provided, as the JSON folder path is required for the test suite.
+
+path could be something like:
+
+for GitHub Actions -> /home/runner/HPCCSystems-regression/log/
+
+for local machine -> C:/Users/nisha/Documents/Internship/Work/files/
+
+So an example of complete CLI arguments would look like this:
+
+-l debug -p C:/Users/nisha/Documents/Internship/Work/files/
+
+#### Implementation Steps for URL Management
+
+- A HashMap (urlMap) is created to store URL mappings in config/URLConfig.java file. This map will use the page name as the key and a URLMapping object as the value. The URLMapping object contains the page name, its URL, and another HashMap for nested pages and tabs.
+- A static block is used to initialize the urlMap with the initial URL mapping for the Activities navigation. The URL is retrieved using a method from the Common utility class, which handles the dynamic retrieval of the IP address based on the environment whether it is local or GitHub Actions.
+- For each main navigation section, a URLMapping object is created. This object includes the page name and its corresponding URL. Additionally, it contains another HashMap to store URLs for nested tabs and pages.
+- Each URLMapping object is stored in the urlMap with the main navigation name as the key. This initial setup in the Activities.java class ensures that each navigation section has its base URL stored and accessible.
+- For instance, for any navigation page, each page has multiple tabs, and within those tabs, there are multiple pages and tabs. This structure facilitates easy access to the URL of a particular page.
+- Starting from the Activities page, for each main navigation section, the code iterates over its associated tabs. For each tab, a new URLMapping object is created and added to the HashMap within the corresponding URLMapping object of the main navigation section. This creates a tree-like structure, allowing easy access to URLs for both navigation sections and their nested tabs.
+- By following these implementation steps, the URLConfig class ensures that all URLs within the application are well-organized and easily accessible through a hierarchical structure. This setup simplifies navigation and URL management within the application, making it easier to handle complex page structures and dynamic URL retrievals.
+
+
+Below are the dependencies used in the project:
+
+- https://repo1.maven.org/maven2/org/testng/testng/7.7.1/testng-7.7.1.jar
+- https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-annotations/2.17.0/jackson-annotations-2.17.0.jar
+- https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/2.17.0/jackson-core-2.17.0.jar
+- https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-databind/2.17.0/jackson-databind-2.17.0.jar
+- https://repo1.maven.org/maven2/com/beust/jcommander/1.82/jcommander-1.82.jar
+- https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.22.0/selenium-java-4.22.0.zip
+- https://repo1.maven.org/maven2/org/slf4j/slf4j-api/1.7.30/slf4j-api-1.7.30.jar
+- https://repo1.maven.org/maven2/org/slf4j/slf4j-simple/1.7.30/slf4j-simple-1.7.30.jar
+
+Notes: 
+1. Users need to run these tests with regression test suite only.
+2. Code should be updated accordingly if selenium server jar updates.
+3. ActivitiesTest class should always be the first class to load in TestClasses.java, as it gets URLs for all other pages.
+4. For future testing developers, custom class names or attributes defined by UI developers can change frequently during updates or redesigns. However, standard attributes that are part of the HTML specifications (such as id, type, value, href, aria-sort, aria-disabled, etc.) are much more stable. Therefore, it is advisable to use only standard HTML attributes to access web elements. This approach ensures that test cases remain consistent and are less likely to break due to UI changes.
+5. Ignore the compiler warnings/errors before the beginning of the test logs. They are because of guava-33.2.1-jre-sources.jar, it seems it is not fully compatible with JRE 21, that is installed on GH Actions. But that does not impact our code in any way, so it is better to just ignore it.

esp/src/test-ui/tests/framework/SetupForDev.md

@@ -0,0 +1,125 @@
+This documentation provides a comprehensive guide to setting up an Ubuntu VM on Oracle VirtualBox, installing the HPCC-Platform, and preparing the environment for testing and development.
+
+#### Setting Up an Ubuntu VM on Oracle VirtualBox
+
+**Overview of the installation process on a Windows machine:**
+
+1. **Download and install Oracle VirtualBox:**
+    - Visit the Oracle VirtualBox [website](https://www.virtualbox.org/) and download the latest version for Windows.
+    - Follow the installation instructions to install VirtualBox on your system.
+
+2. **Download the Ubuntu 22.04 Desktop ISO file:**
+    - Go to the Ubuntu [downloads page](https://ubuntu.com/download/desktop) and download the Ubuntu 22.04 LTS ISO file.
+
+3. **Set up a new VM in VirtualBox:**
+    - Open VirtualBox and click on `New` to create a new virtual machine.
+    - Name the VM and select the type and version (Linux, Ubuntu 64-bit).
+    - Configure system settings such as memory size and hard disk (create a virtual hard disk now).
+    - Link the ISO file by going to the `Settings` of the VM, navigating to `Storage`, and attaching the ISO file to the optical drive.
+    - Boot the VM and follow the installation wizard to complete the Ubuntu setup.
+
+#### Installing HPCC-Platform on the VM
+
+**After successfully installing the VM, proceed with installing the HPCC-Platform:**
+
+1. **Download the HPCC-Platform package:**
+   ```sh
+   wget https://cdn.hpccsystems.com/releases/CE-Candidate-9.8.2/bin/platform/hpccsystems-platform-community_9.8.2-1jammy_amd64_withsymbols.deb
+   ```
+
+2. **Install the package:**
+   ```sh
+   sudo dpkg -i hpccsystems-platform-community_9.8.2-1jammy_amd64_withsymbols.deb
+   ```
+
+3. **Fix missing dependencies:**
+   ```sh
+   sudo apt-get install -f
+   ```
+
+4. **Check if the installation is successful:**
+   ```sh
+   sudo dpkg -l | grep 'hpccsystems-pl'
+   ```
+5. **Start HPCC-Platform:**
+   ```sh
+   sudo /etc/init.d/hpcc-init start
+   ```
+
+6. **Verify access to ECL Watch:**
+    - Open a browser on your local machine and go to `http://192.168.0.221:8010/` to check if you can access ECL Watch.
+
+#### Cloning and Checking Out the HPCC-Platform Repository on VM
+
+1. **Clone the HPCC-Platform GitHub repository:**
+   ```sh
+   git clone https://github.com/hpcc-systems/HPCC-Platform.git
+   ```
+
+2. **Navigate to the repository directory:**
+   ```sh
+   cd HPCC-Platform
+   ```
+
+3. **Check out the specific version of HPCC-Platform:**
+   ```sh
+   git checkout candidate-9.8.x
+   ```
+
+#### Running Regression Test Setup
+
+**Navigate to the testing directory and set up regression tests:**
+   ```sh
+   cd testing/regress
+   ./ecl-test setup --preAbort '/opt/HPCCSystems/bin/smoketest-preabort.sh'
+   ```
+
+#### Running Spray Tests
+
+**Execute the spray tests:**
+   ```sh
+   ./ecl-test query --preAbort /opt/HPCCSystems/bin/smoketest-preabort.sh --excludeclass python2,embedded-r,embedded-js,3rdpartyservice,mongodb *spray*
+   ```
+
+#### Generating JSON Files
+
+**Generate JSON files for workunits, files, and DFU workunits:**
+   ```sh
+   curl localhost:8010/WsWorkunits/WUQuery.json | python3 -m json.tool > workunits.json
+   curl localhost:8010/WsDfu/DFUQuery.json?PageSize=250 | python3 -m json.tool > files.json
+   curl localhost:8010/FileSpray/GetDFUWorkunits.json | python3 -m json.tool > dfu-workunits.json
+   ```
+
+#### Transferring Files Using WinSCP
+
+Find your json files in the VM and use the WinSCP tool to transfer files from the VM to your local machine.
+
+#### Downloading Dependencies
+
+1. **Download the following dependencies:**
+    - [TestNG 7.7.1](https://repo1.maven.org/maven2/org/testng/testng/7.7.1/testng-7.7.1.jar)
+    - [Jackson Annotations 2.17.0](https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-annotations/2.17.0/jackson-annotations-2.17.0.jar)
+    - [Jackson Core 2.17.0](https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-core/2.17.0/jackson-core-2.17.0.jar)
+    - [Jackson Databind 2.17.0](https://repo1.maven.org/maven2/com/fasterxml/jackson/core/jackson-databind/2.17.0/jackson-databind-2.17.0.jar)
+    - [JCommander 1.82](https://repo1.maven.org/maven2/com/beust/jcommander/1.82/jcommander-1.82.jar)
+    - [Selenium Java 4.22.0](https://github.com/SeleniumHQ/selenium/releases/download/selenium-4.22.0/selenium-java-4.22.0.zip)
+    - [SLF4J API 1.7.30](https://repo1.maven.org/maven2/org/slf4j/slf4j-api/1.7.30/slf4j-api-1.7.30.jar)
+    - [SLF4J Simple 1.7.30](https://repo1.maven.org/maven2/org/slf4j/slf4j-simple/1.7.30/slf4j-simple-1.7.30.jar)
+
+#### Adding Dependencies to Your Java Code
+
+1. Include the downloaded dependencies in your Java project.
+2. Specify the path to your ChromeDriver when creating a `ChromeDriver` object in your code.
+
+#### Writing Test Cases for ECL Watch
+
+You are now ready to start writing your test cases for ECL Watch running at `http://192.168.0.221:8010/`.
+
+#### Uninstall HPCC-Platform on VM
+
+Use below commands
+
+```sh
+   cd /opt/HPCCSystems/sbin
+   sudo ./complete-uninstall.sh -p
+   ```