feat: add warnings

OpenZeppelin · Jan 8, 2025 · 44c6491 · 44c6491
1 parent 6814d0b
commit 44c6491
Show file tree

Hide file tree

Showing 6 changed files with 393 additions and 4 deletions.
diff --git a/...ests/snapshots/openzeppelin_macros__tests__test_with_components__with_access_control.snap b/...ests/snapshots/openzeppelin_macros__tests__test_with_components__with_access_control.snap
@@ -0,0 +1,47 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod Contract {
+    use openzeppelin_access::accesscontrol::DEFAULT_ADMIN_ROLE;
+    use starknet::ContractAddress;
+
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        accesscontrol: AccessControlComponent::Storage,
+    }
+
+    #[constructor]
+    fn constructor(ref self: ContractState, default_admin: ContractAddress) {
+        self.accesscontrol.initializer();
+
+        self.accesscontrol._grant_role(DEFAULT_ADMIN_ROLE, default_admin);
+    }
+
+    use openzeppelin_access::accesscontrol::AccessControlComponent;
+
+    component!(path: AccessControlComponent, storage: accesscontrol, event: AccessControlEvent);
+
+    impl AccessControlInternalImpl = AccessControlComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        AccessControlEvent: AccessControlComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+None
+
+AuxData:
+
+None
diff --git a/...openzeppelin_macros__tests__test_with_components__with_access_control_no_initializer.snap b/...openzeppelin_macros__tests__test_with_components__with_access_control_no_initializer.snap
@@ -0,0 +1,49 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod Contract {
+    use openzeppelin_access::accesscontrol::DEFAULT_ADMIN_ROLE;
+    use starknet::ContractAddress;
+
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        accesscontrol: AccessControlComponent::Storage,
+    }
+
+    #[constructor]
+    fn constructor(ref self: ContractState) {}
+
+    use openzeppelin_access::accesscontrol::AccessControlComponent;
+
+    component!(path: AccessControlComponent, storage: accesscontrol, event: AccessControlEvent);
+
+    impl AccessControlInternalImpl = AccessControlComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        AccessControlEvent: AccessControlComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+====
+Warning: It looks like the initilizers for the following components are missing:
+
+AccessControl
+
+This may lead to unexpected behavior. We recommend adding the corresponding initializer calls to the constructor.
+====
+
+AuxData:
+
+None
diff --git a/...s/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_vesting.snap b/...s/src/tests/snapshots/openzeppelin_macros__tests__test_with_components__with_vesting.snap
@@ -0,0 +1,59 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod VestingWallet {
+    use openzeppelin_finance::vesting::LinearVestingSchedule;
+    use starknet::ContractAddress;
+
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        vesting: VestingComponent::Storage,
+        #[substorage(v0)]
+        ownable: OwnableComponent::Storage,
+    }
+
+    #[constructor]
+    fn constructor(
+        ref self: ContractState,
+        beneficiary: ContractAddress,
+        start: u64,
+        duration: u64,
+        cliff_duration: u64,
+    ) {
+        self.ownable.initializer(beneficiary);
+        self.vesting.initializer(start, duration, cliff_duration);
+    }
+
+    use openzeppelin_finance::vesting::VestingComponent;
+    use openzeppelin_access::ownable::OwnableComponent;
+
+    component!(path: VestingComponent, storage: vesting, event: VestingEvent);
+    component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);
+
+    impl VestingInternalImpl = VestingComponent::InternalImpl<ContractState>;
+    impl OwnableInternalImpl = OwnableComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        VestingEvent: VestingComponent::Event,
+        #[flat]
+        OwnableEvent: OwnableComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+None
+
+AuxData:
+
+None
diff --git a/...pshots/openzeppelin_macros__tests__test_with_components__with_vesting_no_initializer.snap b/...pshots/openzeppelin_macros__tests__test_with_components__with_vesting_no_initializer.snap
@@ -0,0 +1,64 @@
+---
+source: src/tests/test_with_components.rs
+expression: result
+snapshot_kind: text
+---
+TokenStream:
+
+#[starknet::contract]
+pub mod VestingWallet {
+    use openzeppelin_finance::vesting::LinearVestingSchedule;
+    use starknet::ContractAddress;
+
+    #[storage]
+    pub struct Storage {
+        #[substorage(v0)]
+        vesting: VestingComponent::Storage,
+        #[substorage(v0)]
+        ownable: OwnableComponent::Storage,
+    }
+
+    #[constructor]
+    fn constructor(
+        ref self: ContractState,
+        beneficiary: ContractAddress,
+        start: u64,
+        duration: u64,
+        cliff_duration: u64,
+    ) {
+        self.ownable.initializer(beneficiary);
+    }
+
+    use openzeppelin_finance::vesting::VestingComponent;
+    use openzeppelin_access::ownable::OwnableComponent;
+
+    component!(path: VestingComponent, storage: vesting, event: VestingEvent);
+    component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);
+
+    impl VestingInternalImpl = VestingComponent::InternalImpl<ContractState>;
+    impl OwnableInternalImpl = OwnableComponent::InternalImpl<ContractState>;
+
+    #[event]
+    #[derive(Drop, starknet::Event)]
+    enum Event {
+        #[flat]
+        VestingEvent: VestingComponent::Event,
+        #[flat]
+        OwnableEvent: OwnableComponent::Event,
+    }
+}
+
+
+Diagnostics:
+
+====
+Warning: It looks like the initilizers for the following components are missing:
+
+Vesting
+
+This may lead to unexpected behavior. We recommend adding the corresponding initializer calls to the constructor.
+====
+
+AuxData:
+
+None
diff --git a/packages/macros/src/tests/test_with_components.rs b/packages/macros/src/tests/test_with_components.rs
@@ -162,6 +162,116 @@ fn test_with_two_components_no_constructor() {
     assert_snapshot!(result);
 }
 
+#[test]
+fn test_with_access_control() {
+    let attribute = "(AccessControl)";
+    let item = indoc!(
+        "
+        #[starknet::contract]
+        pub mod Contract {
+            use openzeppelin_access::accesscontrol::DEFAULT_ADMIN_ROLE;
+            use starknet::ContractAddress;
+
+            #[storage]
+            pub struct Storage {}
+
+            #[constructor]
+            fn constructor(ref self: ContractState, default_admin: ContractAddress) {
+                self.accesscontrol.initializer();
+
+                self.accesscontrol._grant_role(DEFAULT_ADMIN_ROLE, default_admin);
+            }
+        }
+        "
+    );
+    let result = get_string_result(attribute, item);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn test_with_access_control_no_initializer() {
+    let attribute = "(AccessControl)";
+    let item = indoc!(
+        "
+        #[starknet::contract]
+        pub mod Contract {
+            use openzeppelin_access::accesscontrol::DEFAULT_ADMIN_ROLE;
+            use starknet::ContractAddress;
+
+            #[storage]
+            pub struct Storage {}
+
+            #[constructor]
+            fn constructor(ref self: ContractState) {
+            }
+        }
+        "
+    );
+    let result = get_string_result(attribute, item);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn test_with_vesting() {
+    let attribute = "(Vesting, Ownable)";
+    let item = indoc!(
+        "
+        #[starknet::contract]
+        pub mod VestingWallet {
+            use openzeppelin_finance::vesting::LinearVestingSchedule;
+            use starknet::ContractAddress;
+
+            #[storage]
+            pub struct Storage {}
+
+            #[constructor]
+            fn constructor(
+                ref self: ContractState,
+                beneficiary: ContractAddress,
+                start: u64,
+                duration: u64,
+                cliff_duration: u64,
+            ) {
+                self.ownable.initializer(beneficiary);
+                self.vesting.initializer(start, duration, cliff_duration);
+            }
+        }
+        "
+    );
+    let result = get_string_result(attribute, item);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn test_with_vesting_no_initializer() {
+    let attribute = "(Vesting, Ownable)";
+    let item = indoc!(
+        "
+        #[starknet::contract]
+        pub mod VestingWallet {
+            use openzeppelin_finance::vesting::LinearVestingSchedule;
+            use starknet::ContractAddress;
+
+            #[storage]
+            pub struct Storage {}
+
+            #[constructor]
+            fn constructor(
+                ref self: ContractState,
+                beneficiary: ContractAddress,
+                start: u64,
+                duration: u64,
+                cliff_duration: u64,
+            ) {
+                self.ownable.initializer(beneficiary);
+            }
+        }
+        "
+    );
+    let result = get_string_result(attribute, item);
+    assert_snapshot!(result);
+}
+
 #[test]
 fn test_with_no_contract_attribute() {
     let attribute = "(Ownable)";