Skip to content

rust runtime integration tests #339

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
JoshOrndorff merged 17 commits into from
Apr 21, 2021
Merged

rust runtime integration tests #339

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
832726b
init
4meta5 Apr 8, 2021
f179e91
Merge branch 'master' into amar-int-tests
4meta5 Apr 12, 2021
737c0fd
save
4meta5 Apr 13, 2021
69a32b7
import pallet instances from runtime and start evm transfer to stake …
4meta5 Apr 14, 2021
71d5660
transfer to stake without evm transfer
4meta5 Apr 14, 2021
1f10d75
rename carl to charlie
4meta5 Apr 14, 2021
97fc054
push failed test to show how evm call works
4meta5 Apr 15, 2021
688a324
set gas price and limit to make test pass
JoshOrndorff Apr 15, 2021
b3abf42
test still fails, push to show that transfer through EVM does not suc…
4meta5 Apr 15, 2021
f154f50
test passes
4meta5 Apr 15, 2021
270ea2d
save unfinished pay block authors todo
4meta5 Apr 15, 2021
fbb9852
reward block authors runtime integration test
4meta5 Apr 16, 2021
15aae62
improve readability
4meta5 Apr 18, 2021
a46d404
increase test inflation config to see test balances go up more
4meta5 Apr 18, 2021
481f43d
address most review comments
4meta5 Apr 21, 2021
ca44e43
Merge branch 'master' into amar-int-tests
JoshOrndorff Apr 21, 2021
9e6c7f8
Fix test for root origin
JoshOrndorff Apr 21, 2021
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
2 changes: 2 additions & 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.

4 changes: 4 additions & 0 deletions runtime/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ cumulus-pallet-parachain-system = { git = "https://github.com/paritytech/cumulus
cumulus-primitives-core = { git = "https://github.com/paritytech/cumulus", default-features = false, branch = "rococo-v1" }
parachain-info = { git = "https://github.com/paritytech/cumulus", default-features = false, branch = "rococo-v1" }

[dev-dependencies]
cumulus-test-relay-sproof-builder = { git = "https://github.com/paritytech/cumulus", default-features = false, branch = "rococo-v1" }
cumulus-primitives-parachain-inherent = { git = "https://github.com/paritytech/cumulus", default-features = false, branch = "rococo-v1" }

[build-dependencies]
substrate-wasm-builder = { version = "4.0.0", git = "https://github.com/paritytech/substrate", branch = "rococo-v1" }

Expand Down
71 changes: 70 additions & 1 deletion runtime/tests/integration_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

#![cfg(test)]

use cumulus_primitives_parachain_inherent::ParachainInherentData;
use frame_support::{
assert_noop, assert_ok,
dispatch::Dispatchable,
Expand Down Expand Up @@ -116,6 +117,10 @@ fn origin_of(account_id: AccountId) -> <Runtime as frame_system::Config>::Origin
<Runtime as frame_system::Config>::Origin::signed(account_id)
}

fn inherent_origin() -> <Runtime as frame_system::Config>::Origin {
<Runtime as frame_system::Config>::Origin::none()
}

#[test]
fn join_collator_candidates() {
ExtBuilder::default()
Expand Down Expand Up @@ -228,5 +233,69 @@ fn transfer_through_evm_to_stake() {

#[test]
fn reward_block_authors() {
assert!(true);
ExtBuilder::default()
.balances(vec![
(AccountId::from(ALICE), 2_000 * GLMR),
(AccountId::from(BOB), 1_000 * GLMR),
])
.staking(vec![
// collator
(AccountId::from(ALICE), None, 1_000 * GLMR),
// nominators
(
AccountId::from(BOB),
Some(AccountId::from(ALICE)),
500 * GLMR,
),
])
.build()
.execute_with(|| {
// set parachain inherent data
use cumulus_primitives_core::PersistedValidationData;
use cumulus_test_relay_sproof_builder::RelayStateSproofBuilder;
let sproof_builder = RelayStateSproofBuilder::default();
let (relay_parent_storage_root, relay_chain_state) =
sproof_builder.into_state_root_and_proof();
let vfp = PersistedValidationData {
relay_parent_number: 1u32,
relay_parent_storage_root,
..Default::default()
};
let parachain_inherent_data = ParachainInherentData {
validation_data: vfp,
relay_chain_state: relay_chain_state,
downward_messages: Default::default(),
horizontal_messages: Default::default(),
};
assert_ok!(
Call::ParachainSystem(ParachainSystemCall::set_validation_data(
parachain_inherent_data
))
.dispatch(inherent_origin())
);
fn set_alice_as_author() {
assert_ok!(
Call::AuthorInherent(AuthorInherentCall::set_author(AccountId::from(ALICE)))
.dispatch(inherent_origin())
);
}
for x in 2..1201 {
set_alice_as_author();
Copy link
Contributor

@joelamouche joelamouche Apr 19, 2021

Choose a reason for hiding this comment

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

why do you need to set alice as author if she is the only collator? Maybe set up a test with more than one collator and somehow count how many time each collator was selected as author and test that the balance reward is correct in a dynamic way

Copy link
Contributor Author

@4meta5 4meta5 Apr 19, 2021

Choose a reason for hiding this comment

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

An author must be set every block or on_finalize in author-inherent panics.

Having multiple collators to test correct reward distribution is already done in parachain-staking unit tests. I think it's reasonable to add the same test here as well.

Copy link
Contributor

@JoshOrndorff JoshOrndorff Apr 20, 2021

Choose a reason for hiding this comment

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

@joelamouche This is a good chance to learn about Substrate inherents. When a collator authors a block, they have the opportunity to include inherent extrinsics. In moonbeam there are three of them (timestamp, validation_data, and author) and all three are required. It is behind-the-scenes from a user perspective, but every time a collator authors a moonbeam block, they insert these three inherents. Since Amar is mocking here, and there is no collator process to do any actual block authoring, we have to call these inherents manually. So setting the author to Alice here is mocking Alice authoring the block.

Copy link
Contributor Author

@4meta5 4meta5 Apr 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe set up a test with more than one collator and somehow count how many time each collator was selected as author and test that the balance reward is correct in a dynamic way

I'd rather do this at the pallet level (and have done it there) where I can mock the set_author command more easily.

I added Charlie, Dave, and Eve to the set of collators in this test and none of them were included in the set of valid block authors so it kept returning the following error:

---- reward_block_authors stdout ----
thread 'reward_block_authors' panicked at 'Expected Ok(_). Got Err(
    DispatchErrorWithPostInfo {
        post_info: PostDispatchInfo {
            actual_weight: None,
            pays_fee: Pays::Yes,
        },
        error: DispatchError::Module {
            index: 17,
            error: 1,
            message: Some(
                "CannotBeAuthor",
            ),
        },
    },
)', runtime/tests/integration_test.rs:337:17

Testing multiple block authors in a runtime integration test is worthwhile, but I'd prefer for it to be pursued in a follow up...

run_to_block(x);
}
// no rewards doled out yet
assert_eq!(Balances::free_balance(AccountId::from(ALICE)), 1_000 * GLMR,);
assert_eq!(Balances::free_balance(AccountId::from(BOB)), 500 * GLMR,);
set_alice_as_author();
run_to_block(1201);
// rewards minted and distributed
assert_eq!(
Balances::free_balance(AccountId::from(ALICE)),
1000010038599992699200,
);
assert_eq!(
Balances::free_balance(AccountId::from(BOB)),
500003650399996349600,
);
});
}