lyx_mirror

mirror of https://git.lyx.org/repos/lyx.git synced 2024-11-30 05:12:40 +00:00

History

Tommaso Cucinotta dcf0eb944e Now the framework works running LyX in the language required by the test script (if any) also when LyX is not installed on your system (using a variant of the trick suggested by Enrico, i.e., create a symlink locale from the LyX sources root to an autotests/locale folder). At least, it does on Linux. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@37589 a592a061-630c-0410-9148-cb99ea01b6c8		2011-02-10 22:33:23 +00:00
..
xvkbd	Added -wait_idle option to wait for the target process to idle at each key press.	2011-02-06 22:47:33 +00:00
findadv-01-in.txt	Saving a doc is faster and more reliable by Ctrl-s, rather than activating a menu (thx Pavel).	2011-02-03 09:13:19 +00:00
findadv-02-in.txt	More regular expression testing.	2011-02-06 22:48:54 +00:00
findadv-03-in.txt	fix findadv-03-in.txt	2011-02-03 00:01:53 +00:00
findadv-04-in.txt	Saving a doc is faster and more reliable by Ctrl-s, rather than activating a menu (thx Pavel).	2011-02-03 09:13:19 +00:00
findadv-05-in.txt	More regular expression testing.	2011-02-06 22:48:54 +00:00
findadv-06-in.txt	More regular expression testing.	2011-02-06 22:48:54 +00:00
findadv-07-in.txt	More regular expression testing.	2011-02-06 22:48:54 +00:00
findadv-08-in.txt	Now the framework works running LyX in the language required by the test	2011-02-10 22:33:23 +00:00
findadv-09-in.txt	More regular expression testing.	2011-02-06 22:48:54 +00:00
first-time-in.txt	Added the creation of a custom .lyx folder inside `pwd`/home/.lyx at	2011-02-01 22:08:07 +00:00
hello-world-in.txt	Now the framework works running LyX in the language required by the test	2011-02-10 22:33:23 +00:00
keytest.py	Now the framework works running LyX in the language required by the test	2011-02-10 22:33:23 +00:00
Makefile	If XVKBD_HACKED env var is not set, then don't try to build any custom xvkbd.	2011-02-06 22:56:02 +00:00
README	Forgot to terminate the emergency button.	2011-02-07 23:37:34 +00:00
run-tests.sh	Now the framework works running LyX in the language required by the test	2011-02-10 22:33:23 +00:00
single-test.sh	Made use of internal hacked xvkbd optional. Now it is needed and	2011-02-06 22:50:07 +00:00
stop_autotests.tcl	Now the framework works running LyX in the language required by the test	2011-02-10 22:33:23 +00:00
stop.gif	Added emergency STOP button in tcl/tk window for immediate & painless termination of the tests.	2011-02-07 23:32:27 +00:00

README

Automated tests based on the "MonKey Testing" keytest program.
======================================================================

WARNING!!
----------------------------------------------------------------------
Running the tests in this folder may cause abrupt kill of existing
LyX instances on your system. In order to avoid any possible data
loss, quit any running instance of LyX in which you're carrying out
real work. Also, although precautions have been taken in order to not
allow the key presses to reach non-LyX windows, this may sometimes
happen anyway. Please, close any running application that is not
strictly needed.


DEPENDENCIES
----------------------------------------------------------------------
The following programs are needed by the testing framework:
- xvkbd: a modified copy of xvkbd is included in this folder, and should
         be built before running the tests
- wmctrl
- pcregrep
- Tcl/Tk


USAGE
----------------------------------------------------------------------
In order to launch all the tests available in this folder, just run

  make

and do not interact with your computer while the tests are running.

If you wish to launch one or more specific tests, then provide them
as argument to the run-tests.sh script, e.g.:

  ./run-tests.sh <whatever>*-in.txt

For failed tests you get a folder with the logs that help you identify
the problem.

Despite the efforts to avoid it, sometimes a test fails simply because
the key presses provided to the process are someway lost due to slow
hardware, slow window manager, too beautiful and animated desktop,...
When this happens, the tests should be run with a higher delay among
key presses. The default of 100 milliseconds can be changed by setting
the XVKBD_DELAY environment variable.

The standard xvkbd available on your system may be used to run the
tests. However, a custom xvkbd may optionally be used that forbids the
testing framework to type into non-LyX windows and may mitigate the
issue described right above. This option can be activated by defining
the XVKBD_HACKED environment variable to any value.


SYNTAX
----------------------------------------------------------------------
Each test-case script should be named as xxx-in.txt. The syntax of the
script is described in detail in the sample test-case script
hello-world-in.txt.


TODO
----------------------------------------------------------------------
Speed-up the execution of the tests as much as possible (i.e., get rid
of heuristic waits when present and replace them with exact check of
the condition we're waiting for).

Allow for tests with multiple LyX instances, e.g., for copy&paste
across LyX instances, or multiple applications, i.e., for testing
the interaction between LyX and other applications.