test.py 31 KB

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