browser: add focusedElement() (#1606)

Author: MykolaGolubyev

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/Browser.java

@@ -168,6 +168,10 @@ public PageElement element(String css) {
         return new PageElement(driver, additionalBrowserInteractions, PageElementPath.css(css), false);
     }
 
+    public PageElement focusedElement() {
+        return element(":focus");
+    }
+
     public PageElement $(String css) {
         return element(css);
     }

webtau-docs/znai/browser/element-states.md

@@ -0,0 +1,7 @@
+# Focused Element
+
+Acting on currently focused element:
+
+:include-file: scenarios/ui/focusedElement.groovy {
+  surroundedBy: "focused-element-send-keys"
+}

webtau-docs/znai/release-notes/2.5/add-2024-08-24-focused-element.md

@@ -0,0 +1 @@
+* Add: [browser.focusedElement](browser/element-states)

webtau-docs/znai/toc

@@ -34,8 +34,6 @@ browser
     basic-configuration
     page-element-and-value
     page-object
-    element-actions-reference
-    element-values-reference
     forms
     tables
     asynchronous-page
@@ -47,6 +45,9 @@ browser
     navigation
     alerts
     page-open-handlers
+    element-states
+    element-actions-reference
+    element-values-reference
     finders-and-filters
     matchers
 servers

webtau-feature-testing/examples/scenarios/ui/focusedElement.groovy

@@ -0,0 +1,19 @@
+package scenarios.ui
+
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+scenario("send text to focused element") {
+    browser.open("/search")
+    $("#search-box").click()
+    // focused-element-send-keys
+    browser.focusedElement().setValue("search this")
+    // focused-element-send-keys
+    browser.focusedElement().sendKeys(browser.keys.enter)
+
+    $("#message").should contain("searching for")
+}
+
+scenario("send text when no focused element") {
+    browser.reopen("/search")
+    browser.focusedElement().sendKeys("search this\n")
+}

webtau-feature-testing/examples/scenarios/ui/searchInnerDeclarations.groovy

@@ -2,11 +2,11 @@ package scenarios.ui
 
 import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
 
-scenario('search by specific query') {
-    browser.open('/search')
+scenario("search by specific query") {
+    browser.open("/search")
 
-    $('#search-box').setValue('search this')
-    $('#search-box').sendKeys("\n")
+    $("#search-box").setValue("search this")
+    $("#search-box").sendKeys(browser.keys.enter)
 
-    $('#results .result').count.shouldBe > 1
+    $("#results .result").count.shouldBe > 1
 }

webtau-feature-testing/examples/scenarios/ui/searchOuterDeclarations.groovy

@@ -3,13 +3,13 @@ package scenarios.ui
 import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
 
 def searchBox = $("#search-box")
-def numberOfResults = searchBox.count
+def numberOfResults = $("#results .result").count
 
 scenario("search by specific query") {
     browser.open("/search")
 
     searchBox.setValue("search this")
-    searchBox.sendKeys("\n")
+    searchBox.sendKeys(browser.keys.enter)
 
     numberOfResults.shouldBe > 1
 }

webtau-feature-testing/src/test/groovy/org/testingisdocumenting/webtau/featuretesting/WebTauBrowserFeaturesTestBase.groovy

@@ -365,6 +365,21 @@ class WebTauBrowserFeaturesTestBase {
         runCli("scrollsNoElement.groovy", "webtau.cfg.groovy")
     }
 
+    @Test
+    void "search with page elements in place"() {
+        runCli("searchInnerDeclarations.groovy", "webtau.cfg.groovy")
+    }
+
+    @Test
+    void "search with page elements outside"() {
+        runCli("searchOuterDeclarations.groovy", "webtau.cfg.groovy")
+    }
+
+    @Test
+    void "focused element"() {
+        runCli("focusedElement.groovy", "webtau.cfg.groovy")
+    }
+
     @Test
     void "personas searching"() {
         runCli("searchWithPersonas.groovy", "webtau.cfg.groovy")

webtau-feature-testing/test-expectations/scenarios/ui/focusedElement/chrome-run-details.json

@@ -0,0 +1,23 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "send text to focused element",
+    "shortContainerId" : "focusedElement.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 8
+    }
+  }, {
+    "scenario" : "send text when no focused element",
+    "shortContainerId" : "focusedElement.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1,
+      "numberOfFailed" : 1
+    }
+  } ],
+  "exitCode" : 1
+}

webtau-feature-testing/test-expectations/scenarios/ui/focusedElement/firefox-run-details.json

@@ -0,0 +1,23 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "send text to focused element",
+    "shortContainerId" : "focusedElement.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 8
+    }
+  }, {
+    "scenario" : "send text when no focused element",
+    "shortContainerId" : "focusedElement.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1,
+      "numberOfFailed" : 1
+    }
+  } ],
+  "exitCode" : 1
+}

webtau-feature-testing/test-expectations/scenarios/ui/searchInnerDeclarations/chrome-run-details.json

@@ -0,0 +1,16 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "search by specific query",
+    "shortContainerId" : "searchInnerDeclarations.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 7
+    }
+  } ],
+  "exitCode" : 0
+}

webtau-feature-testing/test-expectations/scenarios/ui/searchInnerDeclarations/firefox-run-details.json

@@ -0,0 +1,16 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "search by specific query",
+    "shortContainerId" : "searchInnerDeclarations.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 7
+    }
+  } ],
+  "exitCode" : 0
+}

webtau-feature-testing/test-expectations/scenarios/ui/searchOuterDeclarations/chrome-run-details.json

@@ -0,0 +1,16 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "search by specific query",
+    "shortContainerId" : "searchOuterDeclarations.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 7
+    }
+  } ],
+  "exitCode" : 0
+}

webtau-feature-testing/test-expectations/scenarios/ui/searchOuterDeclarations/firefox-run-details.json

@@ -0,0 +1,16 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 1
+    }
+  }, {
+    "scenario" : "search by specific query",
+    "shortContainerId" : "searchOuterDeclarations.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 7
+    }
+  } ],
+  "exitCode" : 0
+}