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