Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

Commit db2e0b4

Browse files
committed
0.1.5
Documentation: - Testing documentation;
1 parent 6dda85d commit db2e0b4

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

README.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@ The following documentation is also available:
177177
* link:doc/advanced-use.adoc[Advanced use] (including cleaning by property filters, for example: application,
178178
category,...)
179179
* link:doc/planned-features.adoc[Planned features] - what's coming up next
180+
* link:doc/testing.adoc[Testing] - Unit testing with Pester
180181
* link:CONTRIBUTING.adoc[Contributing] - guidelines for software contribution, feature requests and populating the
181182
cleanup list
182183

doc/testing.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
= Testing
2+
:toc:
3+
:toclevels: 5
4+
5+
== Prerequisites
6+
7+
https://pester.dev/docs/quick-start[Pester 5.6] is used for unit tests in this project. Please note that Windows is shipped
8+
with much older version of Pester. For installation instructions follow the
9+
https://pester.dev/docs/introduction/installation[official guide].
10+
11+
== Running tests
12+
13+
To run the whole test suite (all available tests) with code coverage, use the link:../pester.ps1[`pester.ps1`] script:
14+
15+
[source,shell]
16+
----
17+
pwsh .\pester.ps1
18+
----
19+
20+
Otherwise, you can run individual tests in terminal by following the instructions in
21+
https://pester.dev/docs/quick-start[Pester quick start guide].
22+
23+
== Testing conventions
24+
25+
- All tests are located in the link:../tests/[tests] directory or its subdirectories.
26+
- All test files are following the naming convention `*.Tests.ps1`.
27+
- Coverage report is available at `./coverage/coverage.xml` (when you run the full test suite, of course);

0 commit comments

Comments
 (0)