-
Notifications
You must be signed in to change notification settings - Fork 645
Add simple READMEs for SDK test clients #350
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| This test client is used with two modules: | ||
|
|
||
| - [`sdk-test-connect-disconnect`](/modules/sdk-test-connect-disconnect) | ||
| - [`sdk-test-connect-disconnect-cs`](/modules/sdk-test-connect-disconnect-cs) | ||
|
|
||
| Currently, the bindings are generated using only one of those two modules, | ||
| chosen arbitrarily on each test run. | ||
| The two tests which use this client, | ||
| `connect_disconnect_callbacks` and `connect_disconnect_callbacks_csharp`, | ||
| are not intended to test codegeneration. | ||
|
|
||
| The goal of the two tests is to verify that module-side `connect` and `disconnect` events | ||
| fire when an SDK connects or disconnects via WebSocket, | ||
| and that the client can observe mutations performed by those events. | ||
|
|
||
| To (re-)generate the `module_bindings`, from this directory, run: | ||
|
|
||
| ```sh | ||
| mkdir -P src/module_bindings | ||
| spacetime generate --lang rust \ | ||
| --out-dir src/module_bindings \ | ||
| --project-path ../../../../modules/sdk-test-connect-disconnect | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| This test client is used with the module [`sdk-test`](/modules/sdk-test). | ||
|
|
||
| It is invoked by a majority of the SDK tests, | ||
| and is responsible for testing that | ||
| serialization, deserialization, type dispatch, and client-side callbacks | ||
| work as expected. | ||
|
|
||
| To (re-)generate the `module_bindings`, from this directory, run: | ||
|
|
||
| ```sh | ||
| mkdir -p src/module_bindings | ||
| spacetime generate --lang rust --out-dir src/module_bindings --project-path ../../../../modules/sdk-test | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.