docs: Improve tester's manual

This commit is contained in:
Igor Murzov 2011-06-04 19:00:18 +04:00
parent 59cee8c139
commit 4f7e60a425

View File

@ -116,7 +116,7 @@ command has two stages which are now reflected in the two files:
Running the tests Running the tests
----------------- -----------------
The tests are run by calling `runtest` in the test directory: The tests are run by calling `runtest` command in the test directory:
----------------------- -----------------------
runtest --outdir log --tool completion runtest --outdir log --tool completion
runtest --outdir log --tool install runtest --outdir log --tool install
@ -129,6 +129,12 @@ directory:
./runInstall ./runInstall
./runUnit ./runUnit
----------------------- -----------------------
To run a particular test, specify file name of your test as an argument to
`runCompletion` script:
-----------------------
./runCompletion ssh.exp
-----------------------
That will run `test/completion/ssh.exp`.
Running tests via cron Running tests via cron
@ -214,7 +220,13 @@ Maintenance
Adding a completion test Adding a completion test
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
You can run `cd test && ./generate` to add a test. You can run `cd test && ./generate cmd` to add a test for the `cmd` command.
This will add two files with a very basic tests:
----------------------------------
test/completion/cmd.exp
test/lib/completions/cmd.exp
----------------------------------
Place any additional tests into `test/lib/completions/cmd.exp`.
Fixing a completion test Fixing a completion test
@ -451,7 +463,7 @@ Within test scripts the following library functions can be used:
The test environment needs to be put to fixed states when testing. For The test environment needs to be put to fixed states when testing. For
instance the bash prompt (PS1) is set to the current test directory, followed instance the bash prompt (PS1) is set to the current test directory, followed
by an ampersand (@). The default settings for `bash` reside in `config/bashrc` by an at sign (@). The default settings for `bash` reside in `config/bashrc`
and `config/inputrc`. and `config/inputrc`.
For each tool (completion, install, unit) a slightly different context is in For each tool (completion, install, unit) a slightly different context is in