test.py 32 KB

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