Add generate_spy_event_helpers macro

Scarb.lock

@@ -30,6 +30,7 @@ dependencies = [
  "openzeppelin_introspection",
  "openzeppelin_test_common",
  "openzeppelin_testing",
+ "openzeppelin_utils",
  "snforge_std",
 ]
 
@@ -125,6 +126,7 @@ dependencies = [
  "openzeppelin_interfaces",
  "openzeppelin_test_common",
  "openzeppelin_testing",
+ "openzeppelin_utils",
  "snforge_std",
 ]
 

packages/access/Scarb.toml

@@ -32,6 +32,7 @@ assert_macros.workspace = true
 snforge_std.workspace = true
 openzeppelin_testing = { path = "../testing" }
 openzeppelin_test_common = { path = "../test_common" }
+openzeppelin_utils = { path = "../utils" }
 
 [lib]
 

packages/access/src/tests/test_accesscontrol.cairo

@@ -6,12 +6,10 @@ use openzeppelin_test_common::mocks::access::DualCaseAccessControlMock;
 use openzeppelin_testing::constants::{
     ADMIN, AUTHORIZED, OTHER, OTHER_ADMIN, OTHER_ROLE, ROLE, TIMESTAMP, ZERO,
 };
-use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, spy_events};
+use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, ExpectedEvent, spy_events};
 use snforge_std::{start_cheat_block_timestamp_global, start_cheat_caller_address, test_address};
 use starknet::ContractAddress;
-use crate::accesscontrol::AccessControlComponent::{
-    InternalImpl, RoleAdminChanged, RoleGranted, RoleGrantedWithDelay, RoleRevoked,
-};
+use crate::accesscontrol::AccessControlComponent::InternalImpl;
 use crate::accesscontrol::{AccessControlComponent, DEFAULT_ADMIN_ROLE};
 
 //
@@ -700,9 +698,12 @@ pub impl AccessControlSpyHelpersImpl of AccessControlSpyHelpers {
         account: ContractAddress,
         sender: ContractAddress,
     ) {
-        let expected = AccessControlComponent::Event::RoleRevoked(
-            RoleRevoked { role, account, sender },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("RoleRevoked"))
+            .data(role)
+            .data(account)
+            .data(sender);
+
         self.assert_emitted_single(contract, expected);
     }
 
@@ -713,9 +714,12 @@ pub impl AccessControlSpyHelpersImpl of AccessControlSpyHelpers {
         account: ContractAddress,
         sender: ContractAddress,
     ) {
-        let expected = AccessControlComponent::Event::RoleRevoked(
-            RoleRevoked { role, account, sender },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("RoleRevoked"))
+            .data(role)
+            .data(account)
+            .data(sender);
+
         self.assert_only_event(contract, expected);
     }
 
@@ -726,9 +730,12 @@ pub impl AccessControlSpyHelpersImpl of AccessControlSpyHelpers {
         account: ContractAddress,
         sender: ContractAddress,
     ) {
-        let expected = AccessControlComponent::Event::RoleGranted(
-            RoleGranted { role, account, sender },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("RoleGranted"))
+            .data(role)
+            .data(account)
+            .data(sender);
+
         self.assert_only_event(contract, expected);
     }
 
@@ -740,9 +747,13 @@ pub impl AccessControlSpyHelpersImpl of AccessControlSpyHelpers {
         sender: ContractAddress,
         delay: u64,
     ) {
-        let expected = AccessControlComponent::Event::RoleGrantedWithDelay(
-            RoleGrantedWithDelay { role, account, sender, delay },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("RoleGrantedWithDelay"))
+            .data(role)
+            .data(account)
+            .data(sender)
+            .data(delay);
+
         self.assert_only_event(contract, expected);
     }
 
@@ -753,9 +764,12 @@ pub impl AccessControlSpyHelpersImpl of AccessControlSpyHelpers {
         previous_admin_role: felt252,
         new_admin_role: felt252,
     ) {
-        let expected = AccessControlComponent::Event::RoleAdminChanged(
-            RoleAdminChanged { role, previous_admin_role, new_admin_role },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("RoleAdminChanged"))
+            .data(role)
+            .data(previous_admin_role)
+            .data(new_admin_role);
+
         self.assert_only_event(from_address, expected);
     }
 }

packages/access/src/tests/test_accesscontrol_default_admin_rules.cairo

@@ -10,13 +10,10 @@ use openzeppelin_test_common::mocks::access::DualCaseAccessControlDefaultAdminRu
 use openzeppelin_testing::constants::{
     ADMIN, AUTHORIZED, OTHER, OTHER_ADMIN, OTHER_ROLE, ROLE, TIMESTAMP, ZERO,
 };
-use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, spy_events};
+use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, ExpectedEvent, spy_events};
 use snforge_std::{start_cheat_block_timestamp_global, start_cheat_caller_address, test_address};
 use starknet::ContractAddress;
-use crate::accesscontrol::extensions::AccessControlDefaultAdminRulesComponent::{
-    DefaultAdminDelayChangeCanceled, DefaultAdminDelayChangeScheduled, DefaultAdminTransferCanceled,
-    DefaultAdminTransferScheduled, InternalTrait,
-};
+use crate::accesscontrol::extensions::AccessControlDefaultAdminRulesComponent::InternalTrait;
 use crate::accesscontrol::extensions::{
     AccessControlDefaultAdminRulesComponent, DEFAULT_ADMIN_ROLE, DefaultConfig,
 };
@@ -1169,39 +1166,38 @@ impl AccessControlDefaultAdminRulesSpyHelpersImpl of AccessControlDefaultAdminRu
         new_admin: ContractAddress,
         accept_schedule: u64,
     ) {
-        let expected =
-            AccessControlDefaultAdminRulesComponent::Event::DefaultAdminTransferScheduled(
-            DefaultAdminTransferScheduled { new_admin, accept_schedule },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("DefaultAdminTransferScheduled"))
+            .key(new_admin)
+            .data(accept_schedule);
+
         self.assert_only_event(contract, expected);
     }
 
     fn assert_only_event_default_admin_transfer_canceled(
         ref self: EventSpy, contract: ContractAddress,
     ) {
-        let expected = AccessControlDefaultAdminRulesComponent::Event::DefaultAdminTransferCanceled(
-            DefaultAdminTransferCanceled {},
-        );
+        let expected = ExpectedEvent::new().key(selector!("DefaultAdminTransferCanceled"));
+
         self.assert_only_event(contract, expected);
     }
 
     fn assert_only_event_default_admin_delay_change_scheduled(
         ref self: EventSpy, contract: ContractAddress, new_delay: u64, effect_schedule: u64,
     ) {
-        let expected =
-            AccessControlDefaultAdminRulesComponent::Event::DefaultAdminDelayChangeScheduled(
-            DefaultAdminDelayChangeScheduled { new_delay, effect_schedule },
-        );
+        let expected = ExpectedEvent::new()
+            .key(selector!("DefaultAdminDelayChangeScheduled"))
+            .data(new_delay)
+            .data(effect_schedule);
+
         self.assert_only_event(contract, expected);
     }
 
     fn assert_only_event_default_admin_delay_change_canceled(
         ref self: EventSpy, contract: ContractAddress,
     ) {
-        let expected =
-            AccessControlDefaultAdminRulesComponent::Event::DefaultAdminDelayChangeCanceled(
-            DefaultAdminDelayChangeCanceled {},
-        );
+        let expected = ExpectedEvent::new().key(selector!("DefaultAdminDelayChangeCanceled"));
+
         self.assert_only_event(contract, expected);
     }
 }

packages/access/src/tests/test_ownable_twostep.cairo

@@ -4,11 +4,12 @@ use openzeppelin_test_common::mocks::access::DualCaseTwoStepOwnableMock;
 use openzeppelin_test_common::ownable::OwnableSpyHelpers;
 use openzeppelin_testing::constants::{NEW_OWNER, OTHER, OWNER, ZERO};
 use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, spy_events};
-use snforge_std::{start_cheat_caller_address, test_address};
+use openzeppelin_utils::serde::SerializedAppend;
+use snforge_std::{Event, start_cheat_caller_address, test_address};
 use starknet::ContractAddress;
 use starknet::storage::{StoragePointerReadAccess, StoragePointerWriteAccess};
 use crate::ownable::OwnableComponent;
-use crate::ownable::OwnableComponent::{InternalTrait, OwnershipTransferStarted};
+use crate::ownable::OwnableComponent::InternalTrait;
 
 //
 // Setup
@@ -291,9 +292,12 @@ impl TwoStepSpyHelpersImpl of TwoStepSpyHelpers {
         previous_owner: ContractAddress,
         new_owner: ContractAddress,
     ) {
-        let expected = OwnableComponent::Event::OwnershipTransferStarted(
-            OwnershipTransferStarted { previous_owner, new_owner },
-        );
+        let mut keys = array![];
+        keys.append_serde(selector!("OwnershipTransferStarted"));
+        keys.append_serde(previous_owner);
+        keys.append_serde(new_owner);
+
+        let expected = Event { keys, data: array![] };
         self.assert_emitted_single(from_address, expected);
     }
 }

packages/finance/src/tests/test_vesting_linear.cairo

@@ -2,7 +2,7 @@ use openzeppelin_interfaces::erc20::{IERC20Dispatcher, IERC20DispatcherTrait};
 use openzeppelin_interfaces::ownable::{IOwnableDispatcher, IOwnableDispatcherTrait};
 use openzeppelin_interfaces::vesting::IVestingDispatcherTrait;
 use openzeppelin_test_common::mocks::vesting::LinearVestingMock;
-use openzeppelin_test_common::vesting::VestingSpyHelpers;
+use openzeppelin_test_common::vesting::VestingSpyHelpersTrait;
 use openzeppelin_testing::constants::{OTHER, OWNER};
 use openzeppelin_testing::{EventSpyExt, spy_events};
 use snforge_std::{start_cheat_block_timestamp_global, start_cheat_caller_address};

packages/finance/src/tests/test_vesting_steps.cairo

@@ -2,7 +2,7 @@ use openzeppelin_interfaces::erc20::{IERC20Dispatcher, IERC20DispatcherTrait};
 use openzeppelin_interfaces::ownable::{IOwnableDispatcher, IOwnableDispatcherTrait};
 use openzeppelin_interfaces::vesting::IVestingDispatcherTrait;
 use openzeppelin_test_common::mocks::vesting::StepsVestingMock;
-use openzeppelin_test_common::vesting::VestingSpyHelpers;
+use openzeppelin_test_common::vesting::VestingSpyHelpersTrait;
 use openzeppelin_testing::constants::{OTHER, OWNER};
 use openzeppelin_testing::spy_events;
 use snforge_std::{start_cheat_block_timestamp_global, start_cheat_caller_address};

packages/governance/src/governor/proposal_core.cairo

@@ -84,7 +84,6 @@ mod tests {
     use core::num::traits::Bounded;
     use openzeppelin_testing::constants::ALICE;
     use openzeppelin_testing::{FuzzableBool, FuzzableContractAddress};
-    use starknet::ContractAddress;
     use super::{ProposalCore, ProposalCoreStorePacking as StorePacking};
 
     #[test]

packages/governance/src/tests/governor/block_number/test_governor_settings.cairo

@@ -1,12 +1,12 @@
 use openzeppelin_test_common::mocks::governor::GovernorTimelockedMock::SNIP12MetadataImpl;
 use openzeppelin_testing::constants::OTHER;
 use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, spy_events};
-use snforge_std::{start_cheat_caller_address, test_address};
+use openzeppelin_utils::serde::SerializedAppend;
+use snforge_std::{Event, start_cheat_caller_address, test_address};
 use starknet::ContractAddress;
 use starknet::storage::StoragePointerWriteAccess;
 use crate::governor::DefaultConfig;
 use crate::governor::GovernorComponent::InternalImpl;
-use crate::governor::extensions::GovernorSettingsComponent;
 use crate::governor::extensions::GovernorSettingsComponent::{
     GovernorSettings, GovernorSettingsAdminImpl, InternalImpl as GovernorSettingsInternalImpl,
 };
@@ -15,6 +15,7 @@ use crate::tests::governor::block_number::common::{
     set_executor,
 };
 
+
 //
 // Extensions
 //
@@ -395,9 +396,14 @@ pub(crate) impl GovernorSettingsSpyHelpersImpl of GovernorSettingsSpyHelpers {
     fn assert_event_voting_delay_updated(
         ref self: EventSpy, contract: ContractAddress, old_voting_delay: u64, new_voting_delay: u64,
     ) {
-        let expected = GovernorSettingsComponent::Event::VotingDelayUpdated(
-            GovernorSettingsComponent::VotingDelayUpdated { old_voting_delay, new_voting_delay },
-        );
+        let mut keys = array![];
+        keys.append_serde(selector!("VotingDelayUpdated"));
+
+        let mut data = array![];
+        data.append_serde(old_voting_delay);
+        data.append_serde(new_voting_delay);
+
+        let expected = Event { keys, data };
         self.assert_emitted_single(contract, expected);
     }
 
@@ -414,9 +420,14 @@ pub(crate) impl GovernorSettingsSpyHelpersImpl of GovernorSettingsSpyHelpers {
         old_voting_period: u64,
         new_voting_period: u64,
     ) {
-        let expected = GovernorSettingsComponent::Event::VotingPeriodUpdated(
-            GovernorSettingsComponent::VotingPeriodUpdated { old_voting_period, new_voting_period },
-        );
+        let mut keys = array![];
+        keys.append_serde(selector!("VotingPeriodUpdated"));
+
+        let mut data = array![];
+        data.append_serde(old_voting_period);
+        data.append_serde(new_voting_period);
+
+        let expected = Event { keys, data };
         self.assert_emitted_single(contract, expected);
     }
 
@@ -436,11 +447,14 @@ pub(crate) impl GovernorSettingsSpyHelpersImpl of GovernorSettingsSpyHelpers {
         old_proposal_threshold: u256,
         new_proposal_threshold: u256,
     ) {
-        let expected = GovernorSettingsComponent::Event::ProposalThresholdUpdated(
-            GovernorSettingsComponent::ProposalThresholdUpdated {
-                old_proposal_threshold, new_proposal_threshold,
-            },
-        );
+        let mut keys = array![];
+        keys.append_serde(selector!("ProposalThresholdUpdated"));
+
+        let mut data = array![];
+        data.append_serde(old_proposal_threshold);
+        data.append_serde(new_proposal_threshold);
+
+        let expected = Event { keys, data };
         self.assert_emitted_single(contract, expected);
     }
 

packages/governance/src/tests/governor/block_number/test_governor_votes_quorum_fraction.cairo

@@ -2,16 +2,17 @@ use openzeppelin_test_common::mocks::governor::GovernorQuorumFractionMock;
 use openzeppelin_test_common::mocks::governor::GovernorQuorumFractionMock::SNIP12MetadataImpl;
 use openzeppelin_testing::constants::{OTHER, VOTES_TOKEN, ZERO};
 use openzeppelin_testing::{EventSpyExt, EventSpyQueue as EventSpy, spy_events};
-use snforge_std::{start_cheat_block_number_global, start_mock_call, test_address};
+use openzeppelin_utils::serde::SerializedAppend;
+use snforge_std::{Event, start_cheat_block_number_global, start_mock_call, test_address};
 use starknet::ContractAddress;
 use crate::governor::GovernorComponent::InternalImpl;
-use crate::governor::extensions::GovernorVotesQuorumFractionComponent;
 use crate::governor::extensions::GovernorVotesQuorumFractionComponent::{
     GovernorQuorum, GovernorVotes, InternalTrait, QuorumFractionImpl,
 };
 use crate::governor::{DefaultConfig, GovernorComponent};
 use crate::tests::governor::block_number::common::deploy_votes_token;
 
+
 pub type ComponentState =
     GovernorComponent::ComponentState<GovernorQuorumFractionMock::ContractState>;
 
@@ -240,11 +241,14 @@ pub(crate) impl GovernorSettingsSpyHelpersImpl of GovernorSettingsSpyHelpers {
         old_quorum_numerator: u256,
         new_quorum_numerator: u256,
     ) {
-        let expected = GovernorVotesQuorumFractionComponent::Event::QuorumNumeratorUpdated(
-            GovernorVotesQuorumFractionComponent::QuorumNumeratorUpdated {
-                old_quorum_numerator, new_quorum_numerator,
-            },
-        );
+        let mut keys = array![];
+        keys.append_serde(selector!("QuorumNumeratorUpdated"));
+
+        let mut data = array![];
+        data.append_serde(old_quorum_numerator);
+        data.append_serde(new_quorum_numerator);
+
+        let expected = Event { keys, data };
         self.assert_emitted_single(contract, expected);
     }