Skip to content

Commit 27b6f9c

Browse files
authored
Update docs and traceability for expanded self-validation suite (#56)
* Update self-validation documentation * Fix self-validation traceability --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 1595b5c commit 27b6f9c

3 files changed

Lines changed: 51 additions & 21 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,17 @@ Running self-validation produces a report demonstrating that FileAssert is funct
279279
✓ FileAssert_VersionDisplay - Passed
280280
✓ FileAssert_HelpDisplay - Passed
281281
✓ FileAssert_Results - Passed
282-
✓ FileAssert_Exists - Passed
283-
✓ FileAssert_Contains - Passed
284-
285-
Total Tests: 5
286-
Passed: 5
282+
✓ FileAssert_File - Passed
283+
✓ FileAssert_Text - Passed
284+
✓ FileAssert_Html - Passed
285+
✓ FileAssert_Xml - Passed
286+
✓ FileAssert_Yaml - Passed
287+
✓ FileAssert_Json - Passed
288+
✓ FileAssert_Pdf - Passed
289+
✓ FileAssert_Zip - Passed
290+
291+
Total Tests: 11
292+
Passed: 11
287293
Failed: 0
288294
```
289295

@@ -292,8 +298,14 @@ Each test in the report proves:
292298
- **`FileAssert_VersionDisplay`** - `--version` outputs a valid version string.
293299
- **`FileAssert_HelpDisplay`** - `--help` outputs usage and options information.
294300
- **`FileAssert_Results`** - `--results` generates test results with pass and fail outcomes.
295-
- **`FileAssert_Exists`** - `--config` verifies file-existence via glob pattern.
296-
- **`FileAssert_Contains`** - `--config` verifies file content with contains assertions.
301+
- **`FileAssert_File`** - `--config` verifies file-existence via glob pattern.
302+
- **`FileAssert_Text`** - `--config` verifies file content with contains assertions.
303+
- **`FileAssert_Html`** - `--config` verifies HTML XPath assertions.
304+
- **`FileAssert_Xml`** - `--config` verifies XML XPath assertions.
305+
- **`FileAssert_Yaml`** - `--config` verifies YAML key-path assertions.
306+
- **`FileAssert_Json`** - `--config` verifies JSON key-path assertions.
307+
- **`FileAssert_Pdf`** - `--config` verifies PDF metadata and text assertions.
308+
- **`FileAssert_Zip`** - `--config` verifies zip archive entry assertions.
297309

298310
See the [User Guide][link-guide] for more details on the self-validation tests.
299311

docs/reqstream/file-assert/selftest.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,14 @@ sections:
1919
- FileAssert-Validation-Run
2020
- FileAssert-Validation-Results
2121
- FileAssert-Validation-ResultsTest
22-
- FileAssert-Validation-ExistsTest
23-
- FileAssert-Validation-ContainsTest
22+
- FileAssert-Validation-FileTest
23+
- FileAssert-Validation-TextTest
24+
- FileAssert-Validation-HtmlTest
25+
- FileAssert-Validation-XmlTest
26+
- FileAssert-Validation-YamlTest
27+
- FileAssert-Validation-JsonTest
28+
- FileAssert-Validation-PdfTest
29+
- FileAssert-Validation-ZipTest
2430
- FileAssert-Validation-NullContext
2531
- FileAssert-Validation-Depth
2632
tests:

docs/user_guide/introduction.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -130,20 +130,26 @@ Example validation report:
130130
131131
| Information | Value |
132132
| :------------------ | :------------------------------------------------- |
133-
| Tool Version | 1.0.0 |
134-
| Machine Name | BUILD-SERVER |
135-
| OS Version | Ubuntu 22.04.3 LTS |
136-
| DotNet Runtime | .NET 10.0.0 |
137-
| Time Stamp | 2024-01-15 10:30:00 UTC |
133+
| Tool Version | <version> |
134+
| Machine Name | <machine-name> |
135+
| OS Version | <os-version> |
136+
| DotNet Runtime | <dotnet-runtime-version> |
137+
| Time Stamp | 2026-06-21 15:48:28 UTC |
138138
139139
✓ FileAssert_VersionDisplay - Passed
140140
✓ FileAssert_HelpDisplay - Passed
141141
✓ FileAssert_Results - Passed
142-
✓ FileAssert_Exists - Passed
143-
✓ FileAssert_Contains - Passed
144-
145-
Total Tests: 5
146-
Passed: 5
142+
✓ FileAssert_File - Passed
143+
✓ FileAssert_Text - Passed
144+
✓ FileAssert_Html - Passed
145+
✓ FileAssert_Xml - Passed
146+
✓ FileAssert_Yaml - Passed
147+
✓ FileAssert_Json - Passed
148+
✓ FileAssert_Pdf - Passed
149+
✓ FileAssert_Zip - Passed
150+
151+
Total Tests: 11
152+
Passed: 11
147153
Failed: 0
148154
```
149155

@@ -154,8 +160,14 @@ Each test proves specific functionality works correctly:
154160
- **`FileAssert_VersionDisplay`** - `--version` outputs a valid version string.
155161
- **`FileAssert_HelpDisplay`** - `--help` outputs usage and options information.
156162
- **`FileAssert_Results`** - `--results` generates test results with pass and fail outcomes.
157-
- **`FileAssert_Exists`** - `--config` verifies file-existence via glob pattern.
158-
- **`FileAssert_Contains`** - `--config` verifies file content with contains assertions.
163+
- **`FileAssert_File`** - `--config` verifies file-existence via glob pattern.
164+
- **`FileAssert_Text`** - `--config` verifies file content with contains assertions.
165+
- **`FileAssert_Html`** - `--config` verifies HTML XPath assertions.
166+
- **`FileAssert_Xml`** - `--config` verifies XML XPath assertions.
167+
- **`FileAssert_Yaml`** - `--config` verifies YAML key-path assertions.
168+
- **`FileAssert_Json`** - `--config` verifies JSON key-path assertions.
169+
- **`FileAssert_Pdf`** - `--config` verifies PDF metadata and text assertions.
170+
- **`FileAssert_Zip`** - `--config` verifies zip archive entry assertions.
159171

160172
## Silent Mode
161173

0 commit comments

Comments
 (0)