Skip to content

Commit decbb49

Browse files
[DOCUMENTATION] Cleaned up markdown for new Testing documentation (- WIP #411 -)
Changes in file docs/Testing.md: * Many style fixes * related work Changes in file docs/utils.py: * added gists to url list
1 parent 6419e29 commit decbb49

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/Testing.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Details about the Multicast project's own testing.
2525

2626
> [!IMPORTANT]
2727
> 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
2929
> just `make test` and can be reset before and after with: `make clean` and `make purge`.
3030
3131
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.
3535
actual pair of processes to test that `SAY` and `HEAR` indeed work together.
3636

3737
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`).
3939

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)
4343

4444
## Test Groups
4545

@@ -63,15 +63,15 @@ Multicast project to be considered acceptable.
6363

6464
1. Clone a [development build](https://github.com/reactive-firewall/multicast/tree/patch-readme-docs?tab=readme-ov-file#developer-builds)
6565

66-
1. Invoke the MATs test target.
66+
2. Invoke the MATs test target.
6767

6868
```bash
6969
make test-mats
7070
```
7171

7272
#### Categories
7373

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`,
7575
`say`, `hear`, and `usage`.
7676

7777
| Category | Criteria | _TestSuites_ |
@@ -97,7 +97,7 @@ Currently MATs are comprised of the test categories `bootstrap`, `basic`, `build
9797
#### The Test Runner
9898

9999
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
101101
for running the various tests during the act of testing.
102102

103103
> [!IMPORTANT]
@@ -233,7 +233,7 @@ are present.
233233
> To effectively leverage the source code for performing fuzzing, you must install a licensed
234234
> copy of the hypothesis python module.
235235
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
237237
`fuzzing` test group contains only one category named `slow`.
238238

239239
| Category | Criteria | _TestSuites_ |
@@ -276,7 +276,7 @@ The Multicast project uses CI/CD to ensure constant and comprehensive testing. `
276276
`extra` group's context is referring to "extra test coverage".
277277

278278
> [!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 fall back to the
280280
> `coverage` category, so not to get bogged down before code review, where the categorization
281281
> can better be discussed.
282282
@@ -304,7 +304,7 @@ See implementation for more details.
304304
305305
#### Logging and Coverage testing
306306
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)
308308
). The test-runner [`run_selective.py`](https://github.com/reactive-firewall/multicast/tree/HEAD/tests/run_selective.py)
309309
inserts its own [special log handler](https://github.com/search?q=repo%3Areactive-firewall%2Fmulticast+path%3Atests%2F*.py+ColoredStreamHandler)
310310
during testing to assist in debugging. Code coverage is only collected when invoking tests via the

docs/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
# Enforces:
3838
# - URLs Must belong to one of these domains
3939
URL_ALLOWED_NETLOCS = frozenset({
40-
"github.com", "readthedocs.com", "docs.python.org", "peps.python.org",
40+
"github.com", "gist.github.com", "readthedocs.com", "docs.python.org", "peps.python.org",
4141
})
4242

4343

0 commit comments

Comments
 (0)