Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

try-runtime-cli docs and tests #13796

Closed
4 of 6 tasks
liamaharon opened this issue Apr 1, 2023 · 6 comments
Closed
4 of 6 tasks

try-runtime-cli docs and tests #13796

liamaharon opened this issue Apr 1, 2023 · 6 comments
Assignees
Labels
I5-tests Tests need fixing, improving or augmenting. I6-documentation Documentation needs fixing, improving or augmenting. T1-runtime This PR/Issue is related to the topic “runtime”. Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be.

Comments

@liamaharon
Copy link
Contributor

liamaharon commented Apr 1, 2023

At least one try-runtime-cli command passes parameters in the incorrect order (https://substrate.stackexchange.com/q/7902/3991).

Need to audit all the examples in the docs and fix any issues, and write some CLI tests to make sure they don't break in the future.

We should also write some CLI tests. See subtrate CLI and I believe this repo is using similar testing patterns https://github.com/paritytech/staking-miner-v2/tree/main/tests for an examples on how to write the tests.

Docs

Tests

@liamaharon liamaharon added I6-documentation Documentation needs fixing, improving or augmenting. Z0-trivial Writing the issue is of the same difficulty as patching the code. labels Apr 1, 2023
@liamaharon liamaharon self-assigned this Apr 1, 2023
@liamaharon liamaharon added I5-tests Tests need fixing, improving or augmenting. and removed Z0-trivial Writing the issue is of the same difficulty as patching the code. labels Apr 1, 2023
@ggwpez
Copy link
Member

ggwpez commented Apr 1, 2023

There are more example node tests here, just as an idea of how to do it in Substrate https://github.com/paritytech/substrate/blob/8a9f48bcf0c9f92949082535d77c12166522bb2f/bin/node/cli/tests/

@liamaharon
Copy link
Contributor Author

There are more example node tests here, just as an idea of how to do it in Substrate https://github.com/paritytech/substrate/blob/8a9f48bcf0c9f92949082535d77c12166522bb2f/bin/node/cli/tests/

Thanks!

@liamaharon liamaharon changed the title try-runtime-cli example command/s are broken try-runtime-cli docs and tests Apr 4, 2023
@liamaharon liamaharon added the Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be. label Apr 6, 2023
@Szegoo
Copy link
Contributor

Szegoo commented Apr 17, 2023

@liamaharon Just to let you know I am looking to rewrite the example part of the try-runtime-cli docs, specifically the try-state section. I believe that some of the examples and explanations could be better. I will also try my best to fix all of the issues.

@juangirini juangirini added the T1-runtime This PR/Issue is related to the topic “runtime”. label Jun 7, 2023
@Szegoo
Copy link
Contributor

Szegoo commented Jun 10, 2023

@liamaharon If you haven't already started working on it, I would like to create a PR that covers execute-block and create-snapshot with tests.

@liamaharon
Copy link
Contributor Author

I'm not currently working on these, go ahead @Szegoo

@liamaharon
Copy link
Contributor Author

Moved to paritytech/try-runtime-cli#10

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
I5-tests Tests need fixing, improving or augmenting. I6-documentation Documentation needs fixing, improving or augmenting. T1-runtime This PR/Issue is related to the topic “runtime”. Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be.
Projects
Status: Done
Development

No branches or pull requests

4 participants