Skip to content

Commit 8544272

Browse files
authored
fix: add missing channel binary to testing Cargo.toml (#423)
- Add channel binary definition to Cargo.toml to make it buildable - Update README.md to document the channel binary usage - Fixes issue #390: Update rust test applications The channel.rs binary was present in src/bin/ and referenced in Taskfile.yml but missing from Cargo.toml, preventing it from being built. Signed-off-by: Rahul Sharma <[email protected]>
1 parent bdce118 commit 8544272

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

data-plane/testing/Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ path = "src/bin/subscriber.rs"
1717
name = "publisher"
1818
path = "src/bin/publisher.rs"
1919

20+
[[bin]]
21+
name = "channel"
22+
path = "src/bin/channel.rs"
23+
2024
[dependencies]
2125
agntcy-slim = { workspace = true }
2226
agntcy-slim-auth = { workspace = true }

data-plane/testing/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,26 @@ Options:
7878
-V, --version Print version
7979
```
8080

81+
### Channel
82+
```channel``` is an application that tests streaming sessions with MLS encryption support. It can run in moderator mode (creates and manages the channel) or participant mode (joins an existing channel). It supports both MLS-enabled and MLS-disabled modes for testing purposes. It can be run as follow:
83+
```
84+
$ cargo run --release --bin channel -- --help
85+
Usage: channel [OPTIONS] --config <CONFIGURATION> --name <ENDOPOINT>
86+
87+
Options:
88+
-c, --config <CONFIGURATION> Slim config file
89+
-n, --name <ENDOPOINT> Local endpoint name in the form org/ns/type/id
90+
-i, --is-moderator Runs the endpoint in moderator mode
91+
-a, --is-attacker Runs the endpoint in attacker mode
92+
-m, --mls-disabled Runs the endpoint with MLS disabled
93+
-p, --participants <PARITICIPANTS>... List of participant types to add to the channel (moderator mode only)
94+
-o, --moderator-name <MODERATOR_NAME> Moderator name (participant mode only)
95+
-f, --frequency <FREQUENCY> Time between publications in milliseconds [default: 1000]
96+
--max-packets <MAX_PACKETS> Maximum number of packets to send (moderator only)
97+
-h, --help Print help
98+
-V, --version Print version
99+
```
100+
81101
#### Message format and test verification
82102
The payload of a publication message has this format
83103
```

0 commit comments

Comments
 (0)