Programs needed to have a use for this tool:
- Java runtime environment. I tested with java versions 1.4 and 1.5 on the following platforms:
  Windows 2003/XP - Linux x86 - Solaris Sparc - Solaris x86 - MacOS X 10.3
- The VCL TestTool Glue java binary package: vcltesttoolglue-v0.2.zip
  Available from http://sourceforge.net/projects/vcltesttoolglue/
- A used and working automated OOo GUI testing environment, which consists of:
   - OpenOffice.org
   - VCL TestTool application
   - VCL TestTool environment
- A graphical user interface ;-)

How to start:
- Unzip the package
- Unix/Linux/MacOS: In a terminal under X11 environment type: java -jar VCLTestTool.jar
- Windows: A doubleclick on VCLTestTool.jar should work
     (If you start it from a command window, also with java -jar VCLTestTool.jar you get some output which might help if something doesn't work)

During startup the following happens:
- The program tries to find the VCL TestTool configuration file; If it is not found, a file selection dialog comes up, asking for thethe file:
  On Unix/Linux the file has to be: ~/.testtoolrc
  On MacOS: ~/Library/Application Data/.testtoolrc
  On Windows: %APPDATA%\testtool.ini
- The VCL TestTool configuration needs to contain a valid profile.
   - Base directory pointing to the VCL TestTool environment files
   - Errorlog directory with *.res files from some test runs

If everything is ok, 2 windows are coming up:
- VCL TestTool Glue Result
- VCL TestTool Glue 

Select a VCL TestTool application on the tab page 'Settings': 
- Click the three dots ... for 'VCL TestTool Application' - a file selection dialog comes up:
  On Unix/Linux the file has to be: testtool.bin and is usually in your OpenOffice.org program directory.
  On MacOS: It needs to be the script: testtool.
  On Windows: the application file is called testtool.exe
  (The test button has currently no function.)
  The selection is saved in the VCL TestTool Glue configuration file at ~/vclttg/vclttg_config.txt
- Go back to the tab page Results
  If you click in the 5th column from the left 'State' in any row, the VCL TestTool application should come up with the result and source file - Close it, this was just to check that it works.

What can you do with this tool?:
- Control and analyze the testing of OpenOffice.org with the VCL TestTool application.
- Go to the tabpage 'RunSet' and just hit the 'Run' button: All mandatory tests will be run.
- There exists a remote viewing option via IRC or telnet to be up to date what is going on.
- You will get notified via email when the tests are finished.
- Define actions, to make a testrun more stable.

How to get a batch of tests run?: 
- Select the category you want to test
- Press the button: 'Run'
- What happens now?:
  - Every test that exists is started by VCL TestTool application
    If a test does not exist, the checkmark is missing in the column 'Active'
    If a test is run for the first time, the expected default length is 2 hours + 20%
  - When the test finished or the duration + 20% is reached, VCL TestTool application closes
  - The duration is set, but not changed if it is not the first time the test runs
    The duration is saved on closing VCL TestTool Glue to the file: ~/vclttg/vclttg_duration.txt
  - The difference to the expected duration is shown in the column 'Date'
  - The success of the test is shown in the column State, if the tests could not to the end a 'f' for failed is shown
  - If set on the Run settings tab, a cleanup script is run
  - If set on the Run settings tab, OpenOffice.org will be terminated
  - The next test is started
  - After the last last test the result page is updated and an email is send, if selected on the Run settings tab
  - A message box pops up: finished

Get an overview about the tests you have run.
Every .res file in the Errorlog directory of the VCL TestTool application is parsed and the coresponding source file, too.
You get the following information for every .res file:
(From left to right)
- Internal number for VCL TestTool Glue application
- The checkbox 'Active', that marks the tests that should be run by the button 'Run selection'
- A checkbox without meaning/function
- If found, the name of the test source file - ending with .bas, if not found the name of the resultfile - ending with .res.
- State of the last test run:
  - 'f' it is an invalid test run
  - 'd' error in submitting the result to the database
  - '.' the result is the same as the last result found in the result file
  - '!' the result is different to the last result
  The column is also 'active' - If you click on it, the VCL TestTool application is started with the result and source file.
- Version of the tested OOo application from the last test run.
- Some counters from the last test run:
  E: Errors; W: Warnings; Wi: Warnings during initialisation; L: QA Errorlogs; A: Assertions; T: Test cases
- Date of the last test run.
- Maintainer / Owner of the test.
- Description of the test.

The table is sorted descending from the date column per default;
If you click into any header the sorting can get changed from descending to ascending to not sorted.

If you click on a line, and it is not the State column, two things happen:
- The lower table get's filled: All available entries of the resultfile are shown
  The entries are in descending order, newest at the top;
  The lines are also 'active' - if you click one, the errors are shown in the result window.
- The result window content changes: You see an abstract of the errors, warnings and logs of the last test run
  You see the name of the test case where the error happened;
  The message text - currently always 'translated' to english;
  If the error is known, and the test script maintainer put the issue id in a defined format into the message, the number is separated.


The entries in the upper table of the main window are selectable for a block, or just one single entry;
Then the button 'Export selection' may be used - A messagebox informs about a created HTML page in the errorlog directory: index.html.


This HTML page is a summary of all selected entries with three sections:
- Index
- Result file header extract of the first selected entry
- Detailed error messages

Example:
The data in the example is taken from http://smsm1.pwp.blueyonder.co.uk/ooo/qa/testtool/
The old tools show just: http://smsm1.pwp.blueyonder.co.uk/ooo/qa/testtool/20061218viTesttoolResultsSummary.txt
This tool shows: http://vcltesttoolglue.sourceforge.net/20061218vi.html

Settings for running a batch of tests:

! You have to leave every changed field with the Return key, else the setting is not saved!
- Kill command, that is executed, if the checkmark below is set. It is used to terminate OpenOffice.org.
  Start OpenOffice.org and press the button 'test' - OpenOffice.org should vanish
- Run after every test: A batch/.bas file that is run after every test with the VCL TestTool application, path has to be absolute

- To be able to get a state of what is going on on your test machine you may enable
  telnet, IRC, email notifications:
  - Telnet: enable it, and connect to your machine to the port with telnet. When starting a test you get some information.
  - IRC: same as telnet, but result is posted into an IRC channel
  - Email: only after finishing the whole batch, an email is send

SourceForge.net Logo