]> git.lyx.org Git - lyx.git/blob - development/autotests/keytest.py
748e833c96436b8ed173297c0647fa0340bfe3d4
[lyx.git] / 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 DELAY = '59'
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         #print '\nLine read: <<' + line + '>>\n'
153         sys.stdout.write('r')
154         return line
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 def lyx_sleeping():
163     fname = '/proc/' + lyx_pid + '/status'
164     f = open(fname, 'r')
165     lines = f.readlines()
166     sleeping = lines[1].find('(sleeping)') > 0
167
168     # print 'LYX_STATE', lines[1] , 'SLEEPING=', sleeping
169
170     return sleeping
171
172
173 # Interruptible os.system()
174 def intr_system(cmd):
175     ret = os.system(cmd)
176     if os.WIFSIGNALED(ret):
177         raise KeyboardInterrupt
178     return ret
179
180
181 def sendKeystring(keystr, LYX_PID):
182
183     # print "sending keystring "+keystr+"\n"
184
185     if not re.match(".*\w.*", keystr):
186         print 'print .' + keystr + '.\n'
187         keystr = 'a'
188     before_secs = time.time()
189     while lyx_exists() and not lyx_sleeping():
190         time.sleep(0.02)
191         sys.stdout.write('.')
192         sys.stdout.flush()
193         if time.time() - before_secs > 180:
194             print 'Killing due to freeze (KILL_FREEZE)'
195
196             # Do profiling, but sysprof has no command line interface?
197             # intr_system("killall -KILL lyx")
198
199             os._exit(1)
200     if not screenshot_out is None:
201         while lyx_exists() and not lyx_sleeping():
202             time.sleep(0.02)
203             sys.stdout.write('.')
204             sys.stdout.flush()
205         print 'Making Screenshot: ' + screenshot_out + ' OF ' + infilename
206         time.sleep(0.2)
207         intr_system('import -window root '+screenshot_out+str(x.count)+".png")
208         time.sleep(0.1)
209     sys.stdout.flush()
210     if (subprocess.call(
211             [xvkbd_exe, "-no_root", "-xsendevent", "-window", lyx_window_name, "-delay", DELAY, "-text", keystr],
212             stdout=FNULL,stderr=FNULL
213             ) == 0):
214         sys.stdout.write('*')
215     else:
216         sys.stdout.write('X')
217
218 def system_retry(num_retry, cmd):
219     i = 0
220     rtn = intr_system(cmd)
221     while ( ( i < num_retry ) and ( rtn != 0) ):
222         i = i + 1
223         rtn = intr_system(cmd)
224         time.sleep(1)
225     if ( rtn != 0 ):
226         print "Command Failed: "+cmd
227         print " EXITING!\n"
228         os._exit(1)
229
230 def RaiseWindow():
231     #intr_system("echo x-session-manager PID: $X_PID.")
232     #intr_system("echo x-session-manager open files: `lsof -p $X_PID | grep ICE-unix | wc -l`")
233     ####intr_system("wmctrl -l | ( grep '"+lyx_window_name+"' || ( killall lyx ; sleep 1 ; killall -9 lyx ))")
234     #intr_system("wmctrl -R '"+lyx_window_name+"' ;sleep 0.1")
235     system_retry(30, "wmctrl -a '"+lyx_window_name+"'")
236
237
238 lyx_pid = os.environ.get('LYX_PID')
239 print 'lyx_pid: ' + str(lyx_pid) + '\n'
240 infilename = os.environ.get('KEYTEST_INFILE')
241 outfilename = os.environ.get('KEYTEST_OUTFILE')
242 max_drop = os.environ.get('MAX_DROP')
243 lyx_window_name = os.environ.get('LYX_WINDOW_NAME')
244 screenshot_out = os.environ.get('SCREENSHOT_OUT')
245 lyx_userdir = os.environ.get('LYX_USERDIR')
246
247 max_loops = os.environ.get('MAX_LOOPS')
248 if max_loops is None:
249     max_loops = 3
250
251 lyx_exe = os.environ.get('LYX_EXE')
252 if lyx_exe is None:
253     lyx_exe = "lyx"
254
255 xvkbd_exe = os.environ.get('XVKBD_EXE')
256 if xvkbd_exe is None:
257     xvkbd_exe = "xvkbd"
258
259 file_new_command = os.environ.get('FILE_NEW_COMMAND')
260 if file_new_command is None:
261     file_new_command = "\Afn"
262
263 ResetCommand = os.environ.get('RESET_COMMAND')
264 if ResetCommand is None:
265     ResetCommand = "\[Escape]\[Escape]\[Escape]\[Escape]" + file_new_command
266     #ResetCommand="\[Escape]\[Escape]\[Escape]\[Escape]\Cw\Cw\Cw\Cw\Cw\Afn"
267
268 if lyx_window_name is None:
269     lyx_window_name = 'LyX'
270
271 print 'outfilename: ' + outfilename + '\n'
272 print 'max_drop: ' + max_drop + '\n'
273
274 if infilename is None:
275     print 'infilename is None\n'
276     x = CommandSource()
277     print 'Using x=CommandSource\n'
278 else:
279     print 'infilename: ' + infilename + '\n'
280     probability_we_drop_a_command = random.uniform(0, float(max_drop))
281     print 'probability_we_drop_a_command: '
282     print '%s' % probability_we_drop_a_command
283     print '\n'
284     x = CommandSourceFromFile(infilename, probability_we_drop_a_command)
285     print 'Using x=CommandSourceFromFile\n'
286
287 outfile = open(outfilename, 'w')
288
289 if not lyx_pid is None:
290     RaiseWindow()
291     sendKeystring("\Afn", lyx_pid)
292
293 write_commands = True
294 failed = False
295
296 while not failed:
297     #intr_system('echo -n LOADAVG:; cat /proc/loadavg')
298     c = x.getCommand()
299     if c is None:
300         break
301     if c.strip() == "":
302         continue
303     outfile.writelines(c + '\n')
304     outfile.flush()
305     if c[0] == '#':
306         print "\nIgnoring comment line: " + c
307     elif c[0:9] == 'TestBegin':
308         print "\n"
309         lyx_pid=os.popen("pidof lyx").read()
310         if lyx_pid != "":
311             print "Found running instance(s) of LyX: " + lyx_pid + ": killing them all\n"
312             intr_system("killall lyx")
313             time.sleep(0.5)
314             intr_system("killall -KILL lyx")
315         time.sleep(0.2)
316         print "Starting LyX . . ."
317         if lyx_userdir is None:
318             intr_system(lyx_exe + c[9:] + "&")
319         else:
320             intr_system(lyx_exe + " -userdir " + lyx_userdir + " " + c[9:] + "&")
321         while True:
322             lyx_pid=os.popen("pidof lyx").read().rstrip()
323             if lyx_pid != "":
324                 lyx_window_name=os.popen("wmctrl -l -p | grep ' " + str(lyx_pid) +  " ' | cut -d ' ' -f 1").read().rstrip()
325                 if lyx_window_name != "":
326                     break
327             print 'lyx_win: ' + lyx_window_name + '\n'
328             print "Waiting for LyX to show up . . ."
329             time.sleep(1)
330         print 'lyx_pid: ' + lyx_pid + '\n'
331         print 'lyx_win: ' + lyx_window_name + '\n'
332     elif c[0:5] == 'Sleep':
333         print "\nSleeping for " + c[6:] + "\n"
334         time.sleep(float(c[6:]))
335     elif c[0:4] == 'Exec':
336         cmd = c[5:].rstrip()
337         print "\nExecuting " + cmd + "\n"
338         intr_system(cmd)
339     elif c == 'Loop':
340         outfile.close()
341         outfile = open(outfilename + '+', 'w')
342         print 'Now Looping'
343     elif c == 'RaiseLyx':
344         print 'Raising Lyx'
345         RaiseWindow()
346     elif c[0:4] == 'KK: ':
347         if lyx_exists():
348             sendKeystring(c[4:], lyx_pid)
349         else:
350             ##intr_system('killall lyx; sleep 2 ; killall -9 lyx')
351             print 'No path /proc/' + lyx_pid + '/status, exiting'
352             os._exit(1)
353     elif c[0:4] == 'KD: ':
354         DELAY = c[4:].rstrip('\n')
355         print 'Setting DELAY to ' + DELAY + '.'
356     elif c == 'Loop':
357         RaiseWindow()
358         sendKeystring(ResetCommand, lyx_pid)
359     elif c[0:6] == 'Assert':
360         cmd = c[7:].rstrip()
361         print "\nExecuting " + cmd
362         result = intr_system(cmd)
363         failed = failed or (result != 0)
364         print "result=" + str(result) + ", failed=" + str(failed)
365     elif c[0:7] == 'TestEnd':
366         time.sleep(0.5)
367         print "\nTerminating lyx instance: " + str(lyx_pid) + "\n"
368         intr_system("kill -9 " + str(lyx_pid) + "\n");
369         while lyx_exists():
370             print "Waiting for lyx to die...\n"
371             time.sleep(0.5)
372         cmd = c[8:].rstrip()
373         print "\nExecuting " + cmd
374         result = intr_system(cmd)
375         failed = failed or (result != 0)
376         print "result=" + str(result) + ", failed=" + str(failed)
377     elif c[0:4] == 'Lang':
378         lang = c[5:].rstrip()
379         print "\nSetting LANG=" + lang
380         os.environ['LANG'] = lang
381     else:
382         print "Unrecognised Command '" + c + "'\n"
383         failed = True
384
385 print "Test case terminated: "
386 if failed:
387     print "FAIL\n"
388     os._exit(1)
389 else:
390     print "Ok\n"
391     os._exit(0)