~geoff.bache/storytext/selftest-trunk

« back to all changes in this revision

Viewing changes to documentation/help_text/output.pyusecase

  • Committer: Geoff Bache
  • Date: 2009-11-23 21:17:44 UTC
  • Revision ID: geoff.bache@jeppesen.com-20091123211744-a5htfbhx9mjnngrn
New tests for the documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Usage: pyusecase [options] <program> <program_args> ...
 
2
 
 
3
PyUseCase is a record/replay tool for Python GUIs, currently consisting of a generic 
 
4
interface and an implementation for PyGTK. Unlike traditional record/replay tools, 
 
5
it does not record UI events directly but relies on its user maintaining a mapping 
 
6
between the current UI controls and "domain language" names that express the 
 
7
intent of the actions, allowing tests to be recorded in a very high level customer-readable format.
 
8
 
 
9
For PyGTK, it also generates a logfile describing in a textual format the visible GUI and the changes
 
10
that occur in it. This makes it easy to test PyGTK GUIs using a text-based test tool such as TextTest.
 
11
It does not currently have any other means of "asserting" what is happening in the GUI.
 
12
 
 
13
For fuller documentation refer to the online docs at http://www.texttest.org
 
14
 
 
15
Options:
 
16
  --version             show program's version number and exit
 
17
  -h, --help            show this help message and exit
 
18
  -d SECONDS, --delay=SECONDS
 
19
                        amount of time to wait between each action when
 
20
                        replaying. Also enabled via the environment variable
 
21
                        USECASE_REPLAY_DELAY.
 
22
  -i INTERFACE, --interface=INTERFACE
 
23
                        type of interface used by application, should be
 
24
                        'console' or 'gtk' ('gtk' is default)
 
25
  -l LEVEL, --loglevel=LEVEL
 
26
                        produce logging at level LEVEL, should be 'info',
 
27
                        'debug', 'config' or 'off'. 'info' will point the
 
28
                        auto-generated GUI log at standard output. 'debug'
 
29
                        will produce a large amount of PyUseCase debug
 
30
                        information on standard output. 'off' will disable the
 
31
                        auto-generated log. 'config' will enabled the auto-
 
32
                        generated log but not set any global log level: it is
 
33
                        a way to tell PyUseCase that your application will
 
34
                        configure its logging via its own log configuration
 
35
                        files.
 
36
  -m FILE1,..., --mapfiles=FILE1,...
 
37
                        Use the UI map file(s) at FILE1,... If not set
 
38
                        PyUseCase will read and write such a file at the
 
39
                        location determined by $USECASE_HOME/ui_map.conf. If
 
40
                        run standalone $USECASE_HOME defaults to ~/usecases,
 
41
                        while TextTest will point it to a 'pyusecase_files'
 
42
                        subdirectory of the root test suite. If multiple files
 
43
                        are provided, the last in the list will be used for
 
44
                        writing.
 
45
  -p FILE, --replay=FILE
 
46
                        replay script from FILE. Also enabled via the
 
47
                        environment variable USECASE_REPLAY_SCRIPT.
 
48
  -r FILE, --record=FILE
 
49
                        record script to FILE. Also enabled via the
 
50
                        environment variable USECASE_RECORD_SCRIPT.
 
51
  -s, --supported       list which PyGTK widgets and signals are currently
 
52
                        supported 'out-of-the-box'
 
53
  -x, --disable_usecase_names
 
54
                        Disable the entering of usecase names when
 
55
                        unrecognised actions are recorded. Recommended only
 
56
                        for quick-and-dirty experimenting. Will result in
 
57
                        recorded scripts that are easy to make but hard to
 
58
                        read and hard to maintain.