test.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032
  1. #!/usr/bin/env python3
  2. #
  3. # mmgen = Multi-Mode GENerator, command-line Bitcoin cold storage solution
  4. # Copyright (C)2013-2023 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(cfg,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 gc.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. die(4,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 Config()
  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 get_overlay_tree_dir,overlay_setup
  68. overlay_tree_dir = get_overlay_tree_dir(repo_root)
  69. sys.path.insert(0,overlay_tree_dir)
  70. if sys.argv[-1] == 'clean':
  71. from shutil import rmtree
  72. rmtree(overlay_tree_dir,ignore_errors=True)
  73. else:
  74. # overlay must be set up before importing mmgen mods!
  75. overlay_setup(repo_root)
  76. from mmgen.common import *
  77. from mmgen.devinit import init_dev
  78. init_dev()
  79. try:
  80. os.unlink(os.path.join(repo_root,'test.py.err'))
  81. except:
  82. pass
  83. os.environ['MMGEN_QUIET'] = '0' # for this script and spawned scripts
  84. opts_data = {
  85. 'sets': [
  86. ('list_current_cmd_groups',True,'list_cmd_groups',True),
  87. ('demo',True,'exact_output',True),
  88. ('demo',True,'buf_keypress',True),
  89. ('demo',True,'pexpect_spawn',True),
  90. ],
  91. 'text': {
  92. 'desc': 'Test suite for the MMGen suite',
  93. 'usage':'[options] [command [..command]] | [command_group[.command_subgroup][:command]]',
  94. 'options': """
  95. -h, --help Print this help message
  96. --, --longhelp Print help message for long options (common options)
  97. -a, --no-altcoin Skip altcoin tests (WIP)
  98. -A, --no-daemon-autostart Don't start and stop daemons automatically
  99. -B, --bech32 Generate and use Bech32 addresses
  100. -b, --buf-keypress Use buffered keypresses as with real human input
  101. (often required on slow systems, or under emulation)
  102. -c, --print-cmdline Print the command line of each spawned command
  103. -C, --coverage Produce code coverage info using trace module
  104. -x, --debug-pexpect Produce debugging output for pexpect calls
  105. --, --demo Add extra delay after each send to make input visible.
  106. Implies --exact-output --pexpect-spawn --buf-keypress
  107. -d, --deps-only Run a command or command subgroup’s dependencies without
  108. running the command or command group itself.
  109. -D, --no-daemon-stop Don't stop auto-started daemons after running tests
  110. -E, --direct-exec Bypass pexpect and execute a command directly (for
  111. debugging only)
  112. -e, --exact-output Show the exact output of the MMGen script(s) being run
  113. -G, --exclude-groups=G Exclude the specified command groups (comma-separated)
  114. -l, --list-cmds List the test script’s available commands
  115. -L, --list-cmd-groups List the test script’s command groups and subgroups
  116. -g, --list-current-cmd-groups List command groups for current configuration
  117. -n, --names Display command names instead of descriptions
  118. -N, --no-timings Suppress display of timing information
  119. -o, --log Log commands to file {lf!r}
  120. -O, --pexpect-spawn Use pexpect.spawn instead of popen_spawn (much slower,
  121. kut does real terminal emulation)
  122. -p, --pause Pause between tests, resuming on keypress
  123. -P, --profile Record the execution time of each script
  124. -q, --quiet Produce minimal output. Suppress dependency info
  125. -r, --resume=c Resume at command 'c' after interrupted run
  126. -R, --resume-after=c Same, but resume at command following 'c'
  127. -t, --step After resuming, execute one command and stop
  128. -s, --system Test scripts and modules installed on system rather
  129. than those in the repo root
  130. -S, --skip-deps Skip dependency checking for command
  131. -u, --usr-random Get random data interactively from user
  132. -T, --pexpect-timeout=T Set the timeout for pexpect
  133. -v, --verbose Produce more verbose output
  134. -W, --no-dw-delete Don't remove default wallet from data dir after dw tests
  135. are done
  136. -X, --exit-after=C Exit after command 'C'
  137. -y, --segwit Generate and use Segwit addresses
  138. -Y, --segwit-random Generate and use a random mix of Segwit and Legacy addrs
  139. """,
  140. 'notes': """
  141. If no command is given, the whole test suite is run for the currently
  142. specified coin (default BTC).
  143. For traceback output and error file support, set the EXEC_WRAPPER_TRACEBACK
  144. environment var
  145. """
  146. },
  147. 'code': {
  148. 'options': lambda proto,help_notes,s: s.format(
  149. lf = help_notes('test_py_log_file')
  150. )
  151. }
  152. }
  153. # we need some opt values before running opts.init, so parse without initializing:
  154. po = Config(opts_data=opts_data,parse_only=True)._parsed_opts
  155. from test.include.common import set_globals,get_test_data_dir
  156. data_dir = get_test_data_dir() # include/common.py
  157. # step 1: delete data_dir symlink in ./test;
  158. if not po.user_opts.get('skipping_deps'):
  159. try: os.unlink(data_dir)
  160. except: pass
  161. # step 2: opts.init will create new data_dir in ./test (if not cfg.skipping_deps)
  162. cfg = Config(opts_data=opts_data)
  163. set_globals(cfg)
  164. from test.test_py_d.common import * # this must be loaded after set_globals()
  165. type(cfg)._reset_ok += (
  166. 'no_daemon_autostart',
  167. 'names',
  168. 'no_timings',
  169. 'exit_after',
  170. 'resuming',
  171. 'skipping_deps' )
  172. cfg.resuming = any(k in po.user_opts for k in ('resume','resume_after'))
  173. cfg.skipping_deps = cfg.resuming or 'skip_deps' in po.user_opts
  174. cmd_args = cfg._args
  175. if cfg.pexpect_spawn and gc.platform == 'win':
  176. die(1,'--pexpect-spawn option not supported on Windows platform, exiting')
  177. if cfg.daemon_id and cfg.daemon_id in cfg.blacklisted_daemons.split():
  178. die(1,f'test.py: daemon {cfg.daemon_id!r} blacklisted, exiting')
  179. network_id = cfg.coin.lower() + ('_tn' if cfg.testnet else '')
  180. proto = cfg._proto
  181. # step 3: move data_dir to /dev/shm and symlink it back to ./test:
  182. trash_dir = os.path.join('test','trash')
  183. trash_dir2 = os.path.join('test','trash2')
  184. if not cfg.skipping_deps:
  185. shm_dir = create_shm_dir(data_dir,trash_dir)
  186. check_segwit_opts()
  187. testing_segwit = cfg.segwit or cfg.segwit_random or cfg.bech32
  188. if cfg.test_suite_deterministic:
  189. cfg.no_timings = True
  190. init_color(num_colors=0)
  191. os.environ['MMGEN_DISABLE_COLOR'] = '1' # for this script and spawned scripts
  192. if cfg.profile:
  193. cfg.names = True
  194. if cfg.exact_output:
  195. def noop(s):
  196. pass
  197. qmsg = qmsg_r = msg = noop
  198. else:
  199. qmsg = cfg._util.qmsg
  200. qmsg_r = cfg._util.qmsg_r
  201. if cfg.skipping_deps:
  202. cfg.no_daemon_autostart = True
  203. from test.test_py_d.cfg import cfgs,fixup_cfgs
  204. for k in cfgs:
  205. cfgs[k]['tmpdir'] = os.path.join('test','tmp',str(k))
  206. fixup_cfgs()
  207. utils = {
  208. # 'check_deps': 'check dependencies for specified command (WIP)', # TODO
  209. 'clean': 'clean specified tmp dir(s) (specify by integer, no arg = all dirs)',
  210. }
  211. def list_cmds():
  212. def gen_output():
  213. gm = CmdGroupMgr()
  214. cw,d = 0,[]
  215. yield green('AVAILABLE COMMANDS:')
  216. for gname in gm.cmd_groups:
  217. ts = gm.gm_init_group(None,gname,None,None)
  218. desc = ts.__doc__.strip() if ts.__doc__ else type(ts).__name__
  219. d.append( (gname,desc,gm.cmd_list,gm.dpy_data) )
  220. cw = max(max(len(k) for k in gm.dpy_data),cw)
  221. for gname,gdesc,clist,dpdata in d:
  222. yield '\n'+green(f'{gname!r} - {gdesc}:')
  223. for cmd in clist:
  224. data = dpdata[cmd]
  225. yield ' {:{w}} - {}'.format(
  226. cmd,
  227. (data if type(data) == str else data[1]),
  228. w = cw )
  229. w = max(map(len,utils))
  230. yield '\n'+green('AVAILABLE UTILITIES:')
  231. for cmd in sorted(utils):
  232. yield ' {:{w}} - {}'.format( cmd, utils[cmd], w=w )
  233. from mmgen.ui import do_pager
  234. do_pager('\n'.join(gen_output()))
  235. sys.exit(0)
  236. def do_between():
  237. if cfg.pause:
  238. confirm_continue()
  239. elif (cfg.verbose or cfg.exact_output) and not cfg.skipping_deps:
  240. sys.stderr.write('\n')
  241. def list_tmpdirs():
  242. return {k:cfgs[k]['tmpdir'] for k in cfgs}
  243. def clean(usr_dirs=None,clean_overlay=True):
  244. if cfg.skipping_deps:
  245. return
  246. all_dirs = list_tmpdirs()
  247. dirnums = map(int,(usr_dirs if usr_dirs is not None else all_dirs))
  248. dirlist = list(map(str,sorted(dirnums)))
  249. for d in dirlist:
  250. if d in all_dirs:
  251. cleandir(all_dirs[d])
  252. else:
  253. die(1,f'{d}: invalid directory number')
  254. if dirlist:
  255. iqmsg(green('Cleaned tmp director{} {}'.format(
  256. suf(dirlist,'ies'),
  257. ' '.join(dirlist))
  258. ))
  259. cleandir(data_dir)
  260. cleandir(trash_dir)
  261. cleandir(trash_dir2)
  262. iqmsg(green(f'Cleaned directories {data_dir!r} {trash_dir!r} {trash_dir2!r}'))
  263. if clean_overlay:
  264. cleandir(overlay_tree_dir)
  265. iqmsg(green(f'Cleaned directory {os.path.relpath(overlay_tree_dir)!r}'))
  266. def create_tmp_dirs(shm_dir):
  267. if gc.platform == 'win':
  268. for cfg in sorted(cfgs):
  269. mk_tmpdir(cfgs[cfg]['tmpdir'])
  270. else:
  271. os.makedirs( os.path.join('test','tmp'), mode=0o755, exist_ok=True )
  272. for cfg in sorted(cfgs):
  273. src = os.path.join(shm_dir,cfgs[cfg]['tmpdir'].split('/')[-1])
  274. mk_tmpdir(src)
  275. try:
  276. os.unlink(cfgs[cfg]['tmpdir'])
  277. except OSError as e:
  278. if e.errno != 2:
  279. raise
  280. finally:
  281. os.symlink(src,cfgs[cfg]['tmpdir'])
  282. def set_restore_term_at_exit():
  283. import termios,atexit
  284. fd = sys.stdin.fileno()
  285. old = termios.tcgetattr(fd)
  286. def at_exit():
  287. termios.tcsetattr(fd, termios.TCSADRAIN, old)
  288. atexit.register(at_exit)
  289. class CmdGroupMgr(object):
  290. from test.test_py_d.cfg import cmd_groups_dfl,cmd_groups_extra
  291. cmd_groups = cmd_groups_dfl.copy()
  292. cmd_groups.update(cmd_groups_extra)
  293. @staticmethod
  294. def create_cmd_group(cls,sg_name=None):
  295. cmd_group_in = dict(cls.cmd_group_in)
  296. if sg_name and 'subgroup.' + sg_name not in cmd_group_in:
  297. die(1,f'{sg_name!r}: no such subgroup in test group {cls.__name__}')
  298. def add_entries(key,add_deps=True,added_subgroups=[]):
  299. if add_deps:
  300. for dep in cmd_group_in['subgroup.'+key]:
  301. for e in add_entries(dep):
  302. yield e
  303. assert isinstance(cls.cmd_subgroups[key][0],str), f'header for subgroup {key!r} missing!'
  304. if not key in added_subgroups:
  305. for e in cls.cmd_subgroups[key][1:]:
  306. yield e
  307. added_subgroups.append(key)
  308. def gen():
  309. for name,data in cls.cmd_group_in:
  310. if name.startswith('subgroup.'):
  311. from mmgen.util2 import removeprefix
  312. sg_key = removeprefix(name,'subgroup.')
  313. # sg_key = name.removeprefix('subgroup.') # Python 3.9
  314. if sg_name in (None,sg_key):
  315. for e in add_entries(
  316. sg_key,
  317. add_deps = sg_name and not cfg.skipping_deps,
  318. added_subgroups = [sg_name] if cfg.deps_only else [] ):
  319. yield e
  320. if cfg.deps_only and sg_key == sg_name:
  321. return
  322. elif not cfg.skipping_deps:
  323. yield (name,data)
  324. return tuple(gen())
  325. def load_mod(self,gname,modname=None):
  326. clsname,kwargs = self.cmd_groups[gname]
  327. if modname == None and 'modname' in kwargs:
  328. modname = kwargs['modname']
  329. import importlib
  330. modpath = f'test.test_py_d.ts_{modname or gname}'
  331. return getattr(importlib.import_module(modpath),clsname)
  332. def create_group(self,gname,sg_name,full_data=False,modname=None,is3seed=False,add_dpy=False):
  333. """
  334. Initializes the list 'cmd_list' and dict 'dpy_data' from module's cmd_group data.
  335. Alternatively, if called with 'add_dpy=True', updates 'dpy_data' from module data
  336. without touching 'cmd_list'
  337. """
  338. cls = self.load_mod(gname,modname)
  339. cdata = []
  340. def get_shared_deps(cmdname,tmpdir_idx):
  341. """
  342. shared_deps are "implied" dependencies for all cmds in cmd_group that don't appear in
  343. the cmd_group data or cmds' argument lists. Supported only for 3seed tests at present.
  344. """
  345. if not hasattr(cls,'shared_deps'):
  346. return []
  347. return [k for k,v in cfgs[str(tmpdir_idx)]['dep_generators'].items()
  348. if k in cls.shared_deps and v != cmdname]
  349. if not hasattr(cls,'cmd_group'):
  350. cls.cmd_group = self.create_cmd_group(cls,sg_name)
  351. for a,b in cls.cmd_group:
  352. if is3seed:
  353. for n,(i,j) in enumerate(zip(cls.tmpdir_nums,(128,192,256))):
  354. k = f'{a}_{n+1}'
  355. if hasattr(cls,'skip_cmds') and k in cls.skip_cmds:
  356. continue
  357. sdeps = get_shared_deps(k,i)
  358. if type(b) == str:
  359. cdata.append( (k, (i,f'{b} ({j}-bit)',[[[]+sdeps,i]])) )
  360. else:
  361. cdata.append( (k, (i,f'{b[1]} ({j}-bit)',[[b[0]+sdeps,i]])) )
  362. else:
  363. cdata.append( (a, b if full_data else (cls.tmpdir_nums[0],b,[[[],cls.tmpdir_nums[0]]])) )
  364. if add_dpy:
  365. self.dpy_data.update(dict(cdata))
  366. else:
  367. self.cmd_list = tuple(e[0] for e in cdata)
  368. self.dpy_data = dict(cdata)
  369. return cls
  370. def gm_init_group(self,trunner,gname,sg_name,spawn_prog):
  371. kwargs = self.cmd_groups[gname][1]
  372. cls = self.create_group(gname,sg_name,**kwargs)
  373. cls.group_name = gname
  374. return cls(trunner,cfgs,spawn_prog)
  375. def get_cls_by_gname(self,gname):
  376. return self.load_mod( gname, self.cmd_groups[gname][1].get('modname') )
  377. def list_cmd_groups(self):
  378. ginfo = []
  379. for gname in self.cmd_groups:
  380. ginfo.append(( gname, self.get_cls_by_gname(gname) ))
  381. if cfg.list_current_cmd_groups:
  382. exclude = (cfg.exclude_groups or '').split(',')
  383. ginfo = [g for g in ginfo
  384. if network_id in g[1].networks
  385. and not g[0] in exclude
  386. and g[0] in tuple(self.cmd_groups_dfl) + tuple(cmd_args) ]
  387. desc = 'CONFIGURED'
  388. else:
  389. desc = 'AVAILABLE'
  390. def gen_output():
  391. yield green(f'{desc} COMMAND GROUPS AND SUBGROUPS:')
  392. yield ''
  393. for name,cls in ginfo:
  394. yield ' {} - {}'.format(
  395. yellow(name.ljust(13)),
  396. (cls.__doc__.strip() if cls.__doc__ else cls.__name__) )
  397. if hasattr(cls,'cmd_subgroups'):
  398. subgroups = {k:v for k,v in cls.cmd_subgroups.items() if not k.startswith('_')}
  399. max_w = max(len(k) for k in subgroups)
  400. for k,v in subgroups.items():
  401. yield ' + {} · {}'.format( cyan(k.ljust(max_w+1)), v[0] )
  402. from mmgen.ui import do_pager
  403. do_pager('\n'.join(gen_output()))
  404. Msg( '\n' + ' '.join(e[0] for e in ginfo) )
  405. sys.exit(0)
  406. def find_cmd_in_groups(self,cmd,group=None):
  407. """
  408. Search for a test command in specified group or all configured command groups
  409. and return it as a string. Loads modules but alters no global variables.
  410. """
  411. if group:
  412. if not group in [e[0] for e in self.cmd_groups]:
  413. die(1,f'{group!r}: unrecognized group')
  414. groups = [self.cmd_groups[group]]
  415. else:
  416. groups = self.cmd_groups
  417. for gname in groups:
  418. cls = self.get_cls_by_gname(gname)
  419. if not hasattr(cls,'cmd_group'):
  420. cls.cmd_group = self.create_cmd_group(cls)
  421. if cmd in cls.cmd_group: # first search the class
  422. return gname
  423. if cmd in dir(cls(None,None,None)): # then a throwaway instance
  424. return gname # cmd might exist in more than one group - we'll go with the first
  425. return None
  426. class TestSuiteRunner(object):
  427. 'test suite runner'
  428. def __del__(self):
  429. if cfg.log:
  430. self.log_fd.close()
  431. def __init__(self,data_dir,trash_dir):
  432. self.data_dir = data_dir
  433. self.trash_dir = trash_dir
  434. self.cmd_total = 0
  435. self.rebuild_list = {}
  436. self.gm = CmdGroupMgr()
  437. self.repo_root = repo_root
  438. self.skipped_warnings = []
  439. self.resume_cmd = None
  440. self.deps_only = None
  441. if cfg.log:
  442. self.log_fd = open(log_file,'a')
  443. self.log_fd.write(f'\nLog started: {make_timestr()} UTC\n')
  444. omsg(f'INFO → Logging to file {log_file!r}')
  445. else:
  446. self.log_fd = None
  447. if cfg.coverage:
  448. coverdir,accfile = init_coverage()
  449. omsg(f'INFO → Writing coverage files to {coverdir!r}')
  450. self.pre_args = ['python3','-m','trace','--count','--coverdir='+coverdir,'--file='+accfile]
  451. else:
  452. self.pre_args = ['python3'] if gc.platform == 'win' else []
  453. if cfg.pexpect_spawn:
  454. omsg(f'INFO → Using pexpect.spawn() for real terminal emulation')
  455. self.set_spawn_env()
  456. def set_spawn_env(self):
  457. self.spawn_env = dict(os.environ)
  458. self.spawn_env.update({
  459. 'MMGEN_NO_LICENSE': '1',
  460. 'MMGEN_BOGUS_SEND': '1',
  461. 'MMGEN_TEST_SUITE_PEXPECT': '1',
  462. 'EXEC_WRAPPER_SPAWN':'1',
  463. # if test.py itself is running under exec_wrapper, disable writing of traceback file for spawned script
  464. 'EXEC_WRAPPER_TRACEBACK': '' if os.getenv('MMGEN_EXEC_WRAPPER') else '1',
  465. })
  466. if cfg.exact_output:
  467. from mmgen.term import get_terminal_size
  468. self.spawn_env['MMGEN_COLUMNS'] = str(get_terminal_size().width)
  469. else:
  470. self.spawn_env['MMGEN_COLUMNS'] = '120'
  471. if not cfg.system:
  472. self.spawn_env['PYTHONPATH'] = repo_root
  473. def spawn_wrapper(self,cmd,
  474. args = [],
  475. extra_desc = '',
  476. no_output = False,
  477. msg_only = False,
  478. no_msg = False,
  479. cmd_dir = 'cmds',
  480. no_exec_wrapper = False,
  481. timeout = None,
  482. pexpect_spawn = None,
  483. direct_exec = False,
  484. env = {} ):
  485. desc = self.ts.test_name if cfg.names else self.gm.dpy_data[self.ts.test_name][1]
  486. if extra_desc:
  487. desc += ' ' + extra_desc
  488. cmd_path = (
  489. cmd if cfg.system # cfg.system is broken for main test group with overlay tree
  490. else os.path.relpath(os.path.join(repo_root,cmd_dir,cmd)) )
  491. args = (
  492. self.pre_args +
  493. ([] if no_exec_wrapper else ['scripts/exec_wrapper.py']) +
  494. [cmd_path] +
  495. self.passthru_opts +
  496. self.ts.extra_spawn_args +
  497. args )
  498. qargs = ['{q}{}{q}'.format( a, q = "'" if ' ' in a else '' ) for a in args]
  499. cmd_disp = ' '.join(qargs).replace('\\','/') # for mingw
  500. if cfg.log:
  501. self.log_fd.write('[{}][{}:{}] {}\n'.format(
  502. proto.coin.lower(),
  503. self.ts.group_name,
  504. self.ts.test_name,
  505. cmd_disp))
  506. for i in args: # die only after writing log entry
  507. if not isinstance(i,str):
  508. die(2,'Error: missing input files in cmd line?:\nName: {}\nCmdline: {!r}'.format(
  509. self.ts.test_name,
  510. args ))
  511. if not no_msg:
  512. t_pfx = '' if cfg.no_timings else f'[{time.time() - self.start_time:08.2f}] '
  513. if cfg.verbose or cfg.print_cmdline or cfg.exact_output:
  514. omsg(green(f'{t_pfx}Testing: {desc}'))
  515. if not msg_only:
  516. clr1,clr2 = (nocolor,nocolor) if cfg.print_cmdline else (green,cyan)
  517. omsg(
  518. clr1('Executing: ') +
  519. clr2(repr(cmd_disp) if gc.platform == 'win' else cmd_disp)
  520. )
  521. else:
  522. omsg_r('{a}Testing {b}: {c}'.format(
  523. a = t_pfx,
  524. b = desc,
  525. c = 'OK\n' if direct_exec or cfg.direct_exec else ''))
  526. if msg_only:
  527. return
  528. # NB: the `pexpect_spawn` arg enables hold_protect and send_delay while the corresponding cmdline
  529. # option does not. For performance reasons, this is the desired behavior. For full emulation of
  530. # the user experience with hold protect enabled, specify --buf-keypress or --demo.
  531. send_delay = 0.4 if pexpect_spawn is True or cfg.buf_keypress else None
  532. pexpect_spawn = pexpect_spawn if pexpect_spawn is not None else bool(cfg.pexpect_spawn)
  533. spawn_env = dict(self.ts.spawn_env)
  534. spawn_env.update({
  535. 'MMGEN_HOLD_PROTECT_DISABLE': '' if send_delay else '1',
  536. 'MMGEN_TEST_SUITE_POPEN_SPAWN': '' if pexpect_spawn else '1',
  537. })
  538. spawn_env.update(env)
  539. from test.include.pexpect import MMGenPexpect
  540. return MMGenPexpect(
  541. args = args,
  542. no_output = no_output,
  543. spawn_env = spawn_env,
  544. pexpect_spawn = pexpect_spawn,
  545. timeout = timeout,
  546. send_delay = send_delay,
  547. direct_exec = direct_exec )
  548. def end_msg(self):
  549. t = int(time.time() - self.start_time)
  550. sys.stderr.write(green(
  551. f'{self.cmd_total} test{suf(self.cmd_total)} performed' +
  552. ('\n' if cfg.no_timings else f'. Elapsed time: {t//60:02d}:{t%60:02d}\n')
  553. ))
  554. def init_group(self,gname,sg_name=None,cmd=None,quiet=False,do_clean=True):
  555. ts_cls = CmdGroupMgr().load_mod(gname)
  556. if gc.platform == 'win' and ts_cls.win_skip:
  557. omsg(f'Skipping test {gname!r} for Windows platform')
  558. return False
  559. for k in ('segwit','segwit_random','bech32'):
  560. if getattr(cfg,k):
  561. segwit_opt = k
  562. break
  563. else:
  564. segwit_opt = None
  565. def gen_msg():
  566. yield ('{g}:{c}' if cmd else 'test group {g!r}').format(g=gname,c=cmd)
  567. if len(ts_cls.networks) != 1:
  568. yield f' for {proto.coin} {proto.network}'
  569. if segwit_opt:
  570. yield ' (--{})'.format( segwit_opt.replace('_','-') )
  571. m = ''.join(gen_msg())
  572. if segwit_opt and not ts_cls.segwit_opts_ok:
  573. iqmsg('INFO → skipping ' + m)
  574. return False
  575. # 'networks = ()' means all networks allowed
  576. nws = [(e.split('_')[0],'testnet') if '_' in e else (e,'mainnet') for e in ts_cls.networks]
  577. if nws:
  578. coin = proto.coin.lower()
  579. nw = ('mainnet','testnet')[proto.testnet]
  580. for a,b in nws:
  581. if a == coin and b == nw:
  582. break
  583. else:
  584. iqmsg('INFO → skipping ' + m)
  585. return False
  586. if do_clean:
  587. clean(ts_cls.tmpdir_nums,clean_overlay=False)
  588. if not quiet:
  589. bmsg('Executing ' + m)
  590. if (not self.daemon_started) and self.gm.get_cls_by_gname(gname).need_daemon:
  591. start_test_daemons(network_id,remove_datadir=True)
  592. self.daemon_started = True
  593. self.ts = self.gm.gm_init_group(self,gname,sg_name,self.spawn_wrapper)
  594. self.ts_clsname = type(self.ts).__name__
  595. # pass through opts from cmdline (po.user_opts)
  596. self.passthru_opts = ['--{}{}'.format(
  597. k.replace('_','-'),
  598. '' if cfg._uopts[k] is True else '=' + cfg._uopts[k]
  599. ) for k in cfg._uopts if k in self.ts.base_passthru_opts + self.ts.passthru_opts]
  600. if cfg.resuming:
  601. rc = cfg.resume or cfg.resume_after
  602. offset = 1 if cfg.resume_after else 0
  603. self.resume_cmd = self.gm.cmd_list[self.gm.cmd_list.index(rc)+offset]
  604. omsg(f'INFO → Resuming at command {self.resume_cmd!r}')
  605. if cfg.step:
  606. cfg.exit_after = self.resume_cmd
  607. if cfg.exit_after and cfg.exit_after not in self.gm.cmd_list:
  608. die(1,f'{cfg.exit_after!r}: command not recognized')
  609. return True
  610. def run_tests(self,cmd_args):
  611. self.start_time = time.time()
  612. self.daemon_started = False
  613. gname_save = None
  614. if cmd_args:
  615. for arg in cmd_args:
  616. if arg in self.gm.cmd_groups:
  617. if not self.init_group(arg):
  618. continue
  619. for cmd in self.gm.cmd_list:
  620. self.check_needs_rerun(cmd,build=True)
  621. do_between()
  622. else:
  623. def parse_arg(arg):
  624. if '.' in arg:
  625. a,b = arg.split('.')
  626. return [a] + b.split(':') if ':' in b else [a,b,None]
  627. elif ':' in arg:
  628. a,b = arg.split(':')
  629. return [a,None,b]
  630. else:
  631. return [self.gm.find_cmd_in_groups(arg),None,arg]
  632. gname,sg_name,cmdname = parse_arg(arg)
  633. if gname:
  634. same_grp = gname == gname_save # same group as previous cmd: don't clean, suppress blue msg
  635. if not self.init_group(gname,sg_name,cmdname,quiet=same_grp,do_clean=not same_grp):
  636. continue
  637. if cmdname:
  638. if cfg.deps_only:
  639. self.deps_only = cmdname
  640. try:
  641. self.check_needs_rerun(cmdname,build=True)
  642. except Exception as e: # allow calling of functions not in cmd_group
  643. if isinstance(e,KeyError) and e.args[0] == cmdname:
  644. ret = getattr(self.ts,cmdname)()
  645. if type(ret).__name__ == 'coroutine':
  646. async_run(ret)
  647. else:
  648. raise
  649. do_between()
  650. else:
  651. for cmd in self.gm.cmd_list:
  652. self.check_needs_rerun(cmd,build=True)
  653. do_between()
  654. gname_save = gname
  655. else:
  656. die(1,f'{arg!r}: command not recognized')
  657. else:
  658. if cfg.exclude_groups:
  659. exclude = cfg.exclude_groups.split(',')
  660. for e in exclude:
  661. if e not in self.gm.cmd_groups_dfl:
  662. die(1,f'{e!r}: group not recognized')
  663. for gname in self.gm.cmd_groups_dfl:
  664. if cfg.exclude_groups and gname in exclude:
  665. continue
  666. if not self.init_group(gname):
  667. continue
  668. for cmd in self.gm.cmd_list:
  669. self.check_needs_rerun(cmd,build=True)
  670. do_between()
  671. self.end_msg()
  672. def check_needs_rerun(self,cmd,
  673. build = False,
  674. root = True,
  675. force_delete = False,
  676. dpy = False ):
  677. self.ts.test_name = cmd
  678. if self.ts_clsname == 'TestSuiteMain' and testing_segwit and cmd not in self.ts.segwit_do:
  679. return False
  680. rerun = root # force_delete is not passed to recursive call
  681. fns = []
  682. if force_delete or not root:
  683. # does cmd produce a needed dependency(ies)?
  684. ret = self.get_num_exts_for_cmd(cmd,dpy)
  685. if ret:
  686. for ext in ret[1]:
  687. fn = get_file_with_ext(cfgs[ret[0]]['tmpdir'],ext,delete=build)
  688. if fn:
  689. if force_delete: os.unlink(fn)
  690. else: fns.append(fn)
  691. else: rerun = True
  692. fdeps = self.generate_file_deps(cmd)
  693. cdeps = self.generate_cmd_deps(fdeps)
  694. for fn in fns:
  695. my_age = os.stat(fn).st_mtime
  696. for num,ext in fdeps:
  697. f = get_file_with_ext(cfgs[num]['tmpdir'],ext,delete=build)
  698. if f and os.stat(f).st_mtime > my_age:
  699. rerun = True
  700. for cdep in cdeps:
  701. if self.check_needs_rerun(cdep,build=build,root=False,dpy=cmd):
  702. rerun = True
  703. if build:
  704. if rerun:
  705. for fn in fns:
  706. if not root:
  707. os.unlink(fn)
  708. if not (dpy and cfg.skipping_deps):
  709. self.run_test(cmd)
  710. if not root:
  711. do_between()
  712. else:
  713. # If prog produces multiple files:
  714. if cmd not in self.rebuild_list or rerun == True:
  715. self.rebuild_list[cmd] = (rerun,fns[0] if fns else '') # FIX
  716. return rerun
  717. def run_test(self,cmd):
  718. if self.deps_only and cmd == self.deps_only:
  719. sys.exit(0)
  720. d = [(str(num),ext) for exts,num in self.gm.dpy_data[cmd][2] for ext in exts]
  721. # delete files depended on by this cmd
  722. arg_list = [get_file_with_ext(cfgs[num]['tmpdir'],ext) for num,ext in d]
  723. # remove shared_deps from arg list
  724. if hasattr(self.ts,'shared_deps'):
  725. arg_list = arg_list[:-len(self.ts.shared_deps)]
  726. if self.resume_cmd:
  727. if cmd != self.resume_cmd:
  728. return
  729. bmsg(f'Resuming at {self.resume_cmd!r}')
  730. self.resume_cmd = None
  731. cfg.skipping_deps = False
  732. cfg.resuming = False
  733. if cfg.profile:
  734. start = time.time()
  735. self.ts.test_name = cmd # NB: Do not remove, this needs to be set twice
  736. cdata = self.gm.dpy_data[cmd]
  737. # self.ts.test_dpydata = cdata
  738. self.ts.tmpdir_num = cdata[0]
  739. # self.ts.cfg = cfgs[str(cdata[0])] # will remove this eventually
  740. test_cfg = cfgs[str(cdata[0])]
  741. for k in ( 'seed_len', 'seed_id',
  742. 'wpasswd', 'kapasswd',
  743. 'segwit', 'hash_preset',
  744. 'bw_filename', 'bw_params', 'ref_bw_seed_id',
  745. 'addr_idx_list', 'pass_idx_list' ):
  746. if k in test_cfg:
  747. setattr(self.ts,k,test_cfg[k])
  748. ret = getattr(self.ts,cmd)(*arg_list) # run the test
  749. if type(ret).__name__ == 'coroutine':
  750. ret = async_run(ret)
  751. self.process_retval(cmd,ret)
  752. if cfg.profile:
  753. omsg('\r\033[50C{:.4f}'.format( time.time() - start ))
  754. if cmd == cfg.exit_after:
  755. sys.exit(0)
  756. def warn_skipped(self):
  757. if self.skipped_warnings:
  758. print(yellow('The following tests were skipped and may require attention:'))
  759. r = '-' * 72 + '\n'
  760. print(r+('\n'+r).join(self.skipped_warnings))
  761. def process_retval(self,cmd,ret):
  762. if type(ret).__name__ == 'MMGenPexpect':
  763. ret.ok()
  764. self.cmd_total += 1
  765. elif ret == 'ok':
  766. ok()
  767. self.cmd_total += 1
  768. elif ret == 'error':
  769. die(2,red(f'\nTest {self.ts.test_name!r} failed'))
  770. elif ret in ('skip','silent'):
  771. if ret == 'silent':
  772. self.cmd_total += 1
  773. elif type(ret) == tuple and ret[0] == 'skip_warn':
  774. self.skipped_warnings.append(
  775. 'Test {!r} was skipped:\n {}'.format(cmd,'\n '.join(ret[1].split('\n'))))
  776. else:
  777. die(2,f'{cmd!r} returned {ret}')
  778. def check_deps(self,cmds): # TODO: broken
  779. if len(cmds) != 1:
  780. die(1,f'Usage: {gc.prog_name} check_deps <command>')
  781. cmd = cmds[0]
  782. if cmd not in self.gm.cmd_list:
  783. die(1,f'{cmd!r}: unrecognized command')
  784. if not cfg.quiet:
  785. omsg(f'Checking dependencies for {cmd!r}')
  786. self.check_needs_rerun(self.ts,cmd,build=False)
  787. w = max(map(len,self.rebuild_list)) + 1
  788. for cmd in self.rebuild_list:
  789. c = self.rebuild_list[cmd]
  790. m = 'Rebuild' if (c[0] and c[1]) else 'Build' if c[0] else 'OK'
  791. omsg('cmd {:<{w}} {}'.format( cmd+':', m, w=w ))
  792. def generate_file_deps(self,cmd):
  793. return [(str(n),e) for exts,n in self.gm.dpy_data[cmd][2] for e in exts]
  794. def generate_cmd_deps(self,fdeps):
  795. return [cfgs[str(n)]['dep_generators'][ext] for n,ext in fdeps]
  796. def get_num_exts_for_cmd(self,cmd,dpy=False): # dpy ignored here
  797. try:
  798. num = str(self.gm.dpy_data[cmd][0])
  799. except KeyError:
  800. qmsg_r(f'Missing dependency {cmd!r}')
  801. gname = self.gm.find_cmd_in_groups(cmd)
  802. if gname:
  803. kwargs = self.gm.cmd_groups[gname][1]
  804. kwargs.update({'add_dpy':True})
  805. self.gm.create_group(gname,None,**kwargs)
  806. num = str(self.gm.dpy_data[cmd][0])
  807. qmsg(f' found in group {gname!r}')
  808. else:
  809. qmsg(' not found in any command group!')
  810. raise
  811. dgl = cfgs[num]['dep_generators']
  812. if cmd in dgl.values():
  813. exts = [k for k in dgl if dgl[k] == cmd]
  814. return (num,exts)
  815. else:
  816. return None
  817. # main()
  818. if not cfg.skipping_deps: # do this before list cmds exit, so we stay in sync with shm_dir
  819. create_tmp_dirs(shm_dir)
  820. if cfg.list_cmd_groups:
  821. CmdGroupMgr().list_cmd_groups()
  822. elif cfg.list_cmds:
  823. list_cmds()
  824. elif cmd_args and cmd_args[0] in utils:
  825. globals()[cmd_args[0]](*cmd_args[1:])
  826. sys.exit(0)
  827. if cfg.pause:
  828. set_restore_term_at_exit()
  829. from mmgen.exception import TestSuiteException,TestSuiteFatalException
  830. try:
  831. tr = TestSuiteRunner(data_dir,trash_dir)
  832. tr.run_tests(cmd_args)
  833. tr.warn_skipped()
  834. if tr.daemon_started:
  835. stop_test_daemons(network_id)
  836. except KeyboardInterrupt:
  837. if tr.daemon_started:
  838. stop_test_daemons(network_id)
  839. tr.warn_skipped()
  840. die(1,'\ntest.py exiting at user request')
  841. except TestSuiteException as e:
  842. die(2,e.args[0])
  843. except TestSuiteFatalException as e:
  844. die(4,e.args[0])
  845. except Exception:
  846. if os.getenv('MMGEN_EXEC_WRAPPER'): # test.py itself is running under exec_wrapper
  847. import traceback
  848. print(''.join(traceback.format_exception(*sys.exc_info())))
  849. msg(blue('Test script exited with error'))
  850. else:
  851. msg(blue('Spawned script exited with error'))
  852. raise
  853. except:
  854. raise