browser: tableEl.extractData (#1521)

Author: MykolaGolubyev

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/PageElement.java

@@ -47,6 +47,7 @@
 import org.testingisdocumenting.webtau.reporter.WebTauStepInputKeyValue;
 
 import java.util.*;
+import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.function.Supplier;
 import java.util.regex.Pattern;
@@ -127,6 +128,13 @@ public TokenizedMessage describe() {
         return pathDescription;
     }
 
+    public void forEach(Consumer<PageElement> consumer) {
+        Integer count = extractNumberOfElements();
+        for (int idx = 0; idx < count; idx++) {
+            consumer.accept(get(idx));
+        }
+    }
+
     public void highlight() {
         additionalBrowserInteractions.flashWebElements(findElements());
     }
@@ -410,7 +418,7 @@ private List<Object> extractListOfValues() {
         return result;
     }
 
-    private Integer extractNumberOfElements() {
+    Integer extractNumberOfElements() {
         return getValueForStaleElement(() -> {
             List<WebElement> webElements = path.find(driver);
             return webElements.size();

webtau-browser/src/main/java/org/testingisdocumenting/webtau/browser/page/TablePageElement.java

@@ -27,6 +27,7 @@
 import org.testingisdocumenting.webtau.reporter.StepReportOptions;
 
 import java.util.List;
+import java.util.function.Consumer;
 import java.util.stream.Stream;
 
 import static org.testingisdocumenting.webtau.WebTauCore.*;
@@ -60,6 +61,17 @@ public boolean isVisible() {
         return root.isVisible();
     }
 
+    public void forEach(Consumer<TablePageElement> consumer) {
+        Integer count = root.extractNumberOfElements();
+        for (int idx = 0; idx < count; idx++) {
+            consumer.accept(new TablePageElement(root.get(idx)));
+        }
+    }
+
+    /**
+     * extracts table data from first matching browser table
+     * @return extracted TableData
+     */
     public TableData extractTableData() {
         List<HtmlNode> htmlNodes = root.extractHtmlNodes();
         if (htmlNodes.isEmpty()) {
@@ -69,6 +81,23 @@ public TableData extractTableData() {
         return BrowserTableParser.parse(htmlNodes.stream().findFirst().get().outerHtml());
     }
 
+    /**
+     * extracts and combines TableData from all tables matching selector
+     * @return extracted TableData
+     */
+    public TableData extractAndMergeTableData() {
+        TableData result = extractTableData();
+
+        Integer count = root.extractNumberOfElements();
+        for (int idx = 1; idx < count; idx++) {
+            TablePageElement tablePageElement = new TablePageElement(root.get(idx + 1));
+            TableData extracted = tablePageElement.extractTableData();
+            result.addRowsExistingColumnsOnly(extracted);
+        }
+
+        return result;
+    }
+
     @Override
     public StepReportOptions shouldReportOption() {
         return StepReportOptions.REPORT_ALL;

webtau-docs/znai/browser/tables.md

@@ -21,6 +21,42 @@ Java:
 }
 ```
 
+# Extracting Table Data
+
+Use `:identifier: extractTableData` to extract `TableData` for further processing, e.g. saving to a disk:
+
+```tabs
+Groovy: 
+:include-file: examples/scenarios/ui/tables.groovy {
+  title: "table data extraction",
+  surroundedBy: "extract-single-table-data"
+}
+
+Java:
+:include-file: com/example/tests/junit5/BrowserTablesJavaTest.java {
+  title: "table data extraction",
+  surroundedBy: "extract-single-table-data"
+}
+```
+
+Use `:identifier: extractAndMergeTableData` to extract `TableData` from multiple tables matching the selector:
+
+```tabs
+Groovy: 
+:include-file: examples/scenarios/ui/tables.groovy {
+  title: "multiple tables data extraction",
+  surroundedBy: "extract-all-table-data"
+}
+
+Java:
+:include-file: com/example/tests/junit5/BrowserTablesJavaTest.java {
+  title: "multiple tables data extraction",
+  surroundedBy: "extract-all-table-data"
+}
+```
+
+Note: Only first table columns will be used
+
 # Supported Tables Flavor
 
 WebTau supports standard HTML tables and [AG Grid](https://www.ag-grid.com).

webtau-docs/znai/release-notes/2.1/add-2023-07-20-table-data-extract.md

@@ -0,0 +1 @@
+* Add: [Browser tableEl.extratTableData](browser/tables#extracting-table-data) to get table data from a page

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

@@ -10,13 +10,46 @@ scenario("standard table equality") {
     // table-data-validation
     def summaryTable = browser.table("#summary")
 
-    summaryTable.should == ["column A" | "column B"] {
-                           ___________________________
-                                  "A1" |       "B1"
-                                  "A2" |       "B2" }
+    summaryTable.should == [ "column A" | "column B" | "column C"] {
+                           _______________________________________
+                                  "A-1" |      "B-1" | "C-1"
+                                  "A-2" |      "B-2" | "C-2" }
     // table-data-validation
 }
 
+scenario("extract single table") {
+    // extract-single-table-data
+    def summaryTable = browser.table("#summary")
+    def tableData = summaryTable.extractTableData()
+
+    data.csv.write("table-data.csv", tableData)
+    // extract-single-table-data
+
+    defer {
+        fs.delete("table-data.csv")
+    }
+}
+
+scenario("extract from each table") {
+    // extract-all-table-data
+    def tablesList = browser.table("table")
+    def combinedTableData = tablesList.extractAndMergeTableData()
+
+    data.csv.write("combined-table-data.csv", combinedTableData)
+    // extract-all-table-data
+
+    defer {
+        fs.delete("combined-table-data.csv")
+    }
+
+    combinedTableData.should == [ "column A" | "column B" | "column C"] {
+                                 _______________________________________
+                                       "A-1" |      "B-1" | "C-1"
+                                       "A-2" |      "B-2" | "C-2"
+                                       "A@1" |      "B@1" | "C@1"
+                                       "A@2" |      "B@2" | "C@2" }
+}
+
 scenario("simple ag grid equality") {
     def summaryTable = browser.table("#ag-grid-simple")
 

webtau-feature-testing/src/test/resources/tables.html

@@ -29,16 +29,48 @@
     <th>
       column B
     </th>
+    <th>
+      column C
+    </th>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td>A-1</td>
+    <td>B-1</td>
+    <td>C-1</td>
+  </tr>
+  <tr>
+    <td>A-2</td>
+    <td>B-2</td>
+    <td>C-2</td>
+  </tr>
+  </tbody>
+</table>
+<table id='extra-summary'>
+  <thead>
+  <tr>
+    <th>
+      column A
+    </th>
+    <th>
+      column B
+    </th>
+    <th>
+      column C
+    </th>
   </tr>
   </thead>
   <tbody>
   <tr>
-    <td>A1</td>
-    <td>B1</td>
+    <td>A@1</td>
+    <td>B@1</td>
+    <td>C@1</td>
   </tr>
   <tr>
-    <td>A2</td>
-    <td>B2</td>
+    <td>A@2</td>
+    <td>B@2</td>
+    <td>C@2</td>
   </tr>
   </tbody>
 </table>

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

@@ -17,6 +17,18 @@
     "stepsSummary" : {
       "numberOfSuccessful" : 1
     }
+  }, {
+    "scenario" : "extract single table",
+    "shortContainerId" : "tables.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 4
+    }
+  }, {
+    "scenario" : "extract from each table",
+    "shortContainerId" : "tables.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 5
+    }
   }, {
     "scenario" : "simple ag grid equality",
     "shortContainerId" : "tables.groovy",

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

@@ -17,6 +17,18 @@
     "stepsSummary" : {
       "numberOfSuccessful" : 1
     }
+  }, {
+    "scenario" : "extract single table",
+    "shortContainerId" : "tables.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 4
+    }
+  }, {
+    "scenario" : "extract from each table",
+    "shortContainerId" : "tables.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 5
+    }
   }, {
     "scenario" : "simple ag grid equality",
     "shortContainerId" : "tables.groovy",

webtau-junit5-examples/src/test/java/com/example/tests/junit5/BrowserTablesJavaTest.java

@@ -19,6 +19,7 @@
 import org.junit.jupiter.api.Test;
 import org.testingisdocumenting.webtau.junit5.WebTau;
 
+import static org.testingisdocumenting.webtau.WebTauCore.*;
 import static org.testingisdocumenting.webtau.WebTauDsl.*;
 
 @WebTau
@@ -30,10 +31,36 @@ public void standardTable() {
         // table-data-validation
         var summaryTable = browser.table("#summary");
 
-        summaryTable.should(equal(table("column A", "column B",
-                                       ___________________________,
-                                             "A1" ,       "B1",
-                                             "A2" ,       "B2" )));
+        summaryTable.should(equal(table("column A", "column B", "column C",
+                                       ____________________________________,
+                                            "A-1" ,      "B-1", "C-1",
+                                            "A-2" ,      "B-2", "C-2" )));
         // table-data-validation
     }
+
+    @Test
+    public void extractSingleTable() {
+        browser.open("/tables");
+
+        // extract-single-table-data
+        var summaryTable = browser.table("#summary");
+        var tableData = summaryTable.extractTableData();
+
+        data.csv.write("table-data.csv", tableData);
+        // extract-single-table-data
+
+        defer(() -> fs.delete("table-data.csv"));
+    }
+
+    @Test
+    public void extractFromAllTables() {
+        // extract-all-table-data
+        var tablesList = browser.table("table");
+        var combinedTableData = tablesList.extractAndMergeTableData();
+
+        data.csv.write("combined-table-data.csv", combinedTableData);
+        // extract-all-table-data
+
+        defer(() -> fs.delete("combined-table-data.csv"));
+    }
 }

webtau-junit5-examples/test-expectations/BrowserTablesJavaTest/run-details.json

@@ -1,5 +1,11 @@
 {
   "standardTable()" : {
     "numberOfSuccessful" : 3
+  },
+  "extractSingleTable()" : {
+    "numberOfSuccessful" : 5
+  },
+  "extractFromAllTables()" : {
+    "numberOfSuccessful" : 4
   }
 }