Difference between revisions of "UnoAPITest"

Revision as of 18:49, 25 October 2007

To check the UnoApi there exists a framework implemented in Java. See http://qa.openoffice.org/qadevOOo_doc/index.html

All components which supports Uno-Objects has a QA folder which contains all information to run the UnoApiTest of the module successfully.

$MODULE/qa/unoapi

The folder which contains all necessary files

$MODULE.sce

ScenarioFile: This file contains all known implementation objects of the module.

knownissues.xcl

This file contains a list of all known issues.

makefile.mk

This file is the makefile

How to run the tests

To run the tests you have to start a connectable office and run dmake in the $MODULE/qa/unoapi folder:

./soffice "-accept=socket,host=0,port=8100;urp;"&
cd $MODULE/qa/unoapi
dmake

In case of working on a shared machine, you should use a named pipe instead. Add the usage of the pipe in the RunnerProps file and start the office like this:

./soffice "-accept=pipe,name=$USER;urp;" &   # Unix
 soffice "-accept=pipemname=%USERNAME%;urp;" # Windows

You can use any unique name as pipe name, but as the user-name is very well suited for this purpose, it is a good idea to use it.

The result of the tests is shown at the end and could look like this:

***** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK
*********************************************************

Failures that appeared during scenario execution:
         svtools.AccessibleTabBar
1 of 12 tests failed
Job -sce svtools.sce done

Explanations of the test result

**** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK

While running the UnoApiTest of svtools.AccessibleTreeListBoxEntry one ore more interface tests failed but the problem is known and an issue is already written. You will find the issue in the knownissues.xcl

Failures that appeared during scenario execution:
        svtools.AccessibleTabBar
1 of 12 tests failed

One of the object tests failed. In this case svtools.AccessibleTabBar causes an unkown error and needs a deeper investigation. After all one of 12 tests failed.

What should I do with unkown error ?

To validate the ``unkown error`` you can call the CheckAPI script with the failed object as argument, in this example case:

checkapi -o svtools.AccessibleTabBar

This shows you all failures in the test. If you like to run the test with the knownissues.xcl try this:

checkapi -o svtools.AccessibleTabBar -xcl knownissues.xcl

Parameter to the testrun

It is not possible to use command line parameters in the ProjectUnoApiTest. But to change some default parameter like the connection string you can use the RunnerProps file.