Difference between revisions of "VCLTesttool"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Run a single autotest)
(fixes / rephrasing by Bernd Günter)
Line 1: Line 1:
== About the TestTool ==
+
== About the VCLTesttool ==
  
The TestTool is a standalone program that is used for the automated testing of OpenOffice.org. The TestTool communicates with the TCP/IP-Interface of OpenOffice.org and can test each installation of OpenOffice.org on a PC or in a local area network (LAN). The current TestTool can be used on OpenOffice.org 1.1beta and higher. However, as there can be some incompatible changes in future OpenOffice.org builds you may need to use a newer version of the TestTool. Current versions of TestTool can always be [http://qa.openoffice.org/ooQAReloaded/AutomationTeamsite/ooQA-TeamAutomationBin.html found here]
+
The VCLTesttool is a standalone program that is used for the automated testing of OpenOffice.org. The VCLTesttool communicates with the TCP/IP-Interface of OpenOffice.org and can test each installation of OpenOffice.org on a PC or in a local area network (LAN). The current VCLTesttool can be used on OpenOffice.org 1.1beta and higher. However, as there can be some incompatible changes in future OpenOffice.org builds you may need to use a newer version of the VCLTesttool then. Current versions of VCLTesttool can always be [http://qa.openoffice.org/ooQAReloaded/AutomationTeamsite/ooQA-TeamAutomationBin.html found here]
  
 
== Quick start ==
 
== Quick start ==
Line 7: Line 7:
 
If you want to help in automated testing and start immediately this guide is the right choice for you. It offers a step-by-step guide to start with and is valid for testing OpenOffice.org-Version 3.x. However this guide claims to reach testers with basic and experienced knowledge too.
 
If you want to help in automated testing and start immediately this guide is the right choice for you. It offers a step-by-step guide to start with and is valid for testing OpenOffice.org-Version 3.x. However this guide claims to reach testers with basic and experienced knowledge too.
  
==== Prerequisite ====
+
==== Prerequisites ====
If all of the following prerequisites are done one can start with automated testing
+
If all of the following prerequisites are done you can start with automated testing.
  
 
===== CVS/SVN =====
 
===== CVS/SVN =====
You must have a working CVS or SVN (migration to SubVersion started with Milestone DEV300_m32) on the system.
+
You must have a working CVS or SVN (migration to SubVersion started with milestone DEV300_m32) on the system.
+
Read [http://qa.openoffice.org/servlets/ProjectSource CVS client setup] to setup client to be used on OpenOffice.org
+
  
Read [[OOo_and_Subversion]] to use SubVersion on OOo
+
Read [http://qa.openoffice.org/servlets/ProjectSource CVS client setup] to setup client to be used on OpenOffice.org.
 +
 
 +
Read [[OOo_and_Subversion]] to use SubVersion on OpenOffice.org.
  
 
===== OpenOffice.org =====
 
===== OpenOffice.org =====
One must have an installed office on the system and it is important to know what version has to be tested.
+
You must have an installed OpenOffice.org on the system, and it is important to know what version is to be tested.
 +
 
 +
If you are not sure what version is installed on your system you can check
 +
 
 +
* .versionrc (UNIX-Systems) or
 +
* version.ini (Windows-Systems)
  
If you are not sure what version is installed on your system you can check version.ini (.versionrc on UNIX-Systems) in installation directory<br>
+
in installation directory<br>
 
(look in <INSTALLDIR>/OpenOffice.org 3/program)  
 
(look in <INSTALLDIR>/OpenOffice.org 3/program)  
  
Line 33: Line 38:
 
ProductSource=DEV300
 
ProductSource=DEV300
  
===== TestTool framework (testautomation) =====
+
===== VCLTesttool framework (testautomation) =====
The TestTool framework holds all scripts provided to test a milestone based on current branch and is found to be in CVS/SVN as module '''testautomation'''. You can find all those files in OpenOffice.org CVS/SVN and can easily download them to your local file system via cvs/svn checkout. Let's say you're about to test a version based on branch 'DEV300' with milestone 'm29'.
+
The VCLTesttool framework holds all scripts provided to test a milestone based on current branch and is found to be in CVS/SVN as module '''testautomation'''. You can find all those files in OpenOffice.org CVS/SVN and can easily download them to your local file system via cvs/svn checkout. Let's say you're about to test a version based on branch 'DEV300' with milestone 'm29'.
  
 
Use the following cvs command to get the sources:  
 
Use the following cvs command to get the sources:  
Line 40: Line 45:
 
''cvs checkout -r DEV300_m29 -d testautomation_m29 testautomation''
 
''cvs checkout -r DEV300_m29 -d testautomation_m29 testautomation''
  
(optional parameter -d is used to checkout into specific directory to be able holding more versions in parallel)
+
(optional parameter -d is used to checkout into a specific directory to be able to hold more versions in parallel.)
  
 
Checkout via SubVersion:
 
Checkout via SubVersion:
Line 47: Line 52:
  
 
===== VCLTestTool =====
 
===== VCLTestTool =====
To be able start automated testing of OpenOffice.org you must have a local copy of VCLTesttool on your system too.
+
To be able to start automated testing of OpenOffice.org you must have a local copy of VCLTesttool on your system too.
 +
 
 +
[http://qa.openoffice.org/ooQAReloaded/AutomationTeamsite/ooQA-TeamAutomationBin.html Download current VCLTesttool] matching your OS to a location of your choice on your local machine and extract the archive to your local system. After all files are extracted please start testtool.bin (testtool.exe on windows) the first time. Once VCLTesttool is started go to Tools->Options.
 +
 
 +
'''(all entries on screenshots are examples only and need to be adapted to your needs)'''
  
[http://qa.openoffice.org/ooQAReloaded/AutomationTeamsite/ooQA-TeamAutomationBin.html Download current TestTool] matching your OS to a location of your choice on your local machine and extract the archive to your local system. After all files are extracted please start testtool.bin (testtool.exe on windows) the first time. Once testtool is started go to Tools->Options
 
  
'''(all entrys on screenshots are examples only and need to be adapted to your needs)'''
 
  
 
* Tabpage 'Profile'
 
* Tabpage 'Profile'
Line 57: Line 64:
 
[[Image: Testtool-option-profile.jpg]]
 
[[Image: Testtool-option-profile.jpg]]
  
Create a profile for current testauomation module to be used. Therefor enter
+
Create a profile for current testautomation module to be used. Therefor enter
  
1. Profile name: DEV300m29
+
1. Profile: DEV300m29
  
2. Log base directory: (All resultsfiles created during a testrun are written here)
+
2. Log base directory: (All resultsfiles created during a testrun are written here.)
  
3. Base directory: The base directory of checked-out testautomation-scripts
+
3. Base directory: The base directory of checked-out testautomation-scripts.
  
 
4. Default HID directory is set automatically and must not be adapted in most cases.
 
4. Default HID directory is set automatically and must not be adapted in most cases.
Line 73: Line 80:
 
[[Image: Testtool-option-crashreport.jpg]]
 
[[Image: Testtool-option-crashreport.jpg]]
  
Check 'Allow contact' checkbox and enter your valid OOo-mail-address in EMail field. This mail address will be used if testtool sends a crashreport and later on if you are familiar with automated testing you can add your results to [[QUASTe]] (Quality Assurance Statuspage) Therefor a vaild mail-address is important.
+
Check 'Allow contact' checkbox and enter your valid OpenOffice.org-mail-address in 'EMail' field. This mail address will be used when VCLTesttool sends a crashreport. Later on when you are familiar with automated testing you can add your results to [[QUASTe]] (Quality Assurance Statuspage) Therefor a valid mail-address is important.
 +
 
  
  
Line 80: Line 88:
 
[[Image: Testtool-option-misc.jpg]]
 
[[Image: Testtool-option-misc.jpg]]
  
On this tabpage you can set the options to be used by testtool to communicate with OpenOffice.org. In most cases this values can stay default. If testtool is unable to start your OpenOffice.org installation 'Testtool Port' or 'Remote UNO Port' may be blocked or reserved by your system.
+
On this tabpage you can set the options to be used by VCLTesttool to communicate with OpenOffice.org. In most cases this values can stay default. If VCLTesttool is unable to start your OpenOffice.org installation 'Testtool Port' or 'Remote UNO Port' may be blocked or reserved by your system.
'OOo Program Dir' can be set to the program dir of your OpenOffice.org-Installation to be tested with VCLTestTool. In most cases this value can be leaved empty as testtool should be able to find your OpenOffice.org Installation. If not you can try adding the path to your installation here. For example: <INSTALLDIR>/OpenOffice.org 3/program
+
'OOo Program Dir' can be set to the program dir of your OpenOffice.org-Installation to be tested with VCLTestTool. In most cases this field can be left empty as VCLTesttool should be able to find your OpenOffice.org Installation. If not you can try adding the path to your installation here. For example: <INSTALLDIR>/OpenOffice.org 3/program
 +
 
 +
All your changes to VCLTestTool-options are saved in
  
All your changes to VCLTestTool-options are saved in an .testtoolrc file created in your home-directory (UNIX-Systems - on Windows systems={USER}\Application Data\testtool.ini)
+
** ${HOME}/.testtoolrc (UNIX-Systems) or
 +
** %APPDATA%\testtool.ini (Windows-Systems).
  
 
Click on 'OK' button in Options to save your changes and exit VCLTestTool for this time.
 
Click on 'OK' button in Options to save your changes and exit VCLTestTool for this time.
  
  
Now all prerequisites are done !
+
Now all prerequisites are done!
  
 
== Run a single autotest ==
 
== Run a single autotest ==
  
Running a single autotest is quiet easy once you managed to download the scripts to your machines space and made all neccessary settings described in 'Quick start' section. If you want more information on how to know what autotests should be finished please visit [http://wiki.services.openoffice.org/wiki/QUASTe#Category_model this page]
+
Running a single autotest is quite easy once you managed to download the scripts to your machine's space and made all necessary settings described in 'Quick start' section. If you want more information on how to know what autotests should be finished please visit [http://wiki.services.openoffice.org/wiki/QUASTe#Category_model this page].
  
 
* Start VCLTesttool and choose File->Open
 
* Start VCLTesttool and choose File->Open
* change filetype to *.bas
+
* change file type to *.bas
 
* choose directory holding the testscripts
 
* choose directory holding the testscripts
* choose bas-file to be run next
+
* choose *.bas-file to be run next
* Select 'OK' in Filedialog
+
* Select 'OK' in file dialog
 
* Press 'F5' or select 'Program->start' to run the autotest
 
* Press 'F5' or select 'Program->start' to run the autotest
  
Now you only have to wait until test has been finished and analyze the testresults written to *.res-file
+
Now you only have to wait until test has finished and analyzed the test results written to *.res-file.
  
  
  
 
[[Category:Quality_Assurance]]
 
[[Category:Quality_Assurance]]

Revision as of 14:34, 30 November 2008

About the VCLTesttool

The VCLTesttool is a standalone program that is used for the automated testing of OpenOffice.org. The VCLTesttool communicates with the TCP/IP-Interface of OpenOffice.org and can test each installation of OpenOffice.org on a PC or in a local area network (LAN). The current VCLTesttool can be used on OpenOffice.org 1.1beta and higher. However, as there can be some incompatible changes in future OpenOffice.org builds you may need to use a newer version of the VCLTesttool then. Current versions of VCLTesttool can always be found here

Quick start

If you want to help in automated testing and start immediately this guide is the right choice for you. It offers a step-by-step guide to start with and is valid for testing OpenOffice.org-Version 3.x. However this guide claims to reach testers with basic and experienced knowledge too.

Prerequisites

If all of the following prerequisites are done you can start with automated testing.

CVS/SVN

You must have a working CVS or SVN (migration to SubVersion started with milestone DEV300_m32) on the system.

Read CVS client setup to setup client to be used on OpenOffice.org.

Read OOo_and_Subversion to use SubVersion on OpenOffice.org.

OpenOffice.org

You must have an installed OpenOffice.org on the system, and it is important to know what version is to be tested.

If you are not sure what version is installed on your system you can check

  • .versionrc (UNIX-Systems) or
  • version.ini (Windows-Systems)

in installation directory
(look in <INSTALLDIR>/OpenOffice.org 3/program)

Open file and see area [Version]:

Example:

ProductMajor=300

ProductMinor=29

ProductSource=DEV300

VCLTesttool framework (testautomation)

The VCLTesttool framework holds all scripts provided to test a milestone based on current branch and is found to be in CVS/SVN as module testautomation. You can find all those files in OpenOffice.org CVS/SVN and can easily download them to your local file system via cvs/svn checkout. Let's say you're about to test a version based on branch 'DEV300' with milestone 'm29'.

Use the following cvs command to get the sources:

cvs checkout -r DEV300_m29 -d testautomation_m29 testautomation

(optional parameter -d is used to checkout into a specific directory to be able to hold more versions in parallel.)

Checkout via SubVersion:

svn checkout svn://svn.services.openoffice.org/ooo/tags/DEV300_m32/testautomation testautomation_m32

VCLTestTool

To be able to start automated testing of OpenOffice.org you must have a local copy of VCLTesttool on your system too.

Download current VCLTesttool matching your OS to a location of your choice on your local machine and extract the archive to your local system. After all files are extracted please start testtool.bin (testtool.exe on windows) the first time. Once VCLTesttool is started go to Tools->Options.

(all entries on screenshots are examples only and need to be adapted to your needs)


  • Tabpage 'Profile'

Testtool-option-profile.jpg

Create a profile for current testautomation module to be used. Therefor enter

1. Profile: DEV300m29

2. Log base directory: (All resultsfiles created during a testrun are written here.)

3. Base directory: The base directory of checked-out testautomation-scripts.

4. Default HID directory is set automatically and must not be adapted in most cases.


  • Tabpage 'Crashreport'

Testtool-option-crashreport.jpg

Check 'Allow contact' checkbox and enter your valid OpenOffice.org-mail-address in 'EMail' field. This mail address will be used when VCLTesttool sends a crashreport. Later on when you are familiar with automated testing you can add your results to QUASTe (Quality Assurance Statuspage) Therefor a valid mail-address is important.


  • Tabpage 'Misc'

Testtool-option-misc.jpg

On this tabpage you can set the options to be used by VCLTesttool to communicate with OpenOffice.org. In most cases this values can stay default. If VCLTesttool is unable to start your OpenOffice.org installation 'Testtool Port' or 'Remote UNO Port' may be blocked or reserved by your system. 'OOo Program Dir' can be set to the program dir of your OpenOffice.org-Installation to be tested with VCLTestTool. In most cases this field can be left empty as VCLTesttool should be able to find your OpenOffice.org Installation. If not you can try adding the path to your installation here. For example: <INSTALLDIR>/OpenOffice.org 3/program

All your changes to VCLTestTool-options are saved in

    • ${HOME}/.testtoolrc (UNIX-Systems) or
    •  %APPDATA%\testtool.ini (Windows-Systems).

Click on 'OK' button in Options to save your changes and exit VCLTestTool for this time.


Now all prerequisites are done!

Run a single autotest

Running a single autotest is quite easy once you managed to download the scripts to your machine's space and made all necessary settings described in 'Quick start' section. If you want more information on how to know what autotests should be finished please visit this page.

  • Start VCLTesttool and choose File->Open
  • change file type to *.bas
  • choose directory holding the testscripts
  • choose *.bas-file to be run next
  • Select 'OK' in file dialog
  • Press 'F5' or select 'Program->start' to run the autotest

Now you only have to wait until test has finished and analyzed the test results written to *.res-file.

Personal tools