Static Analyzer for Solidity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
slither/tests/unit/core/test_source_mapping.py

127 lines
4.7 KiB

from pathlib import Path
from solc_select import solc_select
from slither import Slither
from slither.core.declarations import Function
TEST_DATA_DIR = Path(__file__).resolve().parent / "test_data"
SRC_MAPPING_TEST_ROOT = Path(TEST_DATA_DIR, "src_mapping")
def test_source_mapping():
solc_select.switch_global_version("0.6.12", always_install=True)
file = Path(SRC_MAPPING_TEST_ROOT, "inheritance.sol").as_posix()
slither = Slither(file)
# Check if A.f() is at the offset 27
functions = slither.offset_to_objects(file, 27)
print(functions)
assert len(functions) == 1
function = functions.pop()
assert isinstance(function, Function)
assert function.canonical_name == "A.f()"
# Only one definition for A.f()
assert {(x.start, x.end) for x in slither.offset_to_definitions(file, 27)} == {(26, 28)}
# Only one reference for A.f(), in A.test()
assert {(x.start, x.end) for x in slither.offset_to_references(file, 27)} == {(92, 93)}
# Only one implementation for A.f(), in A.test()
assert {(x.start, x.end) for x in slither.offset_to_implementations(file, 27)} == {(17, 53)}
# Check if C.f() is at the offset 203
functions = slither.offset_to_objects(file, 203)
assert len(functions) == 1
function = functions.pop()
assert isinstance(function, Function)
assert function.canonical_name == "C.f()"
# Only one definition for C.f()
assert {(x.start, x.end) for x in slither.offset_to_definitions(file, 203)} == {(202, 204)}
# Two references for C.f(), in A.test() and C.test2()
assert {(x.start, x.end) for x in slither.offset_to_references(file, 203)} == {
(270, 271),
(92, 93),
}
# Only one implementation for A.f(), in A.test()
assert {(x.start, x.end) for x in slither.offset_to_implementations(file, 203)} == {(193, 230)}
# Offset 93 is the call to f() in A.test()
# This can lead to three differents functions, depending on the current contract's context
functions = slither.offset_to_objects(file, 93)
print(functions)
assert len(functions) == 3
for function in functions:
assert isinstance(function, Function)
assert function.canonical_name in ["A.f()", "B.f()", "C.f()"]
# There are three definitions possible (in A, B or C)
assert {(x.start, x.end) for x in slither.offset_to_definitions(file, 93)} == {
(26, 28),
(202, 204),
(138, 140),
}
# There are two references possible (in A.test() or C.test2() )
assert {(x.start, x.end) for x in slither.offset_to_references(file, 93)} == {
(92, 93),
(270, 271),
}
# There are three implementations possible (in A, B or C)
assert {(x.start, x.end) for x in slither.offset_to_implementations(file, 93)} == {
(17, 53),
(193, 230),
(129, 166),
}
def _sort_references_lines(refs: list) -> list:
return sorted([ref.lines[0] for ref in refs])
def _test_references_user_defined_aliases():
"""
Tests if references are filled correctly for user defined aliases (declared using "type [...] is [...]" statement).
"""
solc_select.switch_global_version("0.8.16", always_install=True)
file = Path(SRC_MAPPING_TEST_ROOT, "ReferencesUserDefinedAliases.sol").as_posix()
slither = Slither(file)
alias_top_level = slither.compilation_units[0].user_defined_value_types["aliasTopLevel"]
assert len(alias_top_level.references) == 2
lines = _sort_references_lines(alias_top_level.references)
assert lines == [12, 16]
alias_contract_level = (
slither.compilation_units[0]
.contracts[0]
.file_scope.user_defined_types["C.aliasContractLevel"]
)
assert len(alias_contract_level.references) == 2
lines = _sort_references_lines(alias_contract_level.references)
assert lines == [13, 16]
def _test_references_user_defined_types_when_casting():
"""
Tests if references are filled correctly for user defined types in case of casting.
"""
solc_select.switch_global_version("0.8.16", always_install=True)
file = Path(SRC_MAPPING_TEST_ROOT, "ReferencesUserDefinedTypesCasting.sol").as_posix()
slither = Slither(file)
contracts = slither.compilation_units[0].contracts
a = contracts[0] if contracts[0].is_interface else contracts[1]
assert len(a.references) == 2
lines = _sort_references_lines(a.references)
assert lines == [12, 18]
def test_references():
"""
Tests if references list is filled correctly in the following cases:
- user defined aliases (declared using "type [...] is [...]" statement)
- user defined types in case of casting (TypeConversion expressions)
"""
_test_references_user_defined_aliases()
_test_references_user_defined_types_when_casting()