fs: wait for file content change (#1563)

Author: MykolaGolubyev

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

@@ -107,7 +107,7 @@ public PageElement(WebDriver driver,
         this.offsetWidth = new PageElementValue<>(this, "offsetWidth", fetchIntElementPropertyFunc("offsetWidth"));
         this.clientHeight = new PageElementValue<>(this, "clientHeight", fetchIntElementPropertyFunc("clientHeight"));
         this.clientWidth = new PageElementValue<>(this, "clientWidth", fetchIntElementPropertyFunc("clientWidth"));
-        this.snapshotValue = SnapshotValue.EMPTY;
+        this.snapshotValue = SnapshotValue.empty();
     }
 
     public PageElementValue<String> attribute(String name) {
@@ -366,9 +366,9 @@ public void prettyPrint(PrettyPrinter printer) {
 
     @Override
     public void takeSnapshot() {
-        execute(tokenizedMessage().action("taking value snapshot").add(pathDescription),
+        snapshotValue.take(tokenizedMessage().action("taking value snapshot").add(pathDescription),
                 () -> tokenizedMessage().action("value snapshot is taken").forP().add(pathDescription),
-                () -> snapshotValue.take(extractActualValue()));
+                this::extractActualValue);
     }
 
     @Override

webtau-core/src/main/java/org/testingisdocumenting/webtau/data/snapshot/SnapshotValue.java

@@ -16,18 +16,27 @@
 
 package org.testingisdocumenting.webtau.data.snapshot;
 
+import org.testingisdocumenting.webtau.reporter.TokenizedMessage;
+import org.testingisdocumenting.webtau.reporter.WebTauStep;
+
+import java.util.function.Supplier;
+
 /**
  * Snapshot value that maintains a state whether it was taken or not
  */
 public class SnapshotValue {
     private Object value;
     private boolean isTaken;
 
-    public static final SnapshotValue EMPTY = new SnapshotValue(null, false);
+    public static SnapshotValue empty() {
+        return new SnapshotValue(null, false);
+    }
 
-    public void take(Object value) {
-        this.isTaken = true;
-        this.value = value;
+    public void take(TokenizedMessage inProgressMessage, Supplier<TokenizedMessage> completionMessage, Supplier<Object> value) {
+        WebTauStep.createAndExecuteStep(inProgressMessage, completionMessage, () -> {
+            this.isTaken = true;
+            this.value = value.get();
+        });
     }
 
     private SnapshotValue(Object value, boolean isTaken) {

webtau-docs/znai/release-notes/2.4/add-2024-01-10-file-content-wait-for-change.md

@@ -0,0 +1 @@
+* Add: File Content [wait to change](utilities/file-system#wait-for-content-change)

webtau-docs/znai/utilities/file-system.md

@@ -45,6 +45,14 @@ left: :include-file: doc-artifacts/fs-content-to-replace.txt {title: "file to re
 right: :include-file: doc-artifacts/fs-content-after-replace-text.txt {title: "result of replace"}
 ```
 
+# Wait For Content Change
+
+:include-file: doc-artifacts/snippets/fsFileContent/waitForChange.groovy {
+  title: "wait for file content change",
+  surroundedBy: ["file-take-snapshot", "file-wait-to-change"],
+  surroundedBySeparator: "..."
+}
+
 # Copy
 
 :include-file: doc-artifacts/snippets/fsCopy/copyFileToDir.groovy {

webtau-feature-testing/examples/scenarios/fs/files.groovy

@@ -67,4 +67,19 @@ scenario('replace file content using regexp') {
     doc.capture('fs-content-after-replace-text', contentAfter)
 
     fs.delete(path)
+}
+
+scenario('snapshot and change') {
+    def path = fs.tempFile('snapshot', 'change')
+    fs.writeText(path, 'hello')
+
+    // file-take-snapshot
+    def textContent = fs.textContent(path)
+    textContent.takeSnapshot()
+    // file-take-snapshot
+
+    fs.writeText(path, 'hello world')
+    // file-wait-to-change
+    textContent.waitTo change
+    // file-wait-to-change
 }

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

@@ -67,7 +67,8 @@ class WebTauFileSystemFeaturesTest {
                 'fsFileContent', 'examples/scenarios/fs/files.groovy', [
                 'createFile.groovy': 'create file using string path',
                 'readFile.groovy': 'read file using string path',
-                'replaceFile.groovy': 'replace file content using regexp'
+                'replaceFile.groovy': 'replace file content using regexp',
+                'waitForChange.groovy': 'snapshot and change'
         ])
     }
 

webtau-feature-testing/test-expectations/scenarios/fs/files/run-details.json

@@ -1,5 +1,11 @@
 {
   "scenarioDetails" : [ {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 2
+    }
+  }, {
     "scenario" : "create and delete file",
     "shortContainerId" : "files.groovy",
     "stepsSummary" : {
@@ -23,6 +29,12 @@
     "stepsSummary" : {
       "numberOfSuccessful" : 8
     }
+  }, {
+    "scenario" : "snapshot and change",
+    "shortContainerId" : "files.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 5
+    }
   } ],
   "exitCode" : 0
 }

webtau-filesystem/src/main/java/org/testingisdocumenting/webtau/fs/FileTextContent.java

@@ -17,6 +17,8 @@
 package org.testingisdocumenting.webtau.fs;
 
 import org.testingisdocumenting.webtau.data.ValuePath;
+import org.testingisdocumenting.webtau.data.snapshot.SnapshotValue;
+import org.testingisdocumenting.webtau.data.snapshot.SnapshotValueAware;
 import org.testingisdocumenting.webtau.expectation.ActualPathAndDescriptionAware;
 import org.testingisdocumenting.webtau.expectation.ActualValueExpectations;
 import org.testingisdocumenting.webtau.reporter.StepReportOptions;
@@ -30,12 +32,14 @@
 
 import static org.testingisdocumenting.webtau.WebTauCore.tokenizedMessage;
 
-public class FileTextContent implements ActualValueExpectations, ActualPathAndDescriptionAware {
+public class FileTextContent implements ActualValueExpectations, ActualPathAndDescriptionAware, SnapshotValueAware {
     private final ValuePath actualPath;
     private final Path path;
+    private final SnapshotValue snapshotValue;
 
     public FileTextContent(Path path) {
         this.actualPath = new ValuePath("file <" + path.getFileName().toString() + ">");
+        this.snapshotValue = SnapshotValue.empty();
         this.path = path;
     }
 
@@ -104,4 +108,21 @@ private String extractByRegexpStepImpl(Pattern regexp) {
 
         return extracted;
     }
+
+    @Override
+    public void takeSnapshot() {
+        snapshotValue.take(tokenizedMessage().action("taking snapshot").from().url(path),
+                () -> tokenizedMessage().action("snapshot is taken").forP().url(path),
+                this::getData);
+    }
+
+    @Override
+    public Object snapshotValue() {
+        return snapshotValue.required();
+    }
+
+    @Override
+    public Object currentValue() {
+        return getData();
+    }
 }