development/keystest/README

   1 --- LyXtest ---
   2
   3 This is a program to spam LyX with millions of randomly generated key
   4 presses, and collect the crash results.
   5
   6 Since the code involves spamming random keypresses, I run it under a special
   7 user "keytest", well away from my main X windows session.
   8
   9 To use this software, first configure it by editing the
  10 configuration parameters in shared_functions.sh and shared_variables.sh
  11 then run the following:
  12
  13 ./setup.sh   # add keytest user and apt-get required files
  14 sudo -H -u keytest -e xterm # Create a xterm for running keytest in
  15 . ./initXvfb # sets up a fake X server for keytest to play in
  16 ./main.sh
  17
  18 Note that this bug finding software is itself quite buggy.
  19
  20 CONTENTS:
  21
  22 README: this readme file
  23 report_html.sh: A quick way of generating bug reports and an overview from the logs.
  24 make_screen_shots.sh: a script for making screenshots, if they are missing from output of above.
  25 autolyx: A script to continually restart lyx and collect the bug reports
  26 maketar.sh: Makes this tar file :)
  27 keytest.py: Sends randomly generated keypresses to the LyX window.
  28 killtest: stop the testing
  29 stock_text: The stock test to add to each bug report.
  30 watch_keytest.sh: Dumps various info on what keytest is doing, often run as "watch watch_keytest.sh"
  31
  32 OUTPUTS:
  33
  34 autolyx: Outputs out/*.GDB, a log of all output, including backtraces.
  35 keytest.py: Outputs out/*.KEYCODES, a list of all keycodes sent to LyX
  36
  37 TIPS:
  38 To reduce the degree to which keytest writes to your HDD, you may want to run
  39    mount -t tmpfs -o size=50m tmpfs /home/keytest/kt.dir
  40 as root
  41
  42 AUTHOR:
  43 Copyright (C) 2009 John McCabe-Dansted, gmatht at gmail dot com.
  44 Published under the Gnu General Public Licence, version 2 or later.