Skip to content
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.

Sign up for GitHub

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

docs/: Fix outdated localnet docs #5986

Merged
merged 2 commits into from
Jan 7, 2025
Merged

docs/: Fix outdated localnet docs #5986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
412871b
go/oasis-test-runner/README: Fix runner command
martintomazic Jan 3, 2025
72abf37
docs/development-setup: Fix oasis-net-runner.md
martintomazic Jan 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .changelog/5986.trivial.md
View file
Open in desktop
Empty file.
17 changes: 0 additions & 17 deletions docs/development-setup/oasis-net-runner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,6 @@ and supports reading, writing, and fetching string values associated with the
given key. To learn how to create your own runtime, see the sources of the
[simple-keyvalue example] and [Building a runtime] chapter in the Oasis SDK.

Finally, to test Oasis node, we will run a test client written specifically
for the `simple-keyvalue` runtime. The client sends a few keys with associated
values and fetches them back over RPC defined in the runtime's API. Execute the
client as follows (substituting the socket path from your log output) in a
different terminal:

```
./target/default/release/simple-keyvalue-client \
--runtime-id 8000000000000000000000000000000000000000000000000000000000000000 \
--node-address unix:/tmp/oasis-net-runner530668299/net-runner/network/client-0/internal.sock
```

By default, Oasis node is configured with a 30-second epoch, so you may
initially need to wait for the first epoch to pass before the test client will
make any progress. For more information on writing your own client, see the
[Oasis SDK](https://github.com/oasisprotocol/oasis-sdk).

<!-- markdownlint-disable line-length -->
[the default network fixture]: https://github.com/oasisprotocol/oasis-core/tree/master/go/oasis-net-runner/fixtures/default.go
[simple-keyvalue example]: https://github.com/oasisprotocol/oasis-core/tree/master/tests/runtimes/simple-keyvalue
Expand Down
16 changes: 14 additions & 2 deletions go/oasis-test-runner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,22 @@ oasis-test-runner list
If no flags are provided, all scenarios are executed.

To run a specific scenario, e.g `e2e/runtime/runtime-dynamic`, pass the
`--scenario` flag (or its short version, `-s`) followed by scenario's name:
`--scenario` flag (or its short version, `-s`) followed by scenario's name,
together with the relevant parameters:

```bash
oasis-test-runner --scenario e2e/runtime/runtime-dynamic
oasis-test-runner \
--e2e.node.binary go/oasis-node/oasis-node \
--e2e/runtime.runtime.binary_dir.default ./target/default/release \
--log.level debug \
--scenario e2e/runtime/runtime-dynamic
```

To avoid manually setting parameters, you may run the CI script from the root
instead:

```bash
.buildkite/scripts/test_e2e.sh --scenario=e2e.runtime.runtime-dynamic
```

## Benchmarking
Expand Down
Loading