Skip to content

chore(docs): run WASM tests with Cargo #1965

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

Merged
onur-ozkan merged 7 commits into from
Sep 11, 2023
Merged

chore(docs): run WASM tests with Cargo #1965

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
46535e8
Merge pull request #1771 from KomodoPlatform/dev
ca333 Apr 28, 2023
371595d
Merge pull request #1804 from KomodoPlatform/dev
shamardy May 22, 2023
1d8bebd
Merge pull request #1844 from KomodoPlatform/dev
shamardy Jun 8, 2023
ef89614
Merge pull request #1871 from KomodoPlatform/dev
shamardy Jul 24, 2023
79f6205
Merge pull request #1936 from KomodoPlatform/dev
shamardy Sep 8, 2023
aafd02a
Running WASM tests with Cargo
borngraced Sep 9, 2023
505bf9e
update title
borngraced Sep 10, 2023
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
13 changes: 12 additions & 1 deletion docs/DEV_ENVIRONMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
export BOB_PASSPHRASE="also shoot benefit prefer juice shell elder veteran woman mimic image kidney"
export ALICE_PASSPHRASE="spice describe gravity federal blast come thank unfair canal monkey style afraid"
```
6. Run WASM tests
5. Run WASM tests
- for Linux users:
```
wasm-pack test --firefox --headless mm2src/mm2_main
Expand All @@ -66,5 +66,16 @@
CC=/opt/homebrew/opt/llvm/bin/clang AR=/opt/homebrew/opt/llvm/bin/llvm-ar wasm-pack test --firefox --headless mm2src/mm2_main
```
Please note `CC` and `AR` must be specified in the same line as `wasm-pack test mm2src/mm2_main`.
#### Running WASM tests with Cargo</br>

@onur-ozkan onur-ozkan Sep 10, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, the way this looks feels too much like "you can run tests with cargo without needing to setup things above".

@borngraced borngraced Sep 10, 2023 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmmm, I think this is mostly useful when you want to run a single or some specific wasm tests alone. While the other tries to run all tests

@onur-ozkan onur-ozkan Sep 10, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My concern is this title can lead to confusions. Different title("example of running single test") would be more appropriate I guess.

@borngraced borngraced Sep 10, 2023

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand, but keep in mind that the command can also be used to run the full test just like wasm-pack..hence why I used the title as it's not just limited to running single/some tests

@onur-ozkan onur-ozkan Sep 10, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know but I don't think anyone will think cargo can only do single test. Command explicitly contains flags that everyone can understand. I want to avoid the confusion of "there is an alternative way of running wasm tests that don't require prequests mentioned above".

@borngraced borngraced Sep 10, 2023

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok got it. amended now

@onur-ozkan onur-ozkan Sep 10, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we run single test using wasm-pack? If we can, we should use wasm-pack for "example of running single test", and find better title for cargo one probably.

@borngraced borngraced Sep 10, 2023 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I understood that, thanks.
but personally, I'm not sure if wasm-pack can perform same action tho

- Install `wasm-bindgen-cli`: </br>
Make sure you have wasm-bindgen-cli installed with a version that matches the one specified in your Cargo.toml file.
You can install it using Cargo with the following command:
```
cargo install -f wasm-bindgen-cli --version <wasm-bindgen-version>
```
- Run
```
cargo test --target wasm32-unknown-unknown --package coins --lib utxo::utxo_block_header_storage::wasm::indexeddb_block_header_storage
```

PS If you notice that this guide is outdated, please submit a PR.