Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,38 @@ templatetool --silent --log output.log
| `--results <file>` | Write validation results to file (TRX or JUnit format) |
| `--log <file>` | Write output to log file |

## Self Validation
Comment thread
Malcolmnixon marked this conversation as resolved.

Running self-validation produces a report containing the following information:

```text
# DEMA Consulting Template DotNet Tool

Comment thread
Malcolmnixon marked this conversation as resolved.
| Information | Value |
| :------------------ | :------------------------------------------------- |
| Tool Version | <version> |
| Machine Name | <machine-name> |
| OS Version | <os-version> |
| DotNet Runtime | <dotnet-runtime-version> |
| Time Stamp | <timestamp> UTC |

✓ Version Display Test - PASSED
✓ Help Display Test - PASSED

Total Tests: 2
Passed: 2
Failed: 0
```

Each test in the report proves:

- **`TemplateTool_VersionDisplay`** - `--version` outputs a valid version string.
- **`TemplateTool_HelpDisplay`** - `--help` outputs usage and options information.

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

On validation failure the tool will exit with a non-zero exit code.

Comment thread
Malcolmnixon marked this conversation as resolved.
## Documentation

Generated documentation includes:
Expand Down Expand Up @@ -99,3 +131,4 @@ By contributing to this project, you agree that your contributions will be licen
[link-quality]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetTool
[link-nuget]: https://www.nuget.org/packages/DemaConsulting.TemplateDotNetTool
[link-guide]: https://github.com/demaconsulting/TemplateDotNetTool/blob/main/docs/guide/guide.md
44 changes: 41 additions & 3 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,20 @@ Display usage information:
templatetool --help
```

## Run Self-Validation
## Self-Validation

Run self-validation tests:
Self-validation produces a report demonstrating that Template DotNet Tool is functioning
correctly. This is useful in regulated industries where tool validation evidence is required.

### Running Validation

To perform self-validation:

```bash
templatetool --validate
```

Save validation results to a file:
To save validation results to a file:

```bash
templatetool --validate --results results.trx
Expand All @@ -57,6 +62,39 @@ templatetool --validate --results results.trx
The results file format is determined by the file extension: `.trx` for TRX (MSTest) format,
or `.xml` for JUnit format.

### Validation Report

The validation report contains the tool version, machine name, operating system version,
.NET runtime version, timestamp, and test results.

Example validation report:

```text
# DEMA Consulting Template DotNet Tool

| Information | Value |
| :------------------ | :------------------------------------------------- |
| Tool Version | 1.0.0 |
| Machine Name | BUILD-SERVER |
| OS Version | Ubuntu 22.04.3 LTS |
| DotNet Runtime | .NET 10.0.0 |
| Time Stamp | 2024-01-15 10:30:00 UTC |

✓ Version Display Test - PASSED
✓ Help Display Test - PASSED

Total Tests: 2
Passed: 2
Failed: 0
```

### Validation Tests

Each test proves specific functionality works correctly:

- **`TemplateTool_VersionDisplay`** - `--version` outputs a valid version string.
- **`TemplateTool_HelpDisplay`** - `--help` outputs usage and options information.

## Silent Mode

Suppress console output:
Expand Down