pexpect.py 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  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
  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. if not opt.pexpect_spawn:
  71. self.p.sendeof()
  72. self.p.read()
  73. ret = self.p.wait()
  74. if ret != self.req_exit_val and not opt.coverage:
  75. die(1,red(f'test.py: spawned program exited with value {ret}'))
  76. if opt.profile:
  77. return
  78. if not self.skip_ok:
  79. m = 'OK\n' if ret == 0 else f'OK[{ret}]\n'
  80. sys.stderr.write( green(m) if opt.exact_output or opt.verbose else ' '+m )
  81. return self
  82. def license(self):
  83. if 'MMGEN_NO_LICENSE' in os.environ: return
  84. self.expect("'w' for conditions and warranty info, or 'c' to continue: ",'c')
  85. def label(self,label='Test Label (UTF-8) α'):
  86. self.expect('Enter a wallet label, or hit ENTER for no label: ',label+'\n')
  87. def usr_rand(self,num_chars):
  88. if opt.usr_random:
  89. self.interactive()
  90. self.send('\n')
  91. else:
  92. rand_chars = list(getrandstr(num_chars,no_space=True))
  93. vmsg_r('SEND ')
  94. while rand_chars:
  95. ch = rand_chars.pop(0)
  96. msg_r(yellow(ch)+' ' if opt.verbose else '+')
  97. ret = self.expect('left: ',ch,delay=0.005)
  98. self.expect('ENTER to continue: ','\n')
  99. def passphrase_new(self,desc,passphrase):
  100. self.expect(f'Enter passphrase for {desc}: ',passphrase+'\n')
  101. self.expect('Repeat passphrase: ',passphrase+'\n')
  102. def passphrase(self,desc,passphrase,pwtype=''):
  103. if pwtype: pwtype += ' '
  104. self.expect(f'Enter {pwtype}passphrase for {desc}.*?: ',passphrase+'\n',regex=True)
  105. def hash_preset(self,desc,preset=''):
  106. self.expect(f'Enter hash preset for {desc}')
  107. self.expect('or hit ENTER .*?:',str(preset)+'\n',regex=True)
  108. def written_to_file(self,desc,overwrite_unlikely=False,query='Overwrite? ',oo=False):
  109. s1 = f'{desc} written to file '
  110. s2 = query + "Type uppercase 'YES' to confirm: "
  111. ret = self.expect(([s1,s2],s1)[overwrite_unlikely])
  112. if ret == 1:
  113. self.send('YES\n')
  114. return self.expect_getend("Overwriting file '").rstrip("'")
  115. self.expect(NL,nonl=True)
  116. outfile = self.p.before.strip().strip("'")
  117. if opt.debug_pexpect:
  118. rmsg(f'Outfile [{outfile}]')
  119. vmsg('{} file: {}'.format( desc, cyan(outfile.replace('"',"")) ))
  120. return outfile
  121. def hincog_create(self,hincog_bytes):
  122. ret = self.expect(['Create? (Y/n): ',"'YES' to confirm: "])
  123. if ret == 0:
  124. self.send('\n')
  125. self.expect('Enter file size: ',str(hincog_bytes)+'\n')
  126. else:
  127. self.send('YES\n')
  128. return ret
  129. def no_overwrite(self):
  130. self.expect("Overwrite? Type uppercase 'YES' to confirm: ",'\n')
  131. self.expect('Exiting at user request')
  132. def expect_getend(self,s,regex=False):
  133. ret = self.expect(s,regex=regex,nonl=True)
  134. debug_pexpect_msg(self.p)
  135. # readline() of partial lines doesn't work with PopenSpawn, so do this instead:
  136. self.expect(NL,nonl=True,silent=True)
  137. debug_pexpect_msg(self.p)
  138. end = self.p.before.rstrip()
  139. if not g.debug:
  140. vmsg(f' ==> {cyan(end)}')
  141. return end
  142. def interactive(self):
  143. return self.p.interact() # interact() not available with popen_spawn
  144. def kill(self,signal):
  145. return self.p.kill(signal)
  146. def match_expect_list(self,expect_list,greedy=False):
  147. res = strip_ansi_escapes(self.read()).replace('\r','')
  148. allrep = '.*' if greedy else '.*?'
  149. expect = (
  150. r'(\b|\s)' +
  151. fr'\s{allrep}\s'.join(s.replace(r'.',r'\.').replace(' ',r'\s+') for s in expect_list) +
  152. r'(\b|\s)' )
  153. m = re.search(expect,res,re.DOTALL)
  154. assert m, f'No match found for regular expression {expect!r}'
  155. return m
  156. def expect(self,s,t='',delay=None,regex=False,nonl=False,silent=False):
  157. delay = delay or (0,0.3)[bool(opt.buf_keypress)]
  158. if not silent:
  159. if opt.verbose:
  160. msg_r('EXPECT ' + yellow(str(s)))
  161. elif not opt.exact_output: msg_r('+')
  162. try:
  163. if s == '':
  164. ret = 0
  165. else:
  166. f = (self.p.expect_exact,self.p.expect)[bool(regex)]
  167. ret = f(s)
  168. except pexpect.TIMEOUT:
  169. if opt.debug_pexpect:
  170. raise
  171. m1 = f'\nERROR. Expect {s!r} timed out. Exiting\n'
  172. m2 = f'before: [{self.p.before}]\n'
  173. m3 = f'sent value: [{self.sent_value}]' if self.sent_value != None else ''
  174. die(2,m1+m2+m3)
  175. debug_pexpect_msg(self.p)
  176. if opt.verbose and type(s) != str:
  177. msg_r(f' ==> {ret} ')
  178. if ret == -1:
  179. die(4,f'Error. Expect returned {ret}')
  180. else:
  181. if t == '':
  182. if not nonl and not silent: vmsg('')
  183. else:
  184. self.send(t,delay,s)
  185. return ret
  186. def send(self,t,delay=None,s=False):
  187. self.sent_value = None
  188. delay = delay or (0,0.3)[bool(opt.buf_keypress)]
  189. if delay: time.sleep(delay)
  190. ret = self.p.send(t) # returns num bytes written
  191. if ret:
  192. self.sent_value = t
  193. if delay: time.sleep(delay)
  194. if opt.verbose:
  195. ls = '' if opt.debug or not s else ' '
  196. es = '' if s else ' '
  197. yt = yellow('{!r}'.format( t.replace('\n',r'\n') ))
  198. msg(f'{ls}SEND {es}{yt}')
  199. return ret
  200. def read(self,n=-1):
  201. return self.p.read(n)
  202. def close(self):
  203. if opt.pexpect_spawn:
  204. self.p.close()