-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[FIX] - Adding references to tutorials (#230)
* fix: adding reference to tutorials on asset hub page * Add xcm channels * Add runtime upgrades * Add chain spec * Add custom parachains * fix: adding chopsticks * fix: zombienet * Update develop/parachains/get-started/build-custom-parachains.md Co-authored-by: Nicolás Hussein <[email protected]> * fix: xcm channels references * fix: generate chain specs references * fix: generate chain specs 'where to go next' * fix: build custom parachains references * fix: runtime upgrades references * fix: chopsticks get started references * fix: zombienet get started references * fix: asset hub references * fix: add existing pallets references * fix: add smart contract funcionality references * fix: make custom pallet references * fix: pallet testing references * fix: generate chain specs references * fix: adding comment in build custom parachains * fix: deploy parachain to polkadot references * fix: setup references * fix: consensus get started references removed * fix: architecture parachains references --------- Co-authored-by: 0xLucca <[email protected]> Co-authored-by: 0xLucca <[email protected]>
- Loading branch information
3 people
committed
Dec 12, 2024
1 parent
4bb3fd1
commit d5ac8cc
Showing
15 changed files
with
313 additions
and
22 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| title: Testing Setup for a Polkadot SDK-Based Chain | ||
| description: Learn how to create a mock environment to test complete runtime functionalities in the Polkadot SDK, ensuring integration between pallets and system components. | ||
| --- | ||
|
|
||
| # Testing Setup | ||
|
|
||
| ## Introduction | ||
|
|
||
| In Polkadot SDK development, testing is crucial to ensure your blockchain works as expected. While unit testing for individual pallets validates isolated functionality, as discussed in [Pallet Testing](/develop/parachains/customize-parachain/pallet-testing/){target=\_blank}, it's equally important to test how these pallets function together within the runtime. Runtime testing fills this role by providing a complete simulation of the blockchain system. | ||
|
|
||
| This guide will help you set up an environment to test an entire runtime. Runtime testing will enable you to assess how different pallets, their configurations, and system components interact, ensuring your blockchain behaves correctly under real-world conditions. | ||
|
|
||
| ## Runtime Testing | ||
|
|
||
| In the context of Polkadot SDK, runtime testing involves creating a simulated environment that mimics actual blockchain conditions. This type of testing goes beyond individual pallet validation, focusing on how multiple components integrate and collaborate across the system. This way, multiple runtimes can be tested if needed. | ||
|
|
||
| While unit tests provide confidence that individual pallets function correctly in isolation, runtime tests offer a holistic view. These tests validate pallets' communication and interaction, ensuring a seamless and functional blockchain system. By running integration tests at the runtime level, you can catch issues that only arise when multiple pallets are combined, which is critical for building a stable and reliable blockchain. | ||
|
|
||
| ### Configuring a Mock Runtime for Integration Tests | ||
|
|
||
| The mock runtime includes all the necessary pallets and configurations needed for testing. To simplify the process, you can create a module that integrates all components, making it easier to assess how pallets and system elements interact. | ||
|
|
||
| Here's a simple example of how to create a testing module that simulates these interactions: | ||
|
|
||
| ```rust | ||
| --8<-- 'code/develop/parachains/testing/setup/integration-testing-module.rs' | ||
| ``` | ||
| !!! note | ||
| The `crate::*;` snippet imports all the components from your crate (including runtime configurations, pallet modules, and utility functions) into the `integration_testing` module. This allows you to write tests without manually importing each piece, making the code more concise and readable. | ||
| Once the testing module is set, the next step is configuring the genesis storage—the initial state of your blockchain. Genesis storage sets the starting conditions for the runtime, defining how pallets are configured before any blocks are produced. | ||
| In Polkadot SDK, you can create this storage using the [`BuildStorage`](https://paritytech.github.io/polkadot-sdk/master/sp_runtime/trait.BuildStorage.html){target=\_blank} trait from the [`sp_runtime`](https://paritytech.github.io/polkadot-sdk/master/sp_runtime){target=\_blank} crate. This trait is essential for building the configuration that initializes the blockchain's state. | ||
|
|
||
| The function `new_test_ext()` demonstrates setting up this environment. It uses `frame_system::GenesisConfig::<Runtime>::default()` to generate a default genesis configuration for the runtime, followed by `.build_storage()` to create the initial storage state. This storage is then converted into a format usable by the testing framework, [`sp_io::TestExternalities`](https://paritytech.github.io/polkadot-sdk/master/sp_io/type.TestExternalities.html){target=\_blank}, allowing tests to be executed in a simulated blockchain environment. | ||
|
|
||
| Here's the code that sets up the mock runtime: | ||
|
|
||
| ```rust | ||
| --8<-- 'code/develop/parachains/testing/setup/genesis-config.rs' | ||
| ``` | ||
| You can also customize the genesis storage to set initial values for your runtime pallets. For example, you can set the initial balance for accounts like this: | ||
| ```rust | ||
| --8<-- 'code/develop/parachains/testing/setup/genesis-config-custom.rs' | ||
| ``` | ||
| ## Where to Go Next | ||
| With the mock environment in place, you can now write tests to validate how your pallets interact within the runtime. This approach ensures that your blockchain behaves as expected when the entire runtime is assembled. | ||
| You can view a complete example of an integration test in the [Astar parachain](https://github.com/AstarNetwork/Astar/tree/master/tests/integration){target=\_blank} codebase. | ||
| <div class="grid cards" markdown> | ||
| - <span class="badge guide">Guide</span> __Pallet Testing__ | ||
| --- | ||
| Learn how to test your blockchain functionality using unit tests. | ||
| [:octicons-arrow-right-24: Reference](/develop/parachains/testing/pallet-testing/) | ||
| </div> |
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
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
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
Oops, something went wrong.