tooltest.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2022 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. -s, --system Test scripts and modules installed on system rather than
  40. those in the repo root
  41. -t, --type=t Specify address type (valid options: 'zcash_z')
  42. -v, --verbose Produce more verbose output
  43. """,
  44. 'notes': """
  45. If no command is given, the whole suite of tests is run.
  46. """
  47. }
  48. }
  49. sys.argv = [sys.argv[0]] + ['--skip-cfg-file'] + sys.argv[1:]
  50. cmd_args = opts.init(opts_data,add_opts=['exact_output','profile'])
  51. from mmgen.protocol import init_proto_from_opts
  52. proto = init_proto_from_opts()
  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 opt.type == 'zcash_z':
  90. del cmd_data['cryptocoin']['cmd_data']['pubhash2addr']
  91. cfg = {
  92. 'name': 'the tool utility',
  93. 'enc_passwd': 'Ten Satoshis',
  94. 'tmpdir': 'test/tmp10',
  95. 'tmpdir_num': 10,
  96. 'refdir': 'test/ref',
  97. 'txfile': {
  98. 'btc': ('0B8D5A[15.31789,14,tl=1320969600].rawtx',
  99. '0C7115[15.86255,14,tl=1320969600].testnet.rawtx'),
  100. 'bch': ('460D4D-BCH[10.19764,tl=1320969600].rawtx',
  101. '359FD5-BCH[6.68868,tl=1320969600].testnet.rawtx'),
  102. 'ltc': ('AF3CDF-LTC[620.76194,1453,tl=1320969600].rawtx',
  103. 'A5A1E0-LTC[1454.64322,1453,tl=1320969600].testnet.rawtx'),
  104. },
  105. 'addrfile': '98831F3A{}[1,31-33,500-501,1010-1011]{}.addrs',
  106. 'addrfile_chk': {
  107. 'btc': ('6FEF 6FB9 7B13 5D91','424E 4326 CFFE 5F51'),
  108. 'bch': ('6FEF 6FB9 7B13 5D91','424E 4326 CFFE 5F51'),
  109. 'ltc': ('AD52 C3FE 8924 AAF0','4EBE 2E85 E969 1B30'),
  110. }
  111. }
  112. ref_subdir = '' if proto.base_coin == 'BTC' else proto.name.lower()
  113. altcoin_pfx = '' if proto.base_coin == 'BTC' else '-'+proto.base_coin
  114. tn_ext = ('','.testnet')[proto.testnet]
  115. mmgen_cmd = 'mmgen-tool'
  116. if not opt.system:
  117. os.environ['PYTHONPATH'] = repo_root
  118. mmgen_cmd = os.path.relpath(os.path.join(repo_root,'cmds',mmgen_cmd))
  119. spawn_cmd = ['scripts/exec_wrapper.py',mmgen_cmd]
  120. if opt.coverage:
  121. d,f = init_coverage()
  122. spawn_cmd = ['python3','-m','trace','--count','--coverdir='+d,'--file='+f] + spawn_cmd
  123. elif g.platform == 'win':
  124. spawn_cmd = ['python3'] + spawn_cmd
  125. add_spawn_args = ['--data-dir='+cfg['tmpdir']] + ['--{}{}'.format(
  126. k.replace('_','-'),'='+getattr(opt,k) if getattr(opt,k) != True else '')
  127. for k in ('testnet','rpc_host','regtest','coin','type') if getattr(opt,k)]
  128. if opt.list_cmds:
  129. fs = ' {:<{w}} - {}'
  130. Msg('Available commands:')
  131. w = max(map(len,cmd_data))
  132. for cmd in cmd_data:
  133. Msg(fs.format(cmd,cmd_data[cmd]['desc'],w=w))
  134. Msg('\nAvailable utilities:')
  135. Msg(fs.format('clean','Clean the tmp directory',w=w))
  136. sys.exit(0)
  137. if opt.list_names:
  138. tcmd = ['python3','test/tooltest2.py','--list-tested-cmds']
  139. tested_in = {
  140. 'tooltest.py': [],
  141. 'test.py': (
  142. 'encrypt','decrypt','find_incog_data',
  143. 'addrfile_chksum','keyaddrfile_chksum','passwdfile_chksum',
  144. 'add_label','remove_label','remove_address','twview',
  145. 'getbalance','listaddresses','listaddress'),
  146. 'tooltest2.py': run(tcmd,stdout=PIPE,check=True).stdout.decode().split()
  147. }
  148. for v in cmd_data.values():
  149. tested_in['tooltest.py'] += list(v['cmd_data'].keys())
  150. msg(green("TESTED 'MMGEN-TOOL' COMMANDS"))
  151. for l in ('tooltest.py','tooltest2.py','test.py','test-release.sh'):
  152. msg(blue(l+':'))
  153. msg(' '+'\n '.join(sorted(tested_in[l])))
  154. ignore = ()
  155. from mmgen.tool import MMGenToolCmd
  156. uc = sorted(
  157. set(MMGenToolCmds) -
  158. set(ignore) -
  159. set(tested_in['tooltest.py']) -
  160. set(tested_in['tooltest2.py']) -
  161. set(tested_in['test.py']) -
  162. set(tested_in['test-release.sh'])
  163. )
  164. die(0,'\n{}\n {}'.format(yellow('Untested commands:'),'\n '.join(uc)))
  165. from mmgen.tx import is_wif,is_coin_addr
  166. def is_wif_loc(s):
  167. return is_wif(proto,s)
  168. def is_coin_addr_loc(s):
  169. return is_coin_addr(proto,s)
  170. msg_w = 35
  171. def test_msg(m):
  172. m2 = f'Testing {m}'
  173. msg_r(green(m2+'\n') if opt.verbose else '{:{w}}'.format( m2, w=msg_w+8 ))
  174. compressed = ('','compressed')['C' in proto.mmtypes]
  175. segwit = ('','segwit')['S' in proto.mmtypes]
  176. bech32 = ('','bech32')['B' in proto.mmtypes]
  177. type_compressed_arg = ([],['--type=compressed'])['C' in proto.mmtypes]
  178. type_segwit_arg = ([],['--type=segwit'])['S' in proto.mmtypes]
  179. type_bech32_arg = ([],['--type=bech32'])['B' in proto.mmtypes]
  180. class MMGenToolTestUtils(object):
  181. def run_cmd(self,name,tool_args,kwargs='',extra_msg='',silent=False,strip=True,add_opts=[],binary=False):
  182. sys_cmd = (
  183. spawn_cmd +
  184. add_spawn_args +
  185. ['-r0','-d',cfg['tmpdir']] +
  186. add_opts +
  187. [name.lower()] +
  188. tool_args +
  189. kwargs.split()
  190. )
  191. if extra_msg: extra_msg = f'({extra_msg})'
  192. full_name = ' '.join([name.lower()]+add_opts+kwargs.split()+extra_msg.split())
  193. if not silent:
  194. if opt.verbose:
  195. sys.stderr.write(green(f'Testing {full_name}\nExecuting '))
  196. sys.stderr.write(cyan(' '.join(sys_cmd)+'\n'))
  197. else:
  198. msg_r('Testing {:{w}}'.format( full_name+':', w=msg_w ))
  199. cp = run(sys_cmd,stdout=PIPE,stderr=PIPE)
  200. out = cp.stdout
  201. err = cp.stderr
  202. if opt.debug:
  203. try: dmsg(err.decode())
  204. except: dmsg(repr(err))
  205. if not binary:
  206. out = out.decode()
  207. if cp.returncode != 0:
  208. msg('{}\n{}\n{}'.format(
  209. red('FAILED'),
  210. yellow('Command stderr output:'),
  211. err.decode() ))
  212. rdie(1,f'Called process returned with an error (retcode {cp.returncode})')
  213. return (out,out.rstrip())[bool(strip)]
  214. def run_cmd_chk(self,name,f1,f2,kwargs='',extra_msg='',strip_hex=False,add_opts=[]):
  215. idata = read_from_file(f1).rstrip()
  216. odata = read_from_file(f2).rstrip()
  217. ret = self.run_cmd(name,[odata],kwargs=kwargs,extra_msg=extra_msg,add_opts=add_opts)
  218. vmsg('In: ' + repr(odata))
  219. vmsg('Out: ' + repr(ret))
  220. def cmp_equal(a,b):
  221. return (a.lstrip('0') == b.lstrip('0')) if strip_hex else (a == b)
  222. if cmp_equal(ret,idata): ok()
  223. else:
  224. fs = "Error: values don't match:\nIn: {!r}\nOut: {!r}"
  225. rdie(3,fs.format(idata,ret))
  226. return ret
  227. def run_cmd_nochk(self,name,f1,kwargs='',add_opts=[]):
  228. odata = read_from_file(f1).rstrip()
  229. ret = self.run_cmd(name,[odata],kwargs=kwargs,add_opts=add_opts)
  230. vmsg('In: ' + repr(odata))
  231. vmsg('Out: ' + repr(ret))
  232. return ret
  233. def run_cmd_out(self,name,carg=None,Return=False,kwargs='',fn_idx='',extra_msg='',
  234. literal=False,chkdata='',hush=False,add_opts=[]):
  235. if carg: write_to_tmpfile(cfg,f'{name}{fn_idx}.in',carg+'\n')
  236. ret = self.run_cmd(name,([],[carg])[bool(carg)],kwargs=kwargs,
  237. extra_msg=extra_msg,add_opts=add_opts)
  238. if carg: vmsg('In: ' + repr(carg))
  239. vmsg('Out: ' + (repr(ret),ret)[literal])
  240. if ret or ret == '':
  241. write_to_tmpfile(cfg,f'{name}{fn_idx}.out',ret+'\n')
  242. if chkdata:
  243. cmp_or_die(ret,chkdata)
  244. return
  245. if Return: return ret
  246. else:
  247. if not hush: ok()
  248. else:
  249. rdie(3,f'Error for command {name!r}')
  250. def run_cmd_randinput(self,name,strip=True,add_opts=[]):
  251. s = getrand(128)
  252. fn = name+'.in'
  253. write_to_tmpfile(cfg,fn,s,binary=True)
  254. ret = self.run_cmd(name,[get_tmpfile(cfg,fn)],strip=strip,add_opts=add_opts)
  255. fn = name+'.out'
  256. write_to_tmpfile(cfg,fn,ret+'\n')
  257. ok()
  258. vmsg(f'Returned: {ret}')
  259. tu = MMGenToolTestUtils()
  260. def ok_or_die(val,chk_func,s,skip_ok=False):
  261. try: ret = chk_func(val)
  262. except: ret = False
  263. if ret:
  264. if not skip_ok: ok()
  265. else:
  266. rdie(3,f'Returned value {val!r} is not a {s}')
  267. class MMGenToolTestCmds(object):
  268. # Cryptocoin
  269. def randwif(self,name):
  270. for n,k in enumerate(['',compressed]):
  271. ao = ['--type='+k] if k else []
  272. ret = tu.run_cmd_out(name,add_opts=ao,Return=True,fn_idx=n+1)
  273. ok_or_die(ret,is_wif_loc,'WIF key')
  274. def randpair(self,name):
  275. for n,k in enumerate(['',compressed,segwit,bech32]):
  276. ao = ['--type='+k] if k else []
  277. wif,addr = tu.run_cmd_out(name,add_opts=ao,Return=True,fn_idx=n+1,literal=True).split()
  278. ok_or_die(wif,is_wif_loc,'WIF key',skip_ok=True)
  279. ok_or_die(addr,is_coin_addr_loc,'Coin address')
  280. def wif2addr(self,name,f1,f2,f3,f4):
  281. for n,f,k in (
  282. (1,f1,''),
  283. (2,f2,compressed),
  284. (3,f3,segwit),
  285. (4,f4,bech32)
  286. ):
  287. ao = ['--type='+k] if k else []
  288. wif = read_from_file(f).split()[0]
  289. tu.run_cmd_out(name,wif,add_opts=ao,fn_idx=n)
  290. def wif2hex(self,name,f1,f2,f3,f4):
  291. for n,f,m in (
  292. (1,f1,''),
  293. (2,f2,compressed),
  294. (3,f3,'{} for {}'.format( compressed or 'uncompressed', segwit or 'p2pkh' )),
  295. (4,f4,'{} for {}'.format( compressed or 'uncompressed', bech32 or 'p2pkh' ))
  296. ):
  297. wif = read_from_file(f).split()[0]
  298. tu.run_cmd_out(name,wif,fn_idx=n,extra_msg=m)
  299. def privhex2addr(self,name,f1,f2,f3,f4):
  300. keys = [read_from_file(f).rstrip() for f in (f1,f2,f3,f4)]
  301. for n,k in enumerate(('',compressed,segwit,bech32)):
  302. ao = ['--type='+k] if k else []
  303. ret = tu.run_cmd(name,[keys[n]],add_opts=ao).rstrip()
  304. iaddr = read_from_tmpfile(cfg,f'randpair{n+1}.out').split()[-1]
  305. vmsg(f'Out: {ret}')
  306. cmp_or_die(iaddr,ret)
  307. ok()
  308. def hex2wif(self,name,f1,f2,f3,f4):
  309. for n,fi,fo,k in ((1,f1,f2,''),(2,f3,f4,compressed)):
  310. ao = ['--type='+k] if k else []
  311. ret = tu.run_cmd_chk(name,fi,fo,add_opts=ao)
  312. def addr2pubhash(self,name,f1,f2,f3,f4):
  313. for n,f,m,ao in (
  314. (1,f1,'',[]),
  315. (2,f2,'from {}'.format( compressed or 'uncompressed' ),[]),
  316. (4,f4,'',type_bech32_arg),
  317. ):
  318. addr = read_from_file(f).split()[-1]
  319. tu.run_cmd_out(name,addr,fn_idx=n,add_opts=ao,extra_msg=m)
  320. def pubhash2addr(self,name,f1,f2,f3,f4,f5,f6,f7,f8):
  321. for n,fi,fo,m,ao in (
  322. (1,f1,f2,'',[]),
  323. (2,f3,f4,'from {}'.format( compressed or 'uncompressed' ),[]),
  324. (4,f7,f8,'',type_bech32_arg)
  325. ):
  326. tu.run_cmd_chk(name,fi,fo,add_opts=ao,extra_msg=m)
  327. def privhex2pubhex(self,name,f1,f2,f3): # from Hex2wif
  328. addr = read_from_file(f3).strip()
  329. tu.run_cmd_out(name,addr,add_opts=type_compressed_arg,fn_idx=3) # what about uncompressed?
  330. def pubhex2redeem_script(self,name,f1,f2,f3): # from above
  331. addr = read_from_file(f3).strip()
  332. tu.run_cmd_out(name,addr,add_opts=type_segwit_arg,fn_idx=3)
  333. rs = read_from_tmpfile(cfg,'privhex2pubhex3.out').strip()
  334. tu.run_cmd_out('pubhex2addr',rs,add_opts=type_segwit_arg,fn_idx=3,hush=True)
  335. addr1 = read_from_tmpfile(cfg,'pubhex2addr3.out').strip()
  336. addr2 = read_from_tmpfile(cfg,'randpair3.out').split()[1]
  337. cmp_or_die(addr1,addr2)
  338. ok()
  339. def wif2redeem_script(self,name,f1,f2,f3): # compare output with above
  340. wif = read_from_file(f3).split()[0]
  341. ret1 = tu.run_cmd_out(name,wif,add_opts=type_segwit_arg,fn_idx=3,Return=True)
  342. ret2 = read_from_tmpfile(cfg,'pubhex2redeem_script3.out').strip()
  343. cmp_or_die(ret1,ret2)
  344. ok()
  345. def wif2segwit_pair(self,name,f1,f2): # does its own checking, so just run
  346. wif = read_from_file(f2).split()[0]
  347. tu.run_cmd_out(name,wif,add_opts=type_segwit_arg,fn_idx=2)
  348. def pubhex2addr(self,name,f1,f2,f3):
  349. addr = read_from_file(f3).strip()
  350. tu.run_cmd_out(name,addr,add_opts=type_segwit_arg,fn_idx=3)
  351. def pipetest(self,name,f1,f2,f3):
  352. wif = read_from_file(f3).split()[0]
  353. cmd = ( '{c} {a} wif2hex {wif}' +
  354. ' | {c} {a} --type=compressed privhex2pubhex -' +
  355. ' | {c} {a} --type=segwit pubhex2redeem_script -' +
  356. ' | {c} {a} hash160 -' +
  357. ' | {c} {a} --type=segwit pubhash2addr -').format(
  358. c=' '.join(spawn_cmd),
  359. a=' '.join(add_spawn_args),
  360. wif=wif)
  361. test_msg('command piping')
  362. if opt.verbose:
  363. sys.stderr.write(green('Executing ') + cyan(cmd) + '\n')
  364. res = run(cmd,stdout=PIPE,shell=True).stdout.decode().strip()
  365. addr = read_from_tmpfile(cfg,'wif2addr3.out').strip()
  366. cmp_or_die(addr,res)
  367. ok()
  368. # Mnemonic
  369. def hex2mn(self,name):
  370. for n,size,m in ((1,16,'128-bit'),(2,24,'192-bit'),(3,32,'256-bit')):
  371. hexnum = getrandhex(size)
  372. tu.run_cmd_out(name,hexnum,fn_idx=n,extra_msg=m)
  373. def mn2hex(self,name,f1,f2,f3,f4,f5,f6):
  374. for f_i,f_o,m in ((f1,f2,'128-bit'),(f3,f4,'192-bit'),(f5,f6,'256-bit')):
  375. tu.run_cmd_chk(name,f_i,f_o,extra_msg=m,strip_hex=True)
  376. def mn_rand128(self,name): tu.run_cmd_out(name)
  377. def mn_rand192(self,name): tu.run_cmd_out(name)
  378. def mn_rand256(self,name): tu.run_cmd_out(name)
  379. def mn_stats(self,name): tu.run_cmd_out(name)
  380. def mn_printlist(self,name):
  381. tu.run_cmd(name,[])
  382. ok()
  383. # main()
  384. import time
  385. start_time = int(time.time())
  386. mk_tmpdir(cfg['tmpdir'])
  387. def gen_deps_for_cmd(cmd,cdata):
  388. fns = []
  389. if cdata:
  390. name,code = cdata
  391. io,count = (code[:-1],int(code[-1])) if code[-1] in '0123456789' else (code,1)
  392. for c in range(count):
  393. fns += ['{}{}{}'.format(
  394. name,
  395. (c+1 if count > 1 else ''),
  396. ('.in' if ch == 'i' else '.out'),
  397. ) for ch in io]
  398. return fns
  399. def do_cmds(cmd_group):
  400. tc = MMGenToolTestCmds()
  401. gdata = cmd_data[cmd_group]['cmd_data']
  402. for cmd in gdata:
  403. fns = gen_deps_for_cmd(cmd,gdata[cmd])
  404. cmdline = [cmd] + [os.path.join(cfg['tmpdir'],fn) for fn in fns]
  405. getattr(tc,cmd)(*cmdline)
  406. try:
  407. if cmd_args:
  408. if len(cmd_args) != 1:
  409. die(1,'Only one command may be specified')
  410. cmd = cmd_args[0]
  411. if cmd in cmd_data:
  412. cleandir(cfg['tmpdir'],do_msg=True)
  413. msg('Running tests for {}:'.format( cmd_data[cmd]['desc'] ))
  414. do_cmds(cmd)
  415. elif cmd == 'clean':
  416. cleandir(cfg['tmpdir'],do_msg=True)
  417. sys.exit(0)
  418. else:
  419. die(1,f'{cmd!r}: unrecognized command')
  420. else:
  421. cleandir(cfg['tmpdir'],do_msg=True)
  422. for cmd in cmd_data:
  423. msg('Running tests for {}:'.format( cmd_data[cmd]['desc'] ))
  424. do_cmds(cmd)
  425. if cmd is not list(cmd_data.keys())[-1]: msg('')
  426. except KeyboardInterrupt:
  427. die(1,green('\nExiting at user request'))
  428. end_msg(int(time.time()) - start_time)