From 882e8522dfbdcdea99c0af13550b5096b97aeffe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Mi=C5=9Bkowicz?= Date: Wed, 10 Apr 2024 16:57:49 +0200 Subject: [PATCH] Update `Running Tests` docs section commit-id:9e36d3c9 --- docs/src/development/environment-setup.md | 52 ++++++++++++++--------- 1 file changed, 33 insertions(+), 19 deletions(-) diff --git a/docs/src/development/environment-setup.md b/docs/src/development/environment-setup.md index a7c447aa0e..3373db87b0 100644 --- a/docs/src/development/environment-setup.md +++ b/docs/src/development/environment-setup.md @@ -8,7 +8,7 @@ ### Rust Install the latest stable [Rust](https://www.rust-lang.org/tools/install) version. -If you already have Rust installed make sure to upgrade it by running +If you already have Rust installed make sure to upgrade it by running: ```shell $ rustup update @@ -16,7 +16,6 @@ $ rustup update ### Scarb You can read more about installing Scarb [here](https://docs.swmansion.com/scarb/download.html) - Please make sure you're using Scarb installed via [asdf](https://asdf-vm.com/) - otherwise some tests may fail. > To verify, run: > @@ -28,49 +27,64 @@ Please make sure you're using Scarb installed via [asdf](https://asdf-vm.com/) - > $HOME/.asdf/shims/scarb > ``` > -> If you previously installed scarb using official installer, you may need to remove this installation or modify your PATH to make sure asdf installed one is always used. - - -> ❗️ **Warning** -> -> If you haven't pushed your branch to the remote yet (you've been working only locally), two tests will fail: -> -> - `e2e::running::init_new_project_test` -> - `e2e::running::simple_package_with_git_dependency` +> 💡 **Info** > -> After pushing the branch to the remote, those tests should pass. +> If you previously installed Scarb using official installer, you may need to remove that installation or modify your `PATH` +> to make sure the version installed by `asdf` is always used. ### Starknet Devnet -To install it run `./scripts/install_devnet.sh` +To install it, run `./scripts/install_devnet.sh` ### Universal sierra compiler Install the latest [universal-sierra-compiler](https://github.com/software-mansion/universal-sierra-compiler) version. +### Environmental variables +Set `NODE_URL` environmental variable to a Sepolia testnet node URL: + - either manually in your shell + ```shell + $ export NODE_URL="https://example.com" + ``` + - or inside [`.cargo/config.toml` file](https://doc.rust-lang.org/cargo/reference/config.html#configuration-format) + ```toml + [env] + NODE_URL = "https://example.com/rpc" + ``` + +Additionally, if you want to run your tests on GitHub Actions, you need to +[set a secret variable](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) ## Running Tests -Tests can be run with: +After performing these steps, you can run tests with: ```shell $ cargo test ``` +> ❗️ **Warning** +> +> If you haven't pushed your branch to the remote yet (you've been working only locally), two tests will fail: +> +> - `e2e::running::init_new_project_test` +> - `e2e::running::simple_package_with_git_dependency` +> +> After pushing the branch to the remote, those tests should pass. ## Formatting and Lints -Starknet Foundry uses [rustfmt](https://github.com/rust-lang/rustfmt) for formatting. You can run the formatter with +Starknet Foundry uses [rustfmt](https://github.com/rust-lang/rustfmt) for formatting. You can run the formatter with: ```shell $ cargo fmt ``` -For linting, it uses [clippy](https://github.com/rust-lang/rust-clippy). You can run it with this command: +For linting, it uses [clippy](https://github.com/rust-lang/rust-clippy). You can run it with: ```shell $ cargo clippy --all-targets --all-features -- --no-deps -W clippy::pedantic -A clippy::missing_errors_doc -A clippy::missing_panics_doc -A clippy::default_trait_access ``` -Or using our defined alias +or using our defined alias: ```shell $ cargo lint @@ -80,13 +94,13 @@ $ cargo lint Starknet Foundry uses [typos](https://github.com/marketplace/actions/typos-action) for spelling checks. -You can run the checker with +You can run the checker with: ```shell $ typos ``` -Some typos can be automatically fixed by running +Some typos can be automatically fixed by running: ```shell $ typos -w