Skip to content

tests: dynamically search for deep mutable properties #1340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jansegre merged 1 commit into from
Aug 1, 2025
+342 −0
Merged

tests: dynamically search for deep mutable properties #1340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
342 changes: 342 additions & 0 deletions tests/nanocontracts/test_exposed_properties.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,342 @@
from collections.abc import Iterator
from importlib import import_module
from sys import version_info
from types import MethodType
from typing import Any

from hathor.nanocontracts import Blueprint, Context, public
from hathor.nanocontracts.custom_builtins import EXEC_BUILTINS
from hathor.nanocontracts.on_chain_blueprint import ALLOWED_IMPORTS
from tests.nanocontracts.blueprints.unittest import BlueprintTestCase

MAX_DEPTH = 20
NEW_PROP_NAME = 'some_new_attribute'

# XXX: if KNOWN_CASES is not empty then there is a bug
KNOWN_CASES = [
'MyBlueprint.check',
'MyBlueprint.initialize',
'MyBlueprint.log',
'MyBlueprint.some_new_attribute',
'MyBlueprint.syscall',
'aiter.some_new_attribute',
'all.some_new_attribute',
'anext.some_new_attribute',
'any.some_new_attribute',
'ascii.some_new_attribute',
'breakpoint.some_new_attribute',
'compile.some_new_attribute',
'copyright.some_new_attribute',
'credits.some_new_attribute',
'ctx.actions_list',
'delattr.some_new_attribute',
'dir.some_new_attribute',
'enumerate.some_new_attribute',
'eval.some_new_attribute',
'exec.some_new_attribute',
'exit.eof',
'exit.name',
'exit.some_new_attribute',
'getattr.some_new_attribute',
'globals.some_new_attribute',
'hasattr.some_new_attribute',
'hathor.nanocontracts.Blueprint.log',
'hathor.nanocontracts.Blueprint.some_new_attribute',
'hathor.nanocontracts.Blueprint.syscall',
'hathor.nanocontracts.blueprint.Blueprint.log',
'hathor.nanocontracts.blueprint.Blueprint.some_new_attribute',
'hathor.nanocontracts.blueprint.Blueprint.syscall',
'hathor.nanocontracts.context.Context.actions',
'hathor.nanocontracts.context.Context.actions_list',
'hathor.nanocontracts.context.Context.address',
'hathor.nanocontracts.context.Context.copy',
'hathor.nanocontracts.context.Context.get_single_action',
'hathor.nanocontracts.context.Context.some_new_attribute',
'hathor.nanocontracts.context.Context.timestamp',
'hathor.nanocontracts.context.Context.to_json',
'hathor.nanocontracts.context.Context.vertex',
'hathor.nanocontracts.exception.NCFail.add_note',
'hathor.nanocontracts.exception.NCFail.args',
'hathor.nanocontracts.exception.NCFail.some_new_attribute',
'hathor.nanocontracts.exception.NCFail.with_traceback',
'hathor.nanocontracts.types.Address.some_new_attribute',
'hathor.nanocontracts.types.Amount.some_new_attribute',
'hathor.nanocontracts.types.BlueprintId.some_new_attribute',
'hathor.nanocontracts.types.ContractId.some_new_attribute',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.melt',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.mint',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.name',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.some_new_attribute',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.to_json',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.token_uid',
'hathor.nanocontracts.types.NCAcquireAuthorityAction.type',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY._name_',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY._sort_order_',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY._value_',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY.from_bytes',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY.some_new_attribute',
'hathor.nanocontracts.types.NCActionType.ACQUIRE_AUTHORITY.to_bytes',
'hathor.nanocontracts.types.NCActionType.DEPOSIT._name_',
'hathor.nanocontracts.types.NCActionType.DEPOSIT._sort_order_',
'hathor.nanocontracts.types.NCActionType.DEPOSIT._value_',
'hathor.nanocontracts.types.NCActionType.DEPOSIT.from_bytes',
'hathor.nanocontracts.types.NCActionType.DEPOSIT.some_new_attribute',
'hathor.nanocontracts.types.NCActionType.DEPOSIT.to_bytes',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY._name_',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY._sort_order_',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY._value_',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY.from_bytes',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY.some_new_attribute',
'hathor.nanocontracts.types.NCActionType.GRANT_AUTHORITY.to_bytes',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL._name_',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL._sort_order_',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL._value_',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL.from_bytes',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL.some_new_attribute',
'hathor.nanocontracts.types.NCActionType.WITHDRAWAL.to_bytes',
'hathor.nanocontracts.types.NCActionType._generate_next_value_',
'hathor.nanocontracts.types.NCActionType._member_map_',
'hathor.nanocontracts.types.NCActionType._member_names_',
'hathor.nanocontracts.types.NCActionType._member_type_',
'hathor.nanocontracts.types.NCActionType._new_member_',
'hathor.nanocontracts.types.NCActionType._unhashable_values_',
'hathor.nanocontracts.types.NCActionType._use_args_',
'hathor.nanocontracts.types.NCActionType._value2member_map_',
'hathor.nanocontracts.types.NCActionType._value_repr_',
'hathor.nanocontracts.types.NCActionType.from_bytes',
'hathor.nanocontracts.types.NCActionType.some_new_attribute',
'hathor.nanocontracts.types.NCActionType.to_bytes',
'hathor.nanocontracts.types.NCDepositAction.amount',
'hathor.nanocontracts.types.NCDepositAction.name',
'hathor.nanocontracts.types.NCDepositAction.some_new_attribute',
'hathor.nanocontracts.types.NCDepositAction.to_json',
'hathor.nanocontracts.types.NCDepositAction.token_uid',
'hathor.nanocontracts.types.NCDepositAction.type',
'hathor.nanocontracts.types.NCGrantAuthorityAction.melt',
'hathor.nanocontracts.types.NCGrantAuthorityAction.mint',
'hathor.nanocontracts.types.NCGrantAuthorityAction.name',
'hathor.nanocontracts.types.NCGrantAuthorityAction.some_new_attribute',
'hathor.nanocontracts.types.NCGrantAuthorityAction.to_json',
'hathor.nanocontracts.types.NCGrantAuthorityAction.token_uid',
'hathor.nanocontracts.types.NCGrantAuthorityAction.type',
'hathor.nanocontracts.types.NCParsedArgs.args',
'hathor.nanocontracts.types.NCParsedArgs.kwargs',
'hathor.nanocontracts.types.NCParsedArgs.some_new_attribute',
'hathor.nanocontracts.types.NCRawArgs.args_bytes',
'hathor.nanocontracts.types.NCRawArgs.some_new_attribute',
'hathor.nanocontracts.types.NCRawArgs.try_parse_as',
'hathor.nanocontracts.types.NCWithdrawalAction.amount',
'hathor.nanocontracts.types.NCWithdrawalAction.name',
'hathor.nanocontracts.types.NCWithdrawalAction.some_new_attribute',
'hathor.nanocontracts.types.NCWithdrawalAction.to_json',
'hathor.nanocontracts.types.NCWithdrawalAction.token_uid',
'hathor.nanocontracts.types.NCWithdrawalAction.type',
'hathor.nanocontracts.types.SignedData._get_raw_signed_data',
'hathor.nanocontracts.types.SignedData.checksig',
'hathor.nanocontracts.types.SignedData.get_data_bytes',
'hathor.nanocontracts.types.SignedData.some_new_attribute',
'hathor.nanocontracts.types.Timestamp.some_new_attribute',
'hathor.nanocontracts.types.TokenUid.some_new_attribute',
'hathor.nanocontracts.types.TxOutputScript.some_new_attribute',
'hathor.nanocontracts.types.VertexId.some_new_attribute',
'hathor.nanocontracts.types.fallback.some_new_attribute',
'hathor.nanocontracts.types.public.some_new_attribute',
'hathor.nanocontracts.types.view.some_new_attribute',
'help.some_new_attribute',
'id.some_new_attribute',
'input.some_new_attribute',
'issubclass.some_new_attribute',
'license.some_new_attribute',
'locals.some_new_attribute',
'memoryview.c_contiguous',
'memoryview.cast',
'memoryview.contiguous',
'memoryview.f_contiguous',
'memoryview.format',
'memoryview.hex',
'memoryview.itemsize',
'memoryview.nbytes',
'memoryview.ndim',
'memoryview.obj',
'memoryview.readonly',
'memoryview.release',
'memoryview.shape',
'memoryview.some_new_attribute',
'memoryview.strides',
'memoryview.suboffsets',
'memoryview.tobytes',
'memoryview.tolist',
'memoryview.toreadonly',
'open.some_new_attribute',
'print.some_new_attribute',
'property.deleter',
'property.fdel',
'property.fget',
'property.fset',
'property.getter',
'property.setter',
'property.some_new_attribute',
'quit.eof',
'quit.name',
'quit.some_new_attribute',
'range._getitem_int',
'range._getitem_slice',
'range._start',
'range._step',
'range._stop',
'range.count',
'range.index',
'range.some_new_attribute',
'range.start',
'range.step',
'range.stop',
'repr.some_new_attribute',
'setattr.some_new_attribute',
'vars.some_new_attribute',
]

# XXX: these only appear in Python 3.11
if version_info[1] == 11:
KNOWN_CASES.extend([
'hathor.nanocontracts.types.SignedData._is_protocol',
])

# XXX: these only appear in Python 3.12
if version_info[1] == 12:
KNOWN_CASES.extend([
'memoryview._from_flags',
])

KNOWN_CASES.sort()


def is_writeable(obj: object, prop_name: str, value: Any) -> bool:
""" Returns True if `obj.prop_name = value` succeeds."""
if has_value := hasattr(obj, prop_name):
orig_value = getattr(obj, prop_name)
try:
# try to overwrite the attribute
setattr(obj, prop_name, value)
# try to delete the attribute
delattr(obj, prop_name)
# restore original value if it had one
if has_value:
setattr(obj, prop_name, orig_value)
except AttributeError:
return False
except TypeError:
return False
else:
return True


def check_property_writeable(obj: object, prop_name: str) -> tuple[bool, object | None]:
""" Checks the property value and returns a tuple (writeable: bool, possible_object: object | None).

The first value, `writeable: bool`, tells whether the property is writeable or not.

The second value, `possible_object: object | None` is the value to be used to continue the recursive check, if it's
`None` there is no need to continue. Note: the value itself could be `None`, and we don't differentiate, we just
don't continue the search eitherway.
"""
prop_value = getattr(obj, prop_name)
match prop_value:
case list():
# XXX: lists are inherently mutable and shouldn't be exposed
prop_value.append(object())
# XXX: is_writeable not called since True is always returned, but it's technically independant
return True, None
case dict():
# XXX: dicts are inherently mutable and shouldn't be exposed
prop_value[None] = object()
# XXX: is_writeable not called since True is always returned, but it's technically independant
return True, None
case int():
# XXX: no need to deep into int's properties
return is_writeable(obj, prop_name, 999), None
case str():
# XXX: no need to deep into str's properties
return is_writeable(obj, prop_name, 'foobar'), None
case bytes():
# XXX: no need to deep into bytes' properties
return is_writeable(obj, prop_name, b'foobar'), None
case tuple():
# XXX: no need to deep into tuple's properties
return is_writeable(obj, prop_name, ()), None
case MethodType():
# XXX: no need to deep into a method's properties
return is_writeable(obj, prop_name, lambda: 'foo'), None
case _ as value:
return is_writeable(obj, prop_name, object()), value


def should_skip_attr(prop_name: str) -> bool:
"""Used to simulate AST restrictions and prevent loops."""
return '__' in prop_name


def _search_writeable_properties(obj: object, *, path: tuple[str, ...], available_depth: int) -> Iterator[str]:
if available_depth <= 0:
assert 'MAX_DEPTH is not high enough to traverse everything'
all_names = set(dir(obj)) | set(getattr(obj, '__dict__', ())) | set(getattr(obj, '__slots__', ()))
prop_names = [prop_name for prop_name in all_names if not should_skip_attr(prop_name)]
available_depth -= 1
for prop_name in prop_names:
next_path = path + (prop_name,)
prop_path = '.'.join(path + (prop_name,))
prop_writeable, prop_value = check_property_writeable(obj, prop_name)
if prop_writeable:
yield prop_path
else:
if prop_value is not None:
yield from _search_writeable_properties(prop_value, path=next_path, available_depth=available_depth)
if is_writeable(obj, NEW_PROP_NAME, object()):
yield '.'.join(path + (NEW_PROP_NAME,))


def search_writeable_properties(obj: object, obj_name: str, /) -> Iterator[str]:
"""Searches for and returns a list of writeable properties, nested properties are joined with '.'"""
yield from _search_writeable_properties(obj, path=(obj_name,), available_depth=MAX_DEPTH)


class MyBlueprint(Blueprint):
@public
def initialize(self, ctx: Context) -> None:
pass

@public
def check(self, ctx: Context) -> list[str]:
mutable_props: list[str] = []
mutable_props.extend(search_writeable_properties(MyBlueprint, 'MyBlueprint'))
mutable_props.extend(search_writeable_properties(self, 'self'))
mutable_props.extend(search_writeable_properties(ctx, 'ctx'))
for module_name, import_names in ALLOWED_IMPORTS.items():
if module_name == 'typing':
# FIXME: typing module causes problems for some reason
continue
module = import_module(module_name)
for import_name in import_names:
obj = getattr(module, import_name)
obj_name = f'{module_name}.{import_name}'
mutable_props.extend(search_writeable_properties(obj, obj_name))
for builtin_name, builtin_obj in EXEC_BUILTINS.items():
if should_skip_attr(builtin_name):
continue
mutable_props.extend(search_writeable_properties(builtin_obj, builtin_name))
return mutable_props


class TestMutableAttributes(BlueprintTestCase):
def setUp(self) -> None:
super().setUp()
self.blueprint_id = self._register_blueprint_class(MyBlueprint)
self.contract_id = self.gen_random_contract_id()
self.runner.create_contract(self.contract_id, self.blueprint_id, self.create_context())

def test_search_mutable_properties(self) -> None:
mutable_props = sorted(self.runner.call_public_method(self.contract_id, 'check', self.create_context()))
debug = False
if debug:
for prop in mutable_props:
print(f" '{prop}',")
self.assertEqual(mutable_props, KNOWN_CASES)