More renaming. Hopefully fixed version number.
This commit is contained in:
30
test/README
30
test/README
@ -1,8 +1,8 @@
|
||||
ORCA TEST HARNESS:
|
||||
------------------
|
||||
|
||||
This document provides a very brief description of the Orca test
|
||||
harness. The Orca test harness is not meant to be our final answer to
|
||||
This document provides a very brief description of the Cthulhu test
|
||||
harness. The Cthulhu test harness is not meant to be our final answer to
|
||||
testing, but it helps fill the gap until more general testing for
|
||||
GNOME is avaialble.
|
||||
|
||||
@ -10,7 +10,7 @@ GNOME is avaialble.
|
||||
MAIN IDEAS:
|
||||
-----------
|
||||
|
||||
The main ideas behind the Orca test harness are as follows:
|
||||
The main ideas behind the Cthulhu test harness are as follows:
|
||||
|
||||
* We try to make sure there is a textual description of a test that
|
||||
someone can follow by hand when sitting behind the machine. The
|
||||
@ -21,29 +21,29 @@ The main ideas behind the Orca test harness are as follows:
|
||||
http://cvs.gnome.org/viewcvs/*checkout*/cthulhu/docs/doc-set/cthulhu.html#TESTINGPLAN
|
||||
|
||||
* Each test is intended to be small and test for a specific feature
|
||||
of Orca and/or for a specific bug that has been been found and
|
||||
of Cthulhu and/or for a specific bug that has been been found and
|
||||
fixed.
|
||||
|
||||
* Orca provides the ability to send a textual description of what it
|
||||
* Cthulhu provides the ability to send a textual description of what it
|
||||
is sending to speech and braille. This allows for the recording
|
||||
of output, thus allowing for comparison to results in the future.
|
||||
|
||||
* The harness merely consists of playing back pre-recorded keystrokes
|
||||
and comparing Orca's output to a previously recorded successful run
|
||||
(where 'success' means Orca output the correct information).
|
||||
and comparing Cthulhu's output to a previously recorded successful run
|
||||
(where 'success' means Cthulhu output the correct information).
|
||||
|
||||
|
||||
DIRECTORY LAYOUT:
|
||||
-----------------
|
||||
|
||||
The Orca regression tests contained in this directory are laid out as
|
||||
The Cthulhu regression tests contained in this directory are laid out as
|
||||
follows:
|
||||
|
||||
./harness: test harness scripts
|
||||
|
||||
./keystrokes: keystroke and otyher files for playing back tests
|
||||
|
||||
./results: reference results containing accurate output from Orca
|
||||
./results: reference results containing accurate output from Cthulhu
|
||||
when the test harness runall script was run using the
|
||||
keystrokes
|
||||
|
||||
@ -74,19 +74,19 @@ MAIN FILES:
|
||||
where the *.keys file contains keystrokes and <app-name> is the
|
||||
name of the application to run with the given *.keys file.
|
||||
|
||||
./harness/user-settings.py.in: contains the default Orca configuration
|
||||
./harness/user-settings.py.in: contains the default Cthulhu configuration
|
||||
settings. The primary thing this file does is disable the use of
|
||||
real speech and braille and instead sends a text form of the speech
|
||||
and braille to a log file. Note that there are also facilities to
|
||||
specify a custom user-settings file for each keystroke file so as to
|
||||
allow the testing of Orca settings (e.g., echo by word).
|
||||
allow the testing of Cthulhu settings (e.g., echo by word).
|
||||
|
||||
./keystrokes/*: The ./keystrokes directory consists of a set of
|
||||
directories, where each directory name has significant meaning
|
||||
and is used to determine which app the test harness uses for
|
||||
testing. The directory name is typically the name of a binary
|
||||
on the path. For example, there is a ./keystrokes/gtk-demo
|
||||
directory, and the files under this directory are for testing Orca
|
||||
directory, and the files under this directory are for testing Cthulhu
|
||||
using the gtk-demo application. The other type of directory name
|
||||
is one that matches the output of 'uname', and is used to contain
|
||||
platform specific tests (e.g., Ctrl+Esc for Solaris versus Alt+F1
|
||||
@ -96,15 +96,15 @@ MAIN FILES:
|
||||
*.keys files. These contain keystrokes recorded using the
|
||||
record_keystrokes.py utility (see RECORDING TESTS below). In
|
||||
addition, there may be an option *.settings file for each *.keys
|
||||
file. The *.settings file is an Orca settings file to use
|
||||
file. The *.settings file is an Cthulhu settings file to use
|
||||
specifically for the *.keys file, and is used to help test
|
||||
specific Orca features such as word echo, key echo, etc.
|
||||
specific Cthulhu features such as word echo, key echo, etc.
|
||||
|
||||
./results/*: The ./results directory should contain a set of
|
||||
directories that matches those in the ./keystrokes directory.
|
||||
Under each of the ./results/* directores are *.cthulhu files
|
||||
containing the reference speech and braille output from a
|
||||
known successful run of Orca using the associated *.keys file.
|
||||
known successful run of Cthulhu using the associated *.keys file.
|
||||
|
||||
|
||||
RECORDING KEYSTROKES:
|
||||
|
Reference in New Issue
Block a user