c8ef5376-56e4-4c32-b815-9e3a6c413153

Committed 02 Apr 2024 05:17PM UTC coverage: 91.947% (+0.002%) from 91.945%

Build # c8ef5376-56e4-4c32-b815-9e3a6c413153

Build Type

circleci

Committed by Mirella de Medeiros

Commit Message

CU-86drpncy1 - Add new methods on storage to get/put primitive values without the need of TypeHelper

Pull Request Pull Request #1231: CU-86drpncy1 - Add new methods on storage to get/put primitive values without the need of TypeHelper

Run Details

290 of 315 new or added lines in 28 files covered. (92.06%)

2 existing lines in 1 file now uncovered.

20894 of 22724 relevant lines covered (91.95%)

1.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.46

/boa3/internal/model/builtin/interop/storage/put/istorageputmethod.py

import abc
import ast
from collections.abc import Iterable, Sized
from typing import Any

from boa3.internal.model import set_internal_call
from boa3.internal.model.builtin.interop.interopmethod import InteropMethod
from boa3.internal.model.builtin.method.builtinmethod import IBuiltinMethod
from boa3.internal.model.expression import IExpression
from boa3.internal.model.type.itype import IType
from boa3.internal.model.variable import Variable


class IStoragePutMethod(InteropMethod, abc.ABC):

    def __init__(self, identifier: str, value_type: IType):
        from boa3.internal.model.type.type import Type
        from boa3.internal.model.builtin.interop.storage.storagecontext.storagecontexttype import StorageContextType

        syscall = 'System.Storage.Put'
        context_type = StorageContextType.build()

        args: dict[str, Variable] = {'key': Variable(Type.bytes),
                                     'value': Variable(value_type),
                                     'context': Variable(context_type)}

        from boa3.internal.model.builtin.interop.storage.storagegetcontextmethod import StorageGetContextMethod
        default_id = StorageGetContextMethod(context_type).identifier
        context_default = set_internal_call(ast.parse(f"{default_id}()"
                                                      ).body[0].value)
        super().__init__(identifier, syscall, args, defaults=[context_default], return_type=Type.none)

    @abc.abstractmethod
    def generate_serialize_value_opcodes(self, code_generator):
        pass

    def generate_internal_opcodes(self, code_generator):
        start_address = code_generator.bytecode_size
        code_generator.swap_reverse_stack_items(3)
        self.generate_serialize_value_opcodes(code_generator)
        end_address = code_generator.last_code_start_address

        if end_address > start_address:
            code_generator.swap_reverse_stack_items(3)
        else:
            code_generator._remove_inserted_opcodes_since(start_address)

        super().generate_internal_opcodes(code_generator)

    @property
    def generation_order(self) -> list[int]:
        """
        Gets the indexes order that need to be used during code generation.
        If the order for generation is the same as inputted in code, returns reversed(range(0,len_args))

        :return: Index order for code generation
        """
        indexes = super().generation_order
        context_index = list(self.args).index('context')

        if indexes[-1] != context_index:
            # context must be the last generated argument
            indexes.remove(context_index)
            indexes.append(context_index)

        return indexes

    @property
    def key_arg(self) -> Variable:
        return self.args['key']

    @property
    def value_arg(self) -> Variable:
        return self.args['value']

    def build(self, value: Any) -> IBuiltinMethod:
        if not isinstance(value, (Sized, Iterable)):
            return self
        num_args: int = len(self.args)
        if len(value) != num_args or any(not isinstance(exp, (IExpression, IType)) for exp in value[:num_args]):
            return self

        exp = [exp if isinstance(exp, IExpression) else Variable(exp) for exp in value]
        if not self.validate_parameters(*exp):
            return self

        key_type: IType = exp[0].type
        value_type: IType = exp[1].type
        if self.key_arg.type.is_type_of(key_type) and self.value_arg.type.is_type_of(value_type):
            return self

        from boa3.internal.model.builtin.interop.storage.put.storageputintmethod import StoragePutBytesMethod
        method: InteropMethod = StoragePutBytesMethod()
        method.args['key'] = Variable(key_type)
        method.args['value'] = Variable(value_type)
        return method

1	import abc	2✔
2	import ast	2✔
3	from collections.abc import Iterable, Sized	2✔
4	from typing import Any	2✔
5
6	from boa3.internal.model import set_internal_call	2✔
7	from boa3.internal.model.builtin.interop.interopmethod import InteropMethod	2✔
8	from boa3.internal.model.builtin.method.builtinmethod import IBuiltinMethod	2✔
9	from boa3.internal.model.expression import IExpression	2✔
10	from boa3.internal.model.type.itype import IType	2✔
11	from boa3.internal.model.variable import Variable	2✔
12
13
14	class IStoragePutMethod(InteropMethod, abc.ABC):	2✔
15
16	def __init__(self, identifier: str, value_type: IType):	2✔
17	from boa3.internal.model.type.type import Type	2✔
18	from boa3.internal.model.builtin.interop.storage.storagecontext.storagecontexttype import StorageContextType	2✔
19
20	syscall = 'System.Storage.Put'	2✔
21	context_type = StorageContextType.build()	2✔
22
23	args: dict[str, Variable] = {'key': Variable(Type.bytes),	2✔
24	'value': Variable(value_type),
25	'context': Variable(context_type)}
26
27	from boa3.internal.model.builtin.interop.storage.storagegetcontextmethod import StorageGetContextMethod	2✔
28	default_id = StorageGetContextMethod(context_type).identifier	2✔
29	context_default = set_internal_call(ast.parse(f"{default_id}()"	2✔
30	).body[0].value)
31	super().__init__(identifier, syscall, args, defaults=[context_default], return_type=Type.none)	2✔
32
33	@abc.abstractmethod	2✔
34	def generate_serialize_value_opcodes(self, code_generator):	2✔
NEW 35	pass	×
36
37	def generate_internal_opcodes(self, code_generator):	2✔
38	start_address = code_generator.bytecode_size	2✔
39	code_generator.swap_reverse_stack_items(3)	2✔
40	self.generate_serialize_value_opcodes(code_generator)	2✔
41	end_address = code_generator.last_code_start_address	2✔
42
43	if end_address > start_address:	2✔
NEW 44	code_generator.swap_reverse_stack_items(3)	×
45	else:
46	code_generator._remove_inserted_opcodes_since(start_address)	2✔
47
48	super().generate_internal_opcodes(code_generator)	2✔
49
50	@property	2✔
51	def generation_order(self) -> list[int]:	2✔
52	"""
53	Gets the indexes order that need to be used during code generation.
54	If the order for generation is the same as inputted in code, returns reversed(range(0,len_args))
55
56	:return: Index order for code generation
57	"""
58	indexes = super().generation_order	2✔
59	context_index = list(self.args).index('context')	2✔
60
61	if indexes[-1] != context_index:	2✔
62	# context must be the last generated argument
63	indexes.remove(context_index)	2✔
64	indexes.append(context_index)	2✔
65
66	return indexes	2✔
67
68	@property	2✔
69	def key_arg(self) -> Variable:	2✔
70	return self.args['key']	×
71
72	@property	2✔
73	def value_arg(self) -> Variable:	2✔
74	return self.args['value']	×
75
76	def build(self, value: Any) -> IBuiltinMethod:	2✔
77	if not isinstance(value, (Sized, Iterable)):	2✔
78	return self	×
79	num_args: int = len(self.args)	2✔
80	if len(value) != num_args or any(not isinstance(exp, (IExpression, IType)) for exp in value[:num_args]):	2✔
81	return self	2✔
82
83	exp = [exp if isinstance(exp, IExpression) else Variable(exp) for exp in value]	2✔
84	if not self.validate_parameters(*exp):	2✔
85	return self	2✔
86
87	key_type: IType = exp[0].type	×
88	value_type: IType = exp[1].type	×
89	if self.key_arg.type.is_type_of(key_type) and self.value_arg.type.is_type_of(value_type):	×
90	return self	×
91
NEW 92	from boa3.internal.model.builtin.interop.storage.put.storageputintmethod import StoragePutBytesMethod	×
NEW 93	method: InteropMethod = StoragePutBytesMethod()	×
94	method.args['key'] = Variable(key_type)	×
95	method.args['value'] = Variable(value_type)	×
96	return method	×

CityOfZion / neo3-boa / c8ef5376-56e4-4c32-b815-9e3a6c413153

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous