ts_shared.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278
  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_d.ts_shared: Shared methods for the test.py test suite
  20. """
  21. import os
  22. from mmgen.util import ymsg,get_extension
  23. from mmgen.wallet import get_wallet_cls
  24. from ..include.common import *
  25. from .common import *
  26. class TestSuiteShared(object):
  27. 'shared methods for the test.py test suite'
  28. def txcreate_ui_common(self,t,
  29. caller = None,
  30. menu = [],
  31. inputs = '1',
  32. file_desc = 'Unsigned transaction',
  33. input_sels_prompt = 'to spend',
  34. bad_input_sels = False,
  35. interactive_fee = '',
  36. fee_desc = 'transaction fee',
  37. fee_info_pat = None,
  38. add_comment = '',
  39. view = 't',
  40. save = True,
  41. tweaks = [],
  42. used_chg_addr_resp = None,
  43. auto_chg_addr = None ):
  44. txdo = (caller or self.test_name)[:4] == 'txdo'
  45. expect_pat = r'\[q\]uit menu, .*?:.'
  46. delete_pat = r'Enter account number .*:.'
  47. confirm_pat = r'Is this what you want.*:.'
  48. if used_chg_addr_resp is not None:
  49. t.expect('reuse harms your privacy.*:.*',used_chg_addr_resp,regex=True)
  50. if auto_chg_addr is not None:
  51. e1 = 'Choose a change address:.*Enter a number> '
  52. e2 = fr'Using .*{auto_chg_addr}.* as.*address'
  53. res = t.expect([e1,e2],regex=True)
  54. if res == 0:
  55. choice = [s.split(')')[0].lstrip() for s in t.p.match[0].split('\n') if auto_chg_addr in s][0]
  56. t.send(f'{choice}\n')
  57. t.expect(e2,regex=True)
  58. t.send('y')
  59. pat = expect_pat
  60. for choice in menu + ['q']:
  61. t.expect(pat,choice,regex=True)
  62. if self.proto.base_proto == 'Ethereum':
  63. pat = confirm_pat if pat == delete_pat else delete_pat if choice == 'D' else expect_pat
  64. if bad_input_sels:
  65. for r in ('x','3-1','9999'):
  66. t.expect(input_sels_prompt+': ',r+'\n')
  67. t.expect(input_sels_prompt+': ',inputs+'\n')
  68. have_est_fee = t.expect([f'{fee_desc}: ','OK? (Y/n): ']) == 1
  69. if have_est_fee and not interactive_fee:
  70. t.send('y')
  71. else:
  72. if have_est_fee:
  73. t.send('n')
  74. t.expect(f'{fee_desc}: ',interactive_fee+'\n')
  75. else:
  76. t.send(interactive_fee+'\n')
  77. if fee_info_pat:
  78. t.expect(fee_info_pat,regex=True)
  79. t.expect('OK? (Y/n): ','y')
  80. t.expect('(Y/n): ','\n') # chg amt OK prompt
  81. if 'confirm_non_mmgen' in tweaks:
  82. t.expect('Continue? (Y/n)','\n')
  83. t.do_comment(add_comment)
  84. t.view_tx(view)
  85. if not txdo:
  86. t.expect('(y/N): ',('n','y')[save])
  87. t.written_to_file(file_desc)
  88. return t
  89. def txsign_ui_common(self,t,
  90. caller = None,
  91. view = 't',
  92. add_comment = '',
  93. file_desc = 'Signed transaction',
  94. ni = False,
  95. save = True,
  96. do_passwd = False,
  97. has_label = False ):
  98. txdo = (caller or self.test_name)[:4] == 'txdo'
  99. if do_passwd:
  100. t.passphrase('MMGen wallet',self.wpasswd)
  101. if not ni and not txdo:
  102. t.view_tx(view)
  103. t.do_comment(add_comment,has_label=has_label)
  104. t.expect('(Y/n): ',('n','y')[save])
  105. t.written_to_file(file_desc)
  106. return t
  107. def txsend_ui_common(self,t,
  108. caller = None,
  109. view = 'n',
  110. add_comment = '',
  111. file_desc = 'Sent transaction',
  112. confirm_send = True,
  113. bogus_send = True,
  114. quiet = False,
  115. has_label = False ):
  116. txdo = (caller or self.test_name)[:4] == 'txdo'
  117. if not txdo:
  118. t.license() # MMGEN_NO_LICENSE is set, so does nothing
  119. t.view_tx(view)
  120. t.do_comment(add_comment,has_label=has_label)
  121. self._do_confirm_send(t,quiet=quiet,confirm_send=confirm_send)
  122. if bogus_send:
  123. txid = ''
  124. t.expect('BOGUS transaction NOT sent')
  125. else:
  126. txid = strip_ansi_escapes(t.expect_getend('Transaction sent: '))
  127. assert len(txid) == 64, f'{txid!r}: Incorrect txid length!'
  128. t.written_to_file(file_desc)
  129. return txid
  130. def txsign_end(self,t,tnum=None,has_label=False):
  131. t.expect('Signing transaction')
  132. t.do_comment(False,has_label=has_label)
  133. t.expect(r'Save signed transaction.*?\? \(Y/n\): ','y',regex=True)
  134. t.written_to_file('Signed transaction' + (' #' + tnum if tnum else ''), oo=True)
  135. return t
  136. def txsign(self,wf,txfile,
  137. pf = '',
  138. bumpf = '',
  139. save = True,
  140. has_label = False,
  141. extra_opts = [],
  142. extra_desc = '',
  143. view = 'n',
  144. dfl_wallet = False ):
  145. opts = extra_opts + ['-d',self.tmpdir,txfile] + ([wf] if wf else [])
  146. t = self.spawn('mmgen-txsign', opts, extra_desc)
  147. t.license()
  148. t.view_tx(view)
  149. wcls = get_wallet_cls( ext = 'mmdat' if dfl_wallet else get_extension(wf) )
  150. if wcls.enc and wcls.type != 'brain':
  151. t.passphrase(wcls.desc,self.wpasswd)
  152. if save:
  153. self.txsign_end(t,has_label=has_label)
  154. else:
  155. t.do_comment(False,has_label=has_label)
  156. t.expect('Save signed transaction? (Y/n): ','n')
  157. t.expect('not saved')
  158. t.req_exit_val = 1
  159. return t
  160. def ref_brain_chk(self,bw_file=ref_bw_file):
  161. wf = joinpath(ref_dir,bw_file)
  162. add_args = [f'-l{self.seed_len}', f'-p{ref_bw_hash_preset}']
  163. return self.walletchk(wf,pf=None,add_args=add_args,sid=self.ref_bw_seed_id)
  164. def walletchk(self,wf,pf,wcls=None,add_args=[],sid=None,extra_desc='',dfl_wallet=False):
  165. hp = self.hash_preset if hasattr(self,'hash_preset') else '1'
  166. wcls = wcls or get_wallet_cls(ext=get_extension(wf))
  167. t = self.spawn('mmgen-walletchk',
  168. ([] if dfl_wallet else ['-i',wcls.fmt_codes[0]])
  169. + add_args + ['-p',hp]
  170. + ([wf] if wf else []),
  171. extra_desc=extra_desc)
  172. if wcls.type != 'incog_hidden':
  173. t.expect(f"Getting {wcls.desc} from file '")
  174. if wcls.enc and wcls.type != 'brain':
  175. t.passphrase(wcls.desc,self.wpasswd)
  176. t.expect(['Passphrase is OK', 'Passphrase.* are correct'],regex=True)
  177. chk = t.expect_getend(f'Valid {wcls.desc} for Seed ID ')[:8]
  178. if sid:
  179. cmp_or_die(chk,sid)
  180. return t
  181. def addrgen(self,wf,
  182. pf = None,
  183. check_ref = False,
  184. ftype = 'addr',
  185. id_str = None,
  186. extra_args = [],
  187. mmtype = None,
  188. stdout = False,
  189. dfl_wallet = False ):
  190. passgen = ftype[:4] == 'pass'
  191. if not mmtype and not passgen:
  192. mmtype = self.segwit_mmtype
  193. cmd_pfx = (ftype,'pass')[passgen]
  194. t = self.spawn(f'mmgen-{cmd_pfx}gen',
  195. ['-d',self.tmpdir] + extra_args +
  196. ([],['--type='+str(mmtype)])[bool(mmtype)] +
  197. ([],['--stdout'])[stdout] +
  198. ([],[wf])[bool(wf)] +
  199. ([],[id_str])[bool(id_str)] +
  200. [getattr(self,f'{cmd_pfx}_idx_list')],
  201. extra_desc=f'({mmtype})' if mmtype in ('segwit','bech32') else '')
  202. t.license()
  203. wcls = get_wallet_cls( ext = 'mmdat' if dfl_wallet else get_extension(wf) )
  204. t.passphrase(wcls.desc,self.wpasswd)
  205. t.expect('Passphrase is OK')
  206. desc = ('address','password')[passgen]
  207. chk = t.expect_getend(rf'Checksum for {desc} data .*?: ',regex=True)
  208. if passgen:
  209. t.expect('Encrypt password list? (y/N): ','N')
  210. t.read() if stdout else t.written_to_file(('Addresses','Password list')[passgen])
  211. if check_ref:
  212. chk_ref = (self.chk_data[self.test_name] if passgen else
  213. self.chk_data[self.test_name][self.fork][self.proto.testnet])
  214. cmp_or_die(chk,chk_ref,desc=f'{ftype}list data checksum')
  215. return t
  216. def keyaddrgen(self,wf,pf=None,check_ref=False,mmtype=None):
  217. if not mmtype:
  218. mmtype = self.segwit_mmtype
  219. args = ['-d',self.tmpdir,self.usr_rand_arg,wf,self.addr_idx_list]
  220. t = self.spawn('mmgen-keygen',
  221. ([],['--type='+str(mmtype)])[bool(mmtype)] + args,
  222. extra_desc=f'({mmtype})' if mmtype in ('segwit','bech32') else '')
  223. t.license()
  224. wcls = get_wallet_cls(ext=get_extension(wf))
  225. t.passphrase(wcls.desc,self.wpasswd)
  226. chk = t.expect_getend(r'Checksum for key-address data .*?: ',regex=True)
  227. if check_ref:
  228. chk_ref = self.chk_data[self.test_name][self.fork][self.proto.testnet]
  229. cmp_or_die(chk,chk_ref,desc='key-address list data checksum')
  230. t.expect('Encrypt key list? (y/N): ','y')
  231. t.usr_rand(self.usr_rand_chars)
  232. t.hash_preset('new key-address list','1')
  233. t.passphrase_new('new key-address list',self.kapasswd)
  234. t.written_to_file('Encrypted secret keys',oo=True)
  235. return t
  236. def _do_confirm_send(self,t,quiet=False,confirm_send=True,sure=True):
  237. if sure:
  238. t.expect('Are you sure you want to broadcast this')
  239. m = ('YES, I REALLY WANT TO DO THIS','YES')[quiet]
  240. t.expect(f'{m!r} to confirm: ',('',m)[confirm_send]+'\n')