Support Selenium WebDriver 4 (#174)

* fix: Upgraded Selenium WebDriver to 4.1.1 and also fixed code smells from Sonar analysis.

* fix: Updated workflows to run on all supported branches.

* fix: Updated config to execute BS tests on BS instead of local.

* fix: Correct Config was not picked when multiple testng yaml was run simultaneuosly.

* fix: Upgraded Selenium Grid version to 4.1.1, also turned off parallel runs.

* fix: Removed failing IE test and updated README.

Author: WasiqB

.github/workflows/codeql-analysis.yml

@@ -13,11 +13,13 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [master]
-  pull_request:
-    branches: [master]
+    branches:
+      - master
+      - main
+      - release
+      - issue-*
   schedule:
-    - cron: "30 10 * * 6"
+    - cron: "0 21 * * *"
 
 jobs:
   analyze:
@@ -31,7 +33,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: ["java"]
+        language: [ "java" ]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://git.io/codeql-language-support
 

.github/workflows/test.yml

@@ -1,11 +1,6 @@
 name: Test coteafs-selenium project
 
 on:
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
   push:
     branches:
       - master
@@ -72,7 +67,7 @@ jobs:
           sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
           sudo apt-get update
           sudo apt-get install google-chrome-stable
-          docker run -d -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-chrome:3.141.59
+          docker run -d -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-chrome:4.1.1
 
       - name: Test execution
         env:
@@ -127,8 +122,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-        run: |
-          mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
-            -Dsonar.projectKey=com.github.wasiqb.coteafs:selenium \
-            -DskipTests \
-            -Dcheckstyle.skip
+        run: mvn -B sonar:sonar -DskipTests -Dcheckstyle.skip

.talismanrc

@@ -26,13 +26,13 @@
 ## :question: What is this Framework about?
 
 This is a Selenium WebDriver wrapper Framework which enables robust, maintainable and easy to write test scripts. _**It
-supports the latest stable Selenium WebDriver 3.141.59**_.
+supports the latest stable Selenium WebDriver 4.1.1**_.
 
 ## :bulb: What features do this framework offer?
 
 Some key features which this framework offers are as follows:
 
-:point_right: Latest stable Selenium WebDriver 3.141.59.
+:point_right: Latest stable Selenium WebDriver 4.1.1
 
 :point_right: Minimal learning curve.
 
@@ -87,7 +87,7 @@ Config file is by default searched in `src/test/resources` folder. The name of t
 as `selenium-config.yaml`. But the same can be overridden by using System property `coteafs.selenium.config` where you
 can specify the new config file for the test.
 
-#### Sample Config file
+### Sample Config file
 
 `src/test/resources/selenium-config.yaml`
 
@@ -167,7 +167,7 @@ site.
 
 > Remember, `BrowserPage` class needs to be extended for every page and also a flavour of inheritance can be added as per requirement.
 
-#### Sample Page object
+### Sample Page object
 
 ```java
 package com.github.wasiqb.coteafs.selenium.pages;
@@ -210,7 +210,7 @@ place.
 > For every page action you need to extend `AbstractPageAction`. Since it is a generic class, you need to pass the action class name as it's generic type.
 > Also, `perform` method needs to be implemented for every action class.
 
-#### Sample page action
+### Sample page action
 
 ```java
 package com.github.wasiqb.coteafs.selenium.pages.action;
@@ -252,7 +252,7 @@ public class LoginPageAction extends AbstractPageAction<LoginPageAction> {
 Test which are written using this framework are slightly different than usual. In the tests, Page actions is used
 instead of page objects. This can be demonstrated as shown below:
 
-#### Sample Test
+### Sample Test
 
 > Every test class extends `BrowserTest` class.
 

README.md

@@ -1 +1,2 @@
+config.stopBubbling = true
 lombok.addLombokGeneratedAnnotation = true

lombok.config

@@ -10,7 +10,7 @@
     <parent>
         <groupId>com.github.wasiqb.coteafs</groupId>
         <artifactId>parent</artifactId>
-        <version>3.8.0</version>
+        <version>3.9.0</version>
     </parent>
 
     <scm>
@@ -25,21 +25,19 @@
     </ciManagement>
 
     <properties>
-        <coteafs.data.version>1.4.0</coteafs.data.version>
+        <coteafs.data.version>1.5.0</coteafs.data.version>
         <coteafs.error.version>1.15.0</coteafs.error.version>
         <log4j.version>2.17.1</log4j.version>
-        <coteafs.listener.version>3.3.0</coteafs.listener.version>
-        <selenium-version>3.141.59</selenium-version>
+        <coteafs.listener.version>3.4.0</coteafs.listener.version>
+        <selenium-version>4.1.1</selenium-version>
         <commons.io.version>2.11.0</commons.io.version>
         <webdrivermanager-version>5.0.3</webdrivermanager-version>
         <faker.version>1.0.2</faker.version>
         <commons.text.version>1.9</commons.text.version>
         <recorder.version>0.7.7.0</recorder.version>
         <lombok.version>1.18.22</lombok.version>
         <jackson.version>2.13.1</jackson.version>
-        <sonar.organization>wasiqb-github</sonar.organization>
-        <sonar.host.url>https://sonarcloud.io</sonar.host.url>
-        <sonar.coverage.jacoco.xmlReportPaths>target/site/jacoco/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
+        <sonar.projectKey>com.github.wasiqb.coteafs:selenium</sonar.projectKey>
     </properties>
 
     <dependencies>

pom.xml

@@ -22,8 +22,6 @@
  * @since Aug 9, 2018 8:23:23 PM
  */
 public final class ConfigUtil {
-    private static BrowserSetting setting;
-
     /**
      * @param browserName Browser setting name.
      *
@@ -33,11 +31,8 @@ public final class ConfigUtil {
      * @since Aug 9, 2018 8:39:04 PM
      */
     public static BrowserSetting appSetting (final String browserName) {
-        if (setting == null) {
-            setting = DataSource.parse (SeleniumConfig.class)
-                .getBrowserSetting (browserName);
-        }
-        return setting;
+        return DataSource.parse (SeleniumConfig.class)
+            .getBrowserSetting (browserName);
     }
 
     private ConfigUtil () {

src/main/java/com/github/wasiqb/coteafs/selenium/config/ConfigUtil.java

@@ -44,6 +44,7 @@ browsers:
     #  version: 2.14
     #  exe_url: https://driver/download/url
   grid:
+    browser: REMOTE
     <<: *default_browser
     headless_mode: true
     remote:
@@ -55,25 +56,27 @@ browsers:
         version: 77.0.3865.75
         platform: LINUX
   bs_chrome:
+    browser: REMOTE
     <<: *default_browser
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: hub-cloud.browserstack.com
       source: BROWSERSTACK
       capabilities:
         browser: Chrome
-        browser_version: 83.0
+        browser_version: latest
         os: Windows
         os_version: 10
         resolution: 1024x768
         name: Bstack-[Java] Sample Chrome Test
   bs_edge:
+    browser: REMOTE
     <<: *default_browser
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: hub-cloud.browserstack.com
       source: BROWSERSTACK
@@ -85,10 +88,11 @@ browsers:
         resolution: 1024x768
         name: Bstack-[Java] Sample Edge Test
   bs_firefox:
+    browser: REMOTE
     <<: *default_browser
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: hub-cloud.browserstack.com
       source: BROWSERSTACK
@@ -100,43 +104,45 @@ browsers:
         resolution: 1024x768
         name: Bstack-[Java] Sample Firefox Test
   bs_ie:
+    browser: REMOTE
     <<: *default_browser
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: hub-cloud.browserstack.com
       source: BROWSERSTACK
       capabilities:
         browser: IE
-        browser_version: 11.0
+        browser_version: latest
         os: Windows
         os_version: 10
         resolution: 1024x768
         name: Bstack-[Java] Sample IE Test
   bs_safari:
+    browser: REMOTE
     <<: *default_browser
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: hub-cloud.browserstack.com
       source: BROWSERSTACK
       capabilities:
         browser: Safari
-        browser_version: 13.1
+        browser_version: latest
         os: OS X
-        os_version: Catalina
+        os_version: Big Sur
         resolution: 1024x768
         name: Bstack-[Java] Sample Safari Test
   sl_chrome:
     <<: *default_browser
-    browser: CHROME
+    browser: REMOTE
     url: http://demo.guru99.com/V4/
     headless_mode: true
     remote:
-      user_id: ${CLOUD_USER}
-      password: ${CLOUD_KEY}
+      user_id: ${env:CLOUD_USER}
+      password: ${env:CLOUD_KEY}
       protocol: HTTPS
       url: ondemand.saucelabs.com
       source: SAUCELABS

src/test/resources/selenium-config.yaml

@@ -29,11 +29,3 @@ tests:
       - name: com.github.wasiqb.coteafs.selenium.SeleniumTest
         includedMethods:
           - testLogin
-  - name: Test BrowserStack IE
-    parameters: {
-      test.browser: bs_ie
-    }
-    classes:
-      - name: com.github.wasiqb.coteafs.selenium.SeleniumTest
-        includedMethods:
-          - testLogin