development/autotests/README

   1 Automated tests based on the "MonKey Testing" keytest program.
   2 ======================================================================
   3
   4 WARNING!!
   5 ----------------------------------------------------------------------
   6 Running the tests in this folder may cause abrupt kill of existing
   7 LyX instances on your system. In order to avoid any possible data
   8 loss, quit any running instance of LyX in which you're carrying out
   9 real work. Also, although precautions have been taken in order to not
  10 allow the key presses to reach non-LyX windows, this may sometimes
  11 happen anyway. Please, close any running application that is not
  12 strictly needed.
  13
  14
  15 DEPENDENCIES
  16 ----------------------------------------------------------------------
  17 The following programs are needed by the testing framework:
  18 - xvkbd: a modified copy of xvkbd is included in this folder, and should
  19          be built before running the tests
  20 - wmctrl
  21 - pcregrep
  22
  23
  24 USAGE
  25 ----------------------------------------------------------------------
  26 In order to launch all the tests available in this folder, just run
  27
  28   make
  29
  30 and do not interact with your computer while the tests are running.
  31
  32 If you wish to launch one or more specific tests, then provide them
  33 as argument to the run-tests.sh script, e.g.:
  34
  35   ./run-tests.sh <whatever>*-in.txt
  36
  37 For failed tests you get a folder with the logs that help you identify
  38 the problem.
  39
  40
  41 SYNTAX
  42 ----------------------------------------------------------------------
  43 Each test-case script should be named as xxx-in.txt. The syntax of the
  44 script is described in detail in the sample test-case script
  45 hello-world-in.txt.
  46
  47
  48 TODO
  49 ----------------------------------------------------------------------
  50 Speed-up the execution of the tests as much as possible (i.e., get rid
  51 of heuristic waits when present and replace them with exact check of
  52 the condition we're waiting for).
  53
  54 Allow for tests with multiple LyX instances, e.g., for copy&paste
  55 across LyX instances, or multiple applications, i.e., for testing
  56 the interaction between LyX and other applications.