Skip to content

Commit 901ce4e

Browse files
[DOCUMENTATION] improved documentation regarding testing a bit (- WIP #411 -)
Changes in file docs/Testing.md: * style changes * re-worded some * related changes
1 parent efd3b50 commit 901ce4e

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

docs/Testing.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ gitGraph:
176176

177177
During the development cycle new features will also need testing, (this is mentioned in detail
178178
by the [Contributing Guidelines](https://github.com/reactive-firewall/multicast/tree/HEAD/.github/CONTRIBUTING.md).
179-
This is where the other-wise undocumented Selective Test Runner [`run_selective.py`](https://github.com/reactive-firewall/multicast/tree/HEAD/tests/run_selective.py),
179+
This is where the otherwise undocumented Selective Test Runner [`run_selective.py`](https://github.com/reactive-firewall/multicast/tree/HEAD/tests/run_selective.py),
180180
comes into play. While the test runner is used by much of the project automation to run all kinds
181181
of tests, it is the most powerful when used to skip tests to save time iteratively developing a
182182
new feature.
@@ -193,7 +193,8 @@ methods are unsuited:
193193
* checking more than just the new tests, until the new tests are passing, is inefficient.
194194

195195
These and similar cases can benefit from the improved granularity of targeted testing provided by
196-
the selective test runner. Of-course eventually the process leads back to the normal CI/CD testing.
196+
the selective test runner. Of course, eventually the process leads back to the normal CI/CD
197+
testing.
197198

198199
```mermaid
199200
sequenceDiagram
@@ -309,11 +310,11 @@ By default, logging from the `multicast` module is ignored (there is a [default
309310
inserts its own [special log handler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast+path%3Atests%2F*.py+ColoredStreamHandler)
310311
during testing to assist in debugging. Code coverage is only collected when invoking tests via the
311312
[`Makefile`](https://github.com/reactive-firewall/multicast/tree/HEAD/Makefile) targets that
312-
support it (and of-course only if already installed).
313+
support it (and of course, only if already installed).
313314
314315
> [!TIP]
315-
> Code coverage can leave a lot of artifacts after testing, so it is a good idea to run the
316-
> `make clean` target when finished with each test run to blow-away such coverage artifacts.
316+
> Code coverage can leave numerous artifacts after testing, so it is a good idea to run the
317+
> `make clean` target when finished with each test run to blow away such coverage artifacts.
317318
318319
Here is how `multicast` module logging and code coverage collection are integrated into the
319320
whole testing process.
@@ -395,24 +396,20 @@ sequenceDiagram
395396
396397
#### As a Dependency, Testing
397398
398-
> [!TIP]
399-
> In a rush to get this module working? Then try using this in your own test workflow
400-
401-
```bash
402-
#cd /MY-AWESOME-DEV-PATH/multicast || git clone ...
403-
make clean ; # cleans up from any previous tests hopefully
404-
make test ; # runs the tests
405-
make clean ; # cleans up for next test
406-
```
399+
The test code for CI/CD is not included with the built Python module `multicast`. Currently, there
400+
is no plan to change this. The Python module `tests` does not need to be installed, so there is
401+
no practical use for including it in build artifacts. Also see relevant "AS-IS" disclaimers in
402+
[`LICENSE.md`](https://github.com/reactive-firewall/multicast/tree/HEAD/LICENSE.md).
407403
408404
> [!TIP]
409-
> Want to check multicast python code style? Great! Try this:
410-
411-
```bash
412-
make clean ; # cleans up from any previous tests hopefully
413-
make test-style ; # runs the project's tests for style
414-
make clean ; # cleans up for next test
415-
```
405+
> In a rush to test this module in your own environment? Then you might try this:
406+
>
407+
> ```bash
408+
> #cd /MY-AWESOME-DEV-PATH/multicast || git clone ...
409+
> make clean ; # cleans up from any previous tests hopefully
410+
> make test ; # runs the tests
411+
> make clean ; # cleans up for next test
412+
> ```
416413
417414
***
418415

0 commit comments

Comments
 (0)