Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

frame system: add event util functions for tests. #8734

Merged
4 commits merged into from
May 12, 2021
Merged

frame system: add event util functions for tests. #8734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
521a598
frame system: add event util functions for tests.
shaunxw May 5, 2021
42aefa4
URemove unused fn.
shaunxw May 5, 2021
94c068b
Merge branch 'master' into sw/event-tests-util
shaunxw May 5, 2021
69ce1e3
Apply review suggestions.
shaunxw May 5, 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
12 changes: 2 additions & 10 deletions frame/assets/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,19 +120,11 @@ fn add_approvals<T: Config<I>, I: 'static>(minter: T::AccountId, n: u32) {
}

fn assert_last_event<T: Config<I>, I: 'static>(generic_event: <T as Config<I>>::Event) {
let events = frame_system::Pallet::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let frame_system::EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

fn assert_event<T: Config<I>, I: 'static>(generic_event: <T as Config<I>>::Event) {
let system_event: <T as frame_system::Config>::Event = generic_event.into();
let events = frame_system::Pallet::<T>::events();
assert!(events.iter().any(|event_record| {
matches!(&event_record, frame_system::EventRecord { event, .. } if &system_event == event)
}));
frame_system::Pallet::<T>::assert_has_event(generic_event.into());
}

benchmarks_instance_pallet! {
Expand Down
11 changes: 2 additions & 9 deletions frame/assets/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ use sp_runtime::TokenError;
use frame_support::{assert_ok, assert_noop, traits::Currency};
use pallet_balances::Error as BalancesError;

fn last_event() -> mock::Event {
frame_system::Pallet::<Test>::events().pop().expect("Event expected").event
}

#[test]
fn basic_minting_should_work() {
new_test_ext().execute_with(|| {
Expand Down Expand Up @@ -401,10 +397,7 @@ fn transferring_less_than_one_unit_is_fine() {
assert_ok!(Assets::mint(Origin::signed(1), 0, 1, 100));
assert_eq!(Assets::balance(0, 1), 100);
assert_ok!(Assets::transfer(Origin::signed(1), 0, 2, 0));
assert_eq!(
last_event(),
mock::Event::pallet_assets(crate::Event::Transferred(0, 1, 2, 0)),
);
System::assert_last_event(mock::Event::pallet_assets(crate::Event::Transferred(0, 1, 2, 0)));
});
}

Expand Down Expand Up @@ -603,7 +596,7 @@ fn force_asset_status_should_work(){
assert_ok!(Assets::mint(Origin::signed(1), 0, 1, 50));
assert_ok!(Assets::mint(Origin::signed(1), 0, 2, 150));

//force asset status to change min_balance > balance
//force asset status to change min_balance > balance
assert_ok!(Assets::force_asset_status(Origin::root(), 0, 1, 1, 1, 1, 100, true, false));
assert_eq!(Assets::balance(0, 1), 50);

Expand Down
24 changes: 5 additions & 19 deletions frame/balances/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ macro_rules! decl_tests {
evt
}

fn last_event() -> Event {
system::Pallet::<Test>::events().pop().expect("Event expected").event
}

#[test]
fn basic_locking_should_work() {
<$ext_builder>::default().existential_deposit(1).monied(true).build().execute_with(|| {
Expand Down Expand Up @@ -467,9 +463,8 @@ macro_rules! decl_tests {
let _ = Balances::deposit_creating(&2, 1);
assert_ok!(Balances::reserve(&1, 110));
assert_ok!(Balances::repatriate_reserved(&1, &2, 41, Status::Free), 0);
assert_eq!(
last_event(),
Event::pallet_balances(crate::Event::ReserveRepatriated(1, 2, 41, Status::Free)),
System::assert_last_event(
Event::pallet_balances(crate::Event::ReserveRepatriated(1, 2, 41, Status::Free))
);
assert_eq!(Balances::reserved_balance(1), 69);
assert_eq!(Balances::free_balance(1), 0);
Expand Down Expand Up @@ -688,27 +683,18 @@ macro_rules! decl_tests {
System::set_block_number(2);
assert_ok!(Balances::reserve(&1, 10));

assert_eq!(
last_event(),
Event::pallet_balances(crate::Event::Reserved(1, 10)),
);
System::assert_last_event(Event::pallet_balances(crate::Event::Reserved(1, 10)));

System::set_block_number(3);
assert!(Balances::unreserve(&1, 5).is_zero());

assert_eq!(
last_event(),
Event::pallet_balances(crate::Event::Unreserved(1, 5)),
);
System::assert_last_event(Event::pallet_balances(crate::Event::Unreserved(1, 5)));

System::set_block_number(4);
assert_eq!(Balances::unreserve(&1, 6), 1);

// should only unreserve 5
assert_eq!(
last_event(),
Event::pallet_balances(crate::Event::Unreserved(1, 5)),
);
System::assert_last_event(Event::pallet_balances(crate::Event::Unreserved(1, 5)));
});
}

Expand Down
59 changes: 8 additions & 51 deletions frame/balances/src/tests_reentrancy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,6 @@ use frame_system::RawOrigin;
type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
type Block = frame_system::mocking::MockBlock<Test>;

fn last_event() -> Event {
system::Pallet::<Test>::events().pop().expect("Event expected").event
}

frame_support::construct_runtime!(
pub enum Test where
Block = Block,
Expand Down Expand Up @@ -189,23 +185,8 @@ fn transfer_dust_removal_tst1_should_work() {
// Number of events expected is 8
assert_eq!(System::events().len(), 11);

assert!(
System::events().iter().any(
|er|
er.event == Event::pallet_balances(
crate::Event::Transfer(2, 3, 450),
),
),
);

assert!(
System::events().iter().any(
|er|
er.event == Event::pallet_balances(
crate::Event::DustLost(2, 50)
),
),
);
System::assert_has_event(Event::pallet_balances(crate::Event::Transfer(2, 3, 450)));
System::assert_has_event(Event::pallet_balances(crate::Event::DustLost(2, 50)));
}
);
}
Expand Down Expand Up @@ -236,23 +217,8 @@ fn transfer_dust_removal_tst2_should_work() {
// Number of events expected is 8
assert_eq!(System::events().len(), 9);

assert!(
System::events().iter().any(
|er|
er.event == Event::pallet_balances(
crate::Event::Transfer(2, 1, 450),
),
),
);

assert!(
System::events().iter().any(
|er|
er.event == Event::pallet_balances(
crate::Event::DustLost(2, 50),
),
),
);
System::assert_has_event(Event::pallet_balances(crate::Event::Transfer(2, 1, 450)));
System::assert_has_event(Event::pallet_balances(crate::Event::DustLost(2, 50)));
}
);
}
Expand Down Expand Up @@ -292,20 +258,11 @@ fn repatriating_reserved_balance_dust_removal_should_work() {
// Number of events expected is 10
assert_eq!(System::events().len(), 10);

assert!(
System::events().iter().any(
|er|
er.event == Event::pallet_balances(
crate::Event::ReserveRepatriated(2, 1, 450, Status::Free),
),
),
);

assert_eq!(
last_event(),
Event::pallet_balances(crate::Event::DustLost(2, 50)),
);
System::assert_has_event(Event::pallet_balances(
crate::Event::ReserveRepatriated(2, 1, 450, Status::Free),
));

System::assert_last_event(Event::pallet_balances(crate::Event::DustLost(2, 50)));
}
);
}
8 changes: 2 additions & 6 deletions frame/bounties/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
use super::*;

use sp_runtime::traits::Bounded;
use frame_system::{EventRecord, RawOrigin};
use frame_system::RawOrigin;
use frame_benchmarking::{benchmarks, account, whitelisted_caller, impl_benchmark_test_suite};
use frame_support::traits::OnInitialize;

Expand Down Expand Up @@ -84,11 +84,7 @@ fn setup_pot_account<T: Config>() {
}

fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
let events = frame_system::Pallet::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

const MAX_BYTES: u32 = 16384;
Expand Down
7 changes: 1 addition & 6 deletions frame/collective/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
use super::*;

use frame_system::RawOrigin as SystemOrigin;
use frame_system::EventRecord;
use frame_benchmarking::{
benchmarks_instance,
account,
Expand All @@ -39,11 +38,7 @@ const SEED: u32 = 0;
const MAX_BYTES: u32 = 1_024;

fn assert_last_event<T: Config<I>, I: Instance>(generic_event: <T as Config<I>>::Event) {
let events = System::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

benchmarks_instance! {
Expand Down
8 changes: 2 additions & 6 deletions frame/democracy/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use frame_support::{
traits::{Currency, Get, EnsureOrigin, OnInitialize, UnfilteredDispatchable,
schedule::DispatchTime},
};
use frame_system::{RawOrigin, Pallet as System, self, EventRecord};
use frame_system::{RawOrigin, Pallet as System, self};
use sp_runtime::traits::{Bounded, One};

use crate::Pallet as Democracy;
Expand All @@ -36,11 +36,7 @@ const MAX_SECONDERS: u32 = 100;
const MAX_BYTES: u32 = 16_384;

fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
let events = System::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

fn funded_account<T: Config>(name: &'static str, index: u32) -> T::AccountId {
Expand Down
24 changes: 5 additions & 19 deletions frame/elections-phragmen/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2132,10 +2132,7 @@ mod tests {
System::set_block_number(5);
Elections::on_initialize(System::block_number());

assert_eq!(
System::events().iter().last().unwrap().event,
Event::elections_phragmen(super::Event::EmptyTerm),
)
System::assert_last_event(Event::elections_phragmen(super::Event::EmptyTerm));
})
}

Expand All @@ -2151,10 +2148,7 @@ mod tests {
System::set_block_number(5);
Elections::on_initialize(System::block_number());

assert_eq!(
System::events().iter().last().unwrap().event,
Event::elections_phragmen(super::Event::NewTerm(vec![(4, 40), (5, 50)])),
);
System::assert_last_event(Event::elections_phragmen(super::Event::NewTerm(vec![(4, 40), (5, 50)])));

assert_eq!(members_and_stake(), vec![(4, 40), (5, 50)]);
assert_eq!(runners_up_and_stake(), vec![]);
Expand All @@ -2165,10 +2159,7 @@ mod tests {
System::set_block_number(10);
Elections::on_initialize(System::block_number());

assert_eq!(
System::events().iter().last().unwrap().event,
Event::elections_phragmen(super::Event::NewTerm(vec![])),
);
System::assert_last_event(Event::elections_phragmen(super::Event::NewTerm(vec![])));

// outgoing have lost their bond.
assert_eq!(balances(&4), (37, 0));
Expand Down Expand Up @@ -2238,10 +2229,7 @@ mod tests {
assert_eq!(Elections::election_rounds(), 1);
assert!(members_ids().is_empty());

assert_eq!(
System::events().iter().last().unwrap().event,
Event::elections_phragmen(super::Event::NewTerm(vec![])),
)
System::assert_last_event(Event::elections_phragmen(super::Event::NewTerm(vec![])));
});
}

Expand Down Expand Up @@ -2599,9 +2587,7 @@ mod tests {
// 5 is an outgoing loser. will also get slashed.
assert_eq!(balances(&5), (45, 2));

assert!(System::events().iter().any(|event| {
event.event == Event::elections_phragmen(super::Event::NewTerm(vec![(4, 40), (5, 50)]))
}));
System::assert_has_event(Event::elections_phragmen(super::Event::NewTerm(vec![(4, 40), (5, 50)])));
})
}

Expand Down
8 changes: 2 additions & 6 deletions frame/identity/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

use super::*;

use frame_system::{EventRecord, RawOrigin};
use frame_system::RawOrigin;
use frame_benchmarking::{benchmarks, account, whitelisted_caller, impl_benchmark_test_suite};
use sp_runtime::traits::Bounded;
use frame_support::{ensure, traits::Get};
Expand All @@ -30,11 +30,7 @@ use crate::Pallet as Identity;
const SEED: u32 = 0;

fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
let events = frame_system::Pallet::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

// Adds `r` registrars to the Identity Pallet. These registrars will have set fees and fields.
Expand Down
10 changes: 1 addition & 9 deletions frame/multisig/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,6 @@ pub fn new_test_ext() -> sp_io::TestExternalities {
ext
}

fn last_event() -> Event {
system::Pallet::<Test>::events().pop().map(|e| e.event).expect("Event expected")
}

fn expect_event<E: Into<Event>>(e: E) {
assert_eq!(last_event(), e.into());
}

fn now() -> Timepoint<u64> {
Multisig::timepoint()
}
Expand Down Expand Up @@ -433,7 +425,7 @@ fn multisig_2_of_3_cannot_reissue_same_call() {
assert_ok!(Multisig::as_multi(Origin::signed(3), 2, vec![1, 2], Some(now()), data.clone(), false, call_weight));

let err = DispatchError::from(BalancesError::<Test, _>::InsufficientBalance).stripped();
expect_event(RawEvent::MultisigExecuted(3, now(), multi, hash, Err(err)));
System::assert_last_event(RawEvent::MultisigExecuted(3, now(), multi, hash, Err(err)).into());
});
}

Expand Down
8 changes: 2 additions & 6 deletions frame/proxy/src/benchmarking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,15 @@
#![cfg(feature = "runtime-benchmarks")]

use super::*;
use frame_system::{RawOrigin, EventRecord};
use frame_system::RawOrigin;
use frame_benchmarking::{benchmarks, account, whitelisted_caller, impl_benchmark_test_suite};
use sp_runtime::traits::Bounded;
use crate::Pallet as Proxy;

const SEED: u32 = 0;

fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
let events = frame_system::Pallet::<T>::events();
let system_event: <T as frame_system::Config>::Event = generic_event.into();
// compare to the last event record
let EventRecord { event, .. } = &events[events.len() - 1];
assert_eq!(event, &system_event);
frame_system::Pallet::<T>::assert_last_event(generic_event.into());
}

fn add_proxies<T: Config>(n: u32, maybe_who: Option<T::AccountId>) -> Result<(), &'static str> {
Expand Down
Loading