Remove explicitly imported function from implicit imports. (#75)

* Remove explicitly imported function from implicit imports.

* Fix test folder name.

* Remove more false positives on implicit-import

amarna/Result.py

@@ -58,7 +58,7 @@ def __eq__(self, other: object) -> bool:
 class ResultMultiplePositions:
     def __init__(
         self,
-        filenames: str,
+        filenames: List[str],
         rule_name: str,
         text: str,
         position_list: List[PositionType],
@@ -143,7 +143,7 @@ def create_result_token(filename: str, rule_name: str, text: str, token: Token)
 
 
 def result_multiple_positions(
-    filenames: str,
+    filenames: List[str],
     rule_name: str,
     text: str,
     position_list: List[PositionType],

amarna/amarna.py

@@ -59,7 +59,7 @@ def get_all_rule_names() -> List[str]:
         )
 
     @staticmethod
-    def print_rule_names_and_descriptions() -> List[str]:
+    def print_rule_names_and_descriptions() -> None:
         ruleset = Amarna.load_classes_in_module(local_rules_module) + Amarna.load_classes_in_module(
             post_process_rules_module
         )

amarna/rules/post_process_rules/ImplicitImportRule.py

@@ -29,24 +29,26 @@ def run_rule(self, gathered_data: Dict) -> List[ResultMultiplePositions]:
 
         for func in declared_functions:
             if any(decorator in self.DECORATORS for decorator in func.decorators):
-                files_marked = []
 
+                explicitly_imp: List[ImportType] = []
+                explicitly_import_names: List[str] = []
                 for imp in import_stmts:
-                    # check if there is any import from the location
-                    # of the external function
+                    # gather all explicitly imported functions
+                    # from the location of the external function
                     if func.file_location.endswith(imp.where_imported):
-                        # do not flag the same file repeatedly
-                        if imp.file_location in files_marked:
-                            continue
-
-                        files_marked.append(imp.file_location)
-
-                        result = result_multiple_positions(
-                            [func.file_location, imp.file_location],
-                            self.RULE_NAME,
-                            self.RULE_TEXT,
-                            [func.position, imp.location],
-                        )
-                        results.append(result)
+                        explicitly_import_names.append(imp.import_name)
+                        explicitly_imp.append(imp)
+
+                # check if there was any import and that it was not
+                # explicitly imported
+                if explicitly_imp and func.name not in explicitly_import_names:
+                    imp = explicitly_imp[0]
+                    result = result_multiple_positions(
+                        [func.file_location, imp.file_location],
+                        self.RULE_NAME,
+                        self.RULE_TEXT,
+                        [func.position, imp.location],
+                    )
+                    results.append(result)
 
         return results

tests/expected/implicit_import_three_test.expected

@@ -0,0 +1,4 @@
+[must-check-caller-address] in utils.cairo:10:10
+[must-check-caller-address] in utils.cairo:23:10
+[unused-imports] in proxy.cairo:3:19
+[unused-imports] in proxy.cairo:3:38

tests/expected/implicit_import_two_test.expected

@@ -0,0 +1,4 @@
+[implicit-import] [This](0) function will be imported by [here](1), even though it was not explicitly imported. in utils.cairo:19:1 and proxy.cairo:3:19
+[must-check-caller-address] in utils.cairo:10:10
+[must-check-caller-address] in utils.cairo:23:10
+[unused-imports] in proxy.cairo:3:19

tests/implicit_import_three_test/proxy.cairo

@@ -0,0 +1,3 @@
+%lang starknet
+
+from utils import auth_read_storage, auth_write_storage

tests/implicit_import_three_test/utils.cairo

@@ -0,0 +1,29 @@
+%lang starknet
+
+from starkware.starknet.common.syscalls import storage_read, storage_write, get_caller_address
+
+# Helpers for auth users to interact with contract's storage
+@view
+func auth_read_storage{
+        syscall_ptr : felt*,
+    }(auth_account : felt, address : felt) -> (value : felt):
+    let (caller) = get_caller_address()
+
+    assert caller = auth_account
+
+    let (value) = storage_read(address=address)
+
+    return (value=value)
+end
+
+@external
+func auth_write_storage{
+        syscall_ptr : felt*,
+    }(auth_account : felt, address : felt, value : felt):
+    let (caller) = get_caller_address()
+
+    assert caller = auth_account
+
+    storage_write(address=address, value=value)
+    return()
+end

tests/implicit_import_two_test/proxy.cairo

@@ -0,0 +1,3 @@
+%lang starknet
+
+from utils import auth_read_storage

tests/implicit_import_two_test/utils.cairo

@@ -0,0 +1,29 @@
+%lang starknet
+
+from starkware.starknet.common.syscalls import storage_read, storage_write, get_caller_address
+
+# Helpers for auth users to interact with contract's storage
+@view
+func auth_read_storage{
+        syscall_ptr : felt*,
+    }(auth_account : felt, address : felt) -> (value : felt):
+    let (caller) = get_caller_address()
+
+    assert caller = auth_account
+
+    let (value) = storage_read(address=address)
+
+    return (value=value)
+end
+
+@external
+func auth_write_storage{
+        syscall_ptr : felt*,
+    }(auth_account : felt, address : felt, value : felt):
+    let (caller) = get_caller_address()
+
+    assert caller = auth_account
+
+    storage_write(address=address, value=value)
+    return()
+end