test.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2019 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/test.py: Test suite for the MMGen wallet system
  20. """
  21. def check_segwit_opts():
  22. for k,m in (('segwit','S'),('segwit_random','S'),('bech32','B')):
  23. if getattr(opt,k) and m not in g.proto.mmtypes:
  24. die(1,'--{} option incompatible with {}'.format(k.replace('_','-'),g.proto.__name__))
  25. def create_shm_dir(data_dir,trash_dir):
  26. # Laggy flash media can cause pexpect to fail, so create a temporary directory
  27. # under '/dev/shm' and put datadir and tmpdirs here.
  28. import shutil
  29. if g.platform == 'win':
  30. for tdir in (data_dir,trash_dir):
  31. try: os.listdir(tdir)
  32. except: pass
  33. else:
  34. try: shutil.rmtree(tdir)
  35. except: # we couldn't remove data dir - perhaps regtest daemon is running
  36. try: subprocess.call(['python3',os.path.join('cmds','mmgen-regtest'),'stop'])
  37. except: rdie(1,"Unable to remove {!r}!".format(tdir))
  38. else:
  39. time.sleep(2)
  40. shutil.rmtree(tdir)
  41. os.mkdir(tdir,0o755)
  42. shm_dir = 'test'
  43. else:
  44. tdir,pfx = '/dev/shm','mmgen-test-'
  45. try:
  46. subprocess.call('rm -rf {}/{}*'.format(tdir,pfx),shell=True)
  47. except Exception as e:
  48. die(2,'Unable to delete directory tree {}/{}* ({})'.format(tdir,pfx,e.args[0]))
  49. try:
  50. import tempfile
  51. shm_dir = str(tempfile.mkdtemp('',pfx,tdir))
  52. except Exception as e:
  53. die(2,'Unable to create temporary directory in {} ({})'.format(tdir,e.args[0]))
  54. dest = os.path.join(shm_dir,os.path.basename(trash_dir))
  55. os.mkdir(dest,0o755)
  56. try: os.unlink(trash_dir)
  57. except: pass
  58. os.symlink(dest,trash_dir)
  59. dest = os.path.join(shm_dir,os.path.basename(data_dir))
  60. shutil.move(data_dir,dest) # data_dir was created by opts.init()
  61. os.symlink(dest,data_dir)
  62. return shm_dir
  63. import sys,os,time
  64. os.environ['MMGEN_TEST_SUITE'] = '1'
  65. repo_root = os.path.normpath(os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]),os.pardir)))
  66. os.chdir(repo_root)
  67. sys.path.__setitem__(0,repo_root)
  68. try: os.unlink(os.path.join(repo_root,'my.err'))
  69. except: pass
  70. # Import these _after_ local path's been added to sys.path
  71. from mmgen.common import *
  72. from test.common import *
  73. from test.test_py_d.common import *
  74. g.quiet = False # if 'quiet' was set in config file, disable here
  75. os.environ['MMGEN_QUIET'] = '0' # for this script and spawned scripts
  76. opts_data = {
  77. 'text': {
  78. 'desc': 'Test suite for the MMGen suite',
  79. 'usage':'[options] [command(s) or metacommand(s)]',
  80. 'options': """
  81. -h, --help Print this help message
  82. --, --longhelp Print help message for long options (common options)
  83. -B, --bech32 Generate and use Bech32 addresses
  84. -b, --buf-keypress Use buffered keypresses as with real human input
  85. (often required on slow systems, or under emulation)
  86. -c, --print-cmdline Print the command line of each spawned command
  87. -C, --coverage Produce code coverage info using trace module
  88. -x, --debug-pexpect Produce debugging output for pexpect calls
  89. -D, --no-daemon-stop Don't stop auto-started daemons after running tests
  90. -E, --direct-exec Bypass pexpect and execute a command directly (for
  91. debugging only)
  92. -e, --exact-output Show the exact output of the MMGen script(s) being run
  93. -G, --exclude-groups=G Exclude the specified command groups (comma-separated)
  94. -l, --list-cmds List and describe the commands in the test suite
  95. -L, --list-cmd-groups Output a list of command groups, with no descriptions
  96. -n, --names Display command names instead of descriptions
  97. -o, --log Log commands to file {lf}
  98. -O, --pexpect-spawn Use pexpect.spawn instead of popen_spawn (much slower,
  99. kut does real terminal emulation)
  100. -p, --pause Pause between tests, resuming on keypress
  101. -P, --profile Record the execution time of each script
  102. -q, --quiet Produce minimal output. Suppress dependency info
  103. -r, --resume=c Resume at command 'c' after interrupted run
  104. -s, --system Test scripts and modules installed on system rather
  105. than those in the repo root
  106. -S, --skip-deps Skip dependency checking for command
  107. -u, --usr-random Get random data interactively from user
  108. -t, --traceback Run the command inside the '{tbc}' script
  109. -T, --pexpect-timeout=T Set the timeout for pexpect
  110. -v, --verbose Produce more verbose output
  111. -W, --no-dw-delete Don't remove default wallet from data dir after dw tests are done
  112. -X, --exit-after=C Exit after command 'C'
  113. -y, --segwit Generate and use Segwit addresses
  114. -Y, --segwit-random Generate and use a random mix of Segwit and Legacy addrs
  115. """,
  116. 'notes': """
  117. If no command is given, the whole test suite is run.
  118. """
  119. },
  120. 'code': {
  121. 'options': lambda s: s.format(
  122. tbc='scripts/traceback_run.py',
  123. lf=log_file),
  124. }
  125. }
  126. data_dir = os.path.join('test','data_dir' + ('','-α')[bool(os.getenv('MMGEN_DEBUG_UTF8'))])
  127. # we need the values of two opts before running opts.init, so parse without initializing:
  128. uopts = opts.init(opts_data,parse_only=True)[0]
  129. # step 1: delete data_dir symlink in ./test;
  130. if not ('resume' in uopts or 'skip_deps' in uopts):
  131. try: os.unlink(data_dir)
  132. except: pass
  133. sys.argv = [sys.argv[0]] + ['--data-dir='+data_dir] + sys.argv[1:]
  134. # step 2: opts.init will create new data_dir in ./test (if not 'resume' or 'skip_deps'):
  135. usr_args = opts.init(opts_data)
  136. # step 3: move data_dir to /dev/shm and symlink it back to ./test:
  137. trash_dir = os.path.join('test','trash')
  138. if not ('resume' in uopts or 'skip_deps' in uopts):
  139. shm_dir = create_shm_dir(data_dir,trash_dir)
  140. check_segwit_opts()
  141. if opt.profile: opt.names = True
  142. if opt.resume: opt.skip_deps = True
  143. if opt.exact_output:
  144. def msg(s): pass
  145. qmsg = qmsg_r = vmsg = vmsg_r = msg_r = msg
  146. cfgs = { # addr_idx_lists (except 31,32,33,34) must contain exactly 8 addresses
  147. '1': { 'wpasswd': 'Dorian-α',
  148. 'kapasswd': 'Grok the blockchain',
  149. 'addr_idx_list': '12,99,5-10,5,12',
  150. 'dep_generators': {
  151. pwfile: 'walletgen',
  152. 'mmdat': 'walletgen',
  153. 'addrs': 'addrgen',
  154. 'rawtx': 'txcreate',
  155. 'txbump': 'txbump',
  156. 'sigtx': 'txsign',
  157. 'mmwords': 'export_mnemonic',
  158. 'mmseed': 'export_seed',
  159. 'mmhex': 'export_hex',
  160. 'mmincog': 'export_incog',
  161. 'mmincox': 'export_incog_hex',
  162. hincog_fn: 'export_incog_hidden',
  163. incog_id_fn: 'export_incog_hidden',
  164. 'akeys.mmenc': 'keyaddrgen'
  165. },
  166. },
  167. '2': { 'wpasswd': 'Hodling away',
  168. 'addr_idx_list': '37,45,3-6,22-23',
  169. 'seed_len': 128,
  170. 'dep_generators': {
  171. 'mmdat': 'walletgen2',
  172. 'addrs': 'addrgen2',
  173. 'rawtx': 'txcreate2',
  174. 'sigtx': 'txsign2',
  175. 'mmwords': 'export_mnemonic2',
  176. },
  177. },
  178. '3': { 'wpasswd': 'Major miner',
  179. 'addr_idx_list': '73,54,1022-1023,2-5',
  180. 'dep_generators': {
  181. 'mmdat': 'walletgen3',
  182. 'addrs': 'addrgen3',
  183. 'rawtx': 'txcreate3',
  184. 'sigtx': 'txsign3'
  185. },
  186. },
  187. '4': { 'wpasswd': 'Hashrate good',
  188. 'addr_idx_list': '63,1004,542-544,7-9',
  189. 'seed_len': 192,
  190. 'dep_generators': {
  191. 'mmdat': 'walletgen4',
  192. 'mmbrain': 'walletgen4',
  193. 'addrs': 'addrgen4',
  194. 'rawtx': 'txcreate4',
  195. 'sigtx': 'txsign4',
  196. 'txdo': 'txdo4',
  197. },
  198. 'bw_filename': 'brainwallet.mmbrain',
  199. 'bw_params': '192,1',
  200. },
  201. '5': { 'wpasswd': 'My changed password-α',
  202. 'hash_preset': '2',
  203. 'dep_generators': {
  204. 'mmdat': 'passchg',
  205. pwfile: 'passchg',
  206. },
  207. },
  208. '6': { 'seed_len': 128,
  209. 'seed_id': 'FE3C6545',
  210. 'ref_bw_seed_id': '33F10310',
  211. 'wpasswd': 'reference password',
  212. 'kapasswd': '',
  213. 'dep_generators': {
  214. 'mmdat': 'ref_walletgen_brain_1',
  215. pwfile: 'ref_walletgen_brain_1',
  216. 'addrs': 'refaddrgen_1',
  217. 'akeys.mmenc': 'refkeyaddrgen_1'
  218. },
  219. },
  220. '7': { 'seed_len': 192,
  221. 'seed_id': '1378FC64',
  222. 'ref_bw_seed_id': 'CE918388',
  223. 'wpasswd': 'reference password',
  224. 'kapasswd': '',
  225. 'dep_generators': {
  226. 'mmdat': 'ref_walletgen_brain_2',
  227. pwfile: 'ref_walletgen_brain_2',
  228. 'addrs': 'refaddrgen_2',
  229. 'akeys.mmenc': 'refkeyaddrgen_2'
  230. },
  231. },
  232. '8': { 'seed_len': 256,
  233. 'seed_id': '98831F3A',
  234. 'ref_bw_seed_id': 'B48CD7FC',
  235. 'wpasswd': 'reference password',
  236. 'kapasswd': '',
  237. 'dep_generators': {
  238. 'mmdat': 'ref_walletgen_brain_3',
  239. pwfile: 'ref_walletgen_brain_3',
  240. 'addrs': 'refaddrgen_3',
  241. 'akeys.mmenc': 'refkeyaddrgen_3'
  242. },
  243. },
  244. '9': { 'tool_enc_infn': 'tool_encrypt.in',
  245. 'dep_generators': {
  246. 'tool_encrypt.in': 'tool_encrypt',
  247. 'tool_encrypt.in.mmenc': 'tool_encrypt',
  248. },
  249. },
  250. '14': { 'kapasswd': 'Maxwell',
  251. 'wpasswd': 'The Halving',
  252. 'addr_idx_list': '61,998,502-504,7-9',
  253. 'seed_len': 256,
  254. 'dep_generators': {
  255. 'mmdat': 'walletgen14',
  256. 'addrs': 'addrgen14',
  257. 'akeys.mmenc': 'keyaddrgen14',
  258. },
  259. },
  260. '15': { 'wpasswd': 'Dorian-α',
  261. 'kapasswd': 'Grok the blockchain',
  262. 'addr_idx_list': '12,99,5-10,5,12',
  263. 'dep_generators': {
  264. pwfile: 'walletgen_dfl_wallet',
  265. 'addrs': 'addrgen_dfl_wallet',
  266. 'rawtx': 'txcreate_dfl_wallet',
  267. 'sigtx': 'txsign_dfl_wallet',
  268. 'mmseed': 'export_seed_dfl_wallet',
  269. 'del_dw_run': 'delete_dfl_wallet',
  270. },
  271. },
  272. '16': { 'wpasswd': 'My changed password',
  273. 'hash_preset': '2',
  274. 'dep_generators': {
  275. pwfile: 'passchg_dfl_wallet',
  276. },
  277. },
  278. '17': {},
  279. '18': {},
  280. '19': { 'wpasswd':'abc' }, # B2X
  281. '20': { 'wpasswd': 'Vsize it',
  282. 'addr_idx_list': '1-8',
  283. 'seed_len': 256,
  284. 'dep_generators': {
  285. 'mmdat': 'walletgen5',
  286. 'addrs': 'addrgen5',
  287. 'rawtx': 'txcreate5',
  288. 'sigtx': 'txsign5',
  289. },
  290. },
  291. '21': { 'wpasswd': 'Vsize it',
  292. 'addr_idx_list': '1-8',
  293. 'seed_len': 256,
  294. 'dep_generators': {
  295. 'mmdat': 'walletgen6',
  296. 'addrs': 'addrgen6',
  297. 'rawtx': 'txcreate6',
  298. 'sigtx': 'txsign6',
  299. },
  300. },
  301. '22': {},
  302. '31': {},
  303. '32': {},
  304. '33': {},
  305. '34': {},
  306. }
  307. for k in cfgs:
  308. cfgs[k]['tmpdir'] = os.path.join('test','tmp{}'.format(k))
  309. cfgs[k]['segwit'] = randbool() if opt.segwit_random else bool(opt.segwit or opt.bech32)
  310. from copy import deepcopy
  311. for a,b in (('6','11'),('7','12'),('8','13')):
  312. cfgs[b] = deepcopy(cfgs[a])
  313. cfgs[b]['tmpdir'] = os.path.join('test','tmp'+b)
  314. if g.debug_utf8:
  315. for k in cfgs: cfgs[k]['tmpdir'] += '-α'
  316. utils = {
  317. # 'check_deps': 'check dependencies for specified command (WIP)', # TODO
  318. 'clean': 'clean specified tmp dir(s) (specify by integer, no arg = all dirs)',
  319. }
  320. def list_cmds():
  321. gm = CmdGroupMgr()
  322. cw,d = 0,[]
  323. Msg(green('AVAILABLE COMMANDS:'))
  324. for gname in gm.cmd_groups:
  325. ts = gm.init_group(None,gname,None)
  326. d.append((gname,ts.__doc__.strip(),gm.cmd_list,gm.dpy_data))
  327. cw = max(max(len(k) for k in gm.dpy_data),cw)
  328. for gname,gdesc,clist,dpdata in d:
  329. Msg('\n'+green('{!r} - {}:'.format(gname,gdesc)))
  330. for cmd in clist:
  331. data = dpdata[cmd]
  332. Msg(' {:{w}} - {}'.format(cmd,data if type(data) == str else data[1],w=cw))
  333. w = max(map(len,utils))
  334. Msg('\n'+green('AVAILABLE UTILITIES:'))
  335. for cmd in sorted(utils):
  336. Msg(' {:{w}} - {}'.format(cmd,utils[cmd],w=w))
  337. sys.exit(0)
  338. def do_between():
  339. if opt.pause:
  340. confirm_continue()
  341. elif (opt.verbose or opt.exact_output) and not opt.skip_deps:
  342. sys.stderr.write('\n')
  343. def list_tmpdirs():
  344. return {k:cfgs[k]['tmpdir'] for k in cfgs}
  345. def clean(usr_dirs=None):
  346. if opt.skip_deps: return
  347. all_dirs = list_tmpdirs()
  348. dirnums = map(int,(usr_dirs if usr_dirs is not None else all_dirs))
  349. dirlist = list(map(str,sorted(dirnums)))
  350. for d in dirlist:
  351. if d in all_dirs:
  352. cleandir(all_dirs[d])
  353. else:
  354. die(1,'{}: invalid directory number'.format(d))
  355. if dirlist:
  356. iqmsg(green('Cleaned tmp director{} {}'.format(suf(dirlist,'ies'),' '.join(dirlist))))
  357. cleandir(data_dir)
  358. cleandir(trash_dir)
  359. iqmsg(green("Cleaned directories '{}'".format("' '".join([data_dir,trash_dir]))))
  360. def create_tmp_dirs(shm_dir):
  361. if g.platform == 'win':
  362. for cfg in sorted(cfgs):
  363. mk_tmpdir(cfgs[cfg]['tmpdir'])
  364. else:
  365. for cfg in sorted(cfgs):
  366. src = os.path.join(shm_dir,cfgs[cfg]['tmpdir'].split('/')[-1])
  367. mk_tmpdir(src)
  368. try:
  369. os.unlink(cfgs[cfg]['tmpdir'])
  370. except OSError as e:
  371. if e.errno != 2: raise
  372. finally:
  373. os.symlink(src,cfgs[cfg]['tmpdir'])
  374. def set_environ_for_spawned_scripts():
  375. from mmgen.term import get_terminal_size
  376. os.environ['MMGEN_TERMINAL_WIDTH'] = str(get_terminal_size()[0])
  377. if os.getenv('MMGEN_DEBUG_ALL'):
  378. for name in g.env_opts:
  379. if name[:11] == 'MMGEN_DEBUG':
  380. os.environ[name] = '1'
  381. if not opt.pexpect_spawn: os.environ['MMGEN_TEST_SUITE_POPEN_SPAWN'] = '1'
  382. if not opt.system: os.environ['PYTHONPATH'] = repo_root
  383. if not opt.buf_keypress:
  384. os.environ['MMGEN_DISABLE_HOLD_PROTECT'] = '1'
  385. # If test.py itself is running under traceback, the spawned script shouldn't be, so disable this:
  386. if os.getenv('MMGEN_TRACEBACK') and not opt.traceback:
  387. os.environ['MMGEN_TRACEBACK'] = ''
  388. # Disable color in spawned scripts so pexpect can parse their output
  389. os.environ['MMGEN_DISABLE_COLOR'] = '1'
  390. os.environ['MMGEN_NO_LICENSE'] = '1'
  391. os.environ['MMGEN_MIN_URANDCHARS'] = '3'
  392. os.environ['MMGEN_BOGUS_SEND'] = '1'
  393. def set_restore_term_at_exit():
  394. import termios,atexit
  395. fd = sys.stdin.fileno()
  396. old = termios.tcgetattr(fd)
  397. def at_exit():
  398. termios.tcsetattr(fd, termios.TCSADRAIN, old)
  399. atexit.register(at_exit)
  400. class CmdGroupMgr(object):
  401. cmd_groups = {
  402. 'helpscreens': ('TestSuiteHelp',{'modname':'misc','full_data':True}),
  403. 'main': ('TestSuiteMain',{'full_data':True}),
  404. 'conv': ('TestSuiteWalletConv',{'is3seed':True,'modname':'wallet'}),
  405. 'ref3': ('TestSuiteRef3Seed',{'is3seed':True,'modname':'ref_3seed'}),
  406. 'ref': ('TestSuiteRef',{}),
  407. 'ref_altcoin': ('TestSuiteRefAltcoin',{}),
  408. 'tool': ('TestSuiteTool',{'modname':'misc','full_data':True}),
  409. 'input': ('TestSuiteInput',{'modname':'misc','full_data':True}),
  410. 'output': ('TestSuiteOutput',{'modname':'misc','full_data':True}),
  411. 'regtest': ('TestSuiteRegtest',{}),
  412. # 'chainsplit': ('TestSuiteChainsplit',{}),
  413. 'ethdev': ('TestSuiteEthdev',{}),
  414. 'autosign': ('TestSuiteAutosign',{}),
  415. 'autosign_minimal': ('TestSuiteAutosignMinimal',{'modname':'autosign'}),
  416. 'autosign_live': ('TestSuiteAutosignLive',{'modname':'autosign'}),
  417. 'create_ref_tx': ('TestSuiteRefTX',{'modname':'misc','full_data':True}),
  418. }
  419. dfl_groups = ( 'helpscreens',
  420. 'main',
  421. 'conv',
  422. 'ref',
  423. 'ref3',
  424. 'ref_altcoin',
  425. 'tool',
  426. 'input',
  427. 'output',
  428. 'autosign_minimal',
  429. 'regtest',
  430. 'ethdev')
  431. def load_mod(self,gname,modname=None):
  432. clsname,kwargs = self.cmd_groups[gname]
  433. if modname == None and 'modname' in kwargs:
  434. modname = kwargs['modname']
  435. gl = globals()
  436. exec('from test.test_py_d import ts_{}'.format(modname or gname),gl,gl)
  437. exec('from test.test_py_d.ts_{} import {}'.format(modname or gname,clsname),gl,gl)
  438. return clsname
  439. def create_group(self,gname,full_data=False,modname=None,is3seed=False,add_dpy=False):
  440. """
  441. Initializes the list 'cmd_list' and dict 'dpy_data' from module's cmd_group data.
  442. Alternatively, if called with 'add_dpy=True', updates 'dpy_data' from module data
  443. without touching 'cmd_list'
  444. """
  445. clsname = self.load_mod(gname,modname)
  446. tmpdir_nums = globals()[clsname].tmpdir_nums
  447. cdata = []
  448. for a,b in getattr(globals()[clsname],'cmd_group'):
  449. if is3seed:
  450. for n,(i,j) in enumerate(zip(tmpdir_nums,(128,192,256))):
  451. k = '{}_{}'.format(a,n+1)
  452. if type(b) == str:
  453. cdata.append( (k, (i,'{} ({}-bit)'.format(b,j),[[[],i]])) )
  454. else:
  455. cdata.append( (k, (i,'{} ({}-bit)'.format(b[1],j),[[b[0],i]])) )
  456. else:
  457. cdata.append( (a, b if full_data else (tmpdir_nums[0],b,[[[],tmpdir_nums[0]]])) )
  458. if add_dpy:
  459. self.dpy_data.update(dict(cdata))
  460. else:
  461. self.cmd_list = tuple(e[0] for e in cdata)
  462. self.dpy_data = dict(cdata)
  463. return clsname
  464. def init_group(self,trunner,gname,spawn_prog):
  465. clsname,kwargs = self.cmd_groups[gname]
  466. self.create_group(gname,**kwargs)
  467. return globals()[clsname](trunner,cfgs,spawn_prog)
  468. def find_cmd_in_groups(self,cmd,group=None):
  469. """
  470. Search for a test command in specified group or all configured command groups
  471. and return it as a string. Loads modules but alters no global variables.
  472. """
  473. if group:
  474. if not group in [e[0] for e in self.cmd_groups]:
  475. die(1,'{!r}: unrecognized group'.format(group))
  476. groups = [self.cmd_groups[group]]
  477. else:
  478. groups = self.cmd_groups
  479. for gname in groups:
  480. clsname,kwargs = self.cmd_groups[gname]
  481. self.load_mod(gname,kwargs['modname'] if 'modname' in kwargs else None)
  482. if cmd in dict(globals()[clsname].cmd_group): # first search the class
  483. return gname
  484. if cmd in dir(globals()[clsname](None,None,None)): # then a throwaway instance
  485. return gname # cmd might be in several groups - we'll go with the first
  486. return None
  487. class TestSuiteRunner(object):
  488. 'test suite runner'
  489. def __init__(self,data_dir,trash_dir):
  490. self.data_dir = data_dir
  491. self.trash_dir = trash_dir
  492. self.cmd_total = 0
  493. from collections import OrderedDict
  494. self.rebuild_list = OrderedDict()
  495. self.gm = CmdGroupMgr()
  496. if opt.log:
  497. self.log_fd = open(log_file,'a')
  498. self.log_fd.write('\nLog started: {} UTC\n'.format(make_timestr()))
  499. omsg('INFO → Logging to file {!r}'.format(log_file))
  500. else:
  501. self.log_fd = None
  502. if opt.coverage:
  503. self.coverdir,self.accfile = init_coverage()
  504. omsg('INFO → Writing coverage files to {!r}'.format(self.coverdir))
  505. def spawn_wrapper( self, cmd,
  506. args = [],
  507. extra_desc = '',
  508. no_output = False,
  509. msg_only = False,
  510. no_msg = False,
  511. cmd_dir = 'cmds' ):
  512. desc = self.ts.test_name if opt.names else self.gm.dpy_data[self.ts.test_name][1]
  513. if extra_desc: desc += ' ' + extra_desc
  514. if not opt.system:
  515. cmd = os.path.relpath(os.path.join(repo_root,cmd_dir,cmd))
  516. elif g.platform == 'win':
  517. cmd = os.path.join('/mingw64','opt','bin',cmd)
  518. passthru_opts = ['--{}{}'.format(k.replace('_','-'),
  519. '=' + getattr(opt,k) if getattr(opt,k) != True else '')
  520. for k in self.ts.passthru_opts if getattr(opt,k)]
  521. args = [cmd] + passthru_opts + ['--data-dir='+self.data_dir] + args
  522. if opt.traceback:
  523. args = ['scripts/traceback_run.py'] + args
  524. if g.platform == 'win':
  525. args = ['python3'] + args
  526. for i in args:
  527. if type(i) != str:
  528. m = 'Error: missing input files in cmd line?:\nName: {}\nCmdline: {!r}'
  529. die(2,m.format(self.ts.test_name,args))
  530. if opt.coverage:
  531. args = ['python3','-m','trace','--count','--coverdir='+self.coverdir,'--file='+self.accfile] + args
  532. qargs = ['{q}{}{q}'.format(a,q=('',"'")[' ' in a]) for a in args]
  533. cmd_disp = ' '.join(qargs).replace('\\','/') # for mingw
  534. if not no_msg:
  535. if opt.verbose or opt.print_cmdline or opt.exact_output:
  536. clr1,clr2 = ((green,cyan),(nocolor,nocolor))[bool(opt.print_cmdline)]
  537. omsg(green('Testing: {}'.format(desc)))
  538. if not msg_only:
  539. s = repr(cmd_disp) if g.platform == 'win' else cmd_disp
  540. omsg(clr1('Executing: ') + clr2(s))
  541. else:
  542. omsg_r('Testing {}: '.format(desc))
  543. if msg_only: return
  544. if opt.log:
  545. try:
  546. self.log_fd.write(cmd_disp+'\n')
  547. except:
  548. self.log_fd.write(ascii(cmd_disp)+'\n')
  549. from test.pexpect import MMGenPexpect
  550. return MMGenPexpect(args,no_output=no_output)
  551. def end_msg(self):
  552. t = int(time.time()) - self.start_time
  553. m = '{} test{} performed. Elapsed time: {:02d}:{:02d}\n'
  554. sys.stderr.write(green(m.format(self.cmd_total,suf(self.cmd_total),t//60,t%60)))
  555. def init_group(self,gname,cmd=None):
  556. ts_cls = globals()[CmdGroupMgr().load_mod(gname)]
  557. for k in ('segwit','segwit_random','bech32'):
  558. if getattr(opt,k):
  559. segwit_opt = k
  560. break
  561. else:
  562. segwit_opt = None
  563. m1 = ('test group {g!r}','{g}:{c}')[bool(cmd)].format(g=gname,c=cmd)
  564. m2 = ' for {} {}net'.format(g.coin.lower(),'test' if g.testnet else 'main') \
  565. if len(ts_cls.networks) != 1 else ''
  566. m3 = ' (--{})'.format(segwit_opt.replace('_','-')) if segwit_opt else ''
  567. m = m1 + m2 + m3
  568. if segwit_opt and not getattr(ts_cls,'segwit_opts_ok'):
  569. iqmsg('INFO → skipping ' + m)
  570. return False
  571. # 'networks = ()' means all networks allowed
  572. nws = [(e.split('_')[0],'testnet') if '_' in e else (e,'mainnet') for e in ts_cls.networks]
  573. if nws:
  574. coin = g.coin.lower()
  575. nw = ('mainnet','testnet')[g.testnet]
  576. for a,b in nws:
  577. if a == coin and b == nw:
  578. break
  579. else:
  580. iqmsg('INFO → skipping ' + m)
  581. return False
  582. bmsg('Executing ' + m)
  583. self.ts = self.gm.init_group(self,gname,self.spawn_wrapper)
  584. if opt.exit_after and opt.exit_after not in self.gm.cmd_list:
  585. die(1,'{!r}: command not recognized'.format(opt.exit_after))
  586. return True
  587. def run_tests(self,usr_args):
  588. self.start_time = int(time.time())
  589. if usr_args:
  590. for arg in usr_args:
  591. if arg in self.gm.cmd_groups:
  592. if not self.init_group(arg): continue
  593. clean(self.ts.tmpdir_nums)
  594. for cmd in self.gm.cmd_list:
  595. self.check_needs_rerun(cmd,build=True)
  596. do_between()
  597. elif arg in utils:
  598. params = usr_args[usr_args.index(arg)+1:]
  599. globals()[arg](*params)
  600. sys.exit(0)
  601. else:
  602. if ':' in arg:
  603. gname,arg = arg.split(':')
  604. else:
  605. gname = self.gm.find_cmd_in_groups(arg)
  606. if gname:
  607. if not self.init_group(gname,arg): continue
  608. clean(self.ts.tmpdir_nums)
  609. self.check_needs_rerun(arg,build=True)
  610. do_between()
  611. else:
  612. die(1,'{!r}: command not recognized'.format(arg))
  613. else:
  614. if opt.exclude_groups:
  615. exclude = opt.exclude_groups.split(',')
  616. for e in exclude:
  617. if e not in self.gm.dfl_groups:
  618. die(1,'{!r}: group not recognized'.format(e))
  619. for gname in self.gm.dfl_groups:
  620. if opt.exclude_groups and gname in exclude: continue
  621. if not self.init_group(gname): continue
  622. clean(self.ts.tmpdir_nums)
  623. for cmd in self.gm.cmd_list:
  624. self.check_needs_rerun(cmd,build=True)
  625. do_between()
  626. self.end_msg()
  627. def check_needs_rerun(self,
  628. cmd,
  629. build=False,
  630. root=True,
  631. force_delete=False,
  632. dpy=False
  633. ):
  634. rerun = root # force_delete is not passed to recursive call
  635. fns = []
  636. if force_delete or not root:
  637. # does cmd produce a needed dependency(ies)?
  638. ret = self.get_num_exts_for_cmd(cmd,dpy)
  639. if ret:
  640. for ext in ret[1]:
  641. fn = get_file_with_ext(cfgs[ret[0]]['tmpdir'],ext,delete=build)
  642. if fn:
  643. if force_delete: os.unlink(fn)
  644. else: fns.append(fn)
  645. else: rerun = True
  646. fdeps = self.generate_file_deps(cmd)
  647. cdeps = self.generate_cmd_deps(fdeps)
  648. for fn in fns:
  649. my_age = os.stat(fn).st_mtime
  650. for num,ext in fdeps:
  651. f = get_file_with_ext(cfgs[num]['tmpdir'],ext,delete=build)
  652. if f and os.stat(f).st_mtime > my_age:
  653. rerun = True
  654. for cdep in cdeps:
  655. if self.check_needs_rerun(cdep,build=build,root=False,dpy=cmd):
  656. rerun = True
  657. if build:
  658. if rerun:
  659. for fn in fns:
  660. if not root: os.unlink(fn)
  661. if not (dpy and opt.skip_deps):
  662. self.run_test(cmd)
  663. if not root: do_between()
  664. else:
  665. # If prog produces multiple files:
  666. if cmd not in self.rebuild_list or rerun == True:
  667. self.rebuild_list[cmd] = (rerun,fns[0] if fns else '') # FIX
  668. return rerun
  669. def run_test(self,cmd):
  670. # delete files produced by this cmd
  671. # for ext,tmpdir in find_generated_exts(cmd):
  672. # print cmd, get_file_with_ext(tmpdir,ext)
  673. d = [(str(num),ext) for exts,num in self.gm.dpy_data[cmd][2] for ext in exts]
  674. # delete files depended on by this cmd
  675. arg_list = [get_file_with_ext(cfgs[num]['tmpdir'],ext) for num,ext in d]
  676. if opt.resume:
  677. if cmd == opt.resume:
  678. bmsg('Resuming at {!r}'.format(cmd))
  679. opt.resume = False
  680. opt.skip_deps = False
  681. else:
  682. return
  683. if opt.profile: start = time.time()
  684. cdata = self.gm.dpy_data[cmd]
  685. self.ts.test_name = cmd
  686. # self.ts.test_dpydata = cdata
  687. self.ts.tmpdir_num = cdata[0]
  688. # self.ts.cfg = cfgs[str(cdata[0])] # will remove this eventually
  689. cfg = cfgs[str(cdata[0])]
  690. for k in ( 'seed_len', 'seed_id',
  691. 'wpasswd', 'kapasswd',
  692. 'segwit', 'hash_preset',
  693. 'bw_filename', 'bw_params', 'ref_bw_seed_id',
  694. 'addr_idx_list', 'pass_idx_list' ):
  695. if k in cfg:
  696. setattr(self.ts,k,cfg[k])
  697. self.process_retval(cmd,getattr(self.ts,cmd)(*arg_list)) # run the test
  698. if opt.profile:
  699. omsg('\r\033[50C{:.4f}'.format(time.time() - start))
  700. if cmd == opt.exit_after:
  701. sys.exit(0)
  702. def process_retval(self,cmd,ret):
  703. if type(ret).__name__ == 'MMGenPexpect':
  704. ret.ok()
  705. self.cmd_total += 1
  706. elif ret == 'ok':
  707. ok()
  708. self.cmd_total += 1
  709. elif ret == 'skip':
  710. pass
  711. else:
  712. rdie(1,'{!r} returned {}'.format(cmd,ret))
  713. def check_deps(self,cmds): # TODO: broken
  714. if len(cmds) != 1:
  715. die(1,'Usage: {} check_deps <command>'.format(g.prog_name))
  716. cmd = cmds[0]
  717. if cmd not in self.gm.cmd_list:
  718. die(1,'{!r}: unrecognized command'.format(cmd))
  719. if not opt.quiet:
  720. omsg('Checking dependencies for {!r}'.format(cmd))
  721. self.check_needs_rerun(self.ts,cmd,build=False)
  722. w = max(map(len,self.rebuild_list)) + 1
  723. for cmd in self.rebuild_list:
  724. c = self.rebuild_list[cmd]
  725. m = 'Rebuild' if (c[0] and c[1]) else 'Build' if c[0] else 'OK'
  726. omsg('cmd {:<{w}} {}'.format(cmd+':', m, w=w))
  727. def generate_file_deps(self,cmd):
  728. return [(str(n),e) for exts,n in self.gm.dpy_data[cmd][2] for e in exts]
  729. def generate_cmd_deps(self,fdeps):
  730. return [cfgs[str(n)]['dep_generators'][ext] for n,ext in fdeps]
  731. def get_num_exts_for_cmd(self,cmd,dpy=False): # dpy ignored here
  732. try:
  733. num = str(self.gm.dpy_data[cmd][0])
  734. except KeyError:
  735. qmsg_r('Missing dependency {!r}'.format(cmd))
  736. gname = self.gm.find_cmd_in_groups(cmd)
  737. if gname:
  738. kwargs = self.gm.cmd_groups[gname][1]
  739. kwargs.update({'add_dpy':True})
  740. self.gm.create_group(gname,**kwargs)
  741. num = str(self.gm.dpy_data[cmd][0])
  742. qmsg(' found in group {!r}'.format(gname))
  743. else:
  744. qmsg(' not found in any command group!')
  745. raise
  746. dgl = cfgs[num]['dep_generators']
  747. if cmd in dgl.values():
  748. exts = [k for k in dgl if dgl[k] == cmd]
  749. return (num,exts)
  750. else:
  751. return None
  752. # main()
  753. if not opt.skip_deps: # do this before list cmds exit, so we stay in sync with shm_dir
  754. create_tmp_dirs(shm_dir)
  755. if opt.list_cmd_groups:
  756. Die(0,' '.join(CmdGroupMgr.cmd_groups))
  757. elif opt.list_cmds:
  758. list_cmds()
  759. if opt.pause:
  760. set_restore_term_at_exit()
  761. set_environ_for_spawned_scripts()
  762. try:
  763. tr = TestSuiteRunner(data_dir,trash_dir)
  764. tr.run_tests(usr_args)
  765. except KeyboardInterrupt:
  766. die(1,'\ntest.py exiting at user request')
  767. except TestSuiteException as e:
  768. ydie(1,e.args[0])
  769. except TestSuiteFatalException as e:
  770. rdie(1,e.args[0])
  771. except Exception:
  772. if opt.traceback:
  773. msg(blue('Spawned script exited with error'))
  774. else:
  775. import traceback
  776. print(''.join(traceback.format_exception(*sys.exc_info())))
  777. msg(blue('Test script exited with error'))
  778. except:
  779. raise