tooltest.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. #!/usr/bin/python
  2. # Chdir to repo root.
  3. # Since script is not in repo root, fix sys.path so that modules are
  4. # imported from repo, not system.
  5. import sys,os
  6. pn = os.path.dirname(sys.argv[0])
  7. os.chdir(os.path.join(pn,os.pardir))
  8. sys.path.__setitem__(0,os.path.abspath(os.curdir))
  9. import mmgen.opt as opt
  10. from mmgen.util import msg,msg_r,vmsg,vmsg_r,Msg,mmsg,mdie
  11. from collections import OrderedDict
  12. cmd_data = OrderedDict([
  13. ('util', {
  14. 'desc': "base conversion, hashing and file utilities",
  15. 'cmd_data': OrderedDict([
  16. ('strtob58', ()),
  17. ('b58tostr', ("strtob58","io")),
  18. ('hextob58', ()),
  19. ('b58tohex', ("hextob58","io")),
  20. ('b58randenc', ()),
  21. ('hextob32', ()),
  22. ('b32tohex', ("hextob32","io")),
  23. ('randhex', ()),
  24. ('id8', ()),
  25. ('id6', ()),
  26. ('str2id6', ()),
  27. ("sha256x2", ()),
  28. ("hexreverse", ()),
  29. ("hexlify", ()),
  30. ('hexdump', ()),
  31. ('unhexdump', ("hexdump","io")),
  32. ('rand2file', ()),
  33. ])
  34. }
  35. ),
  36. ('bitcoin', {
  37. 'desc': "Bitcoin address/key commands",
  38. 'cmd_data': OrderedDict([
  39. ('randwif', ()),
  40. ('randpair', ()),
  41. ('wif2addr', ("randpair","o2")),
  42. ('wif2hex', ("randpair","o2")),
  43. ('privhex2addr', ("wif2hex","o2")), # wif from randpair o2
  44. ('hex2wif', ("wif2hex","io2")),
  45. ('addr2hexaddr', ("randpair","o2")),
  46. ('hexaddr2addr', ("addr2hexaddr","io2")),
  47. # ("pubkey2addr", ['<public key in hex format> [str]']),
  48. # ("pubkey2hexaddr", ['<public key in hex format> [str]']),
  49. ])
  50. }
  51. ),
  52. ('mnemonic', {
  53. 'desc': "mnemonic commands",
  54. 'cmd_data': OrderedDict([
  55. ('hex2mn', ()),
  56. ('mn2hex', ("hex2mn","io3")),
  57. ('mn_rand128', ()),
  58. ('mn_rand192', ()),
  59. ('mn_rand256', ()),
  60. ('mn_stats', ()),
  61. ('mn_printlist', ()),
  62. ])
  63. }
  64. )
  65. ])
  66. cfg = {
  67. 'name': "the tool utility",
  68. 'enc_passwd': "Ten Satoshis",
  69. 'tmpdir': "test/tmp10",
  70. 'tmpdir_num': 10,
  71. }
  72. opts_data = {
  73. 'desc': "Test suite for the 'mmgen-tool' utility",
  74. 'usage':"[options] [command]",
  75. 'options': """
  76. -h, --help Print this help message
  77. -l, --list-cmds List and describe the tests and commands in the test suite
  78. -s, --system Test scripts and modules installed on system rather than
  79. those in the repo root
  80. -v, --verbose Produce more verbose output
  81. """,
  82. 'notes': """
  83. If no command is given, the whole suite of tests is run.
  84. """
  85. }
  86. cmd_args = opt.opts.init(opts_data,add_opts=["exact_output"])
  87. if opt.system: sys.path.pop(0)
  88. if opt.list_cmds:
  89. fs = " {:<{w}} - {}"
  90. Msg("Available commands:")
  91. w = max([len(i) for i in cmd_data])
  92. for cmd in cmd_data:
  93. Msg(fs.format(cmd,cmd_data[cmd]['desc'],w=w))
  94. Msg("\nAvailable utilities:")
  95. Msg(fs.format("clean","Clean the tmp directory",w=w))
  96. sys.exit()
  97. import binascii
  98. from mmgen.test import *
  99. from mmgen.util import get_data_from_file,write_to_file,get_lines_from_file
  100. from mmgen.tx import is_wif,is_btc_addr,is_b58_str
  101. from mmgen.mnemonic import get_seed_from_mnemonic
  102. class MMGenToolTestSuite(object):
  103. def __init__(self):
  104. pass
  105. def gen_deps_for_cmd(self,cmd,cdata):
  106. fns = []
  107. if cdata:
  108. name,code = cdata
  109. io,count = code,1
  110. if code[-1] in "0123456789":
  111. io,count = code[:-1],int(code[-1])
  112. for c in range(count):
  113. fns += ["%s%s%s" % (
  114. name,
  115. (c+1 if count > 1 else ""),
  116. ('.in' if ch=='i' else '.out')
  117. ) for ch in io]
  118. return fns
  119. def get_num_exts_for_cmd(self,cmd,dpy): # dpy required here
  120. num = str(tool_cfgs['tmpdir_num'])
  121. # return only first file - a hack
  122. exts = gen_deps_for_cmd(dpy)
  123. return num,exts
  124. def do_cmds(self,cmd_group):
  125. cdata = cmd_data[cmd_group]['cmd_data']
  126. for cmd in cdata: self.do_cmd(cmd,cdata[cmd])
  127. def do_cmd(self,cmd,cdata):
  128. fns = self.gen_deps_for_cmd(cmd,cdata)
  129. file_list = [os.path.join(cfg['tmpdir'],fn) for fn in fns]
  130. self.__class__.__dict__[cmd](*([self,cmd] + file_list))
  131. def run_cmd(self,name,tool_args,kwargs="",extra_msg="",silent=False):
  132. mmgen_tool = "mmgen-tool"
  133. if not opt.system:
  134. mmgen_tool = os.path.join(os.curdir,mmgen_tool)
  135. sys_cmd = [mmgen_tool, "-d",cfg['tmpdir'], name] + tool_args + kwargs.split()
  136. if extra_msg: extra_msg = "(%s)" % extra_msg
  137. full_name = " ".join([name]+kwargs.split()+extra_msg.split())
  138. if not silent:
  139. if opt.verbose:
  140. sys.stderr.write(green("Testing %s\nExecuting " % full_name))
  141. sys.stderr.write("%s\n" % cyan(repr(sys_cmd)))
  142. else:
  143. msg_r("Testing %-31s%s" % (full_name+":",""))
  144. import subprocess
  145. return subprocess.check_output(sys_cmd)
  146. def run_cmd_chk(self,name,f1,f2,kwargs="",extra_msg=""):
  147. idata = read_from_file(f1)[:-1]
  148. odata = read_from_file(f2)[:-1]
  149. ret = self.run_cmd(name,[odata],kwargs=kwargs,extra_msg=extra_msg)[:-1]
  150. vmsg("In: " + repr(odata))
  151. vmsg("Out: " + repr(ret))
  152. if ret == idata: ok()
  153. else:
  154. msg(red(
  155. "Error: values don't match:\nIn: %s\nOut: %s" % (repr(idata),repr(ret))))
  156. sys.exit(3)
  157. return ret
  158. def run_cmd_nochk(self,name,f1,kwargs=""):
  159. odata = read_from_file(f1)[:-1]
  160. ret = self.run_cmd(name,[odata],kwargs=kwargs)[:-1]
  161. vmsg("In: " + repr(odata))
  162. vmsg("Out: " + repr(ret))
  163. return ret
  164. def run_cmd_out(self,name,carg=None,Return=False,kwargs="",fn_idx="",extra_msg=""):
  165. if carg: write_to_tmpfile(cfg,"%s%s.in" % (name,fn_idx),carg+"\n")
  166. ret = self.run_cmd(name,[carg] if carg else [],kwargs=kwargs,extra_msg=extra_msg)
  167. if carg: vmsg("In: " + repr(carg))
  168. vmsg("Out: " + repr(ret[:-1]))
  169. if ret:
  170. write_to_tmpfile(cfg,"%s%s.out" % (name,fn_idx),ret)
  171. if Return: return ret
  172. else: ok()
  173. else:
  174. msg(red("Error for command '%s'" % name))
  175. sys.exit(3)
  176. def run_cmd_randfileinput(self,name):
  177. s = os.urandom(128)
  178. fn = name+".in"
  179. write_to_tmpfile(cfg,fn,s)
  180. ret = self.run_cmd(name,[get_tmpfile_fn(cfg,fn)])
  181. fn = name+".out"
  182. write_to_tmpfile(cfg,fn,ret)
  183. ok()
  184. vmsg("Returned: %s" % ret)
  185. def str2id6(self,name):
  186. s = getrandstr(120,no_space=True)
  187. s2 = " %s %s %s %s %s " % (s[:3],s[3:9],s[9:29],s[29:50],s[50:120])
  188. ret1 = self.run_cmd(name,[s],extra_msg="unspaced input"); ok()
  189. ret2 = self.run_cmd(name,[s2],extra_msg="spaced input")
  190. cmp_or_die(ret1,ret2)
  191. vmsg("Returned: %s" % ret1)
  192. def mn_rand128(self,name):
  193. self.run_cmd_out(name)
  194. def mn_rand192(self,name):
  195. self.run_cmd_out(name)
  196. def mn_rand256(self,name):
  197. self.run_cmd_out(name)
  198. def mn_stats(self,name):
  199. self.run_cmd_out(name)
  200. def mn_printlist(self,name):
  201. self.run_cmd(name,[])
  202. ok()
  203. def id6(self,name): self.run_cmd_randfileinput(name)
  204. def id8(self,name): self.run_cmd_randfileinput(name)
  205. def hexdump(self,name): self.run_cmd_randfileinput(name)
  206. def unhexdump(self,name,fn1,fn2):
  207. ret = self.run_cmd(name,[fn2])
  208. orig = read_from_file(fn1)
  209. cmp_or_die(orig,ret)
  210. def rand2file(self,name):
  211. of = name + ".out"
  212. dlen = 1024
  213. self.run_cmd(name,[of,str(1024),"threads=4","silent=1"])
  214. d = read_from_tmpfile(cfg,of)
  215. cmp_or_die(dlen,len(d))
  216. def strtob58(self,name): self.run_cmd_out(name,getrandstr(16))
  217. def sha256x2(self,name): self.run_cmd_out(name,getrandstr(16))
  218. def hexreverse(self,name): self.run_cmd_out(name,getrandhex(24))
  219. def hexlify(self,name): self.run_cmd_out(name,getrandstr(24))
  220. def b58tostr(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  221. def hextob58(self,name): self.run_cmd_out(name,getrandhex(32))
  222. def b58tohex(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  223. def hextob32(self,name): self.run_cmd_out(name,getrandhex(24))
  224. def b32tohex(self,name,f1,f2): self.run_cmd_chk(name,f1,f2)
  225. def b58randenc(self,name):
  226. ret = self.run_cmd_out(name,Return=True)
  227. ok_or_die(ret[:-1],is_b58_str,"base 58 string")
  228. def randhex(self,name):
  229. ret = self.run_cmd_out(name,Return=True)
  230. ok_or_die(ret[:-1],binascii.unhexlify,"hex string")
  231. def randwif(self,name):
  232. for n,k in enumerate(["","compressed=1"]):
  233. ret = self.run_cmd_out(name,kwargs=k,Return=True,fn_idx=n+1)
  234. ok_or_die(ret[:-1],is_wif,"WIF key")
  235. def randpair(self,name):
  236. for n,k in enumerate(["","compressed=1"]):
  237. wif,addr = self.run_cmd_out(name,kwargs=k,Return=True,fn_idx=n+1).split()
  238. ok_or_die(wif,is_wif,"WIF key",skip_ok=True)
  239. ok_or_die(addr,is_btc_addr,"Bitcoin address")
  240. def hex2wif(self,name,f1,f2,f3,f4):
  241. for n,fi,fo,k in (1,f1,f2,""),(2,f3,f4,"compressed=1"):
  242. ret = self.run_cmd_chk(name,fi,fo,kwargs=k)
  243. def wif2hex(self,name,f1,f2):
  244. for n,f,k in (1,f1,""),(2,f2,"compressed=1"):
  245. wif = read_from_file(f).split()[0]
  246. self.run_cmd_out(name,wif,kwargs=k,fn_idx=n)
  247. def wif2addr(self,name,f1,f2):
  248. for n,f,k in (1,f1,""),(2,f2,"compressed=1"):
  249. wif = read_from_file(f).split()[0]
  250. self.run_cmd_out(name,wif,kwargs=k,fn_idx=n)
  251. def addr2hexaddr(self,name,f1,f2):
  252. for n,f,m in (1,f1,""),(2,f2,"from compressed"):
  253. addr = read_from_file(f).split()[-1]
  254. self.run_cmd_out(name,addr,fn_idx=n,extra_msg=m)
  255. def hexaddr2addr(self,name,f1,f2,f3,f4):
  256. for n,fi,fo,m in (1,f1,f2,""),(2,f3,f4,"from compressed"):
  257. self.run_cmd_chk(name,fi,fo,extra_msg=m)
  258. def privhex2addr(self,name,f1,f2):
  259. key1 = read_from_file(f1)
  260. key2 = read_from_file(f2)
  261. for n,args in enumerate([[key1],[key2,"compressed=1"]]):
  262. ret = self.run_cmd(name,args).rstrip()
  263. iaddr = read_from_tmpfile(cfg,"randpair%s.out" % (n+1)).split()[-1]
  264. cmp_or_die(iaddr,ret)
  265. def hex2mn(self,name):
  266. for n,size,m in(1,16,"128-bit"),(2,24,"192-bit"),(3,32,"256-bit"):
  267. hexnum = getrandhex(size)
  268. self.run_cmd_out(name,hexnum,fn_idx=n,extra_msg=m)
  269. def mn2hex(self,name,f1,f2,f3,f4,f5,f6):
  270. for f_i,f_o,m in (f1,f2,"128-bit"),(f3,f4,"192-bit"),(f5,f6,"256-bit"):
  271. self.run_cmd_chk(name,f_i,f_o,extra_msg=m)
  272. # main()
  273. import time
  274. start_time = int(time.time())
  275. ts = MMGenToolTestSuite()
  276. mk_tmpdir(cfg)
  277. if cmd_args:
  278. if len(cmd_args) != 1:
  279. msg("Only one command may be specified")
  280. sys.exit(1)
  281. cmd = cmd_args[0]
  282. if cmd in cmd_data:
  283. msg("Running tests for %s:" % cmd_data[cmd]['desc'])
  284. ts.do_cmds(cmd)
  285. elif cmd == "clean":
  286. cleandir(cfg['tmpdir'])
  287. sys.exit(0)
  288. else:
  289. msg("'%s': unrecognized command" % cmd)
  290. sys.exit(1)
  291. else:
  292. cleandir(cfg['tmpdir'])
  293. for cmd in cmd_data:
  294. msg("Running tests for %s:" % cmd_data[cmd]['desc'])
  295. ts.do_cmds(cmd)
  296. if cmd is not cmd_data.keys()[-1]: msg("")
  297. t = int(time.time()) - start_time
  298. msg(green(
  299. "All requested tests finished OK, elapsed time: %02i:%02i" % (t/60,t%60)))