tooltest.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2023 The MMGen Project <mmgen@tuta.io>
  5. #
  6. # This program is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation, either version 3 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. """
  19. test/tooltest.py: Tests for the 'mmgen-tool' utility
  20. """
  21. import sys,os,binascii
  22. from subprocess import run,PIPE
  23. from include.tests_header import repo_root
  24. from test.overlay import overlay_setup
  25. sys.path.insert(0,overlay_setup(repo_root))
  26. from mmgen.common import *
  27. from test.include.common import *
  28. opts_data = {
  29. 'text': {
  30. 'desc': "Test suite for the 'mmgen-tool' utility",
  31. 'usage':'[options] [command]',
  32. 'options': """
  33. -h, --help Print this help message
  34. -C, --coverage Produce code coverage info using trace module
  35. -d, --debug Produce debugging output (stderr from spawned script)
  36. --, --longhelp Print help message for long options (common options)
  37. -l, --list-cmds List and describe the tests and commands in this test suite
  38. -L, --list-names List the names of all tested 'mmgen-tool' commands
  39. -t, --type=t Specify address type (valid choices: 'zcash_z')
  40. -v, --verbose Produce more verbose output
  41. """,
  42. 'notes': """
  43. If no command is given, the whole suite of tests is run.
  44. """
  45. }
  46. }
  47. sys.argv = [sys.argv[0]] + ['--skip-cfg-file'] + sys.argv[1:]
  48. cfg = Config(opts_data=opts_data)
  49. set_globals(cfg)
  50. vmsg = cfg._util.vmsg
  51. proto = cfg._proto
  52. assert cfg.type in (None,'zcash_z'), 'Only zcash-z permitted for --type argument'
  53. cmd_data = {
  54. 'cryptocoin': {
  55. 'desc': 'Cryptocoin address/key commands',
  56. 'cmd_data': {
  57. 'randwif': (),
  58. 'randpair': (), # create 4 pairs: uncomp,comp,segwit,bech32
  59. 'wif2addr': ('randpair','o4'),
  60. 'wif2hex': ('randpair','o4'),
  61. 'privhex2pubhex': ('wif2hex','o3'), # segwit only
  62. 'pubhex2addr': ('privhex2pubhex','o3'), # segwit only
  63. 'hex2wif': ('wif2hex','io2'), # uncomp, comp
  64. 'addr2pubhash': ('randpair','o4'), # uncomp, comp, bech32
  65. 'pubhash2addr': ('addr2pubhash','io4'), # uncomp, comp, bech32
  66. },
  67. },
  68. 'mnemonic': {
  69. 'desc': 'mnemonic commands',
  70. 'cmd_data': {
  71. 'hex2mn': (),
  72. 'mn2hex': ('hex2mn','io3'),
  73. 'mn_rand128': (),
  74. 'mn_rand192': (),
  75. 'mn_rand256': (),
  76. 'mn_stats': (),
  77. 'mn_printlist': (),
  78. },
  79. },
  80. }
  81. if proto.coin in ('BTC','LTC'):
  82. cmd_data['cryptocoin']['cmd_data'].update({
  83. 'pubhex2redeem_script': ('privhex2pubhex','o3'),
  84. 'wif2redeem_script': ('randpair','o3'),
  85. 'wif2segwit_pair': ('randpair','o2'),
  86. 'privhex2addr': ('wif2hex','o4'), # compare with output of randpair
  87. 'pipetest': ('randpair','o3')
  88. })
  89. if proto.coin == 'XMR' or cfg.type == 'zcash_z':
  90. del cmd_data['cryptocoin']['cmd_data']['pubhash2addr']
  91. del cmd_data['cryptocoin']['cmd_data']['addr2pubhash']
  92. tcfg = {
  93. 'name': 'the tool utility',
  94. 'enc_passwd': 'Ten Satoshis',
  95. 'tmpdir': 'test/tmp/10',
  96. 'tmpdir_num': 10,
  97. 'refdir': 'test/ref',
  98. 'txfile': {
  99. 'btc': ('0B8D5A[15.31789,14,tl=1320969600].rawtx',
  100. '0C7115[15.86255,14,tl=1320969600].testnet.rawtx'),
  101. 'bch': ('460D4D-BCH[10.19764,tl=1320969600].rawtx',
  102. '359FD5-BCH[6.68868,tl=1320969600].testnet.rawtx'),
  103. 'ltc': ('AF3CDF-LTC[620.76194,1453,tl=1320969600].rawtx',
  104. 'A5A1E0-LTC[1454.64322,1453,tl=1320969600].testnet.rawtx'),
  105. },
  106. 'addrfile': '98831F3A{}[1,31-33,500-501,1010-1011]{}.addrs',
  107. 'addrfile_chk': {
  108. 'btc': ('6FEF 6FB9 7B13 5D91','424E 4326 CFFE 5F51'),
  109. 'bch': ('6FEF 6FB9 7B13 5D91','424E 4326 CFFE 5F51'),
  110. 'ltc': ('AD52 C3FE 8924 AAF0','4EBE 2E85 E969 1B30'),
  111. }
  112. }
  113. ref_subdir = '' if proto.base_coin == 'BTC' else proto.name.lower()
  114. altcoin_pfx = '' if proto.base_coin == 'BTC' else '-'+proto.base_coin
  115. tn_ext = ('','.testnet')[proto.testnet]
  116. os.environ['PYTHONPATH'] = repo_root
  117. spawn_cmd = [
  118. 'scripts/exec_wrapper.py',
  119. os.path.relpath(os.path.join(repo_root,'cmds','mmgen-tool')) ]
  120. if cfg.coverage:
  121. d,f = init_coverage()
  122. spawn_cmd = ['python3','-m','trace','--count','--coverdir='+d,'--file='+f] + spawn_cmd
  123. elif gc.platform == 'win':
  124. spawn_cmd = ['python3'] + spawn_cmd
  125. add_spawn_args = ['--data-dir='+tcfg['tmpdir']] + ['--{}{}'.format(
  126. k.replace('_','-'),
  127. '='+getattr(cfg,k) if getattr(cfg,k) != True else '')
  128. for k in ('testnet','rpc_host','regtest','coin','type') if getattr(cfg,k)]
  129. if cfg.list_cmds:
  130. fs = ' {:<{w}} - {}'
  131. Msg('Available commands:')
  132. w = max(map(len,cmd_data))
  133. for cmd in cmd_data:
  134. Msg(fs.format(cmd,cmd_data[cmd]['desc'],w=w))
  135. Msg('\nAvailable utilities:')
  136. Msg(fs.format('clean','Clean the tmp directory',w=w))
  137. sys.exit(0)
  138. if cfg.list_names:
  139. tcmd = ['python3','test/tooltest2.py','--list-tested-cmds']
  140. tested_in = {
  141. 'tooltest.py': [],
  142. 'test.py': (
  143. 'encrypt','decrypt','find_incog_data',
  144. 'addrfile_chksum','keyaddrfile_chksum','passwdfile_chksum',
  145. 'add_label','remove_label','remove_address','twview',
  146. 'getbalance','listaddresses','listaddress'),
  147. 'tooltest2.py': run(tcmd,stdout=PIPE,check=True).stdout.decode().split()
  148. }
  149. for v in cmd_data.values():
  150. tested_in['tooltest.py'] += list(v['cmd_data'].keys())
  151. msg(green("TESTED 'MMGEN-TOOL' COMMANDS"))
  152. for l in ('tooltest.py','tooltest2.py','test.py','test-release.sh'):
  153. msg(blue(l+':'))
  154. msg(' '+'\n '.join(sorted(tested_in[l])))
  155. ignore = ()
  156. from mmgen.tool import MMGenToolCmd
  157. uc = sorted(
  158. set(MMGenToolCmds) -
  159. set(ignore) -
  160. set(tested_in['tooltest.py']) -
  161. set(tested_in['tooltest2.py']) -
  162. set(tested_in['test.py']) -
  163. set(tested_in['test-release.sh'])
  164. )
  165. die(0,'\n{}\n {}'.format(yellow('Untested commands:'),'\n '.join(uc)))
  166. from mmgen.key import is_wif
  167. from mmgen.addr import is_coin_addr
  168. def is_wif_loc(s):
  169. return is_wif(proto,s)
  170. def is_coin_addr_loc(s):
  171. return is_coin_addr(proto,s)
  172. msg_w = 35
  173. def test_msg(m):
  174. m2 = f'Testing {m}'
  175. msg_r(green(m2+'\n') if cfg.verbose else '{:{w}}'.format( m2, w=msg_w+8 ))
  176. compressed = cfg.type or ('','compressed')['C' in proto.mmtypes]
  177. segwit = ('','segwit')['S' in proto.mmtypes]
  178. bech32 = ('','bech32')['B' in proto.mmtypes]
  179. type_compressed_arg = ([],['--type=' + (cfg.type or 'compressed')])[bool(cfg.type) or 'C' in proto.mmtypes]
  180. type_segwit_arg = ([],['--type=segwit'])['S' in proto.mmtypes]
  181. type_bech32_arg = ([],['--type=bech32'])['B' in proto.mmtypes]
  182. class MMGenToolTestUtils(object):
  183. def run_cmd(self,name,tool_args,kwargs='',extra_msg='',silent=False,strip=True,add_opts=[],binary=False):
  184. sys_cmd = (
  185. spawn_cmd +
  186. add_spawn_args +
  187. ['-r0','-d',tcfg['tmpdir']] +
  188. add_opts +
  189. [name.lower()] +
  190. tool_args +
  191. kwargs.split()
  192. )
  193. if extra_msg: extra_msg = f'({extra_msg})'
  194. full_name = ' '.join([name.lower()]+add_opts+kwargs.split()+extra_msg.split())
  195. if not silent:
  196. if cfg.verbose:
  197. sys.stderr.write(green(f'Testing {full_name}\nExecuting '))
  198. sys.stderr.write(cyan(' '.join(sys_cmd)+'\n'))
  199. else:
  200. msg_r('Testing {:{w}}'.format( full_name+':', w=msg_w ))
  201. cp = run(sys_cmd,stdout=PIPE,stderr=PIPE)
  202. out = cp.stdout
  203. err = cp.stderr
  204. if cfg.debug:
  205. try: dmsg(err.decode())
  206. except: dmsg(repr(err))
  207. if not binary:
  208. out = out.decode()
  209. if cp.returncode != 0:
  210. msg('{}\n{}\n{}'.format(
  211. red('FAILED'),
  212. yellow('Command stderr output:'),
  213. err.decode() ))
  214. die(2,f'Called process returned with an error (retcode {cp.returncode})')
  215. return (out,out.rstrip())[bool(strip)]
  216. def run_cmd_chk(self,name,f1,f2,kwargs='',extra_msg='',strip_hex=False,add_opts=[]):
  217. idata = read_from_file(f1).rstrip()
  218. odata = read_from_file(f2).rstrip()
  219. ret = self.run_cmd(name,[odata],kwargs=kwargs,extra_msg=extra_msg,add_opts=add_opts)
  220. vmsg('In: ' + repr(odata))
  221. vmsg('Out: ' + repr(ret))
  222. def cmp_equal(a,b):
  223. return (a.lstrip('0') == b.lstrip('0')) if strip_hex else (a == b)
  224. if cmp_equal(ret,idata): ok()
  225. else:
  226. die(4, "Error: values don't match:\nIn: {!r}\nOut: {!r}".format(idata,ret))
  227. return ret
  228. def run_cmd_nochk(self,name,f1,kwargs='',add_opts=[]):
  229. odata = read_from_file(f1).rstrip()
  230. ret = self.run_cmd(name,[odata],kwargs=kwargs,add_opts=add_opts)
  231. vmsg('In: ' + repr(odata))
  232. vmsg('Out: ' + repr(ret))
  233. return ret
  234. def run_cmd_out(self,name,carg=None,Return=False,kwargs='',fn_idx='',extra_msg='',
  235. literal=False,chkdata='',hush=False,add_opts=[]):
  236. if carg:
  237. write_to_tmpfile(tcfg,f'{name}{fn_idx}.in',carg+'\n')
  238. ret = self.run_cmd(name,([],[carg])[bool(carg)],kwargs=kwargs,
  239. extra_msg=extra_msg,add_opts=add_opts)
  240. if carg:
  241. vmsg('In: ' + repr(carg))
  242. vmsg('Out: ' + (repr(ret),ret)[literal])
  243. if ret or ret == '':
  244. write_to_tmpfile(tcfg,f'{name}{fn_idx}.out',ret+'\n')
  245. if chkdata:
  246. cmp_or_die(ret,chkdata)
  247. return
  248. if Return: return ret
  249. else:
  250. if not hush: ok()
  251. else:
  252. die(4,f'Error for command {name!r}')
  253. def run_cmd_randinput(self,name,strip=True,add_opts=[]):
  254. s = getrand(128)
  255. fn = name+'.in'
  256. write_to_tmpfile(tcfg,fn,s,binary=True)
  257. ret = self.run_cmd(name,[get_tmpfile(tcfg,fn)],strip=strip,add_opts=add_opts)
  258. fn = name+'.out'
  259. write_to_tmpfile(tcfg,fn,ret+'\n')
  260. ok()
  261. vmsg(f'Returned: {ret}')
  262. tu = MMGenToolTestUtils()
  263. def ok_or_die(val,chk_func,s,skip_ok=False):
  264. try: ret = chk_func(val)
  265. except: ret = False
  266. if ret:
  267. if not skip_ok: ok()
  268. else:
  269. die(4,f'Returned value {val!r} is not a {s}')
  270. class MMGenToolTestCmds(object):
  271. # Cryptocoin
  272. def randwif(self,name):
  273. for n,k in enumerate(['',compressed]):
  274. ao = ['--type='+k] if k else []
  275. ret = tu.run_cmd_out(name,add_opts=ao,Return=True,fn_idx=n+1)
  276. ok_or_die(ret,is_wif_loc,'WIF key')
  277. def randpair(self,name):
  278. for n,k in enumerate(['',compressed,segwit,bech32]):
  279. ao = ['--type='+k] if k else []
  280. wif,addr = tu.run_cmd_out(name,add_opts=ao,Return=True,fn_idx=n+1,literal=True).split()
  281. ok_or_die(wif,is_wif_loc,'WIF key',skip_ok=True)
  282. ok_or_die(addr,is_coin_addr_loc,'Coin address')
  283. def wif2addr(self,name,f1,f2,f3,f4):
  284. for n,f,k in (
  285. (1,f1,''),
  286. (2,f2,compressed),
  287. (3,f3,segwit),
  288. (4,f4,bech32)
  289. ):
  290. ao = ['--type='+k] if k else []
  291. wif = read_from_file(f).split()[0]
  292. tu.run_cmd_out(name,wif,add_opts=ao,fn_idx=n)
  293. def wif2hex(self,name,f1,f2,f3,f4):
  294. for n,f,m in (
  295. (1,f1,''),
  296. (2,f2,compressed),
  297. (3,f3,'{} for {}'.format( compressed or 'uncompressed', segwit or 'p2pkh' )),
  298. (4,f4,'{} for {}'.format( compressed or 'uncompressed', bech32 or 'p2pkh' ))
  299. ):
  300. wif = read_from_file(f).split()[0]
  301. tu.run_cmd_out(name,wif,fn_idx=n,extra_msg=m)
  302. def privhex2addr(self,name,f1,f2,f3,f4):
  303. keys = [read_from_file(f).rstrip() for f in (f1,f2,f3,f4)]
  304. for n,k in enumerate(('',compressed,segwit,bech32)):
  305. ao = ['--type='+k] if k else []
  306. ret = tu.run_cmd(name,[keys[n]],add_opts=ao).rstrip()
  307. iaddr = read_from_tmpfile(tcfg,f'randpair{n+1}.out').split()[-1]
  308. vmsg(f'Out: {ret}')
  309. cmp_or_die(iaddr,ret)
  310. ok()
  311. def hex2wif(self,name,f1,f2,f3,f4):
  312. for n,fi,fo,k in ((1,f1,f2,''),(2,f3,f4,compressed)):
  313. ao = ['--type='+k] if k else []
  314. ret = tu.run_cmd_chk(name,fi,fo,add_opts=ao)
  315. def addr2pubhash(self,name,f1,f2,f3,f4):
  316. for n,f,m,ao in (
  317. (1,f1,'',[]),
  318. (2,f2,'from {}'.format( compressed or 'uncompressed' ),[]),
  319. (4,f4,'',type_bech32_arg),
  320. ):
  321. addr = read_from_file(f).split()[-1]
  322. tu.run_cmd_out(name,addr,fn_idx=n,add_opts=ao,extra_msg=m)
  323. def pubhash2addr(self,name,f1,f2,f3,f4,f5,f6,f7,f8):
  324. for n,fi,fo,m,ao in (
  325. (1,f1,f2,'',[]),
  326. (2,f3,f4,'from {}'.format( compressed or 'uncompressed' ),[]),
  327. (4,f7,f8,'',type_bech32_arg)
  328. ):
  329. tu.run_cmd_chk(name,fi,fo,add_opts=ao,extra_msg=m)
  330. def privhex2pubhex(self,name,f1,f2,f3): # from Hex2wif
  331. addr = read_from_file(f3).strip()
  332. tu.run_cmd_out(name,addr,add_opts=type_compressed_arg,fn_idx=3) # what about uncompressed?
  333. def pubhex2redeem_script(self,name,f1,f2,f3): # from above
  334. addr = read_from_file(f3).strip()
  335. tu.run_cmd_out(name,addr,add_opts=type_segwit_arg,fn_idx=3)
  336. rs = read_from_tmpfile(tcfg,'privhex2pubhex3.out').strip()
  337. tu.run_cmd_out('pubhex2addr',rs,add_opts=type_segwit_arg,fn_idx=3,hush=True)
  338. addr1 = read_from_tmpfile(tcfg,'pubhex2addr3.out').strip()
  339. addr2 = read_from_tmpfile(tcfg,'randpair3.out').split()[1]
  340. cmp_or_die(addr1,addr2)
  341. ok()
  342. def wif2redeem_script(self,name,f1,f2,f3): # compare output with above
  343. wif = read_from_file(f3).split()[0]
  344. ret1 = tu.run_cmd_out(name,wif,add_opts=type_segwit_arg,fn_idx=3,Return=True)
  345. ret2 = read_from_tmpfile(tcfg,'pubhex2redeem_script3.out').strip()
  346. cmp_or_die(ret1,ret2)
  347. ok()
  348. def wif2segwit_pair(self,name,f1,f2): # does its own checking, so just run
  349. wif = read_from_file(f2).split()[0]
  350. tu.run_cmd_out(name,wif,add_opts=type_segwit_arg,fn_idx=2)
  351. def pubhex2addr(self,name,f1,f2,f3):
  352. addr = read_from_file(f3).strip()
  353. tu.run_cmd_out(name,addr,add_opts=type_segwit_arg,fn_idx=3)
  354. def pipetest(self,name,f1,f2,f3):
  355. wif = read_from_file(f3).split()[0]
  356. cmd = ( '{c} {a} wif2hex {wif}' +
  357. ' | {c} {a} --type=compressed privhex2pubhex -' +
  358. ' | {c} {a} --type=segwit pubhex2redeem_script -' +
  359. ' | {c} {a} --type=segwit redeem_script2addr -').format(
  360. c=' '.join(spawn_cmd),
  361. a=' '.join(add_spawn_args),
  362. wif=wif)
  363. test_msg('command piping')
  364. if cfg.verbose:
  365. sys.stderr.write(green('Executing ') + cyan(cmd) + '\n')
  366. res = run(cmd,stdout=PIPE,shell=True).stdout.decode().strip()
  367. addr = read_from_tmpfile(tcfg,'wif2addr3.out').strip()
  368. cmp_or_die(addr,res)
  369. ok()
  370. # Mnemonic
  371. def hex2mn(self,name):
  372. for n,size,m in ((1,16,'128-bit'),(2,24,'192-bit'),(3,32,'256-bit')):
  373. hexnum = getrandhex(size)
  374. tu.run_cmd_out(name,hexnum,fn_idx=n,extra_msg=m)
  375. def mn2hex(self,name,f1,f2,f3,f4,f5,f6):
  376. for f_i,f_o,m in ((f1,f2,'128-bit'),(f3,f4,'192-bit'),(f5,f6,'256-bit')):
  377. tu.run_cmd_chk(name,f_i,f_o,extra_msg=m,strip_hex=True)
  378. def mn_rand128(self,name): tu.run_cmd_out(name)
  379. def mn_rand192(self,name): tu.run_cmd_out(name)
  380. def mn_rand256(self,name): tu.run_cmd_out(name)
  381. def mn_stats(self,name): tu.run_cmd_out(name)
  382. def mn_printlist(self,name):
  383. tu.run_cmd(name,[])
  384. ok()
  385. # main()
  386. import time
  387. start_time = int(time.time())
  388. mk_tmpdir(tcfg['tmpdir'])
  389. def gen_deps_for_cmd(cmd,cdata):
  390. fns = []
  391. if cdata:
  392. name,code = cdata
  393. io,count = (code[:-1],int(code[-1])) if code[-1] in '0123456789' else (code,1)
  394. for c in range(count):
  395. fns += ['{}{}{}'.format(
  396. name,
  397. (c+1 if count > 1 else ''),
  398. ('.in' if ch == 'i' else '.out'),
  399. ) for ch in io]
  400. return fns
  401. def do_cmds(cmd_group):
  402. tc = MMGenToolTestCmds()
  403. gdata = cmd_data[cmd_group]['cmd_data']
  404. for cmd in gdata:
  405. fns = gen_deps_for_cmd(cmd,gdata[cmd])
  406. cmdline = [cmd] + [os.path.join(tcfg['tmpdir'],fn) for fn in fns]
  407. getattr(tc,cmd)(*cmdline)
  408. try:
  409. if cfg._args:
  410. if len(cfg._args) != 1:
  411. die(1,'Only one command may be specified')
  412. cmd = cfg._args[0]
  413. if cmd in cmd_data:
  414. cleandir(tcfg['tmpdir'],do_msg=True)
  415. msg('Running tests for {}:'.format( cmd_data[cmd]['desc'] ))
  416. do_cmds(cmd)
  417. elif cmd == 'clean':
  418. cleandir(tcfg['tmpdir'],do_msg=True)
  419. sys.exit(0)
  420. else:
  421. die(1,f'{cmd!r}: unrecognized command')
  422. else:
  423. cleandir(tcfg['tmpdir'],do_msg=True)
  424. for cmd in cmd_data:
  425. msg('Running tests for {}:'.format( cmd_data[cmd]['desc'] ))
  426. do_cmds(cmd)
  427. if cmd is not list(cmd_data.keys())[-1]: msg('')
  428. except KeyboardInterrupt:
  429. die(1,green('\nExiting at user request'))
  430. end_msg(int(time.time()) - start_time)