Add Moonwall #315
Open
Add Moonwall #315
Conversation
This file contains 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
0xLucca
added
C1 - Medium
nhussein11
reviewed
Jan 22, 2025
| - fork-chains | ||
| - e2e-testing |
There was a problem hiding this comment.
Suggested change
| - e2e-testing | |
| - 'E2E Testing': e2e-testing |
Otherwise, it renders as:
| @@ -0,0 +1,7 @@ | |||
| --- | |||
| title: E2E Testing | |||
| description: TODO | |||
|
|
||
| ## Introduction | ||
|
|
||
| Moonwall is a end-to-end testing framework specifically designed for Polkadot SDK-based blockchain networks. It addresses one of the most significant challenges in blockchain development: managing complex test environments and network configurations. |
There was a problem hiding this comment.
Unsure if "network configurations" would be 100% accurate here. Does moonwall allow us to test p2p settings and that kind of things?
There was a problem hiding this comment.
oh, maybe you meant something related to the moonwall.config.json file, but even though that file defines some parameters to bootstrap the node, I think the purpose of that file is to define the settings of the test suite
| Moonwall can be installed either globally for system-wide access or locally within specific projects. This section covers both installation methods. | ||
|
|
||
| !!! note | ||
| his documentation corresponds to Moonwall version `{{ dependencies.moonwall.version }}`. Ensure you're using the matching version to avoid compatibility issues with the documented features. |
There was a problem hiding this comment.
Suggested change
| his documentation corresponds to Moonwall version `{{ dependencies.moonwall.version }}`. Ensure you're using the matching version to avoid compatibility issues with the documented features. | |
| This documentation corresponds to Moonwall version `{{ dependencies.moonwall.version }}`. Ensure you're using the matching version to avoid compatibility issues with the documented features. |
| yarn global add @moonwall/cli@{{ dependencies.moonwall.version }} | ||
| ``` | ||
|
|
||
| Now, you should be able to run the `moonwall` command from your terminal. |
There was a problem hiding this comment.
Maybe you can add the output in a termynal element
| !!!note | ||
| A provider is a tool that allows you or your application to connect to a blockchain network and simplifies the low-level details of the process. A provider handles submitting transactions, reading state, and more. For more information on available providers check the [Providers supported](https://moonsong-labs.github.io/moonwall/guide/intro/providers.html#providers-supported){target=\_blank} page. | ||
|
|
||
| Here's a complete configuration example for testing a local node using polkadot.js as a provider: |
There was a problem hiding this comment.
Suggested change
| Here's a complete configuration example for testing a local node using polkadot.js as a provider: | |
| Here's a complete configuration example for testing a local node using Polkadot.js as a provider: |
|
|
||
| ## Writing Tests | ||
|
|
||
| Moonwall uses the `describeSuite` function to define test suites, like using [Mocha](https://mochajs.org/){target=\_blank}. Each test suite requires: |
There was a problem hiding this comment.
is there a link to add as a reference for describeSuite?
|
|
||
| During setup, you'll be prompted for the following parameters: | ||
|
|
||
| - Label - identifies your test configuration |
There was a problem hiding this comment.
In the writing test section, you set the parameters using ``, and for consistency you should do the same here
| @@ -14,6 +14,7 @@ This section explores essential tools for blockchain testing, forking live netwo | |||
|
|
|||
| - [Use Zombienet to spawn a chain](/develop/toolkit/parachains/spawn-chains/zombienet/get-started/) | |||
| - [Use Chopsticks to fork a chain](/develop/toolkit/parachains/fork-chains/chopsticks/get-started/) | |||
| - [Use Moonwall to execute e2e testing](/develop/toolkit/parachains/e2e-testing/moonwall/) | |||
There was a problem hiding this comment.
Suggested change
| - [Use Moonwall to execute e2e testing](/develop/toolkit/parachains/e2e-testing/moonwall/) | |
| - [Use Moonwall to execute E2E testing](/develop/toolkit/parachains/e2e-testing/moonwall/) |
| Execute your tests using the Moonwall CLI command: | ||
|
|
||
| ```bash | ||
| moonwall test INSERT_ENVIRONMENT_NAME_HERE |
There was a problem hiding this comment.
Please add a note below explaining this placeholder
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds Moonwall e2e testing framework to Develop -> Toolkig -> Parachains -> E2E Testing -> Moonwall