Skip to content

How to write unit-tests for substrate #3

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

Open
Niraj-Kamdar wants to merge 1 commit into
base: frame-system-custom-config
Choose a base branch
from
Open

How to write unit-tests for substrate #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions runtime/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ frame-system = { git = "https://github.com/paritytech/polkadot-sdk", branch = "r
## premitivies
sp-core = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" , default-features = false }
sp-runtime = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" , default-features = false }
sp-io = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0", default-features = false }

# pallets that we want to use
pallet-balances = { git = "https://github.com/paritytech/polkadot-sdk", branch = "release-polkadot-v1.9.0" , default-features = false }
Expand Down
95 changes: 0 additions & 95 deletions runtime/src/frame_config.rs
View file
Open in desktop

This file was deleted.

78 changes: 67 additions & 11 deletions runtime/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));
use frame::{
deps::frame_support::{
genesis_builder_helper::{build_config, create_default_config},
weights::{FixedFee, NoFee},
traits::Everything,
weights::{FixedFee, NoFee},
},
prelude::*,
runtime::{
Expand All @@ -37,19 +37,15 @@ use frame::{
},
};

use frame_support::{
weights::{constants::WEIGHT_REF_TIME_PER_MILLIS, IdentityFee, Weight},
};
use frame_support::weights::{constants::WEIGHT_REF_TIME_PER_MILLIS, IdentityFee, Weight};

// Substrate FRAME
#[cfg(feature = "with-paritydb-weights")]
use frame_support::weights::constants::ParityDbWeight as RuntimeDbWeight;
#[cfg(feature = "with-rocksdb-weights")]
use frame_support::weights::constants::RocksDbWeight as RuntimeDbWeight;

use sp_runtime::generic;
use sp_runtime::Perbill;
use sp_runtime::traits::BlakeTwo256;
use sp_runtime::{generic, traits::BlakeTwo256, Perbill};

/// Type of block number.
pub type BlockNumber = u32;
Expand Down Expand Up @@ -113,10 +109,8 @@ construct_runtime!(
const NORMAL_DISPATCH_RATIO: Perbill = Perbill::from_percent(75);
/// We allow for 2000ms of compute with a 6 second average block time.
pub const WEIGHT_MILLISECS_PER_BLOCK: u64 = 2000;
pub const MAXIMUM_BLOCK_WEIGHT: Weight = Weight::from_parts(
WEIGHT_MILLISECS_PER_BLOCK * WEIGHT_REF_TIME_PER_MILLIS,
u64::MAX,
);
pub const MAXIMUM_BLOCK_WEIGHT: Weight =
Weight::from_parts(WEIGHT_MILLISECS_PER_BLOCK * WEIGHT_REF_TIME_PER_MILLIS, u64::MAX);
pub const MAXIMUM_BLOCK_LENGTH: u32 = 5 * 1024 * 1024;

parameter_types! {
Expand Down Expand Up @@ -365,3 +359,65 @@ pub mod interface {
pub type Balance = <Runtime as pallet_balances::Config>::Balance;
pub type MinimumBalance = <Runtime as pallet_balances::Config>::ExistentialDeposit;
}

#[cfg(test)]
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot Apr 1, 2024

Choose a reason for hiding this comment

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

suggestion (testing): Consider adding edge case tests for balance transfers.

It's great to see tests for normal balance transfer scenarios. However, adding tests for edge cases, such as transferring balance when the sender does not have enough funds or transferring a zero balance, would enhance the robustness of the test suite.

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot Apr 1, 2024

Choose a reason for hiding this comment

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

suggestion (testing): Add tests for error conditions in balance transfers.

Testing successful balance transfers is crucial, but it's equally important to verify the system's behavior under error conditions. For instance, tests that verify the system's response when attempting to transfer more than the account's balance or to an invalid account would be valuable.

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot Apr 1, 2024

Choose a reason for hiding this comment

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

suggestion (testing): Include tests for block number increments.

The current test suite checks the block number's set and get functionality but does not cover scenarios where the block number increments over time or through specific actions. Including such tests could provide more insights into the system's behavior over time.

mod tests {
use super::{interface, Balances, Runtime, RuntimeOrigin, System};
use sp_io;
use sp_runtime::BuildStorage;

use sp_core::{crypto::DEV_PHRASE, sr25519, Pair};
use sp_runtime::AccountId32;

use sp_runtime::MultiAddress::Id;

fn get_account_id(name: &str) -> AccountId32 {
let pair = sr25519::Pair::from_string(&format!("{}//{}", DEV_PHRASE, name), None).unwrap();
let pub_key = pair.public();
let account_id = interface::AccountId::from(pub_key);
account_id
}

// Function to set up the externalities
pub fn new_test_ext() -> sp_io::TestExternalities {
let mut storage =
frame_system::GenesisConfig::<Runtime>::default().build_storage().unwrap();

// Here you must include the balances in your genesis configuration.
pallet_balances::GenesisConfig::<Runtime> {
// Assuming Alice's account ID is correct and she should have some balance.
balances: vec![(get_account_id("Alice"), 1000), (get_account_id("Bob"), 1000)],
}
.assimilate_storage(&mut storage)
.unwrap();

sp_io::TestExternalities::from(storage)
}

#[test]
fn test_block_number() {
new_test_ext().execute_with(|| {
assert_eq!(System::block_number(), 0, "Block Number should be 0");
System::set_block_number(5);
assert_eq!(System::block_number(), 5, "Block Number should be 5");
});
}

#[test]
fn test_balance_transfer() {
let ALICE: AccountId32 = get_account_id(&"Alice");
let BOB: AccountId32 = get_account_id(&"Bob");
new_test_ext().execute_with(|| {
assert_eq!(Balances::usable_balance(ALICE.clone()), 1000);
assert_eq!(Balances::usable_balance(BOB.clone()), 1000);
let _ = Balances::transfer_keep_alive(
RuntimeOrigin::signed(ALICE.clone()),
Id(BOB.clone()),
10,
)
.unwrap();
assert_eq!(Balances::usable_balance(ALICE.clone()), 990);
assert_eq!(Balances::usable_balance(BOB.clone()), 1010);
})
}
}