feat(java): 📈 added code coverage check before commit (#119)

* feat(java): 📈 added code coverage check before commit

minimum coverage should be 70% before you can commit

* docs(java): 📝 updated documentations for the pre-commit checks

* docs(website): 📝 updated documentations to add API links

* test(java): ✅ disabled firefox tests

Author: WasiqB

.github/workflows/test-java.yml

@@ -75,7 +75,7 @@ jobs:
           path: ${{ github.workspace }}/core-java
 
       - name: Start Selenium Grid
-        run: java -jar core-java/libs/selenium-server-4.1.2.jar standalone > core-java/selenium-grid.log &
+        run: java -jar core-java/libs/selenium-server-4.3.0.jar standalone > core-java/selenium-grid.log &
 
       - name: All Test execution
         if: github.event_name != 'pull_request'

.husky/pre-commit

@@ -3,4 +3,4 @@
 
 yarn lint-staged
 yarn build:site
-mvn install -f core-java/pom.xml -DskipTests
+mvn org.jacoco:jacoco-maven-plugin:prepare-agent install -f core-java/pom.xml -Pcoverage-per-test -Dsuite-xml=test-suites/testng-local-husky.xml

README.md

@@ -55,70 +55,70 @@
 
 <!-- Table of Contents -->
 
-# :notebook_with_decorative_cover: Table of Contents
-
-- [:notebook_with_decorative_cover: Table of Contents](#notebook_with_decorative_cover-table-of-contents)
-  - [:star2: About the Project](#star2-about-the-project)
-    - [:camera: Screenshots](#camera-screenshots)
-      - [:hammer_and_wrench: Boyka Config file](#hammer_and_wrench-boyka-config-file)
-      - [:knot: API Sample](#knot-api-sample)
-      - [:computer: Web Sample](#computer-web-sample)
-    - [:space_invader: Tech Stack](#space_invader-tech-stack)
-      - [:house_buildings: Boyka Framework](#house_buildings-boyka-framework)
-      - [:computer: Main project and Website](#computer-main-project-and-website)
-    - [:dart: Features](#dart-features)
-  - [:eyes: Usage](#eyes-usage)
-  - [:compass: Future Road-map](#compass-future-road-map)
-  - [:wave: Contributing](#wave-contributing)
-    - [:scroll: Code of Conduct](#scroll-code-of-conduct)
-  - [:warning: License](#warning-license)
-  - [:handshake: Contact](#handshake-contact)
-  - [:gem: Acknowledgements](#gem-acknowledgements)
+# 📔 Table of Contents
+
+- [📔 Table of Contents](#-table-of-contents)
+  - [🌟 About the Project](#-about-the-project)
+    - [📷 Screenshots](#-screenshots)
+      - [🛠️ Boyka Config file](#️-boyka-config-file)
+      - [🪢 API Sample](#-api-sample)
+      - [💻 Web Sample](#-web-sample)
+    - [👾 Tech Stack](#-tech-stack)
+      - [🏘️ Boyka Framework](#️-boyka-framework)
+      - [💻 Main project and Website](#-main-project-and-website)
+    - [🎯 Features](#-features)
+  - [👀 Usage](#-usage)
+  - [🧭 Future Road-map](#-future-road-map)
+  - [👋 Contributing](#-contributing)
+    - [📜 Code of Conduct](#-code-of-conduct)
+  - [⚠️ License](#️-license)
+  - [🤝 Contact](#-contact)
+  - [💎 Acknowledgements](#-acknowledgements)
 
 <!-- About the Project -->
 
-## :star2: About the Project
+## 🌟 About the Project
 
 <!-- Screenshots -->
-### :camera: Screenshots
+### 📷 Screenshots
 
-#### :hammer_and_wrench: Boyka Config file
+#### 🛠️ Boyka Config file
 
 <div>
   <img src="assets/config.png" alt="Boyka Config" width="400" height="auto" />
 </div>
 
-#### :knot: API Sample
+#### 🪢 API Sample
 
 <div>
   <img src="assets/api-schemas.png" alt="API Schemas" width="400" height="auto" />
   <img src="assets/api.png" alt="API sample" width="400" height="auto" />
 </div>
 
-#### :computer: Web Sample
+#### 💻 Web Sample
 
 <div>
   <img src="assets/page.png" alt="Web Page object" width="400" height="auto" />
   <img src="assets/web.png" alt="Web Test" width="400" height="auto" />
 </div>
 
 <!-- TechStack -->
-### :space_invader: Tech Stack
+### 👾 Tech Stack
 
-#### :house_buildings: Boyka Framework
+#### 🏘️ Boyka Framework
 
 <div>
   <img src="assets/boyka-core-tech-stack.png" alt="Boyka core tech stack" width="400" height="auto" />
 </div>
 
-#### :computer: Main project and Website
+#### 💻 Main project and Website
 
 <div>
   <img src="assets/boyka-main-tech-stack.png" alt="Boyka Main project tech stack" width="400" height="auto" />
 </div>
 
 <!-- Features -->
-### :dart: Features
+### 🎯 Features
 
 - Supports Rest API Automation
 - Supports Web Automation
@@ -131,7 +131,7 @@
 - Has in-built Assertion methods
 
 <!-- Usage -->
-## :eyes: Usage
+## 👀 Usage
 
 Use this space to tell a little more about your project and how it can be used. Show additional screenshots, code samples, demos or link to other resources.
 
@@ -144,12 +144,12 @@ Use this space to tell a little more about your project and how it can be used.
 ```
 
 <!-- Road-map -->
-## :compass: Future Road-map
+## 🧭 Future Road-map
 
 See our [Road-map project](https://github.com/orgs/WasiqBhamla/projects/4/views/1) for more details.
 
 <!-- Contributing -->
-## :wave: Contributing
+## 👋 Contributing
 
 [![Contributors](https://contrib.rocks/image?repo=WasiqBhamla/boyka-framework)](https://github.com/WasiqBhamla/boyka-framework/graphs/contributors)
 
@@ -158,24 +158,24 @@ Contributions are always welcome!
 See [`contributing.md`](./.github/CONTRIBUTING.md) for ways to get started.
 
 <!-- Code of Conduct -->
-### :scroll: Code of Conduct
+### 📜 Code of Conduct
 
 Please read the [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
 
 <!-- License -->
-## :warning: License
+## ⚠️ License
 
 Distributed under MIT License. See [LICENSE](LICENSE) for more information.
 
 <!-- Contact -->
-## :handshake: Contact
+## 🤝 Contact
 
 - Join our [Discord server](https://discord.gg/dUg8K9DAsR) to discuss anything about the framework
 - Open a [new Discussion](https://github.com/WasiqBhamla/boyka-framework/discussions/new) on GitHub to ask questions or to discuss ideas
 - Contact / Follow me on [Twitter @WasiqBhamla](https://twitter.com/WasiqBhamla)
 
 <!-- Acknowledgments -->
-## :gem: Acknowledgements
+## 💎 Acknowledgements
 
 Big thanks to the following organizations for their support to the project with their open source licenses:
 

core-java/libs/selenium-server-4.1.2.jar renamed to core-java/libs/selenium-server-4.3.0.jar

@@ -400,6 +400,27 @@
                                     <outputDirectory>${project.reporting.outputDirectory}/jacoco</outputDirectory>
                                 </configuration>
                             </execution>
+                            <execution>
+                                <id>jacoco-check</id>
+                                <goals>
+                                    <goal>check</goal>
+                                </goals>
+                                <configuration>
+                                    <dataFile>${sonar.report}</dataFile>
+                                    <rules>
+                                        <rule>
+                                            <element>PACKAGE</element>
+                                            <limits>
+                                                <limit>
+                                                    <counter>LINE</counter>
+                                                    <value>COVEREDRATIO</value>
+                                                    <minimum>0.7</minimum>
+                                                </limit>
+                                            </limits>
+                                        </rule>
+                                    </rules>
+                                </configuration>
+                            </execution>
                         </executions>
                     </plugin>
                     <plugin>

core-java/pom.xml

@@ -87,14 +87,14 @@ private static <D extends WebDriver> List<WebElement> finds (final D driver, fin
         final var wait = getSession ().getWait ();
         switch (waitStrategy) {
             case CLICKABLE:
-                wait.until (elementToBeClickable (locator.getLocator ()));
+                wait.until (elementToBeClickable (locator.getWeb ()));
                 break;
             case VISIBLE:
             default:
-                wait.until (visibilityOfElementLocated (locator.getLocator ()));
+                wait.until (visibilityOfElementLocated (locator.getWeb ()));
         }
         return LOGGER.traceExit (
-            parent != null ? parent.findElements (locator.getLocator ()) : driver.findElements (locator.getLocator ()));
+            parent != null ? parent.findElements (locator.getWeb ()) : driver.findElements (locator.getWeb ()));
     }
 
     private static <D extends WebDriver> List<WebElement> finds (final D driver, final Locator locator,

core-java/src/main/java/com/github/wasiqb/boyka/actions/ElementFinder.java

@@ -16,13 +16,10 @@
 
 package com.github.wasiqb.boyka.builders;
 
-import static com.github.wasiqb.boyka.enums.Message.APP_TYPE_NOT_SUPPORT_DRIVERS;
-import static com.github.wasiqb.boyka.sessions.ParallelSession.getSession;
 import static org.apache.logging.log4j.LogManager.getLogger;
 
 import java.util.function.Predicate;
 
-import com.github.wasiqb.boyka.exception.FrameworkError;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.ToString;
@@ -42,35 +39,8 @@
 public class Locator {
     private static final Logger LOGGER = getLogger ();
 
-    private By                    android;
     private Predicate<WebElement> filter;
     private int                   index;
-    private By                    ios;
     private Locator               parent;
     private By                    web;
-
-    /**
-     * Returns locator specific to application type.
-     *
-     * @return {@link By}
-     */
-    public By getLocator () {
-        LOGGER.traceEntry ();
-        final By result;
-        switch (getSession ().getApplicationType ()) {
-            case ANDROID:
-                result = this.android;
-                break;
-            case IOS:
-                result = this.ios;
-                break;
-            case WEB:
-                result = this.web;
-                break;
-            case API:
-            default:
-                throw new FrameworkError (APP_TYPE_NOT_SUPPORT_DRIVERS.getMessageText ());
-        }
-        return LOGGER.traceExit (result);
-    }
 }

core-java/src/main/java/com/github/wasiqb/boyka/builders/Locator.java

@@ -16,17 +16,10 @@
 
 package com.github.wasiqb.boyka.config.ui;
 
-import static com.github.wasiqb.boyka.enums.ApplicationType.ANDROID;
-import static com.github.wasiqb.boyka.enums.ApplicationType.IOS;
-import static com.github.wasiqb.boyka.enums.Message.INVALID_PLATFORM_FOR_OPERATION;
-import static java.text.MessageFormat.format;
-import static java.util.Objects.requireNonNull;
 import static org.apache.logging.log4j.LogManager.getLogger;
 
 import java.util.Map;
 
-import com.github.wasiqb.boyka.enums.ApplicationType;
-import com.github.wasiqb.boyka.exception.FrameworkError;
 import lombok.Data;
 import org.apache.logging.log4j.Logger;
 
@@ -38,29 +31,9 @@
 public class UISetting {
     private static final Logger LOGGER = getLogger ();
 
-    private Map<String, MobileSetting> android;
-    private Map<String, MobileSetting> ios;
-    private ScreenshotSetting          screenshot = new ScreenshotSetting ();
-    private TimeoutSetting             timeout    = new TimeoutSetting ();
-    private Map<String, WebSetting>    web;
-
-    /**
-     * Gets the mobile setting.
-     *
-     * @param applicationType the {@link ApplicationType}
-     * @param key the config key for Mobile
-     *
-     * @return the {@link MobileSetting}
-     */
-    public MobileSetting getMobileSetting (final ApplicationType applicationType, final String key) {
-        LOGGER.traceEntry ("ApplicationType: {}, Key: {}", applicationType, key);
-        if (applicationType == IOS) {
-            return LOGGER.traceExit (requireNonNull (this.ios.get (key)));
-        } else if (applicationType == ANDROID) {
-            return LOGGER.traceExit (requireNonNull (this.android.get (key)));
-        }
-        throw new FrameworkError (format (INVALID_PLATFORM_FOR_OPERATION.getMessageText (), applicationType));
-    }
+    private ScreenshotSetting       screenshot = new ScreenshotSetting ();
+    private TimeoutSetting          timeout    = new TimeoutSetting ();
+    private Map<String, WebSetting> web;
 
     /**
      * Gets the web setting.

core-java/src/main/java/com/github/wasiqb/boyka/config/ui/UISetting.java

@@ -23,20 +23,12 @@
  * @since 17-Feb-2022
  */
 public enum ApplicationType {
-    /**
-     * Android application.
-     */
-    ANDROID,
     /**
      * API application.
      */
     API,
-    /**
-     * iOS application.
-     */
-    IOS,
     /**
      * Web application.
      */
     WEB
-}
+}

core-java/src/main/java/com/github/wasiqb/boyka/enums/ApplicationType.java

@@ -27,9 +27,9 @@
 @Getter
 public enum Message {
     /**
-     * Driver does not support API application type
+     * Driver only supports Web application type
      */
-    APP_TYPE_NOT_SUPPORT_DRIVERS ("API application type does not support drivers..."),
+    APP_TYPE_NOT_SUPPORTED ("Application type [{0}] is not yet supported..."),
     /**
      * Basic auth password is empty.
      */
@@ -122,6 +122,10 @@ public enum Message {
      * Schema validation assert failure
      */
     RESPONSE_SCHEMA_NOT_MATCHING ("Schema validation assert failure..."),
+    /**
+     * Test Error.
+     */
+    TEST_ERROR ("Test error..."),
     /**
      * User name required for cloud execution
      */