Skip to content

Commit 84e3f8f

Browse files
glynsagudev
andauthored
Document testing (#385)
* Document testing Describe the current testing situation. not_rust: rust-lang/rfcs#500 Fixes: #376 * Improve fenced code in README * Update README.md Signed-off-by: Samson <[email protected]> --------- Signed-off-by: Samson <[email protected]> Co-authored-by: Samson <[email protected]>
1 parent f2729e1 commit 84e3f8f

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,36 @@ The server process calls `accept()` on the server to accept connect requests fro
3333

3434
So, in order to bootstrap an IPC channel between processes, you create an instance of the `IpcOneShotServer` type, pass the resultant server name into the client process (perhaps via an environment variable or command line flag), and connect to the server in the client. See `spawn_one_shot_server_client()` in `integration_test.rs` for an example of how to do this using a command to spawn the client process and `cross_process_embedded_senders_fork()` in `test.rs` for an example of how to do this using Unix `fork()`[^fork] to create the client process.
3535

36-
## Implementation overview
36+
## Testing
37+
38+
To run the tests, issue:
39+
40+
```console
41+
cargo test
42+
```
43+
44+
Some tests are platform dependent, so for completeness it would be necessary to run the tests on all platforms:
45+
46+
* iOS
47+
* macOS†
48+
* Unix variants:
49+
* Android
50+
* FreeBD
51+
* Illumos
52+
* Linux (Ubuntu†)
53+
* OpenBSD
54+
* WASI
55+
* Windows†
56+
57+
The platforms marked † are covered by CI.
58+
59+
To run the benchmarks, issue:
60+
61+
```console
62+
cargo bench
63+
```
64+
65+
## Implementation overview
3766

3867
`ipc-channel` is implemented in terms of native IPC primitives: file descriptor passing over Unix sockets on Unix variants, Mach ports on macOS, and named pipes on Windows.
3968

0 commit comments

Comments
 (0)