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
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Details about the Multicast project's own testing.
25
25
26
26
> [!IMPORTANT]
27
27
> Multicast project testing is intended for CI/CD but can also be initiated
28
-
> manually (eg. in your local environment) with the bash command: `make test-mats` or
28
+
> manually (e.g., in your local environment) with the bash command: `make test-mats` or
29
29
> just `make test` and can be reset before and after with: `make clean` and `make purge`.
30
30
31
31
You can find all the testing code in the aptly named `tests/` directory.
@@ -35,11 +35,11 @@ You can find all the testing code in the aptly named `tests/` directory.
35
35
actual pair of processes to test that `SAY` and `HEAR` indeed work together.
36
36
37
37
You can find additional custom testing automation tooling in the aptly named `tools/` directory
38
-
inside the `.github` directory (eg.`.github/tools`).
38
+
inside the `.github` directory (e.g.,`.github/tools`).
39
39
40
-
*Unit-testing is primarily done with the `unittest` framework.
41
-
* Functional testing is done via additional checks, including an end-to-end check invoking an
42
-
actual pair of processes to test that `SAY` and `HEAR` indeed work together.
40
+
*The custom scripts for handling various tasks in CI/CD are also located in `.github/tools`
41
+
* Also see [CI Documentation](CI.md)
42
+
* Also see [CEP-5](https://gist.github.com/reactive-firewall/3d2bd3cf37f87974df6f7bee31a05a89)
43
43
44
44
## Test Groups
45
45
@@ -63,15 +63,15 @@ Multicast project to be considered acceptable.
63
63
64
64
1. Clone a [development build](https://github.com/reactive-firewall/multicast/tree/patch-readme-docs?tab=readme-ov-file#developer-builds)
65
65
66
-
1. Invoke the MATs test target.
66
+
2. Invoke the MATs test target.
67
67
68
68
```bash
69
69
make test-mats
70
70
```
71
71
72
72
#### Categories
73
73
74
-
Currently MATs are comprised of the test categories `bootstrap`, `basic`, `build`, `doctests`,
74
+
Currently, MATs are comprised of the test categories `bootstrap`, `basic`, `build`, `doctests`,
75
75
`say`, `hear`, and `usage`.
76
76
77
77
| Category | Criteria |_TestSuites_|
@@ -97,7 +97,7 @@ Currently MATs are comprised of the test categories `bootstrap`, `basic`, `build
97
97
#### The Test Runner
98
98
99
99
The test runner is an often obscure part of the Multicast project testing process, albeit an
100
-
important part. In, general a test runner is exactly what it sounds like, the component responsible
100
+
important part. In general, a test runner is what it sounds like; the component responsible
101
101
for running the various tests during the act of testing.
102
102
103
103
> [!IMPORTANT]
@@ -233,7 +233,7 @@ are present.
233
233
> To effectively leverage the source code for performing fuzzing, you must install a licensed
234
234
> copy of the hypothesis python module.
235
235
236
-
There is a separate test group for optional fuzz testing aptly named `fuzzing`. Currently the
236
+
There is a separate test group for optional fuzz testing aptly named `fuzzing`. Currently, the
237
237
`fuzzing` test group contains only one category named `slow`.
238
238
239
239
| Category | Criteria |_TestSuites_|
@@ -276,7 +276,7 @@ The Multicast project uses CI/CD to ensure constant and comprehensive testing. `
276
276
`extra` group's context is referring to "extra test coverage".
277
277
278
278
> [!TIP]
279
-
> Contributors who are unsure of how to categorize their new test code, may fall-back to the
279
+
> Contributors who are unsure of how to categorize their new test code, may fallback to the
280
280
> `coverage` category, so not to get bogged down before code review, where the categorization
281
281
> can better be discussed.
282
282
@@ -304,7 +304,7 @@ See implementation for more details.
304
304
305
305
#### Logging and Coverage testing
306
306
307
-
By default logging from the `multicast` module is ignored (there is a [default NULLHandeler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast%20path%3Amulticast%2F*.py%20%22addHandler(logging.NullHandler())%22&type=code)
307
+
By default, logging from the `multicast` module is ignored (there is a [default NULLHandeler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast%20path%3Amulticast%2F*.py%20%22addHandler(logging.NullHandler())%22&type=code)
308
308
). The test-runner [`run_selective.py`](https://github.com/reactive-firewall/multicast/tree/HEAD/tests/run_selective.py)
309
309
inserts its own [special log handler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast+path%3Atests%2F*.py+ColoredStreamHandler)
310
310
during testing to assist in debugging. Code coverage is only collected when invoking tests via the
0 commit comments