feat(java): ✨ added experimental options support for web (#909)

Author: WasiqB

README.md

@@ -23,8 +23,8 @@
   <a href="https://central.sonatype.com/artifact/io.github.boykaframework/boyka-framework">
     <img src="https://img.shields.io/maven-central/v/io.github.boykaframework/boyka-framework.svg?style=for-the-badge" alt="Maven Central" />
   </a>
-  <a href="https://github.com/BoykaFramework/boyka-framework/releases/tag/v1.2.0">
-    <img src="https://img.shields.io/github/downloads/BoykaFramework/boyka-framework/v1.2.0/total?color=brightgreen&label=Downloads%20for%20v1.2.0&logo=GitHub&style=for-the-badge" alt="GitHub releases" />
+  <a href="https://github.com/BoykaFramework/boyka-framework/releases/tag/v2.1.1">
+    <img src="https://img.shields.io/github/downloads/BoykaFramework/boyka-framework/v2.1.1/total?color=brightgreen&label=Downloads%20for%20v2.1.1&logo=GitHub&style=for-the-badge" alt="GitHub releases" />
   </a>
   <a href="https://github.com/BoykaFramework/boyka-framework/blob/master/LICENSE">
     <img src="https://img.shields.io/github/license/BoykaFramework/boyka-framework.svg?style=for-the-badge" alt="license" />

core-java/src/main/java/io/github/boykaframework/config/ui/web/WebSetting.java

@@ -46,6 +46,7 @@ public class WebSetting {
     private List<String>        browserOptions;
     private Map<String, Object> capabilities;
     private Dimension           customSize       = new Dimension (1920, 1080);
+    private Map<String, Object> experimentalOptions;
     private boolean             headless         = true;
     private boolean             highlight        = false;
     private String              host;

core-java/src/main/java/io/github/boykaframework/manager/WebDriverManager.java

@@ -128,6 +128,7 @@ private FirefoxOptions getFirefoxOptions (final WebSetting webSetting) {
         final var options = new FirefoxOptions ();
         ofNullable (webSetting.getPlatform ()).ifPresent (options::setPlatformName);
         ofNullable (webSetting.getBrowserOptions ()).ifPresent (l -> l.forEach (options::addArguments));
+        ofNullable (webSetting.getExperimentalOptions ()).ifPresent (l -> l.forEach (options::addPreference));
         if (webSetting.getTarget () == LOCAL && isNull (webSetting.getCapabilities ())) {
             options.setBrowserVersion (webSetting.getVersion ());
         }
@@ -202,6 +203,7 @@ private <T extends ChromiumOptions<T>> void setCommonBrowserOptions (final T opt
         options.addArguments ("--disable-gpu");
         options.addArguments ("--disable-dev-shm-usage");
         ofNullable (webSetting.getBrowserOptions ()).ifPresent (l -> l.forEach (options::addArguments));
+        ofNullable (webSetting.getExperimentalOptions ()).ifPresent (l -> l.forEach (options::setExperimentalOption));
         if (webSetting.isHeadless ()) {
             options.addArguments (HEADLESS);
         }

core-java/src/test/java/io/github/boykaframework/testng/ui/ecomm/AddCartTest.java

@@ -20,6 +20,7 @@
 import static io.github.boykaframework.actions.drivers.WindowActions.onWindow;
 import static io.github.boykaframework.actions.elements.ClickableActions.withMouse;
 import static io.github.boykaframework.actions.elements.ElementActions.onElement;
+import static io.github.boykaframework.actions.elements.TextBoxActions.onTextBox;
 import static io.github.boykaframework.manager.ParallelSession.clearSession;
 import static io.github.boykaframework.manager.ParallelSession.createSession;
 import static io.github.boykaframework.testng.ui.ecomm.pages.HomePage.homePage;
@@ -54,6 +55,10 @@ public void tearDownClass () {
     @Test
     public void testAddCart () {
         navigate ().to ("https://ecommerce-playground.lambdatest.io/");
+
+        onTextBox (homePage ().getSearch ()).enterText ("HTC");
+        withMouse (homePage ().getSearchButton ()).click ();
+
         withMouse (homePage ().getProduct1 ()).scrollIntoView ();
         withMouse (homePage ().getProduct1 ()).hover ();
         withMouse (homePage ().getAddToCart ()).click ();

core-java/src/test/java/io/github/boykaframework/testng/ui/ecomm/pages/HomePage.java

@@ -17,6 +17,7 @@
 package io.github.boykaframework.testng.ui.ecomm.pages;
 
 import static org.openqa.selenium.By.cssSelector;
+import static org.openqa.selenium.By.name;
 
 import io.github.boykaframework.builders.Locator;
 import lombok.Getter;
@@ -40,22 +41,30 @@ public static HomePage homePage () {
         return HOME_PAGE;
     }
 
-    private final Locator addToCart  = Locator.buildLocator ()
+    private final Locator addToCart    = Locator.buildLocator ()
         .name ("Add To Cart")
         .web (cssSelector ("div.product-action button[title=\"Add to Cart\"]"))
         .build ();
-    private final Locator cartCount  = Locator.buildLocator ()
+    private final Locator cartCount    = Locator.buildLocator ()
         .name ("Cart Count")
         .web (cssSelector ("div.cart-icon span"))
         .build ();
-    private final Locator closeToast = Locator.buildLocator ()
+    private final Locator closeToast   = Locator.buildLocator ()
         .name ("Close Toast")
         .web (cssSelector ("button[data-dismiss=\"toast\"]"))
         .build ();
-    private final Locator product1   = Locator.buildLocator ()
-        .web (cssSelector ("div.entry-section div[aria-label=\"1 / 10\"] div.product-thumb-top"))
+    private final Locator product1     = Locator.buildLocator ()
+        .web (cssSelector ("img[title=\"HTC Touch HD\"]"))
         .name ("Product 1")
         .build ();
+    private final Locator search       = Locator.buildLocator ()
+        .name ("Sear Box")
+        .web (name ("search"))
+        .build ();
+    private final Locator searchButton = Locator.buildLocator ()
+        .name ("Search button")
+        .web (cssSelector ("div.search-button button"))
+        .build ();
 
     private HomePage () {
         // Utility class.

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.0",
+  "version": "2.1.1",
   "npmClient": "pnpm",
   "useWorkspace": false,
   "changelog": {

pnpm-lock.yaml

@@ -447,6 +447,8 @@ See the example in [sample configuration file](#config-sample).
 | `resize` | How to resize the window initial state | [`WindowResizeType`](#window-resize-type) | `WindowResizeType.NORMAL` |
 | `custom_size` | Custom window size, when `resize` option is selected as `CUSTOM` | `Dimension` | `1920x1080` |
 | `page_load_strategy` | Page loading strategy (all in capital letters) | [`PageLoadStrategy`](https://www.selenium.dev/documentation/webdriver/drivers/options/#pageloadstrategy) | `NORMAL` |
+| `browser_options` | An array of browser specific arguments | `string[]` | `null` |
+| `experimental_options` | A key-value pair of Browsers Experimental options | `Map<string, object>` | `null` |
 
 :::info
 You can use Environment variables for `user_name` and `password` by using `${env:ENV_NAME}` format
@@ -456,6 +458,12 @@ You can use Environment variables for `user_name` and `password` by using `${env
 When you use Boyka command line assistant to configure your test to run on any Cloud providers using `boyka config [web | api | android | ios] [config_name]` command, then it is **MANDATORY** to provide Environment variable names when prompted for user name and password
 :::
 
+:::warning
+Browser options and Experimental options is not supported for **Safari browser**.
+
+Please raise a [new feature request](https://github.com/BoykaFramework/boyka-framework/issues/new/choose) along with sample example test and options support that is required
+:::
+
 #### Mobile Configuration {#mobile-config}
 
 | Property | Description | Type | Default |

website/docs/framework-docs/guides/config/configuration.md

@@ -1,6 +1,6 @@
 {
   "name": "website",
-  "version": "1.2.0",
+  "version": "2.1.1",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
@@ -45,5 +45,6 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
-  }
+  },
+  "packageManager": "[email protected]"
 }