fs: doc separate chapter (#1565)

Author: MykolaGolubyev

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

@@ -0,0 +1,19 @@
+# Archive
+
+:include-file: scenarios/fs/archive.groovy {
+  title: "zip a directory",
+  surroundedBy: "// zip",
+}
+
+# Un-archive
+
+:include-file: scenarios/fs/archive.groovy {
+  title: "unzip a file",
+  surroundedBy: "// unzip",
+}
+
+:include-file: scenarios/fs/archive.groovy {
+  title: "untar a file",
+  surroundedBy: "// untar",
+}
+

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

@@ -0,0 +1,18 @@
+# Copy To A Directory
+
+:include-file: doc-artifacts/snippets/fsCopy/copyFileToDir.groovy {
+  title: "copy single file to a directory",
+  includeRegexp: ["fs\\.copy", "createDir"]
+}
+
+:include-file: doc-artifacts/snippets/fsCopy/copyFileToTempDir.groovy {
+  title: "copy single file to a temp directory",
+  includeRegexp: ["fs\\.copy", "tempDir"]
+}
+
+# Replace File
+
+:include-file: doc-artifacts/snippets/fsCopy/copyFileToFile.groovy {
+  title: "copy single file to a file",
+  includeRegexp: ["fs\\.copy"]
+}

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

@@ -0,0 +1,63 @@
+# Validation
+
+:include-file: doc-artifacts/snippets/fsFileContent/readFile.groovy {
+  title: "validate file content",
+  surroundedBy: "assert-file"
+}
+
+# Content Extraction
+
+Use `.data` to access actual file content for further processing
+
+:include-file: doc-artifacts/snippets/fsFileContent/readFile.groovy {
+  title: "access file content",
+  surroundedBy: "actual-file-content"
+}
+
+Use `extractByRegexp` to extract content from a file by regular expression
+
+:include-file: doc-artifacts/snippets/fsFileContent/readFile.groovy {
+  title: "extract file content",
+  surroundedBy: "extract-id",
+  excludeRegexp: "statusCode"
+}
+
+# Write To File
+
+:include-file: doc-artifacts/snippets/fsFileContent/createFile.groovy {
+  title: "write content to a file",
+  includeRegexp: ["fs\\.writeText"]
+}
+
+# Replace File Content
+
+Use `replaceText` to replace text in place
+
+:include-file: doc-artifacts/snippets/fsFileContent/replaceFile.groovy {
+  title: "replace file content",
+  surroundedBy: "replace-text"
+}
+
+```columns
+left: :include-file: doc-artifacts/fs-content-to-replace.txt {title: "file to replace"}
+right: :include-file: doc-artifacts/fs-content-after-replace-text.txt {title: "result of replace"}
+```
+
+# Wait For Content 
+
+`fs.textContent` declares file content, but doesn't access it right away.
+WebTau reads file content when validation happens. Here is an example of waiting on file content:
+
+:include-file: doc-artifacts/snippets/fsFileContent/readFile.groovy {
+  title: "wait for a specific file content",
+  surroundedBy: "wait-for-id"
+}
+
+Use `takeSnapshot` and `waitTo change` to wait for any file change:
+
+:include-file: doc-artifacts/snippets/fsFileContent/waitForChange.groovy {
+  title: "wait for any content change",
+  surroundedBy: ["file-take-snapshot", "file-wait-to-change"],
+  surroundedBySeparator: "..."
+}
+

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

@@ -0,0 +1,5 @@
+WebTau provides files system access layer `fs.` to help with files content access, validation and manipulation:
+* [Access and validate file content](file-content)
+* [Copy files](copy)
+* [Archive and Un-archive](archive)
+* [Managing temporary files and directories](temporary-files-dirs)

webtau-docs/znai/file-system/temporary-files-dirs.md

@@ -0,0 +1,31 @@
+# Temporary Dirs
+
+:include-file: scenarios/fs/temp.groovy {
+  title: "create temp directory",
+  surroundedBy: "// temp-dir",
+}
+
+:include-file: scenarios/fs/temp.groovy {
+  title: "create temp directory inside directory",
+  surroundedBy: "// temp-dir-parent",
+}
+
+# Temporary Files 
+
+:include-file: scenarios/fs/temp.groovy {
+  title: "create temp file",
+  surroundedBy: "// temp-file",
+}
+
+:include-file: scenarios/fs/temp.groovy {
+  title: "create temp file inside a directory",
+  surroundedBy: "// temp-file-parent",
+}
+
+:include-file: doc-artifacts/temp-file-path.txt {
+  title: "example of temp file location"
+}
+
+# Automatic Deletion
+
+Note: temp files and temp directories will be automatically deleted at the end of run 

webtau-docs/znai/release-notes/1.42/add-2021-05-30-fs-replace-text.md

@@ -1 +1 @@
-* [replace text content by regexp](utilities/file-system#file-content)
+* [replace text content by regexp](file-system/file-content)

webtau-docs/znai/release-notes/1.44/add-2021-10-10-fs-zip.md

@@ -1 +1 @@
-* Add `fs.zip` command to [zip files](utilities/file-system#archive) 
+* Add `fs.zip` command to zip files

webtau-docs/znai/release-notes/1.45/_fix-2021-11-03-fs-text-content-null.md

@@ -1 +1 @@
-* Fix: [waiting](utilities/file-system) for non-existing file content is **not** throwing error anymore
+* Fix: [waiting](file-system/file-content) for non-existing file content is **not** throwing error anymore

webtau-docs/znai/release-notes/1.45/doc-2021-12-14-fs-delete-temp-step.md

@@ -1 +1 @@
-* Wrap deletion of all [temp files](utilities/file-system) in a parent step
+* Wrap deletion of all [temp files](file-system/introduction) in a parent step

webtau-docs/znai/release-notes/1.47/add-2022-01-24-temp-files.md

@@ -1 +1 @@
-* Add [fs.tempFile](utilities/file-system#temporary-dirs-and-files)
+* Add `fs.tempFile`