Skip to content

Commit b910b45

Browse files
authored
Add simple READMEs for SDK test clients (#350)
1 parent 6325f75 commit b910b45

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
This test client is used with two modules:
2+
3+
- [`sdk-test-connect-disconnect`](/modules/sdk-test-connect-disconnect)
4+
- [`sdk-test-connect-disconnect-cs`](/modules/sdk-test-connect-disconnect-cs)
5+
6+
Currently, the bindings are generated using only one of those two modules,
7+
chosen arbitrarily on each test run.
8+
The two tests which use this client,
9+
`connect_disconnect_callbacks` and `connect_disconnect_callbacks_csharp`,
10+
are not intended to test code generation.
11+
12+
The goal of the two tests is to verify that module-side `connect` and `disconnect` events
13+
fire when an SDK connects or disconnects via WebSocket,
14+
and that the client can observe mutations performed by those events.
15+
16+
To (re-)generate the `module_bindings`, from this directory, run:
17+
18+
```sh
19+
mkdir -P src/module_bindings
20+
spacetime generate --lang rust \
21+
--out-dir src/module_bindings \
22+
--project-path ../../../../modules/sdk-test-connect-disconnect
23+
```
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
This test client is used with the module [`sdk-test`](/modules/sdk-test).
2+
3+
It is invoked by a majority of the SDK tests,
4+
and is responsible for testing that
5+
serialization, deserialization, type dispatch, and client-side callbacks
6+
work as expected.
7+
8+
To (re-)generate the `module_bindings`, from this directory, run:
9+
10+
```sh
11+
mkdir -p src/module_bindings
12+
spacetime generate --lang rust --out-dir src/module_bindings --project-path ../../../../modules/sdk-test
13+
```

0 commit comments

Comments
 (0)