Feature/implement cario coverage & increase coverage

.github/workflows/check.yml

@@ -24,3 +24,19 @@ jobs:
             - uses: asdf-vm/actions/install@v3
             - run: scarb test
               working-directory: contracts
+
+    coverage:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v4
+        - uses: asdf-vm/actions/install@v3
+        - run: curl -L https://raw.githubusercontent.com/software-mansion/cairo-coverage/main/scripts/install.sh | sh
+
+        - name: Run tests and generate report
+          run: cd contracts/ && snforge test --coverage
+
+        - name: Upload coverage to Codecov
+          uses: codecov/codecov-action@v4
+          with:
+            file: ./coverage.lcov
+            token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -2,5 +2,10 @@
 contracts/target
 contracts/.snfoundry_cache/
 
+# snforge --coverage
+contracts/.snfoundry_versioned_programs
+contracts/snfoundry_trace
+contracts/coverage
+
 # `mac`
 **/.DS_Store

README.md

@@ -1,6 +1,7 @@
 # Kudos
 
 [![Check Workflow Status](https://github.com/keep-starknet-strange/kudos/actions/workflows/check.yml/badge.svg)](https://github.com/keep-starknet-strange/kudos/actions/workflows/check.yml)
+[![codecov](https://codecov.io/gh/keep-starknet-strange/kudos/blob/branch/main/graph/badge.svg)](https://codecov.io/gh/keep-starknet-strange/kudos)
 
 An internal application to delegate `kudos` on Starknet by using Google OAuth.
 
@@ -32,3 +33,11 @@ Starknet contracts to handle:
 ```bash
 cd contracts && scarb test
 ```
+***Code Coverage***
+
+Check out the [installation](https://github.com/software-mansion/cairo-coverage#installation) section of `cairo-coverage` for the detailed installation instructions.
+
+```bash
+cd contracts && snforge test --coverage
+```
+

contracts/Scarb.toml

@@ -16,4 +16,9 @@ starknet = "2.8.2"
 assert_macros = "2.8.2"
 snforge_std = "0.30.0"
 
+[profile.dev.cairo]
+unstable-add-statements-functions-debug-info = true
+unstable-add-statements-code-locations-debug-info = true
+inlining-strategy= "avoid"
+
 [[target.starknet-contract]]

contracts/src/credential_registry/tests/test_credential_registry.cairo

@@ -40,6 +40,17 @@ fn test_register_credential() {
     assert!(registry.get_credential_address(CREDENTIAL_HASH) == CALLER());
 }
 
+#[test]
+fn test_register_credential_address_zero() {
+    let mut registry: ComponentState = Default::default();
+    registry._register_credential(CREDENTIAL_HASH, ZERO_ADDRESS());
+    registry._register_user(ZERO_ADDRESS(), CREDENTIAL_HASH);
+
+    assert!(registry.get_credential(ZERO_ADDRESS()) == CREDENTIAL_HASH);
+    assert!(registry.is_registered(ZERO_ADDRESS()) == false);
+    assert!(registry.get_credential_address(CREDENTIAL_HASH) == ZERO_ADDRESS());
+}
+
 #[test]
 #[should_panic(expected: 'User already registered cred')]
 fn test_double_register_credential() {

contracts/src/kudos.cairo

@@ -4,7 +4,6 @@ pub mod Kudos {
     use kudos::credential_registry::{ICredentialRegistry, CredentialRegistryComponent};
     use kudos::oz16::IERC20ReadOnly;
     use kudos::oz16::erc20::{ERC20Component, ERC20HooksEmptyImpl, ERC20Component::InternalTrait};
-    use kudos::oz16::ownable::OwnableComponent;
     use kudos::utils::constants::REGISTRATION_AMOUNT;
     use starknet::storage::{
         StoragePointerReadAccess, StoragePointerWriteAccess, StoragePathEntry, Map
@@ -17,7 +16,6 @@ pub mod Kudos {
         event: CredentialRegistryEvent
     );
     component!(path: ERC20Component, storage: erc20, event: ERC20Event);
-    component!(path: OwnableComponent, storage: ownable, event: OwnableEvent);
 
     #[abi(embed_v0)]
     impl CredentialRegistryImpl =
@@ -26,18 +24,12 @@ pub mod Kudos {
     impl ERC20Impl = ERC20Component::ERC20Impl<ContractState>;
     impl ERC20InternalImpl = ERC20Component::InternalImpl<ContractState>;
 
-    #[abi(embed_v0)]
-    impl OwnableImpl = OwnableComponent::OwnableImpl<ContractState>;
-    impl OwnableInternalImpl = OwnableComponent::InternalImpl<ContractState>;
-
     #[storage]
     struct Storage {
         #[substorage(v0)]
         credential_registry: CredentialRegistryComponent::Storage,
         #[substorage(v0)]
         erc20: ERC20Component::Storage,
-        #[substorage(v0)]
-        ownable: OwnableComponent::Storage,
         total_given: Map<ContractAddress, u256>,
         total_received: Map<ContractAddress, u256>
     }
@@ -50,8 +42,6 @@ pub mod Kudos {
         #[flat]
         ERC20Event: ERC20Component::Event,
         KudosGiven: KudosGiven,
-        #[flat]
-        OwnableEvent: OwnableComponent::Event,
     }
 
     #[derive(Drop, starknet::Event)]
@@ -70,11 +60,8 @@ pub mod Kudos {
     }
 
     #[constructor]
-    fn constructor(
-        ref self: ContractState, name: ByteArray, symbol: ByteArray, owner: ContractAddress
-    ) {
+    fn constructor(ref self: ContractState, name: ByteArray, symbol: ByteArray) {
         self.erc20.initializer(name, symbol);
-        self.ownable.initializer(owner);
     }
 
     #[abi(embed_v0)]
@@ -135,10 +122,5 @@ pub mod Kudos {
         fn balance_of(self: @ContractState, account: ContractAddress) -> u256 {
             self.erc20.balance_of(account)
         }
-        fn allowance(
-            self: @ContractState, owner: ContractAddress, spender: ContractAddress
-        ) -> u256 {
-            self.erc20.allowance(owner, spender)
-        }
     }
 }

contracts/src/lib.cairo

@@ -23,7 +23,6 @@ pub mod oz16 {
     pub mod erc20;
 
     mod interfaces;
-    pub mod ownable;
     pub use interfaces::{
         IERC20, IERC20Dispatcher, IERC20DispatcherTrait, IOwnable, IOwnableDispatcher,
         IOwnableDispatcherTrait, IERC20ReadOnly

contracts/src/oz16/erc20.cairo

@@ -122,16 +122,6 @@ pub mod ERC20Component {
             self.ERC20_balances.read(account)
         }
 
-        /// Returns the remaining number of tokens that `spender` is
-        /// allowed to spend on behalf of `owner` through `transfer_from`.
-        /// This is zero by default.
-        /// This value changes when `approve` or `transfer_from` are called.
-        fn allowance(
-            self: @ComponentState<TContractState>, owner: ContractAddress, spender: ContractAddress
-        ) -> u256 {
-            self.ERC20_allowances.read((owner, spender))
-        }
-
         /// Moves `amount` tokens from the caller's token balance to `to`.
         ///
         /// Requirements:

contracts/src/oz16/interfaces.cairo

@@ -10,7 +10,6 @@ pub trait IERC20<TState> {
     fn decimals(self: @TState) -> u8;
     fn total_supply(self: @TState) -> u256;
     fn balance_of(self: @TState, account: ContractAddress) -> u256;
-    fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256;
     fn transfer(ref self: TState, recipient: ContractAddress, amount: u256) -> bool;
     fn transfer_from(
         ref self: TState, sender: ContractAddress, recipient: ContractAddress, amount: u256
@@ -26,7 +25,6 @@ pub trait IERC20ReadOnly<TState> {
     fn decimals(self: @TState) -> u8;
     fn total_supply(self: @TState) -> u256;
     fn balance_of(self: @TState, account: ContractAddress) -> u256;
-    fn allowance(self: @TState, owner: ContractAddress, spender: ContractAddress) -> u256;
 }
 
 #[starknet::interface]

contracts/src/utils/constants.cairo

@@ -12,10 +12,6 @@ pub fn DUMMY() -> ContractAddress {
     contract_address_const::<'DUMMY'>()
 }
 
-pub fn OWNER() -> ContractAddress {
-    contract_address_const::<'OWNER'>()
-}
-
 pub fn ZERO_ADDRESS() -> ContractAddress {
     contract_address_const::<0>()
 }

contracts/tests/utils.cairo

@@ -1,5 +1,5 @@
 use kudos::utils::constants::{
-    NAME, SYMBOL, OWNER, CALLER, RECEIVER, CREDENTIAL_HASH, CREDENTIAL_HASH_2, ONE
+    NAME, SYMBOL, CALLER, RECEIVER, CREDENTIAL_HASH, CREDENTIAL_HASH_2, ONE
 };
 use kudos::{IKudosDispatcher, IKudosDispatcherTrait};
 use snforge_std::{declare, ContractClassTrait, DeclareResultTrait, start_cheat_caller_address};
@@ -25,7 +25,6 @@ pub fn setup() -> ContractAddress {
     let mut calldata: Array<felt252> = array![];
     calldata.append_serde(NAME());
     calldata.append_serde(SYMBOL());
-    calldata.append_serde(OWNER());
 
     declare_deploy("Kudos", calldata)
 }