tooltest.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391
  1. #!/usr/bin/env python
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2016 Philemon <mmgen-py@yandex.com>
  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
  22. pn = os.path.dirname(sys.argv[0])
  23. os.chdir(os.path.join(pn,os.pardir))
  24. sys.path.__setitem__(0,os.path.abspath(os.curdir))
  25. # Import this _after_ local path's been added to sys.path
  26. from mmgen.common import *
  27. start_mscolor()
  28. from collections import OrderedDict
  29. cmd_data = OrderedDict([
  30. ('util', {
  31. 'desc': 'base conversion, hashing and file utilities',
  32. 'cmd_data': OrderedDict([
  33. ('strtob58', ()),
  34. ('b58tostr', ('strtob58','io')),
  35. ('hextob58', ()),
  36. ('b58tohex', ('hextob58','io')),
  37. ('b58randenc', ()),
  38. ('hextob32', ()),
  39. ('b32tohex', ('hextob32','io')),
  40. ('randhex', ()),
  41. ('id8', ()),
  42. ('id6', ()),
  43. ('str2id6', ()),
  44. ('sha256x2', ()),
  45. ('hexreverse', ()),
  46. ('hexlify', ()),
  47. ('hexdump', ()),
  48. ('unhexdump', ('hexdump','io')),
  49. ('rand2file', ()),
  50. ])
  51. }
  52. ),
  53. ('bitcoin', {
  54. 'desc': 'Bitcoin address/key commands',
  55. 'cmd_data': OrderedDict([
  56. ('randwif', ()),
  57. ('randpair', ()),
  58. ('wif2addr', ('randpair','o2')),
  59. ('wif2hex', ('randpair','o2')),
  60. ('privhex2addr', ('wif2hex','o2')), # wif from randpair o2
  61. ('hex2wif', ('wif2hex','io2')),
  62. ('addr2hexaddr', ('randpair','o2')),
  63. ('hexaddr2addr', ('addr2hexaddr','io2')),
  64. # ('pubkey2addr', ['<public key in hex format> [str]']),
  65. # ('pubkey2hexaddr', ['<public key in hex format> [str]']),
  66. ])
  67. }
  68. ),
  69. ('mnemonic', {
  70. 'desc': 'mnemonic commands',
  71. 'cmd_data': OrderedDict([
  72. ('hex2mn', ()),
  73. ('mn2hex', ('hex2mn','io3')),
  74. ('mn_rand128', ()),
  75. ('mn_rand192', ()),
  76. ('mn_rand256', ()),
  77. ('mn_stats', ()),
  78. ('mn_printlist', ()),
  79. ])
  80. }
  81. ),
  82. ('rpc', {
  83. 'desc': 'Bitcoind RPC commands',
  84. 'cmd_data': OrderedDict([
  85. # ('keyaddrfile_chksum', ()), # interactive
  86. ('addrfile_chksum', ()),
  87. ('getbalance', ()),
  88. ('listaddresses', ()),
  89. ('txview', ()),
  90. ])
  91. }
  92. ),
  93. ])
  94. cfg = {
  95. 'name': 'the tool utility',
  96. 'enc_passwd': 'Ten Satoshis',
  97. 'tmpdir': 'test/tmp10',
  98. 'tmpdir_num': 10,
  99. 'refdir': 'test/ref',
  100. 'txfile': 'FFB367[1.234].rawtx',
  101. 'addrfile': '98831F3A[1,31-33,500-501,1010-1011].addrs',
  102. 'addrfile_chk': '6FEF 6FB9 7B13 5D91',
  103. }
  104. opts_data = {
  105. 'desc': "Test suite for the 'mmgen-tool' utility",
  106. 'usage':'[options] [command]',
  107. 'options': """
  108. -h, --help Print this help message
  109. -l, --list-cmds List and describe the tests and commands in the test suite
  110. -s, --system Test scripts and modules installed on system rather than
  111. those in the repo root
  112. -v, --verbose Produce more verbose output
  113. """,
  114. 'notes': """
  115. If no command is given, the whole suite of tests is run.
  116. """
  117. }
  118. cmd_args = opts.init(opts_data,add_opts=['exact_output','profile'])
  119. if opt.system: sys.path.pop(0)
  120. if opt.list_cmds:
  121. fs = ' {:<{w}} - {}'
  122. Msg('Available commands:')
  123. w = max([len(i) for i in cmd_data])
  124. for cmd in cmd_data:
  125. Msg(fs.format(cmd,cmd_data[cmd]['desc'],w=w))
  126. Msg('\nAvailable utilities:')
  127. Msg(fs.format('clean','Clean the tmp directory',w=w))
  128. sys.exit()
  129. import binascii
  130. from mmgen.test import *
  131. from mmgen.tx import is_wif,is_btc_addr,is_b58_str
  132. class MMGenToolTestSuite(object):
  133. def __init__(self):
  134. pass
  135. def gen_deps_for_cmd(self,cmd,cdata):
  136. fns = []
  137. if cdata:
  138. name,code = cdata
  139. io,count = (code[:-1],int(code[-1])) if code[-1] in '0123456789' else (code,1)
  140. for c in range(count):
  141. fns += ['%s%s%s' % (
  142. name,
  143. ('',c+1)[count > 1],
  144. ('.out','.in')[ch=='i']
  145. ) for ch in io]
  146. return fns
  147. def get_num_exts_for_cmd(self,cmd,dpy): # dpy required here
  148. num = str(tool_cfgs['tmpdir_num'])
  149. # return only first file - a hack
  150. exts = gen_deps_for_cmd(dpy)
  151. return num,exts
  152. def do_cmds(self,cmd_group):
  153. cdata = cmd_data[cmd_group]['cmd_data']
  154. for cmd in cdata: self.do_cmd(cmd,cdata[cmd])
  155. def do_cmd(self,cmd,cdata):
  156. fns = self.gen_deps_for_cmd(cmd,cdata)
  157. file_list = [os.path.join(cfg['tmpdir'],fn) for fn in fns]
  158. self.__class__.__dict__[cmd](*([self,cmd] + file_list))
  159. def run_cmd(self,name,tool_args,kwargs='',extra_msg='',silent=False,strip=True):
  160. mmgen_tool = 'mmgen-tool'
  161. if not opt.system:
  162. mmgen_tool = os.path.join(os.curdir,mmgen_tool)
  163. sys_cmd = ['python', mmgen_tool, '-d',cfg['tmpdir'], name] + tool_args + kwargs.split()
  164. if extra_msg: extra_msg = '(%s)' % extra_msg
  165. full_name = ' '.join([name]+kwargs.split()+extra_msg.split())
  166. if not silent:
  167. if opt.verbose:
  168. sys.stderr.write(green('Testing %s\nExecuting ' % full_name))
  169. sys.stderr.write('%s\n' % cyan(repr(sys_cmd)))
  170. else:
  171. msg_r('Testing %-31s%s' % (full_name+':',''))
  172. import subprocess
  173. p = subprocess.Popen(
  174. sys_cmd,
  175. stdout=subprocess.PIPE,
  176. stderr=subprocess.PIPE,
  177. )
  178. a,b = p.communicate()
  179. retcode = p.wait()
  180. if retcode != 0:
  181. msg('%s\n%s\n%s'%(red('FAILED'),yellow('Command stderr output:'),b))
  182. die(1,red('Called process returned with an error (retcode %s)' % retcode))
  183. return (a,a.rstrip())[bool(strip)]
  184. def run_cmd_chk(self,name,f1,f2,kwargs='',extra_msg=''):
  185. idata = read_from_file(f1).rstrip()
  186. odata = read_from_file(f2).rstrip()
  187. ret = self.run_cmd(name,[odata],kwargs=kwargs,extra_msg=extra_msg)
  188. vmsg('In: ' + repr(odata))
  189. vmsg('Out: ' + repr(ret))
  190. if ret == idata: ok()
  191. else:
  192. die(3,red(
  193. "Error: values don't match:\nIn: %s\nOut: %s" % (repr(idata),repr(ret))))
  194. return ret
  195. def run_cmd_nochk(self,name,f1,kwargs=''):
  196. odata = read_from_file(f1).rstrip()
  197. ret = self.run_cmd(name,[odata],kwargs=kwargs)
  198. vmsg('In: ' + repr(odata))
  199. vmsg('Out: ' + repr(ret))
  200. return ret
  201. def run_cmd_out(self,name,carg=None,Return=False,kwargs='',fn_idx='',extra_msg='',literal=False,chkdata=''):
  202. if carg: write_to_tmpfile(cfg,'%s%s.in' % (name,fn_idx),carg+'\n')
  203. ret = self.run_cmd(name,([],[carg])[bool(carg)],kwargs=kwargs,extra_msg=extra_msg)
  204. if carg: vmsg('In: ' + repr(carg))
  205. vmsg('Out: ' + (repr(ret),ret)[literal])
  206. if ret or ret == '':
  207. write_to_tmpfile(cfg,'%s%s.out' % (name,fn_idx),ret+'\n')
  208. if chkdata:
  209. cmp_or_die(ret,chkdata)
  210. return
  211. if Return: return ret
  212. else: ok()
  213. else:
  214. die(3,red("Error for command '%s'" % name))
  215. def run_cmd_randinput(self,name,strip=True):
  216. s = os.urandom(128)
  217. fn = name+'.in'
  218. write_to_tmpfile(cfg,fn,s,binary=True)
  219. ret = self.run_cmd(name,[get_tmpfile_fn(cfg,fn)],strip=strip)
  220. fn = name+'.out'
  221. write_to_tmpfile(cfg,fn,ret+'\n')
  222. ok()
  223. vmsg('Returned: %s' % ret)
  224. def str2id6(self,name):
  225. s = getrandstr(120,no_space=True)
  226. s2 = ' %s %s %s %s %s ' % (s[:3],s[3:9],s[9:29],s[29:50],s[50:120])
  227. ret1 = self.run_cmd(name,[s],extra_msg='unspaced input'); ok()
  228. ret2 = self.run_cmd(name,[s2],extra_msg='spaced input')
  229. cmp_or_die(ret1,ret2)
  230. vmsg('Returned: %s' % ret1)
  231. def mn_rand128(self,name):
  232. self.run_cmd_out(name)
  233. def mn_rand192(self,name):
  234. self.run_cmd_out(name)
  235. def mn_rand256(self,name):
  236. self.run_cmd_out(name)
  237. def mn_stats(self,name):
  238. self.run_cmd_out(name)
  239. def mn_printlist(self,name):
  240. self.run_cmd(name,[])
  241. ok()
  242. def id6(self,name): self.run_cmd_randinput(name)
  243. def id8(self,name): self.run_cmd_randinput(name)
  244. def hexdump(self,name): self.run_cmd_randinput(name,strip=False)
  245. def unhexdump(self,name,fn1,fn2):
  246. ret = self.run_cmd(name,[fn2],strip=False)
  247. orig = read_from_file(fn1,binary=True)
  248. cmp_or_die(orig,ret)
  249. def rand2file(self,name):
  250. of = name + '.out'
  251. dlen = 1024
  252. self.run_cmd(name,[of,str(1024),'threads=4','silent=1'],strip=False)
  253. d = read_from_tmpfile(cfg,of,binary=True)
  254. cmp_or_die(dlen,len(d))
  255. def strtob58(self,name): self.run_cmd_out(name,getrandstr(16))
  256. def sha256x2(self,name): self.run_cmd_out(name,getrandstr(16))
  257. def hexreverse(self,name): self.run_cmd_out(name,getrandhex(24))
  258. def hexlify(self,name): self.run_cmd_out(name,getrandstr(24))
  259. def b58tostr(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  260. def hextob58(self,name): self.run_cmd_out(name,getrandhex(32))
  261. def b58tohex(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  262. def hextob32(self,name): self.run_cmd_out(name,getrandhex(24))
  263. def b32tohex(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  264. def b58randenc(self,name):
  265. ret = self.run_cmd_out(name,Return=True)
  266. ok_or_die(ret,is_b58_str,'base 58 string')
  267. def randhex(self,name):
  268. ret = self.run_cmd_out(name,Return=True)
  269. ok_or_die(ret,binascii.unhexlify,'hex string')
  270. def randwif(self,name):
  271. for n,k in enumerate(['','compressed=1']):
  272. ret = self.run_cmd_out(name,kwargs=k,Return=True,fn_idx=n+1)
  273. ok_or_die(ret,is_wif,'WIF key')
  274. def randpair(self,name):
  275. for n,k in enumerate(['','compressed=1']):
  276. wif,addr = self.run_cmd_out(name,kwargs=k,Return=True,fn_idx=n+1).split()
  277. ok_or_die(wif,is_wif,'WIF key',skip_ok=True)
  278. ok_or_die(addr,is_btc_addr,'Bitcoin address')
  279. def hex2wif(self,name,f1,f2,f3,f4):
  280. for n,fi,fo,k in (1,f1,f2,''),(2,f3,f4,'compressed=1'):
  281. ret = self.run_cmd_chk(name,fi,fo,kwargs=k)
  282. def wif2hex(self,name,f1,f2):
  283. for n,f,k in (1,f1,''),(2,f2,'compressed=1'):
  284. wif = read_from_file(f).split()[0]
  285. self.run_cmd_out(name,wif,kwargs=k,fn_idx=n)
  286. def wif2addr(self,name,f1,f2):
  287. for n,f,k in (1,f1,''),(2,f2,'compressed=1'):
  288. wif = read_from_file(f).split()[0]
  289. self.run_cmd_out(name,wif,kwargs=k,fn_idx=n)
  290. def addr2hexaddr(self,name,f1,f2):
  291. for n,f,m in (1,f1,''),(2,f2,'from compressed'):
  292. addr = read_from_file(f).split()[-1]
  293. self.run_cmd_out(name,addr,fn_idx=n,extra_msg=m)
  294. def hexaddr2addr(self,name,f1,f2,f3,f4):
  295. for n,fi,fo,m in (1,f1,f2,''),(2,f3,f4,'from compressed'):
  296. self.run_cmd_chk(name,fi,fo,extra_msg=m)
  297. def privhex2addr(self,name,f1,f2):
  298. key1 = read_from_file(f1).rstrip()
  299. key2 = read_from_file(f2).rstrip()
  300. for n,args in enumerate([[key1],[key2,'compressed=1']]):
  301. ret = self.run_cmd(name,args).rstrip()
  302. iaddr = read_from_tmpfile(cfg,'randpair%s.out' % (n+1)).split()[-1]
  303. cmp_or_die(iaddr,ret)
  304. def hex2mn(self,name):
  305. for n,size,m in(1,16,'128-bit'),(2,24,'192-bit'),(3,32,'256-bit'):
  306. hexnum = getrandhex(size)
  307. self.run_cmd_out(name,hexnum,fn_idx=n,extra_msg=m)
  308. def mn2hex(self,name,f1,f2,f3,f4,f5,f6):
  309. for f_i,f_o,m in (f1,f2,'128-bit'),(f3,f4,'192-bit'),(f5,f6,'256-bit'):
  310. self.run_cmd_chk(name,f_i,f_o,extra_msg=m)
  311. def getbalance(self,name):
  312. self.run_cmd_out(name,literal=True)
  313. def listaddresses(self,name):
  314. self.run_cmd_out(name,literal=True)
  315. def txview(self,name):
  316. fn = os.path.join(cfg['refdir'],cfg['txfile'])
  317. self.run_cmd_out(name,fn,literal=True)
  318. def addrfile_chksum(self,name):
  319. fn = os.path.join(cfg['refdir'],cfg['addrfile'])
  320. self.run_cmd_out(name,fn,literal=True,chkdata=cfg['addrfile_chk'])
  321. # main()
  322. import time
  323. start_time = int(time.time())
  324. ts = MMGenToolTestSuite()
  325. mk_tmpdir(cfg)
  326. if cmd_args:
  327. if len(cmd_args) != 1:
  328. die(1,'Only one command may be specified')
  329. cmd = cmd_args[0]
  330. if cmd in cmd_data:
  331. msg('Running tests for %s:' % cmd_data[cmd]['desc'])
  332. ts.do_cmds(cmd)
  333. elif cmd == 'clean':
  334. cleandir(cfg['tmpdir'])
  335. sys.exit()
  336. else:
  337. die(1,"'%s': unrecognized command" % cmd)
  338. else:
  339. cleandir(cfg['tmpdir'])
  340. for cmd in cmd_data:
  341. msg('Running tests for %s:' % cmd_data[cmd]['desc'])
  342. ts.do_cmds(cmd)
  343. if cmd is not cmd_data.keys()[-1]: msg('')
  344. t = int(time.time()) - start_time
  345. msg(green(
  346. 'All requested tests finished OK, elapsed time: %02i:%02i' % (t/60,t%60)))