You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Testing.md
+18-21Lines changed: 18 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,7 +176,7 @@ gitGraph:
176
176
177
177
During the development cycle new features will also need testing, (this is mentioned in detail
178
178
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),
180
180
comes into play. While the test runner is used by much of the project automation to run all kinds
181
181
of tests, it is the most powerful when used to skip tests to save time iteratively developing a
182
182
new feature.
@@ -193,7 +193,8 @@ methods are unsuited:
193
193
* checking more than just the new tests, until the new tests are passing, is inefficient.
194
194
195
195
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.
197
198
198
199
```mermaid
199
200
sequenceDiagram
@@ -309,11 +310,11 @@ By default, logging from the `multicast` module is ignored (there is a [default
309
310
inserts its own [special log handler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast+path%3Atests%2F*.py+ColoredStreamHandler)
310
311
during testing to assist in debugging. Code coverage is only collected when invoking tests via the
311
312
[`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 ofcourse, only if already installed).
313
314
314
315
> [!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 blowaway such coverage artifacts.
317
318
318
319
Here is how `multicast` module logging and code coverage collection are integrated into the
319
320
whole testing process.
@@ -395,24 +396,20 @@ sequenceDiagram
395
396
396
397
#### As a Dependency, Testing
397
398
398
-
> [!TIP]
399
-
> In a rush to get this module working? Then try using this in your own test workflow
0 commit comments