pexpect.py 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  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/pexpect.py: pexpect implementation for MMGen test suites
  20. """
  21. import sys,os,time
  22. from mmgen.globalvars import g
  23. from mmgen.opts import opt
  24. from mmgen.util import msg,msg_r,vmsg,vmsg_r,rmsg,red,yellow,green,cyan,die,rdie
  25. from .common import *
  26. try:
  27. import pexpect
  28. from pexpect.popen_spawn import PopenSpawn
  29. except ImportError as e:
  30. die(2,red(f'Pexpect module is missing. Cannnot run test suite ({e!r})'))
  31. def debug_pexpect_msg(p):
  32. if opt.debug_pexpect:
  33. msg('\n{}{}{}'.format( red('BEFORE ['), p.before, red(']') ))
  34. msg('{}{}{}'.format( red('MATCH ['), p.after, red(']') ))
  35. NL = '\n'
  36. class MMGenPexpect(object):
  37. def __init__(self,args,no_output=False,env=None):
  38. if opt.direct_exec:
  39. msg('')
  40. from subprocess import run,DEVNULL
  41. run([args[0]] + args[1:],check=True,stdout=DEVNULL if no_output else None)
  42. else:
  43. timeout = int(opt.pexpect_timeout or 0) or (60,5)[bool(opt.debug_pexpect)]
  44. if opt.pexpect_spawn:
  45. self.p = pexpect.spawn(args[0],args[1:],encoding='utf8',timeout=timeout,env=env)
  46. self.p.delaybeforesend = 0
  47. else:
  48. self.p = PopenSpawn(args,encoding='utf8',timeout=timeout,env=env)
  49. # self.p.delaybeforesend = 0 # TODO: try this here too
  50. if opt.exact_output:
  51. self.p.logfile = sys.stdout
  52. self.req_exit_val = 0
  53. self.skip_ok = False
  54. self.sent_value = None
  55. def do_decrypt_ka_data(self,hp,pw,desc='key-address data',check=True,have_yes_opt=False):
  56. # self.hash_preset(desc,hp)
  57. self.passphrase(desc,pw)
  58. if not have_yes_opt:
  59. self.expect('Check key-to-address validity? (y/N): ',('n','y')[check])
  60. def view_tx(self,view):
  61. self.expect(r'View.* transaction.*\? .*: ',view,regex=True)
  62. if view not in 'n\n':
  63. self.expect('to continue: ','\n')
  64. def do_comment(self,add_comment,has_label=False):
  65. p = ('Add a comment to transaction','Edit transaction comment')[has_label]
  66. self.expect(f'{p}? (y/N): ',('n','y')[bool(add_comment)])
  67. if add_comment:
  68. self.expect('Comment: ',add_comment+'\n')
  69. def ok(self):
  70. ret = self.p.wait()
  71. if ret != self.req_exit_val and not opt.coverage:
  72. die(1,red(f'test.py: spawned program exited with value {ret}'))
  73. if opt.profile:
  74. return
  75. if not self.skip_ok:
  76. sys.stderr.write(green('OK\n') if opt.exact_output or opt.verbose else (' OK\n'))
  77. return self
  78. def license(self):
  79. if 'MMGEN_NO_LICENSE' in os.environ: return
  80. self.expect("'w' for conditions and warranty info, or 'c' to continue: ",'c')
  81. def label(self,label='Test Label (UTF-8) α'):
  82. self.expect('Enter a wallet label, or hit ENTER for no label: ',label+'\n')
  83. def usr_rand(self,num_chars):
  84. if opt.usr_random:
  85. self.interactive()
  86. self.send('\n')
  87. else:
  88. rand_chars = list(getrandstr(num_chars,no_space=True))
  89. vmsg_r('SEND ')
  90. while rand_chars:
  91. ch = rand_chars.pop(0)
  92. msg_r(yellow(ch)+' ' if opt.verbose else '+')
  93. ret = self.expect('left: ',ch,delay=0.005)
  94. self.expect('ENTER to continue: ','\n')
  95. def passphrase_new(self,desc,passphrase):
  96. self.expect(f'Enter passphrase for {desc}: ',passphrase+'\n')
  97. self.expect('Repeat passphrase: ',passphrase+'\n')
  98. def passphrase(self,desc,passphrase,pwtype=''):
  99. if pwtype: pwtype += ' '
  100. self.expect(f'Enter {pwtype}passphrase for {desc}.*?: ',passphrase+'\n',regex=True)
  101. def hash_preset(self,desc,preset=''):
  102. self.expect(f'Enter hash preset for {desc}')
  103. self.expect('or hit ENTER .*?:',str(preset)+'\n',regex=True)
  104. def written_to_file(self,desc,overwrite_unlikely=False,query='Overwrite? ',oo=False):
  105. s1 = f'{desc} written to file '
  106. s2 = query + "Type uppercase 'YES' to confirm: "
  107. ret = self.expect(([s1,s2],s1)[overwrite_unlikely])
  108. if ret == 1:
  109. self.send('YES\n')
  110. return self.expect_getend("Overwriting file '").rstrip("'")
  111. self.expect(NL,nonl=True)
  112. outfile = self.p.before.strip().strip("'")
  113. if opt.debug_pexpect:
  114. rmsg(f'Outfile [{outfile}]')
  115. vmsg('{} file: {}'.format( desc, cyan(outfile.replace('"',"")) ))
  116. return outfile
  117. def hincog_create(self,hincog_bytes):
  118. ret = self.expect(['Create? (Y/n): ',"'YES' to confirm: "])
  119. if ret == 0:
  120. self.send('\n')
  121. self.expect('Enter file size: ',str(hincog_bytes)+'\n')
  122. else:
  123. self.send('YES\n')
  124. return ret
  125. def no_overwrite(self):
  126. self.expect("Overwrite? Type uppercase 'YES' to confirm: ",'\n')
  127. self.expect('Exiting at user request')
  128. def expect_getend(self,s,regex=False):
  129. ret = self.expect(s,regex=regex,nonl=True)
  130. debug_pexpect_msg(self.p)
  131. # readline() of partial lines doesn't work with PopenSpawn, so do this instead:
  132. self.expect(NL,nonl=True,silent=True)
  133. debug_pexpect_msg(self.p)
  134. end = self.p.before.rstrip()
  135. if not g.debug:
  136. vmsg(f' ==> {cyan(end)}')
  137. return end
  138. def interactive(self):
  139. return self.p.interact() # interact() not available with popen_spawn
  140. def kill(self,signal):
  141. return self.p.kill(signal)
  142. def expect(self,s,t='',delay=None,regex=False,nonl=False,silent=False):
  143. delay = delay or (0,0.3)[bool(opt.buf_keypress)]
  144. if not silent:
  145. if opt.verbose:
  146. msg_r('EXPECT ' + yellow(str(s)))
  147. elif not opt.exact_output: msg_r('+')
  148. try:
  149. if s == '':
  150. ret = 0
  151. else:
  152. f = (self.p.expect_exact,self.p.expect)[bool(regex)]
  153. ret = f(s)
  154. except pexpect.TIMEOUT:
  155. if opt.debug_pexpect: raise
  156. m1 = red(f'\nERROR. Expect {s!r} timed out. Exiting\n')
  157. m2 = f'before: [{self.p.before}]\n'
  158. m3 = f'sent value: [{self.sent_value}]' if self.sent_value != None else ''
  159. rdie(1,m1+m2+m3)
  160. debug_pexpect_msg(self.p)
  161. if opt.verbose and type(s) != str:
  162. msg_r(f' ==> {ret} ')
  163. if ret == -1:
  164. rdie(1,f'Error. Expect returned {ret}')
  165. else:
  166. if t == '':
  167. if not nonl and not silent: vmsg('')
  168. else:
  169. self.send(t,delay,s)
  170. return ret
  171. def send(self,t,delay=None,s=False):
  172. self.sent_value = None
  173. delay = delay or (0,0.3)[bool(opt.buf_keypress)]
  174. if delay: time.sleep(delay)
  175. ret = self.p.send(t) # returns num bytes written
  176. if ret:
  177. self.sent_value = t
  178. if delay: time.sleep(delay)
  179. if opt.verbose:
  180. ls = '' if opt.debug or not s else ' '
  181. es = '' if s else ' '
  182. yt = yellow('{!r}'.format( t.replace('\n',r'\n') ))
  183. msg(f'{ls}SEND {es}{yt}')
  184. return ret
  185. def read(self,n=-1):
  186. return self.p.read(n)
  187. def close(self):
  188. if opt.pexpect_spawn:
  189. self.p.close()