development/autotests/keytest.py

   1 #!/usr/bin/python
   2 # -*- coding: utf-8 -*-
   3 # This script generates hundreds of random keypresses per second,
   4 #  and sends them to the lyx window
   5 # It requires xvkbd and wmctrl
   6 # It generates a log of the KEYCODES it sends as development/keystest/out/KEYCODES
   7 #
   8 # Adapted by Tommaso Cucinotta from the original MonKey Test by
   9 # John McCabe-Dansted.
  10
  11 from __future__ import print_function
  12 import random
  13 import os
  14 import re
  15 import sys
  16 import time
  17 #from subprocess import call
  18 import subprocess
  19
  20 print('Beginning keytest.py')
  21
  22 FNULL = open('/dev/null', 'w')
  23
  24 key_delay = ''
  25
  26 class CommandSource:
  27
  28     def __init__(self):
  29         keycode = [
  30             "\[Left]",
  31             '\[Right]',
  32             '\[Down]',
  33             '\[Up]',
  34             '\[BackSpace]',
  35             '\[Delete]',
  36             '\[Escape]',
  37             ]
  38         keycode[:0] = keycode
  39         keycode[:0] = keycode
  40
  41         keycode[:0] = ['\\']
  42
  43         for k in range(97, 123):
  44             keycode[:0] = chr(k)
  45
  46         for k in range(97, 123):
  47             keycode[:0] = ["\A" + chr(k)]
  48
  49         for k in range(97, 123):
  50             keycode[:0] = ["\A" + chr(k)]
  51
  52         for k in range(97, 123):
  53             keycode[:0] = ["\C" + chr(k)]
  54
  55         self.keycode = keycode
  56         self.count = 0
  57         self.count_max = 1999
  58
  59     def getCommand(self):
  60         self.count = self.count + 1
  61         if self.count % 200 == 0:
  62             return 'RaiseLyx'
  63         elif self.count > self.count_max:
  64             os._exit(0)
  65         else:
  66             keystr = ''
  67             for k in range(1, 2):
  68                 keystr = keystr + self.keycode[random.randint(1,
  69                         len(self.keycode)) - 1]
  70             return 'KK: ' + keystr
  71
  72
  73 class CommandSourceFromFile(CommandSource):
  74
  75     def __init__(self, filename, p):
  76
  77         self.infile = open(filename, 'r')
  78         self.lines = self.infile.readlines()
  79         self.infile.close()
  80         linesbak = self.lines
  81         self.p = p
  82         print(p, self.p, 'self.p')
  83         self.i = 0
  84         self.count = 0
  85         self.loops = 0
  86
  87         # Now we start randomly dropping lines, which we hope are redundant
  88         # p is the probability that any given line will be removed
  89
  90         if p > 0.001:
  91             if random.uniform(0, 1) < 0.5:
  92                 print('randomdrop_independant\n')
  93                 self.randomdrop_independant()
  94             else:
  95                 print('randomdrop_slice\n')
  96                 self.randomdrop_slice()
  97         if screenshot_out is None:
  98             count_atleast = 100
  99         else:
 100             count_atleast = 1
 101         self.max_count = max(len(self.lines) + 20, count_atleast)
 102         if len(self.lines) < 1:
 103             self.lines = linesbak
 104
 105     def randomdrop_independant(self):
 106         p = self.p
 107
 108         # The next couple of lines are to ensure that at least one line is dropped
 109
 110         drop = random.randint(0, len(self.lines) - 1)
 111         del self.lines[drop]
 112         #p = p - 1 / len(self.lines)
 113         origlines = self.lines
 114         self.lines = []
 115         for l in origlines:
 116             if random.uniform(0, 1) < self.p:
 117                 print('Randomly dropping line ' + l + '\n')
 118             else:
 119                 self.lines.append(l)
 120         print('LINES\n')
 121         print(self.lines)
 122         sys.stdout.flush()
 123
 124     def randomdrop_slice(self):
 125         lines = self.lines
 126         if random.uniform(0, 1) < 0.4:
 127             lines.append(lines[0])
 128             del lines[0]
 129         num_lines = len(lines)
 130         max_drop = max(5, num_lines / 5)
 131         num_drop = random.randint(1, 5)
 132         drop_mid = random.randint(0, num_lines)
 133         drop_start = max(drop_mid - num_drop / 2, 0)
 134         drop_end = min(drop_start + num_drop, num_lines)
 135         print(drop_start, drop_mid, drop_end)
 136         print(lines)
 137         del lines[drop_start:drop_end]
 138         print(lines)
 139         self.lines = lines
 140
 141     def getCommand(self):
 142         if self.count >= self.max_count:
 143             os._exit(0)
 144         if self.i >= len(self.lines):
 145             self.loops = self.loops + 1
 146             if self.loops >= int(max_loops):
 147                 return None
 148             self.i = 0
 149             return 'Loop'
 150         line = self.lines[self.i].rstrip('\n')
 151         self.count = self.count + 1
 152         self.i = self.i + 1
 153         return line
 154
 155
 156 def lyx_exists():
 157     if lyx_pid is None:
 158         return False
 159     fname = '/proc/' + lyx_pid + '/status'
 160     return os.path.exists(fname)
 161
 162
 163 # Interruptible os.system()
 164 def intr_system(cmd, ignore_err = False):
 165     print("Executing " + cmd + "\n")
 166     ret = os.system(cmd)
 167     if os.WIFSIGNALED(ret):
 168         raise KeyboardInterrupt
 169     if ret != 0 and not ignore_err:
 170         raise BaseException("command failed:" + cmd)
 171     return ret
 172
 173 statreg = re.compile(r'^State:.*\(([a-z]+)\)')
 174
 175 def lyx_status(pid):
 176   if lyx_pid is None:
 177     return "dead"
 178   fname = '/proc/' + pid + '/status'
 179   try:
 180     f = open(fname)
 181     for line in f:
 182       m = statreg.match(line)
 183       if m:
 184         status = m.group(1)
 185         f.close()
 186         return status
 187     f.close()
 188   except IOError as e:
 189      print("I/O error({0}): {1}".format(e.errno, e.strerror))
 190      return "dead"
 191   except:
 192     print("Unexpected error:", sys.exc_info()[0])
 193   return "dead"
 194
 195 # Return true if LyX (identified via lyx_pid) is sleeping
 196 def lyx_sleeping():
 197     return lyx_status(lyx_pid) == "sleeping"
 198
 199 # Return true if LyX (identified via lyx_pid) is zombie
 200 def lyx_zombie():
 201     return lyx_status(lyx_pid) == "zombie"
 202
 203 def lyx_dead():
 204     status = lyx_status(lyx_pid)
 205     return (status == "dead") or (status == "zombie")
 206
 207 def sendKeystringLocal(keystr, LYX_PID):
 208
 209     # print "sending keystring "+keystr+"\n"
 210     if not re.match(".*\w.*", keystr):
 211         print('print .' + keystr + '.\n')
 212         keystr = 'a'
 213     before_secs = time.time()
 214     while lyx_exists() and not lyx_sleeping():
 215         time.sleep(0.02)
 216         sys.stdout.flush()
 217         if time.time() - before_secs > 180:
 218             print('Killing due to freeze (KILL_FREEZE)')
 219
 220             # Do profiling, but sysprof has no command line interface?
 221             # intr_system("killall -KILL lyx")
 222
 223             os._exit(1)
 224     if not screenshot_out is None:
 225         while lyx_exists() and not lyx_sleeping():
 226             time.sleep(0.02)
 227             sys.stdout.flush()
 228         print('Making Screenshot: ' + screenshot_out + ' OF ' + infilename)
 229         time.sleep(0.2)
 230         intr_system('import -window root '+screenshot_out+str(x.count)+".png")
 231         time.sleep(0.1)
 232     sys.stdout.flush()
 233     actual_delay = key_delay
 234     if actual_delay == '':
 235         actual_delay = def_delay
 236     xvpar = [xvkbd_exe]
 237     if qt_frontend == 'QT5':
 238         xvpar.extend(["-no-jump-pointer"])
 239     else:
 240         xvpar.extend(["-xsendevent"])
 241     xvpar.extend(["-window", lyx_window_name, "-delay", actual_delay, "-text", keystr])
 242
 243     print("Sending \"" + keystr + "\"\n")
 244     subprocess.call(xvpar, stdout = FNULL, stderr = FNULL)
 245
 246 Axreg = re.compile(r'^(.*)\\Ax([^\\]*)(.*)$')
 247 returnreg = re.compile(r'\\\[Return\](.*)$')
 248
 249 # recursive wrapper around sendKeystringLocal()
 250 def sendKeystring(line, LYX_PID):
 251     global key_delay
 252     saved_delay = key_delay
 253     m = Axreg.match(line)
 254     if m:
 255         prefix = m.group(1)
 256         content = m.group(2)
 257         rest = m.group(3);
 258         if prefix != "":
 259             # since (.*) is greedy, check prefix for '\Ax' again
 260             sendKeystring(prefix, LYX_PID)
 261         sendKeystringLocal('\Ax', LYX_PID)
 262         time.sleep(0.1)
 263         m2 = returnreg.match(rest)
 264         if m2:
 265             line = m2.group(1)
 266             key_delay = "1"
 267             sendKeystringLocal(content + '\[Return]', LYX_PID)
 268             key_delay = saved_delay
 269             time.sleep(0.1)
 270             if line != "":
 271                 sendKeystringLocal(line, LYX_PID)
 272         else:
 273             if content != "":
 274                 sendKeystringLocal(content, LYX_PID)
 275             if rest != "":
 276                 sendKeystringLocal(rest, LYX_PID)
 277     else:
 278         if line != "":
 279             sendKeystringLocal(line, LYX_PID)
 280
 281
 282 def system_retry(num_retry, cmd):
 283     i = 0
 284     rtn = intr_system(cmd)
 285     while ( ( i < num_retry ) and ( rtn != 0) ):
 286         i = i + 1
 287         rtn = intr_system(cmd)
 288         time.sleep(1)
 289     if ( rtn != 0 ):
 290         print("Command Failed: "+cmd)
 291         print(" EXITING!\n")
 292         os._exit(1)
 293
 294 def RaiseWindow():
 295     #intr_system("echo x-session-manager PID: $X_PID.")
 296     #intr_system("echo x-session-manager open files: `lsof -p $X_PID | grep ICE-unix | wc -l`")
 297     ####intr_system("wmctrl -l | ( grep '"+lyx_window_name+"' || ( killall lyx ; sleep 1 ; killall -9 lyx ))")
 298     print("lyx_window_name = " + lyx_window_name + "\n")
 299     intr_system("wmctrl -R '"+lyx_window_name+"' ;sleep 0.1")
 300     system_retry(30, "wmctrl -i -a '"+lyx_window_name+"'")
 301
 302
 303 lyx_pid = os.environ.get('LYX_PID')
 304 print('lyx_pid: ' + str(lyx_pid) + '\n')
 305 infilename = os.environ.get('KEYTEST_INFILE')
 306 outfilename = os.environ.get('KEYTEST_OUTFILE')
 307 max_drop = os.environ.get('MAX_DROP')
 308 lyx_window_name = os.environ.get('LYX_WINDOW_NAME')
 309 screenshot_out = os.environ.get('SCREENSHOT_OUT')
 310 lyx_userdir = os.environ.get('LYX_USERDIR')
 311
 312 max_loops = os.environ.get('MAX_LOOPS')
 313 if max_loops is None:
 314     max_loops = 3
 315
 316 PACKAGE = os.environ.get('PACKAGE')
 317 if not PACKAGE is None:
 318   print("PACKAGE = " + PACKAGE + "\n")
 319
 320 PO_BUILD_DIR = os.environ.get('PO_BUILD_DIR')
 321 if not PO_BUILD_DIR is None:
 322   print("PO_BUILD_DIR = " + PO_BUILD_DIR + "\n")
 323
 324 lyx = os.environ.get('LYX')
 325 if lyx is None:
 326     lyx = "lyx"
 327
 328 lyx_exe = os.environ.get('LYX_EXE')
 329 if lyx_exe is None:
 330     lyx_exe = lyx
 331
 332 xvkbd_exe = os.environ.get('XVKBD_EXE')
 333 if xvkbd_exe is None:
 334     xvkbd_exe = "xvkbd"
 335
 336 qt_frontend = os.environ.get('QT_FRONTEND')
 337 if qt_frontend is None:
 338     qt_frontend = 'QT4'
 339
 340 locale_dir = os.environ.get('LOCALE_DIR')
 341 if locale_dir is None:
 342     locale_dir = '.'
 343
 344 def_delay = os.environ.get('XVKBD_DELAY')
 345 if def_delay is None:
 346     def_delay = '100'
 347
 348 file_new_command = os.environ.get('FILE_NEW_COMMAND')
 349 if file_new_command is None:
 350     file_new_command = "\Afn"
 351
 352 ResetCommand = os.environ.get('RESET_COMMAND')
 353 if ResetCommand is None:
 354     ResetCommand = "\[Escape]\[Escape]\[Escape]\[Escape]" + file_new_command
 355     #ResetCommand="\[Escape]\[Escape]\[Escape]\[Escape]\Cw\Cw\Cw\Cw\Cw\Afn"
 356
 357 if lyx_window_name is None:
 358     lyx_window_name = 'LyX'
 359
 360 print('outfilename: ' + outfilename + '\n')
 361 print('max_drop: ' + max_drop + '\n')
 362
 363 if infilename is None:
 364     print('infilename is None\n')
 365     x = CommandSource()
 366     print('Using x=CommandSource\n')
 367 else:
 368     print('infilename: ' + infilename + '\n')
 369     probability_we_drop_a_command = random.uniform(0, float(max_drop))
 370     print('probability_we_drop_a_command: ')
 371     print('%s' % probability_we_drop_a_command)
 372     print('\n')
 373     x = CommandSourceFromFile(infilename, probability_we_drop_a_command)
 374     print('Using x=CommandSourceFromFile\n')
 375
 376 outfile = open(outfilename, 'w')
 377
 378 if not lyx_pid is None:
 379     RaiseWindow()
 380     # Next command is language dependent
 381     #sendKeystring("\Afn", lyx_pid)
 382
 383 write_commands = True
 384 failed = False
 385
 386 while not failed:
 387     #intr_system('echo -n LOADAVG:; cat /proc/loadavg')
 388     c = x.getCommand()
 389     if c is None:
 390         break
 391     if c.strip() == "":
 392         continue
 393     outfile.writelines(c + '\n')
 394     outfile.flush()
 395     if c[0] == '#':
 396         print("Ignoring comment line: " + c)
 397     elif c[0:9] == 'TestBegin':
 398         print("\n")
 399         lyx_pid=os.popen("pidof " + lyx).read()
 400         if lyx_pid != "":
 401             print("Found running instance(s) of LyX: " + lyx_pid + ": killing them all\n")
 402             intr_system("killall " + lyx, True)
 403             time.sleep(0.5)
 404             intr_system("killall -KILL " + lyx, True)
 405         time.sleep(0.2)
 406         print("Starting LyX . . .")
 407         if lyx_userdir is None:
 408             intr_system(lyx_exe + c[9:] + "&")
 409         else:
 410             intr_system(lyx_exe + " -userdir " + lyx_userdir + " " + c[9:] + "&")
 411         count = 5
 412         while count > 0:
 413             lyx_pid=os.popen("pidof " + lyx).read().rstrip()
 414             print('lyx_pid=' + lyx_pid, '\n')
 415             if lyx_pid != "":
 416                 lyx_window_name=os.popen("wmctrl -l -p | grep ' " + str(lyx_pid) +  " ' | cut -d ' ' -f 1").read().rstrip()
 417                 print('lyx_win=' + lyx_window_name, '\n')
 418                 if lyx_window_name != "":
 419                     break
 420             else:
 421                 count = count - 1
 422             print('lyx_win: ' + lyx_window_name + '\n')
 423             print("Waiting for LyX to show up . . .")
 424             time.sleep(1)
 425         if count <= 0:
 426             print('Timeout: could not start ' + lyx_exe, '\n')
 427             sys.stdout.flush()
 428             failed = True
 429         print('lyx_pid: ' + lyx_pid + '\n')
 430         print('lyx_win: ' + lyx_window_name + '\n')
 431         sendKeystringLocal("\C\[Home]", lyx_pid)
 432     elif c[0:5] == 'Sleep':
 433         print("Sleeping for " + c[6:] + " seconds\n")
 434         time.sleep(float(c[6:]))
 435     elif c[0:4] == 'Exec':
 436         cmd = c[5:].rstrip()
 437         intr_system(cmd)
 438     elif c == 'Loop':
 439         outfile.close()
 440         outfile = open(outfilename + '+', 'w')
 441         print('Now Looping')
 442     elif c == 'RaiseLyx':
 443         print('Raising Lyx')
 444         RaiseWindow()
 445     elif c[0:4] == 'KK: ':
 446         if lyx_exists():
 447             sendKeystring(c[4:], lyx_pid)
 448         else:
 449             ##intr_system('killall lyx; sleep 2 ; killall -9 lyx')
 450             if lyx_pid is None:
 451               print('No path /proc/xxxx/status, exiting')
 452             else:
 453               print('No path /proc/' + lyx_pid + '/status, exiting')
 454             os._exit(1)
 455     elif c[0:4] == 'KD: ':
 456         key_delay = c[4:].rstrip('\n')
 457         print('Setting DELAY to ' + key_delay + '.\n')
 458     elif c == 'Loop':
 459         RaiseWindow()
 460         sendKeystring(ResetCommand, lyx_pid)
 461     elif c[0:6] == 'Assert':
 462         cmd = c[7:].rstrip()
 463         result = intr_system(cmd)
 464         failed = failed or (result != 0)
 465         print("result=" + str(result) + ", failed=" + str(failed))
 466     elif c[0:7] == 'TestEnd':
 467 #        time.sleep(0.5)
 468         if lyx_dead():
 469             print("LyX instance not found because of crash or assert !\n")
 470             failed = True
 471         else:
 472             print("Forcing quit of lyx instance: " + str(lyx_pid) + "...\n")
 473             # \Ax Enter command line is sometimes blocked
 474             # \[Escape] works after this
 475             sendKeystring("\Ax\[Escape]", lyx_pid)
 476             # now we should be outside any dialog
 477             # and so the function lyx-quit should work
 478             sendKeystring("\Cq", lyx_pid)
 479             time.sleep(0.5)
 480             if lyx_sleeping():
 481                 # probably waiting for Save/Discard/Abort, we select 'Discard'
 482                 sendKeystring("\[Tab]\[Return]", lyx_pid)
 483                 lcount = 0
 484             else:
 485                 lcount = 1
 486             while not lyx_dead():
 487                 lcount = lcount + 1
 488                 if lcount > 20:
 489                     print("LyX still up, killing process and waiting for it to die...\n")
 490                     intr_system("kill -9 " + str(lyx_pid), True);
 491                 time.sleep(0.5)
 492         cmd = c[8:].rstrip()
 493         print("Executing " + cmd)
 494         result = intr_system(cmd)
 495         failed = failed or (result != 0)
 496         print("result=" + str(result) + ", failed=" + str(failed))
 497     elif c[0:4] == 'Lang':
 498         lang = c[5:].rstrip()
 499         print("Setting LANG=" + lang + "\n")
 500         os.environ['LANG'] = lang
 501         os.environ['LC_ALL'] = lang
 502 # If it doesn't exist, create a link <locale_dir>/<country-code>/LC_MESSAGES/lyx<version-suffix>.mo
 503 # pointing to the corresponding .gmo file. Needed to let lyx find the right translation files.
 504 # See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg165613.html
 505         idx = lang.rfind(".")
 506         if idx != -1:
 507             ccode = lang[0:idx]
 508         else:
 509             ccode = lang
 510
 511         print("Setting LANGUAGE=" + ccode + "\n")
 512         os.environ['LANGUAGE'] = ccode
 513
 514         idx = lang.find("_")
 515         if idx != -1:
 516             short_code = lang[0:idx]
 517         else:
 518             short_code = ccode
 519         lyx_dir = os.popen("dirname \"" + lyx_exe + "\"").read().rstrip()
 520         if PACKAGE is None:
 521           # on cmake-build there is no Makefile in this directory
 522           # so PACKAGE has to be provided
 523           if os.path.exists(lyx_dir + "/Makefile"):
 524             print("Executing: grep 'PACKAGE =' " + lyx_dir + "/Makefile | sed -e 's/PACKAGE = \(.*\)/\\1/'")
 525             lyx_name = os.popen("grep 'PACKAGE =' " + lyx_dir + "/Makefile | sed -e 's/PACKAGE = \(.*\)/\\1/'").read().rstrip()
 526           else:
 527             print('Could not determine PACKAGE name needed for translations\n')
 528             failed = True
 529         else:
 530           lyx_name = PACKAGE
 531         intr_system("mkdir -p " + locale_dir + "/" + ccode + "/LC_MESSAGES")
 532         intr_system("rm -f " + locale_dir + "/" + ccode + "/LC_MESSAGES/" + lyx_name + ".mo")
 533         if PO_BUILD_DIR is None:
 534             if lyx_dir[0:3] == "../":
 535                 rel_dir = "../../" + lyx_dir
 536             else:
 537                 rel_dir = lyx_dir
 538             intr_system("ln -s " + rel_dir + "/../po/" + short_code + ".gmo " + locale_dir + "/" + ccode + "/LC_MESSAGES/" + lyx_name + ".mo")
 539         else:
 540             intr_system("ln -s " + PO_BUILD_DIR + "/" + short_code + ".gmo " + locale_dir + "/" + ccode + "/LC_MESSAGES/" + lyx_name + ".mo")
 541     else:
 542         print("Unrecognised Command '" + c + "'\n")
 543         failed = True
 544
 545 print("Test case terminated: ")
 546 if failed:
 547     print("FAIL\n")
 548     os._exit(1)
 549 else:
 550     print("Ok\n")
 551     os._exit(0)