cicnet/cic-cli
5
1
Fork 0
Code Issues Pull Requests Projects Releases 18 Wiki Activity

Rehabilitate tests

Browse Source
This commit is contained in:
nolash 2021-11-29 13:18:28 +01:00
parent dcdc4ddbb2
commit 239ca47f32
Signed by: lash
GPG Key ID: 21D2E7BB88C2A746
12 changed files with 167 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
cic/base.py
View File

@ -10,7 +10,8 @@ schema_dir = os.path.join(mod_dir, 'schema')
class Data:
"""Base class for all parts of the token data deployment.
"""
__default_version = 0
@ -28,27 +29,50 @@ class Data:
def hash(self, v):
"""Compute digest of the given data
:param v: Data to hash
:type v: bytes
:rtype: bytes
:return: Hashed data
"""
return self.__hasher(v)
def load(self):
"""Prevents overwriting data from settings if data state has changed.
:raises RuntimeError: If state is dirty
"""
if self.dirty:
raise RuntimeError('Object contains uncommitted changes')
def start(self):
"""Prevents double initialization of data item.
:raises RuntimeError: If already initialized
"""
if self.inited:
raise RuntimeError('Object already initialized')
def verify(self):
"""Verify data state (noop)
"""
return True
def version(self):
"""Return version of data schema.
"""
return self.__version
def set_version(self, version):
self.__version = version
"""Set version of data schema. The version number is a single integer.
:param version: version
:type version: int
"""
self.__version = version

80
cic/extension.py
View File

@ -11,7 +11,21 @@ logg = logging.getLogger(__name__)
class Extension:
"""Base class adapter to initialize, serialize and publish extension-specific token resources.
:param chain_spec: Chain Spec that extension will operate for
:type chain_spec: chainlib.chain.ChainSpec
:param resources: Chain application resources to deploy or interface with
:type resources: dict
:param proof: Proof object to publish
:type proof: cic.proof.Proof
:param signer: Signer capable of generating signatures for chain aplication deployments
:type signer: funga.signer.Signer
:param rpc: RPC adapter capable of submitting and querying the chain network node
:type rpc: chainlib.connection.RPCConnection
:param writer: Writer interface receiving the output of the processor
:type writer: cic.output.OutputWriter
"""
def __init__(self, chain_spec, resources, proof, signer=None, rpc=None, outputs_writer=StdoutWriter()):
self.resources = resources
self.proof = proof
@ -27,10 +41,38 @@ class Extension:
# TODO: apply / prepare token can be factored out
def apply_token(self, token):
"""Initialize extension with token data from settings.
:param token: Token object
:type token: cic.token.Token
:rtype: dict
:returns: Token data state of extension after load
"""
return self.prepare_token(token.name, token.symbol, token.precision, token.code, token.supply)
def prepare_token(self, name, symbol, precision, code, supply, extra=[], extra_types=[], positions=None):
"""Initialize extension token data.
:param name: Token name
:type name: str
:param symbol: Token symbol
:type symbol: str
:param precision: Token value precision (number of decimals)
:type precision: int
:param code: Bytecode for token chain application
:type code: str (hex)
:param supply: Token supply (in smallest precision units)
:type supply: int
:param extra: Extra parameters to pass to token application constructor
:type extra: list
:param extra_types: Type specifications for extra parameters
:type extra_types: list
:param positions: Sequence of parameter indices to pass to application constructor
:type positions: list
:rtype: dict
:returns: Token data state of extension after load
"""
self.token_details = {
'name': name,
'symbol': symbol,
@ -41,13 +83,23 @@ class Extension:
'extra_types': extra_types,
'positions': positions,
}
return self.token_details
def prepare_extension(self):
"""Prepare extension for publishing (noop)
"""
pass
def parse_code_as_file(self, v):
"""Helper method to load application bytecode from file into extensions token data state.
Client code should call load_code instead.
:param v: File path
:type v: str
"""
try:
f = open(v, 'r')
r = f.read()
@ -62,6 +114,13 @@ class Extension:
def parse_code_as_hex(self, v):
"""Helper method to load application bytecode from hex data into extension token data state.
Client code should call load_code instead.
:param v: Bytecode as hex
:type v: str
"""
try:
self.token_code = valid_hex(v)
except ValueError as e:
@ -70,6 +129,13 @@ class Extension:
def load_code(self, hint=None):
"""Attempt to load token application bytecode using token settings.
:param hint: If "hex", will interpret code in settings as literal bytecode
:type hint: str
:rtype: str (hex)
:return: Bytecode loaded into extension token data state
"""
code = self.token_details['code']
if hint == 'hex':
self.token_code = valid_hex(code)
@ -89,6 +155,15 @@ class Extension:
def process(self, writer=None):
"""Adapter used by Processor to process the extensions implementing the Extension base class.
Requires either token address or a valid token code reference to have been included in settings. If token address is not set, the token application code will be deployed.
:param writer: Writer to use for publishing.
:type writer: cic.output.OutputWriter
:rtype: tuple
:return: Token address, token symbol
"""
if writer == None:
writer = self.outputs_writer
@ -102,7 +177,6 @@ class Extension:
self.load_code()
tasks.append('token')
for k in self.resources.keys():
if k == 'token':
continue
@ -112,7 +186,7 @@ class Extension:
self.prepare_extension()
for task in tasks:
logg.debug('ciceth adapter process {}'.format(task))
logg.debug('extension adapter process {}'.format(task))
r = getattr(self, 'process_' + task)(writer=writer)
return (self.token_address, self.token_details['symbol'])
return (self.token_address, self.token_details.get('symbol'))

7
cic/proof.py
View File

@ -38,6 +38,7 @@ class Proof(Data):
self.proofs = []
self.namespace = 'ge'
self.description = None
self.issuer = None
self.path = path
self.writer = writer
self.extra_attachments = attachments
@ -125,7 +126,8 @@ class Proof(Data):
f.write(b)
f.close()
k = self.hash(b.encode('utf-8'))
b = b.encode('utf-8')
k = self.hash(b)
return (k.hex(), b)
@ -140,6 +142,7 @@ class Proof(Data):
(k, v) = self.root()
writer.write(k, v)
root_key = k
token_symbol_bytes = token_symbol.encode('utf-8')
k = generate_metadata_pointer(token_symbol_bytes, MetadataPointer.TOKEN_PROOF_SYMBOL)
@ -171,7 +174,7 @@ class Proof(Data):
json.dump(o, f, sort_keys=True, indent="\t")
f.close()
return k
return root_key
def __str__(self):

20
cic/token.py
View File

@ -10,7 +10,23 @@ from .base import (
class Token(Data):
"""Encapsulates the token data used by the extension to deploy and/or register token and token related applications on chain.
Token details (name, symbol etc) will be used to initialize the token settings when start is called. If load is called instead, any token detail parameters passed to the constructor will be overwritten by data stored in the settings.
:param path: Settings directory path
:type path: str
:param name: Token name
:type name: str
:param symbol: Token symbol
:type symbol: str
:param precision: Token value precision (number of decimals)
:type precision: int
:param supply: Token supply (in smallest precision units)
:type supply: int
:param code: Bytecode for token chain application
:type code: str (hex)
"""
def __init__(self, path='.', name=None, symbol=None, precision=1, supply=0, code=None):
super(Token, self).__init__()
self.name = name
@ -24,6 +40,8 @@ class Token(Data):
def load(self):
"""Load token data from settings.
"""
super(Token, self).load()
f = open(self.token_path, 'r')
@ -41,6 +59,8 @@ class Token(Data):
def start(self):
"""Initialize token settings from arguments passed to the constructor and/or template.
"""
super(Token, self).load()
token_template_file_path = os.path.join(data_dir, 'token_template_v{}.json'.format(self.version()))

12
eth_requirements.txt
View File

@ -1,6 +1,6 @@
chainlib-eth>=0.0.10a21,<0.1.0
funga-eth>=0.5.1a1,<0.6.0
eth-token-index>=0.2.4a1,<0.3.0
eth-address-index>=0.2.4a1,<0.3.0
okota>=0.2.4a6,<0.3.0
cic_eth_registry>=0.6.1a1,<0.7.0
chainlib-eth~=0.0.12
funga-eth~=0.5.1
eth-token-index~=0.2.4
eth-address-index~=0.2.4
okota~=0.2.5a1
cic_eth_registry~=0.6.2

8
requirements.txt
View File

@ -1,5 +1,5 @@
funga-eth>=0.5.0a1,<0.6.0
cic-types>=0.2.1a1,<=0.2.1
confini>=0.4.2rc3,<0.5.0
chainlib>=0.0.10a3,<0.1.0
funga-eth~=0.5.1
cic-types~=0.2.1a5
confini~=0.5.1
chainlib~=0.0.12
cbor2==5.4.1

6
tests/base_cic.py
View File

@ -14,15 +14,15 @@ from cic.processor import Processor
from cic.attachment import Attachment
from cic import Proof
logg = logging.getLogger(__name__)
test_base_dir = os.path.dirname(os.path.realpath(__file__))
test_data_dir = os.path.join(test_base_dir, 'testdata')
proof_hash = '0f6fc017f29caf512c0feaaf83bc10614b488311cace2973dc248dc24b01e04f'
foo_hash = '2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae'
bar_hash = 'fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9'
root_merged_hash = '4bd0ad4305a5fee20fb80e179a437c296f6a769ca376d746a3848a80e9b7a1a6'
#root_merged_hash = '4bd0ad4305a5fee20fb80e179a437c296f6a769ca376d746a3848a80e9b7a1a6'
root_merged_hash = '795fed550ada0ec1eea4309a282f5910bc3bdb3a9762c7d9cc25d6de71c45096'
root_unmerged_hash = '5dc81e51703e624f498663e7d5d70429b824e9ff60f92b61fe47eb6862a971b4'
class TestCICBase(unittest.TestCase):

2
tests/eth/base_eth.py
View File

@ -95,6 +95,8 @@ class TestCICEthBase(EthTesterCase):
self.proofs = Proof(proof_dir, attachments=attach)
self.proofs.load()
logg.debug('proofs {}'.format(self.proofs.attachments))
self.outputs_dir = tempfile.mkdtemp()
self.outputs_writer = KVWriter(self.outputs_dir)

4
tests/eth/test_eth_full.py
View File

@ -28,6 +28,7 @@ from giftable_erc20_token import GiftableToken
# local imports
from cic.ext.eth import CICEth
from cic.processor import Processor
from cic.token import Token
# test imports
from tests.eth.base_eth import TestCICEthTokenBase
@ -65,6 +66,9 @@ class TestCICEthRPC(TestCICEthTokenBase):
self.token_index_address = r['contract_address']
logg.debug('token index deployed at {}'.format(self.token_index_address))
ct = Token(name=self.token_name, symbol=self.token_symbol, precision=self.token_precision, supply=self.token_supply)
self.adapter.apply_token(ct)
self.adapter.process()
results = self.adapter.get_outputs()
for v in results:

18
tests/eth/test_eth_offline.py
View File

@ -19,11 +19,11 @@ class TestCICEthOffline(TestCICEthBase):
def setUp(self):
super(TestCICEthOffline, self).setUp()
self.adapter = CICEth(self.chain_spec, self.resources, self.proofs)
proofs = []
for proof in self.proofs.get():
proofs.append(proof[0])
proofs.sort()
self.first_proof = proofs[0]
#proofs = []
#for proof in self.proofs.get():
# proofs.append(proof[0])
#proofs.sort()
self.first_proof = self.proofs.root()[0]
#self.core_processor = Processor(outputs_writer=self.outputs_writer, extensions=[self.adapter])
@ -37,23 +37,21 @@ class TestCICEthOffline(TestCICEthBase):
def test_offline_address_declarator(self):
self.adapter.token_address = self.token_address
self.adapter.process_address_declarator()
first_proof = self.proofs.get()[0]
self.assertEqual(self.adapter.outputs[0][0], 'address_declarator_' + self.first_proof)
self.assertEqual(self.adapter.outputs[0][1][:8], 'ae47ece0')
self.assertEqual(len(self.adapter.outputs), 3)
# self.assertEqual(len(self.adapter.outputs), 3)
def test_offline_writer(self):
self.adapter.outputs_writer = self.outputs_writer
self.adapter.token_address = self.token_address
self.adapter.process_address_declarator()
logg.debug('proocs {}'.format(self.proofs))
logg.debug('proofs {}'.format(self.proofs))
logg.debug('outputs {}'.format(self.adapter.outputs))
self.assertEqual(self.adapter.outputs[0][0], 'address_declarator_' + self.first_proof)
self.assertEqual(self.adapter.outputs[0][1][:8], 'ae47ece0')
self.assertEqual(len(self.adapter.outputs), 3)
# self.assertEqual(len(self.adapter.outputs), 3)
proofs = self.proofs.get()
for i, v in enumerate(self.adapter.outputs):
fp = os.path.join(self.outputs_dir, v[0])
f = open(fp, 'rb')

5
tests/test_processor.py
View File

@ -33,7 +33,7 @@ class MockExt:
self.address = address
def process(self):
return self.address
return (self.address, 'foo')
class TestCICProcessor(TestCICBase):
@ -74,6 +74,9 @@ class TestCICProcessor(TestCICBase):
def test_processor_proof_noattachment(self):
fp = os.path.join(test_data_dir, 'proof')
m = Proof(fp)
ap = os.path.join(test_data_dir, 'proof_empty')
m.extra_attachments = Attachment(ap)
m.load()
mock_ext = MockExt(self.token_address)

10
tests/testdata/proof/proof.json vendored
View File

@ -1,6 +1,10 @@
{
"version": 0,
"namespace": "ge",
"description": "foo bar baz",
"issuer": "the man",
"description": "foo bar baz"
"namespace": "ge",
"proofs": [
"2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae",
"fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9"
],
"version": 0
}