Apache OpenOffice Wiki - User contributions [en]

Documentation/DevGuide/Database/Usage

2010-09-09T21:39:14Z

Cn:

{{Documentation/DevGuide/DatabaseTOC
|Database2c=block
|DatabaseRowSet=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Database/The RowSet Service
|NextPage=Documentation/DevGuide/Database/Events and Other Notifications
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Database/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:Usage}}
To use a row set, create a <code>RowSet</code> instance at the global service manager through the service name <idl>com.sun.star.sdb.RowSet</idl>. Next, the <code>RowSet</code> needs a ''connection'' and a command before it can be executed. These have to be configured through <code>RowSet</code> properties.

''Connection''

:There are three different ways to establish a connection:

:* Setting <idlm>com.sun.star.sdb.RowSet:DataSourceName</idlm> to a data source from the database context. If the <code>DataSourceName</code> is not a URL, then the <code>RowSet</code> uses the name to get the <code>DataSource</code> from the <code>DatabaseContext</code> to create a connection to that data source.
:* Setting <idlm>com.sun.star.sdb.RowSet:DataSourceName</idlm> to a database URL. The row set tries to use this URL to establish a connection. Database URLs are described in [[Documentation/DevGuide/Database/Connecting Using the DriverManager and a Database URL|Connecting Using the DriverManager and a Database URL]].
:* Setting <idlm>com.sun.star.sdb.RowSet:ActiveConnection</idlm> makes a row set ready for immediate use. The row set uses this connection.

:The difference between the two properties is that in the first case the <code>RowSet</code> owns the connection. The <code>RowSet</code> disposes the connection when it is disposed. In the second case, the <code>RowSet</code> only uses the connection. The user of a <code>RowSet</code> is responsible for the disposition of the connection. For a simple <code>RowSet</code>, use <idlm>com.sun.star.sdb.RowSet:DataSourceName</idlm>, but when sharing the connection between different row sets, then use <idlm>com.sun.star.sdb.RowSet:ActiveConnection</idlm>.

:If there is already a connection, for example, the user opened a database form, open another row set based upon the property <idlm>com.sun.star.sdb.RowSet:ActiveConnection</idlm> of the form. Put the <code>ActiveConnection</code> of the form into the <code>ActiveConnection</code> property of the new row set.

''Command''

:With a connection and a command, the row set is ready to be executed calling <code>execute()</code> on the <idl>com.sun.star.sdbc.XRowSet</idl> interface of the row set. For interactive logon, use <code>executeWithCompletion()</code>, see [[Documentation/DevGuide/Database/Connecting Through a DataSource|Connecting Through a DataSource]]. If interactive logon is not feasible for your application, the properties <code>User</code> and <code>Password</code> can be used to connect to a database that requires logon.

:Once the method for how <code>RowSet</code> creates it connections has been determined, the properties <idlm>com.sun.star.sdb.RowSet:Command</idlm> and <idlm>com.sun.star.sdb.RowSet:CommandType</idlm> have to be set. The <code>CommandType</code> can be <code>TABLE</code>, <code>QUERY</code> or <code>COMMAND</code> where the <code>Command</code> can be a table or query name, or an SQL command.

The following table shows the properties supported by <idl>com.sun.star.sdb.RowSet</idl>.

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
!colspan="2"|Properties of <idl>com.sun.star.sdb.RowSet</idl>
|-
|<idlm>com.sun.star.sdb.RowSet:ActiveConnection</idlm>
|<idl>com.sun.star.sdbc.XConnection</idl>. The active connection is generated by a <code>DataSource</code> or by a URL. It could also be set from the outside. If set from outside, the <code>RowSet</code> is not responsible for disposition of the connection.
|-
|<idlm>com.sun.star.sdb.RowSet:DataSourceName</idlm>
|<code>string</code> - The name of the <code>DataSource</code> to use. This could be a named <code>DataSource</code> or the URL of a data access component.
|-
|<idlm>com.sun.star.sdb.RowSet:Command</idlm>
|<code>string</code> - The <code>Command</code> is the command that should be executed. The type of command depends on the <idl>com.sun.star.sdb.CommandType</idl>.
|-
|<idlm>com.sun.star.sdb.RowSet:CommandType</idlm>
|<idl>com.sun.star.sdb.CommandType</idl> Command type:

<code>TABLE</code>: indicates the command contains a table name that results in a command like "<code>select * from tablename</code>".

<code>QUERY</code>: indicates the command contains a name of a query component that contains a certain statement.

<code>COMMAND</code>: indicates the command is an SQL-Statement.
|-
|<idlm>com.sun.star.sdb.RowSet:ActiveCommand</idlm>
|<code>[readonly] string</code> - The command which is currently used. <idl>com.sun.star.sdb.CommandType</idl>
|-
|<idlm>com.sun.star.sdb.RowSet:IgnoreResult</idlm>
|<code>boolean</code> - Indicates if all results should be discarded.
|-
|<idlm>com.sun.star.sdb.RowSet:Filter</idlm>
|<code>string</code> - Contains a additional filter for a <code>RowSet</code>.
|-
|<idlm>com.sun.star.sdb.RowSet:ApplyFilter</idlm>
|<code>boolean</code> - Indicates if the filter should be applied. The default is false.
|-
|<idlm>com.sun.star.sdb.RowSet:Order</idlm>
|An additional sort order definition for a <code>RowSet</code>.
|-
|<idlm>com.sun.star.sdb.RowSet:Privileges</idlm>
|<code>[readonly] long</code>, constants group <idl>com.sun.star.sdbcx.Privilege</idl>. Indicates the privileges for insert, update, and delete.
|-
|<idlm>com.sun.star.sdb.RowSet:IsModified</idlm>
|<code>[readonly] boolean</code> - Indicates if the current row is modified.
|-
|<idlm>com.sun.star.sdb.RowSet:IsNew</idlm>
|<code>[readonly]</code> boolean - Indicates if the current row is the <code>InsertRow</code> and can be inserted into the database.
|-
|<idlm>com.sun.star.sdb.RowSet:RowCount</idlm>
|<code>[readonly] long</code> - Contains the number of rows accessed in a the data source.
|-
|<idlm>com.sun.star.sdb.RowSet:IsRowCountFinal</idlm>
|<code>[readonly] boolean</code> - Indicates if all rows of the <code>RowSet</code> have been counted.
|-
|<idlm>com.sun.star.sdb.RowSet:UpdateTableName</idlm>
|<code>string</code> - The name of the table that should be updated. This is used for queries that relate to more than one table.
|-
|<idlm>com.sun.star.sdb.RowSet:UpdateSchemaName</idlm>
|<code>string</code> - The name of the table schema.
|-
|<idlm>com.sun.star.sdb.RowSet:UpdateCatalogName</idlm>
|<code>string</code> - The name of the table catalog.
|}

The <idl>com.sun.star.sdb.RowSet</idl> includes the service <idl>com.sun.star.sdbc.RowSet</idl> and its properties. Important settings such as <code>User</code> and <code>Password</code> come from this service:

{|border="1" cellpadding=4 style="border-collapse:collapse;"
|-bgcolor=#EDEDED
!colspan="2"|Properties of <idl>com.sun.star.sdbc.RowSet</idl>
|-
|<idlm>com.sun.star.sdbc.RowSet:DataSourceName</idlm>
|<code>string</code> - Is the name of a named datasource to use.
|-
|<idlm>com.sun.star.sdbc.RowSet:URL</idlm>
|<code>string</code> - The connection URL. Can be used instead of the <code>DataSourceName</code>.
|-
|<idlm>com.sun.star.sdbc.RowSet:Command</idlm>
|<code>string</code> - The command that should be executed.
|-
|<idlm>com.sun.star.sdbc.RowSet:TransactionIsolation</idlm>
|<code>long</code> - Indicates the transaction isolation level that should be used for the connection, according to <idl>com.sun.star.sdbc.TransactionIsolation</idl>
|-
|<idlm>com.sun.star.sdbc.RowSet:TypeMap</idlm>
|<code>com::sun::star::container::XNameAccess</code>. The type map that is used for the custom mapping of SQL structured types and distinct types.
|-
|<idlm>com.sun.star.sdbc.RowSet:EscapeProcessing</idlm>
|boolean - Determines if escape processing is on or off. If escape scanning is on (the default), the driver does the escape substitution before sending the SQL to the database. This is only evaluated if the <code>CommandType</code> is <code>COMMAND</code>.
|-
|<idlm>com.sun.star.sdbc.RowSet:QueryTimeOut</idlm>
|<code>long</code> - Retrieves the number of seconds the driver waits for a Statement to execute. If the limit is exceeded, a SQLException is thrown. There is no limitation if set to zero.
|-
|<idlm>com.sun.star.sdbc.RowSet:MaxFieldSize</idlm>
|<code>long</code> - Returns the maximum number of bytes allowed for any column value. This limit is the maximum number of bytes that can be returned for any column value. The limit applies only to <code>DataType::BINARY<ode>, <code>DataType::VARBINARY</code>, <code>DataType::LONGVARBINARY</code>, <code>DataType::CHAR</code>, <code>DataType::VARCHAR</code>, and <code>DataType::LONGVARCHAR</code> columns. If the limit is exceeded, the excess data is silently discarded. There is no limitation if set to zero.
|-
|<idlm>com.sun.star.sdbc.RowSet:MaxRows</idlm>
|<code>long</code> - Retrieves the maximum number of rows that a <code>ResultSet</code> can contain. If the limit is exceeded, the excess rows are silently dropped. There is no limitation if set to zero.
|-
|<idlm>com.sun.star.sdbc.RowSet:User</idlm>
|<code>string</code> - Determines the user to open the connection for.
|-
|<idlm>com.sun.star.sdbc.RowSet:Password</idlm>
|<code>string</code> - Determines the user to open the connection for.
|-
|<idlm>com.sun.star.sdbc.RowSet:ResultSetType</idlm>
|<code>long</code> - Determine the result set type according to <idl>com.sun.star.sdbc.ResultSetType</idl>
|}

If the command returns results, that is, it selects data, use <code>XRowSet</code> to manipulate the data, because <code>XRowSet</code> is derived from <code>XResultSet</code>. For details on manipulating a <idl>com.sun.star.sdb.ResultSet</idl>, see [[Documentation/DevGuide/Database/Result Sets|Result Sets]].

The code fragment below shows how to create a <code>RowSet</code>.

<source lang="java">
public static void useRowSet(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
// first we create our RowSet object
XRowSet xRowRes = (XRowSet)UnoRuntime.queryInterface(XRowSet.class,
_rMSF.createInstance("com.sun.star.sdb.RowSet"));
System.out.println("RowSet created!");

// set the properties needed to connect to a database
XPropertySet xProp = (XPropertySet)UnoRuntime.queryInterface(XPropertySet.class, xRowRes);
xProp.setPropertyValue("DataSourceName", "Bibliography");
xProp.setPropertyValue("Command", "biblio");
xProp.setPropertyValue("CommandType", new Integer(com.sun.star.sdb.CommandType.TABLE));
xRowRes.execute();
System.out.println("RowSet executed!");
XComponent xComp = (XComponent)UnoRuntime.queryInterface(XComponent.class, xRowRes);
xComp.dispose();
System.out.println("RowSet destroyed!");
}
</source>
The value of the read-only <code>RowSet</code> properties is only valid after the first call to <code>execute()</code> on the <code>RowSet</code>. This snippet shows how to read the privileges out of the <code>RowSet</code>:

<source lang="java">
public static void showRowSetReadOnlyProps(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
// first we create our RowSet object
XRowSet xRowRes =
(XRowSet)UnoRuntime.queryInterface(XRowSet.class_rMSF.createInstance(
"com.sun.star.sdb.RowSet"));
System.out.println("RowSet created!");

// set the properties needed to connect to a database
XPropertySet xProp = (XPropertySet)UnoRuntime.queryInterface(XPropertySet.class, xRowRes);
xProp.setPropertyValue("DataSourceName", "Bibliography");
xProp.setPropertyValue("Command", "biblio");
xProp.setPropertyValue("CommandType", new Integer(com.sun.star.sdb.CommandType.TABLE));
xRowRes.execute();
System.out.println("RowSet executed!");
Integer aPriv = (Integer)xProp.getPropertyValue("Privileges");
int nPriv = aPriv.intValue();

if ((nPriv & Privilege.SELECT) == Privilege.SELECT) System.out.println("SELECT");
if ((nPriv & Privilege.INSERT) == Privilege.INSERT) System.out.println("INSERT");
if ((nPriv & Privilege.UPDATE) == Privilege.UPDATE) System.out.println("UPDATE");
if ((nPriv & Privilege.DELETE) == Privilege.DELETE) System.out.println("DELETE");

XComponent xComp = (XComponent)UnoRuntime.queryInterface(XComponent.class, xRowRes);
xComp.dispose();
System.out.println("RowSet destroyed!");
}
</source>
The next example reads the properties <code>IsRowCountFinal</code> and <code>RowCount</code>.

<source lang="java">
public static void showRowSetRowCount(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
// first we create our RowSet object
XRowSet xRowRes = (XRowSet)UnoRuntime.queryInterface(XRowSet.class,
_rMSF.createInstance("com.sun.star.sdb.RowSet"));
System.out.println("RowSet created!");

// set the properties needed to connect to a database
XPropertySet xProp = (XPropertySet)UnoRuntime.queryInterface(XPropertySet.class,xRowRes);
xProp.setPropertyValue("DataSourceName","Bibliography");
xProp.setPropertyValue("Command","biblio");
xProp.setPropertyValue("CommandType",new Integer(com.sun.star.sdb.CommandType.TABLE));
xRowRes.execute();
System.out.println("RowSet executed!");

// now look if the RowCount is already final
System.out.println("The RowCount is final: " + xProp.getPropertyValue("IsRowCountFinal"));
XResultSet xRes = (XResultSet)UnoRuntime.queryInterface(XResultSet.class,xRowRes);
xRes.last();

System.out.println("The RowCount is final: " + xProp.getPropertyValue("IsRowCountFinal"));
System.out.println("There are " + xProp.getPropertyValue("RowCount") + " rows!");

// now destroy the RowSet
XComponent xComp = (XComponent)UnoRuntime.queryInterface(XComponent.class,xRowRes);
xComp.dispose();
System.out.println("RowSet destroyed!");
}
</source>
Occasionally, it is useful for the user to be notified when the <code>RowCount</code> is final. That is accomplished by adding a <idl>com.sun.star.beans.XPropertyChangeListener</idl> for the property <code>IsRowCountFinal</code>.

{{PDL1}}

[[Category:Documentation/Developer's Guide/Database Access]]

Sdk

2009-01-09T12:07:52Z

Cn: redirect to Documentation/DevGuide/OpenOffice.org_Developers_Guide

#REDIRECT [[Documentation/DevGuide/OpenOffice.org_Developers_Guide]]

Cwscheckapi

2008-06-26T12:33:50Z

Cn: /* Patch vncserver */

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or the project owner have to decide for an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
*put the information about an exception or about problems with the API-Testing into the CWS descriptions

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

==Tips and Tricks==

===Avoid annoying window popup===
The most of the UnoAPI-Tests needs to open a document. On Unix like systems you could do a simple trick to avoid them. Just use a vnc server! And the best: It is not recommended to run this server on your host. You can start it on any server you can reach.
On Windows systems the only way is to run the tests on another (virtual) machine.
====Start vncserver====
*open a shell on the host you like to run a vnc server
*just type
vncserver
*If it is your fist start of a vncserver you have to set a password for further connections. Then you get something like
New '[myHost]:4 ([myHost])' desktop is [myHost]:4

Starting applications specified in /export/.vnc/xstartup
Log file is /export/.vnc/[myHost]:4.log
The vncserver has the display number 4.

====Patch vncserver====
But the default X-Manager on vnc is twm which is not supported by OpenOffice.org. Further more this display manager is unusable since you have to place all windows via mouse. So we have to change the default.
*kill the vncserver. You have to kill the display 4 in this example:
vncserver -kill :4
*change to ~/.vnc
*edit xstartup and change the following: comment '''twm &''' and insert instead '''startkde &'''. Append '''xhost +''' at the end.
'''NOTE''': xhost + is an security issue. Every body from any host can connect to your display. Maybe you can replace + with your host name you connect from.
The '''xstartup''' should look like this:
#!/bin/sh

# Uncomment the following two lines for normal desktop:
# unset SESSION_MANAGER
# exec /etc/X11/xinit/xinitrc

[ -x /etc/vnc/xstartup ] && exec /etc/vnc/xstartup
[ -r $HOME/.Xresources ] && xrdb $HOME/.Xresources
xsetroot -solid grey
vncconfig -iconic &
#xterm -geometry 80x24+10+10 -ls -title "$VNCDESKTOP Desktop" &
#twm &
startkde&
xhost +
*now start the vncserver again with
vncserver
You will '''not''' be ask to a password again. A hash is stored in ~/.vnc/passwd.
*note the display number and go to your shell where you like to run '''cwscheckapi'''
bash: export DISPLAY=[myHost]:[displayNumber]
csh: setenv DISPLAY [myHost]:[displayNumber]
*now all X will be redirected to the vncserver

====Get a view====
to get a view of the vncserver session you have to run the vncviever.
vncviever [hostName]:[displayNumber]

===accessibility===
====Don't touch anything====
If your added modules contains Accessibility-API it is recommended to stay away of keyboard and mouse. Some Accessibility-Test will fail if you do something on your display.
====Redirected display====
If your display is redirected like described above you don't have the problem in such a way. You can open a vncviewer and watch the magic. But don't click into the vncviewer while Accessibility-Tests are running! You can also minimize and close the vncviewer without any risk.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-26T12:08:20Z

Cn: /* Tips and Tricks */

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or the project owner have to decide for an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
*put the information about an exception or about problems with the API-Testing into the CWS descriptions

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

==Tips and Tricks==

===Avoid annoying window popup===
The most of the UnoAPI-Tests needs to open a document. On Unix like systems you could do a simple trick to avoid them. Just use a vnc server! And the best: It is not recommended to run this server on your host. You can start it on any server you can reach.
On Windows systems the only way is to run the tests on another (virtual) machine.
====Start vncserver====
*open a shell on the host you like to run a vnc server
*just type
vncserver
*If it is your fist start of a vncserver you have to set a password for further connections. Then you get something like
New '[myHost]:4 ([myHost])' desktop is [myHost]:4

Starting applications specified in /export/.vnc/xstartup
Log file is /export/.vnc/[myHost]:4.log
The vncserver has the display number 4.

====Patch vncserver====
But the default X-Manager on vnc is twm which is not supported by OpenOffice.org. Further more this display manager is unusable since you have to place all windows via mouse. So we have to change the default.
*kill the vncserver. You have to kill the display 4 in this example:
vncserver -kill :4
*change to ~/.vnc
*edit xstartup and change the following: comment '''twm &''' and insert instead '''startkde &'''. Append '''xhost +''' at the end.
'''NOTE''': This is an security issue. Every body from any host can connect to your display. Maybe you can replace + with your host name you connect from.
The '''xstartup''' should look like this:
#!/bin/sh

# Uncomment the following two lines for normal desktop:
# unset SESSION_MANAGER
# exec /etc/X11/xinit/xinitrc

[ -x /etc/vnc/xstartup ] && exec /etc/vnc/xstartup
[ -r $HOME/.Xresources ] && xrdb $HOME/.Xresources
xsetroot -solid grey
vncconfig -iconic &
#xterm -geometry 80x24+10+10 -ls -title "$VNCDESKTOP Desktop" &
#twm &
startkde&
xhost +
*now start the vncserver again with
vncserver
You will '''not''' be ask to a password again. A hash is stored in ~/.vnc/passwd.
*note the display number and go to your shell where you like to run '''cwscheckapi'''
bash: export DISPLAY=[myHost]:[displayNumber]
csh: setenv DISPLAY [myHost]:[displayNumber]
*now all X will be redirected to the vncserver
====Get a view====
to get a view of the vncserver session you have to run the vncviever.
vncviever [hostName]:[displayNumber]

===accessibility===
====Don't touch anything====
If your added modules contains Accessibility-API it is recommended to stay away of keyboard and mouse. Some Accessibility-Test will fail if you do something on your display.
====Redirected display====
If your display is redirected like described above you don't have the problem in such a way. You can open a vncviewer and watch the magic. But don't click into the vncviewer while Accessibility-Tests are running! You can also minimize and close the vncviewer without any risk.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-26T12:06:00Z

Cn: /* Start vncserver */

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or the project owner have to decide for an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
*put the information about an exception or about problems with the API-Testing into the CWS descriptions

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

==Tips and Tricks==

===Avoid annoying window popup===
The most of the UnoAPI-Tests needs to open a document. On Unix like systems you could do a simple trick to avoid them. Just use a vnc server! And the best: It is not recommended to run this server on your host. You can start it on any server you can reach.
On Windows systems the only way is to run the tests on another (virtual) machine.
====Start vncserver====
*open a shell on the host you like to run a vnc server
*just type
vncserver
*If it is your fist start of a vncserver you have to set a password for further connections. Then you get something like
New '[myHost]:4 ([myHost])' desktop is [myHost]:4

Starting applications specified in /export/.vnc/xstartup
Log file is /export/.vnc/[myHost]:4.log
The vncserver has the display number 4.

====Patch vncserver====
But the default X-Manager on vnc is twm which is not supported by OpenOffice.org. Further more this display manager is unusable since you have to place all windows via mouse. So we have to change the default.
*kill the vncserver. You have to kill the display 4 in this example:
vncserver -kill :4
*change to ~/.vnc
*edit xstartup and change the following: comment _twm &_ and insert instead _startkde &_. Append xhost + at the end.
_NOTE_: This is an security issue. Every body from any host can connect to your display. Maybe you can replace + with your host name you connect from.
The _xstartup_ should look like this:
#!/bin/sh

# Uncomment the following two lines for normal desktop:
# unset SESSION_MANAGER
# exec /etc/X11/xinit/xinitrc

[ -x /etc/vnc/xstartup ] && exec /etc/vnc/xstartup
[ -r $HOME/.Xresources ] && xrdb $HOME/.Xresources
xsetroot -solid grey
vncconfig -iconic &
#xterm -geometry 80x24+10+10 -ls -title "$VNCDESKTOP Desktop" &
#twm &
startkde&
xhost +
*know start the vncserver again with
vncserver
You will not be ask to a password again. A hash is stored in ~/.vnc/passwd.
*note the display number and go to your shell where you like to run _cwscheckapi_
bash: export DISPLAY=[myHost]:[displayNumber]
csh: setenv DISPLAY [myHost]:[displayNumber]
*now all X will be redirected to the vncserver
====Get a view====
to get a view of the vncserver session you have to run the vncviever.
vncviever [hostName]:[displayNumber]

===accessibility===
====Don't touch anything====
If your added modules contains Accessibility-API it is recommended to stay away of keyboard and mouse. Some Accessibility-Test will fail if you do something on your display.
====Redirected display====
If your display is redirected like described above you don't have the problem in such a way. You can open a vncviewer and watch the magic. But don't click into the vncviewer while Accessibility-Tests are running! You can also minimize and close the vncviewer without any risk.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-26T12:00:44Z

Cn: Tips and tricks: vnc

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or the project owner have to decide for an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
*put the information about an exception or about problems with the API-Testing into the CWS descriptions

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

==Tips and Tricks==

===Avoid annoying window popup===
The most of the UnoAPI-Tests needs to open a document. On Unix like systems you could do a simple trick to avoid them. Just use a vnc server! And the best: It is not recommended to run this server on your host. You can start it on any server you can reach.
On Windows systems the only way is to run the tests on another (virtual) machine.
====Start vncserver====
*open a shell on the host you like to run a vnc server
*just type
vncserver
*If it is your fist start of a vncserver you have to set a password for further connections. Then you get something like
New '[myHost]:4 ([myHost])' desktop is [myHost]:4

Starting applications specified in /export/.vnc/xstartup
Log file is /export/.vnc/[myHost]:4.log
*the vncserver has the display number 4.

====Patch vncserver====
But the default X-Manager on vnc is twm which is not supported by OpenOffice.org. Further more this display manager is unusable since you have to place all windows via mouse. So we have to change the default.
*kill the vncserver. You have to kill the display 4 in this example:
vncserver -kill :4
*change to ~/.vnc
*edit xstartup and change the following: comment _twm &_ and insert instead _startkde &_. Append xhost + at the end.
_NOTE_: This is an security issue. Every body from any host can connect to your display. Maybe you can replace + with your host name you connect from.
The _xstartup_ should look like this:
#!/bin/sh

# Uncomment the following two lines for normal desktop:
# unset SESSION_MANAGER
# exec /etc/X11/xinit/xinitrc

[ -x /etc/vnc/xstartup ] && exec /etc/vnc/xstartup
[ -r $HOME/.Xresources ] && xrdb $HOME/.Xresources
xsetroot -solid grey
vncconfig -iconic &
#xterm -geometry 80x24+10+10 -ls -title "$VNCDESKTOP Desktop" &
#twm &
startkde&
xhost +
*know start the vncserver again with
vncserver
You will not be ask to a password again. A hash is stored in ~/.vnc/passwd.
*note the display number and go to your shell where you like to run _cwscheckapi_
bash: export DISPLAY=[myHost]:[displayNumber]
csh: setenv DISPLAY [myHost]:[displayNumber]
*now all X will be redirected to the vncserver
====Get a view====
to get a view of the vncserver session you have to run the vncviever.
vncviever [hostName]:[displayNumber]

===accessibility===
====Don't touch anything====
If your added modules contains Accessibility-API it is recommended to stay away of keyboard and mouse. Some Accessibility-Test will fail if you do something on your display.
====Redirected display====
If your display is redirected like described above you don't have the problem in such a way. You can open a vncviewer and watch the magic. But don't click into the vncviewer while Accessibility-Tests are running! You can also minimize and close the vncviewer without any risk.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Talk:Cwscheckapi

2008-06-20T13:51:18Z

Cn: answer to Thorsten

Hi Christoph,

I have some questions or complaints about the information on the process for API-Testing based on CWS.

* In the first chapter, what does 'CWS is ready' means? You have to clarify the word 'ready'. Does it means the developers finished their work or does it means the QA has also approved the CWS. Should the CWS in state 'ready for QA' or should the run of the API tests be done before the CWS state will be set to 'ready for QA'. Please be more specific here, otherwise it isn't possible to adjust the [http://wiki.services.openoffice.org/wiki/Approve_a_CWS CWS approval process].

* The link for 'to get an exception' doesn't work.

* What do you mean with 'good arguments'. If you write such sentences you have to bring examples. If you want to be funny with this, than it's the wrong place here. You want to describe a process and then you have to give information, what are the arguments could be or that there aren't any arguments. Processes have be documented very clear and not funny.

* Who can approve an exception. Should this be done by the manager really? Who is the manager of a community member? In my opinion it has to be clarified in the project itself and the project lead should be responsible for that. Or shouldn't he know about an exception?

* It isn't needed to get an exception from the QA representative. Often he doesn't have enough information about the API testing and the consequences. But it is needed to put the information about an exception or about problems with the API-Testing into the CWS descriptions. This should be a must and documented here.

Regards,
Thorsten

----
--cn 15:51, 20 June 2008 (CEST)
Hi Thorsten,
thx for you comments! I am be more specific with the "CWS is ready" and "what is an exception"

The idea to describe problems in the CWS descriptions is a very good idea. I have added this. And you are right if you say the a QA representative could not decide about the importance of UnoAPI issues. I have removed them from the exception treatment process.

Christoph

Cwscheckapi

2008-06-20T13:46:49Z

Cn: /* Exception treatment */ explain exceptions

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or the project owner have to decide for an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
*put the information about an exception or about problems with the API-Testing into the CWS descriptions

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-20T13:42:15Z

Cn: /* CWS is ready */ fix exception link

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception treatment|exception]]

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or his manager in consultation with the QA representative have to decide an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-20T13:40:08Z

Cn: /* Exception treatment */ explain exceptions

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
An Exception could be f.e. a defective UnoAPI-Test. Or maybe you owns an important CWS on which other CWS depends and a not critical issue occur. This could also a reason for an exception. At the end the developer and/or his manager in consultation with the QA representative have to decide an exception.

If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-20T10:21:14Z

Cn: /* CWS is ready */ define "CWS is ready"

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

A "CWS is ready" means, that all tasks are fixed and the CWS could be ready for QA. So it is one step before the QA gets the CWS.
If the CWS is ready the developer has to run [[cwscheckapi]]. wscheckapi calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-19T10:17:40Z

Cn: changes notes

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----
----
'''NOTE:''' currently it is not tested for unxmacxi.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-04T13:59:56Z

Cn: note to openoffice environment

'''D R A F T'''

----
'''NOTE:''' currently it is not tested in OpenOffice.org environment. If have Issues please write them to cn@openoffice.org, catrgory API.
----

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-04T13:56:02Z

Cn: /* Test the modules */ notes to a11y-Tests

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s of the module will be executed.

----

'''NOTE:''' since some modules contains '''Accessibility-API''' it is needed to not touch mouse or keyboard while running the tests!

----

=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-06-04T13:52:01Z

Cn: install StarOffice or OpenOffice.org

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== install StarOffice or OpenOffice.org ===
The StarOffice developer mid to install StarOffice as default where the OpenOffice.org developer don't have a StarOffice. So the installation routine checks at first for an StarOffice version (instset_native <-> instetoo_native). If this is not available the OpenOffice.org version will be used. But with parameter -o it is possible to force the OpenOffice.org version
cwscheckapi -o
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s will be executed.
=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

UnoAPITest/project/ModuleTests/module/dbaccess

2008-06-04T12:46:41Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= dbaccess =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| [http://www.openoffice.org/issues/show_bug.cgi?id=84235 84235]
| dbaccess.ORowSet::com::sun::star::sdbc::XWarningSupplier
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=38209 38209 ]
| dbaccess.ODatasourceAdministrationDialog::com::sun::star::sdb::DatasourceAdministrationDialog
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=55579 55579]
| dbaccess.OQueryDesign::com::sun::star::frame::XController
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84113 84113]
| dbaccess.ConnectionLineAccessibility
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84114 84114]
| dbaccess.JoinViewAccessibility
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84116 84116]
| dbaccess.OQueryDesign
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84125 84125 ]
| dbaccess.SbaXGridControl::com::sun::star::view::XSelectionSupplier
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84127 84127 ]
| dbaccess.SbaXGridControl
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84127 84127 ]
| dbaccess.SbaXGridControl::com::sun::star::awt::XWindow
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84128 84128 ]
| dbaccess.TableWindowAccessibility
| Test
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=86990 86990 ]
| dbaccess.ODatabaseSource::com::sun::star::beans::XPropertySet
| rowspan="2" | Test
| rowspan="2" |
|-
| dbaccess.OCommandDefinition::com::sun::star::beans::XPropertySet

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88646 88646]
| dbaccess.ODatabaseContext::com::sun::star::uno::XNamingService
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90358 90358]
| dbaccess.SbaXGridControl::com::sun::star::awt::XView
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90359 90359]
| dbaccess.ODatabaseSource::com::sun::star::sdb::DataSource
| Test
|

|}

UnoAPITest/project/ModuleTests/module/toolkit

2008-06-04T12:37:27Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= toolkit =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86545 86545]
| toolkit.AccessibleToolBoxItem::com::sun::star::accessibility::XAccessibleText
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=37643 37643]
| toolkit.AccessibleStatusBarItem::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87757 87757]
| toolkit.AccessibleFixedText::com::sun::star::accessibility::XAccessibleText
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=30818 30818]
| toolkit.AccessibleToolBox::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=68852 68852]
| toolkit.TabControllerModel::com::sun::star::io::XPersistObject
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=79111 79111]
| toolkit.UnoControlButtonModel::com::sun::star::awt::UnoControlButtonModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=79110 79110]
| toolkit.UnoControlCheckBoxModel::com::sun::star::awt::UnoControlCheckBoxModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84314 84314]
| toolkit.UnoControlImageControlModel::com::sun::star::awt::UnoControlImageControlModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86542 86542]
| toolkit.UnoControlProgressBarModel::com::sun::star::awt::UnoControlProgressBarModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86543 86543]
| toolkit.UnoControlRadioButtonModel::com::sun::star::awt::UnoControlRadioButtonModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=79098 79098]
| toolkit.UnoControlScrollBarModel::com::sun::star::awt::UnoControlScrollBarModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86544 86544]
| toolkit.UnoTreeModel::com::sun::star::awt::tree::TreeControlModel
| Test
|

|-
| rowspan="20" | [http://qa.openoffice.org/issues/show_bug.cgi?id=74011 74011]
| toolkit.UnoControlDateField::com::sun::star::awt::XWindow
| rowspan="20" | Implementation
| rowspan="20" |
|-
| toolkit.UnoSpinButtonControl::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlPatternField::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlRadioButton::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlButton::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlTimeField::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlFormattedField::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlContainer::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlGroupBox::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlFixedText::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlListBox::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlImageControl::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlDialog::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlEdit::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlCurrencyField::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlFileControl::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlComboBox::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlNumericField::com::sun::star::awt::XWindow
|-
| toolkit.UnoControlCheckBox::com::sun::star::awt::XWindow
|-
| toolkit.UnoScrollBarControl::com::sun::star::awt::XWindow
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86296 86296]
| toolkit.UnoControlContainerModel::com::sun::star::awt::UnoControlContainerModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86297 86297]
| toolkit.UnoControlFixedTextModel::com::sun::star::awt::UnoControlFixedTextModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86299 86299]
| toolkit.UnoTreeModel::com::sun::star::awt::UnoControlModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86300 86300]
| toolkit.UnoTreeModel::com::sun::star::beans::XMultiPropertySet
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86007 86007]
| toolkit.AccessibleButton
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86008 86008]
| toolkit.AccessibleComboBox
| Test
|

|-
| rowspan="5" | [http://qa.openoffice.org/issues/show_bug.cgi?id=86110 86110]
| toolkit.AccessibleEdit
| rowspan="5" | Implementation
| rowspan="5" |
|-
| toolkit.AccessibleList
|-
| toolkit.AccessibleListBox
|-
| toolkit.AccessibleListItem
|-
| toolkit.AccessibleRadioButton
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86009 86009]
| toolkit.AccessibleMenuItem
| Test

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86107 86107]
| toolkit.AccessibleRadioButton
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86287 86287]
| toolkit.AccessibleToolBox
| Test
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=80788 80788]
| toolkit.Toolkit
| rowspan="2" | Test
| rowspan="2" |
|-
| toolkit.UnoControlDialog
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86011 86011]
| toolkit.UnoControlFileControl
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86013 86013]
| toolkit.UnoControlFormattedField
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86019 86019]
| toolkit.UnoControlListBox
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86020 86020]
| toolkit.UnoSimpleAnimationControl
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86021 86021]
| toolkit.UnoSimpleAnimationControlModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86022 86022]
| toolkit.UnoThrobberControl
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86023 86023]
| toolkit.UnoThrobberControlModel
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86298 86298]
| toolkit.UnoTreeControl
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=52607 52607]
| toolkit.AccessiblePopupMenu
| Test
|

|-
| rowspan="22" | [http://qa.openoffice.org/issues/show_bug.cgi?id=86660 86660]
| toolkit.UnoControlDateField::com::sun::star::awt::XView
| rowspan="22" | Test
| rowspan="22" |
|-
| toolkit.UnoSpinButtonControl::com::sun::star::awt::XView
|-
| toolkit.UnoControlPatternField::com::sun::star::awt::XView
|-
| toolkit.UnoControlRadioButton::com::sun::star::awt::XView
|-
| toolkit.UnoControlButton::com::sun::star::awt::XView
|-
| toolkit.UnoControlTimeField::com::sun::star::awt::XView
|-
| toolkit.UnoControlFormattedField::com::sun::star::awt::XView
|-
| toolkit.UnoControlGroupBox::com::sun::star::awt::XView
|-
| toolkit.UnoControlContainer::com::sun::star::awt::XView
|-
| toolkit.UnoControlFixedText::com::sun::star::awt::XView
|-
| toolkit.UnoControlListBox::com::sun::star::awt::XView
|-
| toolkit.UnoControlEdit::com::sun::star::awt::XView
|-
| toolkit.UnoControlImageControl::com::sun::star::awt::XView
|-
| toolkit.UnoControlDialog::com::sun::star::awt::XView
|-
| toolkit.UnoThrobberControl::com::sun::star::awt::XView
|-
| toolkit.UnoControlFileControl::com::sun::star::awt::XView
|-
| toolkit.UnoControlCurrencyField::com::sun::star::awt::XView
|-
| toolkit.UnoSimpleAnimationControl::com::sun::star::awt::XView
|-
| toolkit.UnoControlComboBox::com::sun::star::awt::XView
|-
| toolkit.UnoControlNumericField::com::sun::star::awt::XView
|-
| toolkit.UnoControlCheckBox::com::sun::star::awt::XView
|-
| toolkit.UnoScrollBarControl::com::sun::star::awt::XView
|-

|-
| rowspan="5" | [http://qa.openoffice.org/issues/show_bug.cgi?id=87864 87864]
| toolkit.UnoControlCheckBox::com::sun::star::lang::XComponent
| rowspan="5" | Test
| rowspan="5" |
|-
| toolkit.UnoScrollBarControl::com::sun::star::lang::XComponent
|-
| toolkit.UnoSpinButtonControl::com::sun::star::lang::XComponent
|-
| toolkit.UnoControlTimeField::com::sun::star::lang::XComponent
|-
| toolkit.UnoControlEdit::com::sun::star::lang::XComponent
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88054 88054]
| toolkit.UnoControlContainer::com::sun::star::awt::XControl
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88332 88332]
| toolkit.AccessibleCheckBox
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88605 88605]
| toolkit.AccessibleToolBoxItem
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89019 89019]
| toolkit.AccessibleWindow::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88360 88360]
| cfgmgr2.ORootElementValueSetUpdateAccess::com::sun::star::util::XChangesBatch
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89417 89417]
| toolkit.UnoControlContainer::com::sun::star::accessibility::XAccessible
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89418 89418]
| toolkit.UnoSpinButtonControl::com::sun::star::awt::XSpinValue
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90354 90354]
| toolkit.AccessibleScrollBar::com::sun::star::accessibility::XAccessibleComponent
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90356 90356]
| toolkit.UnoScrollBarControl::com::sun::star::awt::XScrollBar
| Test
|

|}

UnoAPITest/project/ModuleTests/module/forms

2008-06-04T12:34:13Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
==forms==
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| forms.OCurrencyModel::com::sun::star::form::XUpdateBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=45204 45204]
| Implementaion
|

|-
| forms.'''***'''Control::com::sun::star::awt::XWindow
| [http://www.openoffice.org/issues/show_bug.cgi?id=46489 46489]
| Test
|

|-
| forms.ODatabaseForm::com::sun::star::sdbc::XWarningsSupplier
| [http://www.openoffice.org/issues/show_bug.cgi?id=84235 84235]
| Test
|

|-
| forms.OCurrencyModel::com::sun::star::form::XUpdateBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=45204 45204]
| Implementation
|

|-
| forms.OScrollBarModel::com::sun::star::awt::UnoControlScrollBarModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=79098 79098]
| Test
|

|-
| forms.ORadioButtonModel::com::sun::star::awt::UnoControlRadioButtonModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=79100 79100]
| Test
|

|-
| forms.OButtonControl::com::sun::star::form::submission::XSubmission
| [http://www.openoffice.org/issues/show_bug.cgi?id=79108 79108]
| Test
|

|-
| forms.OImageButtonControl::com::sun::star::form::submission::XSubmission
| [http://www.openoffice.org/issues/show_bug.cgi?id=79108 79108]
| Test
|

|-
| forms.OFixedTextModel::com::sun::star::awt::UnoControlFixedTextModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=79109 79109]
| Test
|

|-
| forms.OCheckBoxModel::com::sun::star::awt::UnoControlCheckBoxModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=79110 79110]
| Test
|

|-
| forms.OButtonModel::com::sun::star::awt::UnoControlButtonModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=79111 79111]
| Test
|

|-
| forms.ODatabaseForm::com::sun::star::form::XDatabaseParameterBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=84283 84283]
| Implementation
|

|-
| forms.ODatabaseForm::com::sun::star::sdbc::XParameters
| [http://www.openoffice.org/issues/show_bug.cgi?id=84298 84298]
| Test
|

|-
| forms.OEditModel::com::sun::star::style::ParagraphProperties
| [http://www.openoffice.org/issues/show_bug.cgi?id=73994 73994]
| Test
|

|-
| forms.OFixedTextModel::com::sun::star::beans::XMultiPropertySet
| [http://www.openoffice.org/issues/show_bug.cgi?id=84311 84311]
| Implementation
| bgcolor="#00ff00" | src680_m239

|-
| forms.OFixedTextModel::com::sun::star::beans::XFastPropertySet
| [http://www.openoffice.org/issues/show_bug.cgi?id=84311 84311]
| Implementation
| bgcolor="#00ff00" | src680_m239

|-
| forms.OImageButtonModel::com::sun::star::awt::UnoControlImageControlModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=84314 84314]
| Test
|

|-
| forms.OImageControlModel::com::sun::star::awt::UnoControlImageControlModel
| [http://www.openoffice.org/issues/show_bug.cgi?id=84315 84315]
| Test
|

|-
| forms.ONumericModel::com::sun::star::form::XUpdateBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=84316 84316]
| Test
|

|-
| forms.ONavigationBarControl::com::sun::star::lang::XComponent
| [http://www.openoffice.org/issues/show_bug.cgi?id=87212 87212]
| Test
|

|-
| forms.OGroupBoxControl::com::sun::star::awt::XView
| rowspan=16 | [http://www.openoffice.org/issues/show_bug.cgi?id=87213 87213]
| rowspan=16 | Test
| rowspan=16 |
|-
| forms.OListBoxControl::com::sun::star::awt::XView
|-
| forms.OEditControl::com::sun::star::awt::XView
|-
| forms.ORadioButtonControl::com::sun::star::awt::XView
|-
| forms.OButtonControl::com::sun::star::awt::XView
|-
| forms.OPatternControl::com::sun::star::awt::XView
|-
| forms.OCheckBoxControl::com::sun::star::awt::XView
|-
| forms.OTimeControl::com::sun::star::awt::XView
|-
| forms.OCurrencyControl::com::sun::star::awt::XView
|-
| forms.OFormattedControl::com::sun::star::awt::XView
|-
| forms.ONumericControl::com::sun::star::awt::XView
|-
| forms.OImageButtonControl::com::sun::star::awt::XView
|-
| forms.OComboBoxControl::com::sun::star::awt::XView
|-
| forms.ODateControl::com::sun::star::awt::XView
|-
| forms.OImageControlControl::com::sun::star::awt::XView
|-
| forms.ONavigationBarControl::com::sun::star::awt::XView
|-

|-
| forms.OEditControl::com::sun::star::form::XChangeBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=87214 87214]
| Test
|

|-
| forms.OListBoxControl::com::sun::star::form::XChangeBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=87215 87215]
| Test
|

|-
| forms.OEditModel::com::sun::star::form::XUpdateBroadcaster
| [http://www.openoffice.org/issues/show_bug.cgi?id=87861 87861]
| Test
|

|-
| forms.OGroupBoxModel::com::sun::star::lang::XComponent
| [http://www.openoffice.org/issues/show_bug.cgi?id=89421 89421]
| Test
|

|-
| forms.OHiddenModel::com::sun::star::form::component::HiddenControl
| [http://www.openoffice.org/issues/show_bug.cgi?id=89422 89422]
| Test
|

|-
| forms.OListBoxControl::com::sun::star::lang::XComponent
| [http://www.openoffice.org/issues/show_bug.cgi?id=90352 90352]
| Test
|

|}

UnoAPITest/project/ModuleTests/module/starmath

2008-06-04T11:15:33Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
==starmath==
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=23394 23394]
| sm.XMLImporter::com::sun::star::xml::sax::XDocumentHandler
| rowspan="2" | Implementaion
| rowspan="2" |
|-
| sm.XMLMetaImporter::com::sun::star::xml::sax::XDocumentHandler
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88645 88645]
| sm.XMLExporter::com::sun::star::document::XFilter
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90348 90348]
| sm.SmEditAccessible::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90349 90349]
| sm.SmGraphicAccessible::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Test
|

|}

UnoAPITest/project/ModuleTests/module/framework

2008-06-04T11:10:05Z

Cn: /* Issues */

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
==framework==
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| fwk.PopupMenuControllerFactory
| [http://www.openoffice.org/issues/show_bug.cgi?id=84321 84321]
| Test
|

|-
| fwk.Desktop::com::sun::star::lang::XComponent
| [http://www.openoffice.org/issues/show_bug.cgi?id=8242 8242]
| Implementaion
|

|-
| fwl.TypeDetection::com::sun::star::container::XNameReplace
| [http://www.openoffice.org/issues/show_bug.cgi?id=30570 30570]
| Implementaion
|

|-
| fwk.UIConfigurationManager::com::sun::star::ui::XUIConfiguration***
| [http://www.openoffice.org/issues/show_bug.cgi?id=50165 50165]
| Implementaion
|

|-
| fwk.StatusBarControllerFactory::com::sun::star::lang::XMultiComponentFactory
| [http://www.openoffice.org/issues/show_bug.cgi?id=50578 50578]
| Implementaion
|

|-
| fwl.PathSettings::com::sun::star::beans::XMultiPropertySet
| [http://www.openoffice.org/issues/show_bug.cgi?id=68698 68698]
| Test
|

|-
| fwl.FilterFactory::com::sun::star::lang::XMultiServiceFactory
| [http://www.openoffice.org/issues/show_bug.cgi?id=74020 74020]
| Test
|

|-
| fwl.PathSettings::com::sun::star::beans::XMultiPropertySet
| [http://www.openoffice.org/issues/show_bug.cgi?id=84346 84346]
| Implementation
|

|-
| fwk.JobExecutor
| [http://www.openoffice.org/issues/show_bug.cgi?id=84423 84423]
| Test
|

|-
| fwk.JobHandler
| [http://www.openoffice.org/issues/show_bug.cgi?id=84423 84423]
| Test
|

|-
| fwk.Frame::com::sun::star::lang::XComponent
| [http://www.openoffice.org/issues/show_bug.cgi?id=87526 87526]
| Implementation
|

|-
| fwk.Desktop::com::sun::star::frame::XDesktop
| [http://www.openoffice.org/issues/show_bug.cgi?id=87865 87865]
| Test
|

|-
| fwk.Desktop::com::sun::star::frame::XFramesSupplier
| [http://www.openoffice.org/issues/show_bug.cgi?id=88635 88635]
| Test
|

|-
| fwk.Frame
| [http://www.openoffice.org/issues/show_bug.cgi?id=88644 88644]
| Test
|

|-
| fwk.URLTransformer::com::sun::star::util::XURLTransformer
| [http://www.openoffice.org/issues/show_bug.cgi?id=90345 90345]
| Test
|

|}

UnoAPITest/project/ModuleTests/module/sc

2008-06-04T11:07:47Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= sc =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| sc.AccessibleEditableTextPara_PreviewCell::com::sun::star::accessibility::XAccessibleEditableText
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84702 84702]
| Test
|

|-
| sc.ScAreaLinksObj::com::sun::star::sheet::XAreaLinks
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84701 84701]
| Implementation
|

|-
| sc.ScAreaLinkObj::com::sun::star::util::XRefreshable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84711 84711]
| Test
|

|-
| sc.ScNamedRangesObj::com::sun::star::sheet::XNamedRanges
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84697 84697]
| Test
|

|-
| sc.ScCellTextCursor::com::sun::star::beans::XMultiPropertyStates
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84674 84674]
| Implementation
|

|-
| sc.ScHeaderFooterTextCursor::com::sun::star::beans::XMultiPropertyStates
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84674 84674]
| Implementation
|

|-
| sc.ScCellObj::com::sun::star::sheet::XCellRangesQuery
| [http://qa.openoffice.org/issues/show_bug.cgi?id=20044 20044]
| Implementation
|

|-
| sc.ScTableSheetObj::com::sun::star::table::XAutoFormattable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84672 84672]
| Implementation
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XCellRangeData
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84671 84671]
| Implementation
|

|-
| sc.ScTabViewObj::com::sun::star::sheet::XRangeSelection
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84669 84669]
| Test
|

|-
| sc.ScAutoFormatsObj::com::sun::star::container::XNameReplace
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23594 23594]
| Implementation
|

|-
| sc.ScStyleFamilyObj::com::sun::star::container::XNameReplace
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23594 23594]
| Implementation
|

|-
| sc.ScTableSheetsObj::com::sun::star::container::XNameReplace
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23594 23594]
| Implementation
|

|-
| sc.ScDocumentConfiguration::com::sun::star::document::Settings
| [http://qa.openoffice.org/issues/show_bug.cgi?id=31378 31378]
| Test
|

|-
| sc.ScHeaderFooterTextObj::com::sun::star::text::XTextRangeMover
| [http://qa.openoffice.org/issues/show_bug.cgi?id=33869 33869]
| Implementation
|

|-
| sc.ScModelObj::com::sun::star::view::XPrintable::setPrinter()
| [http://qa.openoffice.org/issues/show_bug.cgi?id=34066 34066]
| Test
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XPrintAreas
| [http://qa.openoffice.org/issues/show_bug.cgi?id=34878 34878]
| Implementation
|

|-
| sc.ScAccessibleDocument::com::sun::star::accessibility::XAccessibleSelection
| [http://qa.openoffice.org/issues/show_bug.cgi?id=42534 42534]
| Test
|

|-
| sc.ScDataPilotFieldGroupObj::com::sun::star::container::XNameAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46730 46730]
| Implementation
|

|-
| sc.ScTabViewObj::com::sun::star::awt::XUserInputInterception
| [http://qa.openoffice.org/issues/show_bug.cgi?id=53606 53606]
| Implementation
|

|-
| sc.***::com::sun::star::document::XFilter
| [http://qa.openoffice.org/issues/show_bug.cgi?id=55490 55490]
| Test
|

|-
| sc.ScModelObj::com::sun::star::frame::XStorable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84666 84666]
| Test
|

|-
| sc.ScModelObj::com::sun::star::view::XPrintJobBroadcaster
| [http://qa.openoffice.org/issues/show_bug.cgi?id=34456 34456]
| Implementation
|

|-
| sc.***::com::sun::star::style::ParagraphProperties
| [http://qa.openoffice.org/issues/show_bug.cgi?id=73994 73994]
| Test
|

|-
| sc.ScAccessibleCsvCell::com::sun::star::accessibility::XAccessibleText
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84555 84555]
| Test
|

|-
| sc.ScAccessibleCsvRuler::com::sun::star::accessibility::XAccessibleText
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84555 84555]
| Test
|

|-
| sc.ScAnnotationShapeObj::com::sun::star::drawing::FillProperties
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84722 84722]
| Test
|

|-
| sc.ScAccessibleCsvGrid::com::sun::star::accessibility::XAccessibleTable::getAccessibleRowDescription()
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84726 84726]
| Test
|

|-
| sc.ScAccessibleCsvGrid::com::sun::star::accessibility::XAccessibleTable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84727 84727]
| Test
|

|-
| sc.ScCellRangeObj::com::sun::star::table::XAutoFormattable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84753 84753]
| Test
|

|-
| sc.ScRecentFunctionsObj::com::sun::star::sheet::XRecentFunctions
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84761 84761]
| Test
|

|-
| sc.ScStyleObj::com::sun::star::style::Style
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85566 85566]
| Implementation
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XFormulaQuery
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86793 86793]
| Implementation
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XMultipleOperation
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87863 87863]
| Test
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XSheetFilterableEx
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87876 87876]
| Test
|

|-
| sc.AccessibleEditableTextPara_HeaderFooter
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88241 88241]
| Implementation
|

|-
| sc.ScModelObj::com::sun::star::view::XPrintable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88242 88242]
| Test
|

|-
| sc.ScTableSheetObj::com::sun::star::sheet::XCellSeries
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88311 88311]
| Test
|

|-
| sc.ScAccessibleDocument
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88330 88330]
| Test
|

|-
| sc.ScCellCursorObj::com::sun::star::table::XAutoFormattable
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89020 89020]
| Test
|

|-
| sc.XMLContentExporter
| rowspan="4" | [http://qa.openoffice.org/issues/show_bug.cgi?id=89411 89411]
| rowspan="4" | Test
| rowspan="4" |
|-
| sc.XMLContentImporter
|-
| sc.XMLExporter
|-
| sc.XMLImporter

|-
| sc.ScTableValidationObj::com::sun::star::sheet::TableValidation
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90346 90346]
| Test
|

|}

UnoAPITest/project/ModuleTests/module/framework

2008-06-04T10:58:26Z

Cn: /* Issues */ add issue

UnoAPITest/project/ModuleTests/module/svx

2008-06-03T10:10:02Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= svx =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=85263 85263]
| svx.SvxShape::com::sun::star::drawing::TextProperties::TextWritingMode
| rowspan="2" | Implementation
| rowspan="2" |
|-
| svx.SvxShapeConnector::com::sun::star::drawing::TextProperties::TextWritingMode
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46736 46736]
| svx.AccessibleImageBullet
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85501 85501]
| svx.SvxGraphCtrlAccessibleContext
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85539 85539]
| svx.AccessiblePresentationShape
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85476 85476]
| svx.SvxUnoText::com::sun::star::text::XTextRangeMover
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85478 85478]
| svx.SvxUnoTextRange::com::sun::star::text::XTextRange
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=35965 35965]
| svx.SvxGraphCtrlAccessibleContext::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85479 85479]
| svx.AccessiblePageShape::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85481 85481]
| svx.SvxUnoTextCursor::com::sun::star::beans::XMultiPropertyStates
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=58108 58108]
| svx.SvxUnoText::com::sun::star::text::XTextRangeCompare
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=38623 38623]
| svx.SvxUnoTextCursor::com::sun::star::text::XTextRange
| Test
|

|-
| rowspan="10" | [http://qa.openoffice.org/issues/show_bug.cgi?id=73993 73993]
| svx.SvxUnoTextContent::com::sun::star::style::ParagraphProperties
| rowspan="10" | Implementation
| rowspan="10" |
|-
| svx.SvxUnoTextCursor::com::sun::star::style::ParagraphProperties
|-
| svx.SvxUnoTextRange::com::sun::star::style::ParagraphProperties
|-
| svx.SvxGraphicObject::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShape::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShapeCircle::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShapeConnector::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShapeDimensioning::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShapePolyPolygon::com::sun::star::style::ParagraphProperties
|-
| svx.SvxShapePolyPolygonBezier::com::sun::star::style::ParagraphProperties
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23461 23461]
| svx.SvxDrawPage::com::sun::star::drawing::XMasterPageTarget
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85485 85485]
| svx.SvxShapeDimensioning::com::sun::star::drawing::XShape
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=58125 58125]
| svx.SvxGraphicObject::com::sun::star::drawing::GraphicObjectShape
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87698 87698]
| svx.SvxShapeDimensioning::com::sun::star::drawing::TextProperties
| Implementation
|

|-
| rowspan="7" | [http://qa.openoffice.org/issues/show_bug.cgi?id=87746 87746]
| svx.SvxGraphicObject
| rowspan="7" | Implementation
| rowspan="7" |
|-
| svx.SvxShapeCircle
|-
| svx.SvxShapeControl
|-
| svx.SvxShapeDimensioning
|-
| svx.SvxShapeGroup
|-
| svx.SvxShapePolyPolygon
|-
| svx.SvxShapePolyPolygonBezier
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88543 88543]
| svx.SvxUnoTextRange::com::sun::star::beans::XPropertySet
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=90294 90294]
| svx.GraphicExporter
| Test
|

|}

UnoAPITest/project/ModuleTests/module/forms

2008-05-13T20:42:52Z

Cn: /* Issues */ add issue

UnoAPITest/project/ModuleTests/module/sw

2008-05-13T20:34:27Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= sw =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85576 85576]
| sw.SwXCellRange::com::sun::star::text::CellRange
| Implementation
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=21166 21166]
| sw.SwXCell::com::sun::star::text::CellProperties
| rowspan="2" | Implementation
| rowspan="2" |
|-
| sw.SwXCell::com::sun::star::beans::XPropertySet
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=59143 59143]
| sw.SwXTableColumns::com::sun::star::table::XTableColumns
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85580 85580]
| sw.SwXTextView::com::sun::star::view::XSelectionSupplier
| Implementation
|

|-
| rowspan="3" | [http://qa.openoffice.org/issues/show_bug.cgi?id=23394 23394]
| sw.XMLContentImporter::com::sun::star::xml::sax::XDocumentHandler
| rowspan="3" | Implementation
| rowspan="3" |
|-
| sw.XMLMetaImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| sw.XMLMetaImporter::com::sun::star::xml::sax::XDocumentHandler
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23422 23422]
| sw.SwXTextViewCursor::com::sun::star::beans::XMultiPropertyStates
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23623 23623]
| sw.SwXStyleFamily::com::sun::star::container::XNameReplace
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85583 85583]
| sw.PageStyle::com::sun::star::style::PageProperties
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=25408 25408]
| sw.PageStyle::com::sun::star::style::XStyle
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85584 85584]
| sw.CharacterStyle::com::sun::star::style::CharacterPropertiesAsian
| Test
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=25473 25473]
| sw.ConditionalParagraphStyle::com::sun::star::beans::XMultiPropertyStates
| rowspan="2" | Implementation
| rowspan="2" |
|-
| sw.ParagraphStyle::com::sun::star::beans::XMultiPropertyStates
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=34456 34456]
| sw.SwXTextDocument::com::sun::star::view::XPrintJobBroadcaster
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=37272 37272]
| sw.SwXDrawPage::com::sun::star::drawing::XShapeGrouper
| Test
|

|-
| rowspan="5" | [http://qa.openoffice.org/issues/show_bug.cgi?id=38584 38584]
| sw.SwXParagraph::com::sun::star::beans::XPropertySet
| rowspan="5" | Test
| rowspan="5" |
|-
| sw.SwXTextPortion::com::sun::star::beans::XPropertySet
|-
| sw.SwXTextRange::com::sun::star::beans::XPropertySet
|-
| sw.SwXTextViewCursor::com::sun::star::beans::XPropertySet
|-
| sw.SwXTextCursor::com::sun::star::beans::XPropertySet
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85585 85585]
| sw.SwXTextSection::com::sun::star::text::TextSection
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85586 85586]
| sw.SwAccessibleDocumentView::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=58374 58374]
| sw.DocumentSettings::com::sun::star::document::Settings
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85586 85586]
| sw.SwXAutoTextGroup::com::sun::star::container::XElementAccess
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=72029 72029]
| sw.SwXChapterNumbering::com::sun::star::text::NumberingRules
| Implementation
|

|-
| rowspan="11" | [http://qa.openoffice.org/issues/show_bug.cgi?id=38586 38586]
| sw.SwXParagraph::com::sun::star::style::ParagraphProperties
| rowspan="11" | Test
| rowspan="11" |
|-
| sw.SwXTextPortion::com::sun::star::beans::XPropertySet
|-
| sw.SwXTextCursor::com::sun::star::style::ParagraphProperties
|-
| sw.SwXTextPortion::com::sun::star::style::ParagraphProperties
|-
| sw.SwXTextRange::com::sun::star::style::ParagraphProperties
|-
| sw.SwXTextViewCursor::com::sun::star::style::ParagraphProperties
|-
| sw.ConditionalParagraphStyle::com::sun::star::style::ParagraphProperties
|-
| sw.ParagraphStyle::com::sun::star::style::ParagraphProperties
|-
| sw.SwXCellRange::com::sun::star::style::ParagraphProperties
|-
| sw.SwXTextDefaults::com::sun::star::style::ParagraphProperties
|-
| sw.SwXTextTableCursor::com::sun::star::style::ParagraphProperties
|-

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=85575 85575]
| sw.SwXParagraph::com::sun::star::style::CharacterProperties
| rowspan="2" | Test
| rowspan="2" |
|-
| sw.SwXTextCursor::com::sun::star::style::CharacterProperties
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=77882 77882]
| sw.SwXTextCursor::com::sun::star::document::XDocumentInsertable
| Implementation
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=85595 85595]
| sw.ParagraphStyle::com::sun::star::beans::XMultiPropertySet
| rowspan="2" | Test
| rowspan="2" |
|-
| sw.ParagraphStyle::com::sun::star::beans::XPropertySet
|-

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85596 85596]
| sw.SwXFieldMaster::com::sun::star::text::TextFieldMaster
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85634 85634]
| sw.SwAccessibleTableView
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85635 85635]
| sw.DocumentSettings::com::sun::star::text::PrintPreviewSettings
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85638 85638]
| sw.SwXTextDocument::com::sun::star::frame::XStorable
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=85640 85640]
| sw.SwXMailMerge
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86656 86656]
| sw.SwAccessibleDocumentView::com::sun::star::accessibility::XAccessibleComponent
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=86751 86751]
| sw.SwAccessibleDocumentPageView::com::sun::star::accessibility::XAccessibleEventBroadcaster
| Implementation
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87880 87880]
| sw.SwXTextTable::com::sun::star::table::XAutoFormattable
| Test
|

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=87978 87978]
| sw.DocumentSettings::com::sun::star::beans::XPropertySet
| rowspan="2" | Test
| rowspan="2" |
|-
| sw.ConditionalParagraphStyle::com::sun::star::beans::XPropertySet

|-
| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=88242 88242]
| sw.SwXTextDocument::com::sun::star::view::XPrintable
| rowspan="2" | Test
| rowspan="2" |
|-
| sw.SwXTextDocument::com::sun::star::text::XPagePrintable

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88257 88257]
| sw.SwAccessibleTextGraphicObject::com::sun::star::accessibility::XAccessibleImage
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88262 88262]
| sw.SwAccessibleTextGraphicObject::com::sun::star::accessibility::XAccessibleImage
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88310 88310]
| sw.SwAccessibleTextGraphicObject
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88374 88374]
| sw.SwXTextTable::com::sun::star::table::XAutoFormattable
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88606 88606]
| sw.SwAccessibleTextGraphicObject::com::sun::star::accessibility::XAccessibleContext
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89021 89021]
| sw.SwXTextDefaults
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89022 89022]
| sw.SwAccessiblePageView
| Test
|

|-
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89419 89419]
| sw.SwXTextEmbeddedObject::com::sun::star::text::BaseFrameProperties
| Test
|

|}

UnoAPITest/project/ModuleTests/module/toolkit

2008-05-13T20:09:24Z

Cn: /* Issues */ add issue

UnoAPITest/project/ModuleTests/module/configmgr

2008-05-13T19:55:17Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= configmgr =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| cfgmgr2.LocalSingleBackend::com::sun::star::configuration::backend::XMultiLayerStratum
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84222 84222]
| Test
|

|-
| cfgmgr2.OSetElementGroupUpdateAccess::com::sun::star::container::XChild
| [http://qa.openoffice.org/issues/show_bug.cgi?id=23145 23145]
| Test
|

|-
| cfgmgr2.ConfigurationProvider::com::sun::star::lang::XComponent
| [http://qa.openoffice.org/issues/show_bug.cgi?id=38211 38211]
| Test
|

|-
| sysmgr1.SystemIntegration::com::sun::star::configuration::backend::XBackend
| [http://qa.openoffice.org/issues/show_bug.cgi?id=83874 83874]
| Test
|

|-
| cfgmgr2.ORootElementValueSetUpdateAccess::com::sun::star::container::XNameReplace
| [http://qa.openoffice.org/issues/show_bug.cgi?id=83880 83880]
| Test
|

|-
| cfgmgr2.OInnerValueSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=83881 83881]
| Test
|

|-
| cfgmgr2.ORootElementValueSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=83882 83882]
| Test
|

|-
| cfgmgr2.BootstrapContext
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46913 46913]
| Test
|

|-
| cfgmgr2.OInnerTreeSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46185 46185]
| Implementation
|

|-
| cfgmgr2.ORootElementTreeSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46185 46185]
| Implementation
|

|-
| cfgmgr2.OSetElementTreeSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=46185 46185]
| Implementation
|

|-
| cfgmgr2.OSetElementValueSetUpdateAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=84221 84221]
| Implementation
|

|-
| cfgmgr2.LayerParser
| [http://qa.openoffice.org/issues/show_bug.cgi?id=87744 87744]
| Test
|

|-
| cfgmgr2.OInnerValueSetUpdateAccess::com::sun::star::container::XHierarchicalNameAccess
| rowspan=2 | [http://qa.openoffice.org/issues/show_bug.cgi?id=88358 88358 ]
| rowspan=2 | Test
| rowspan=2 |
|-
|cfgmgr2.OInnerValueSetUpdateAccess::com::sun::star::beans::XExactName

|-
| cfgmgr2.ORootElementValueSetUpdateAccess::com::sun::star::util::XChangesBatch
| [http://qa.openoffice.org/issues/show_bug.cgi?id=88360 88360]
| Test
|

|-
| cfgmgr2.OInnerValueSetUpdateAccess::com::sun::star::container::XElementAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89412 89412]
| Test
|

|-
| cfgmgr2.ORootElementValueSetUpdateAccess::com::sun::star::container::XHierarchicalNameAccess
| [http://qa.openoffice.org/issues/show_bug.cgi?id=89413 89413]
| Test
|

|}

UnoAPITest/project/ModuleTests/module/xmloff

2008-05-13T19:43:51Z

Cn: /* Issues */ add issue

<noinclude>[[Category:UnoAPITest/project/ModuleTests/module]] </noinclude>
= xmloff =
===Status===
Issues complete

===Issues===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #cccccc solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Issue'''</center>
| bgcolor="#cccccc" |<center>'''Implementation'''</center>
| bgcolor="#cccccc" |<center>'''Kind'''</center>
| bgcolor="#cccccc" |<center>'''Fixed'''</center>

|-
| rowspan="10" | [http://qa.openoffice.org/issues/show_bug.cgi?id=23394 23394]
| xmloff.Chart.XMLContentImporter::com::sun::star::xml::sax::XDocumentHandler
| rowspan="10" | Implementation
| rowspan="10" |
|-
| xmloff.Chart.XMLImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Draw.XMLContentImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Draw.XMLImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Draw.XMLMetaImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Draw.XMLStylesImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Impress.XMLContentImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Impress.XMLImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Impress.XMLMetaImporter::com::sun::star::xml::sax::XDocumentHandler
|-
| xmloff.Impress.XMLStylesImporter::com::sun::star::xml::sax::XDocumentHandler
|-

| rowspan="8" | [http://qa.openoffice.org/issues/show_bug.cgi?id=86555 86555]
| xmloff.Chart.XMLExporter::com::sun::star::document::XFilter
| rowspan="8" | Implementation
| rowspan="8" |
|-
| xmloff.Chart.XMLContentExporter::com::sun::star::document::XFilter
|-
| xmloff.Impress.XMLSettingsExporter::com::sun::star::document::XFilter
|-
| xmloff.Impress.XMLImporter::com::sun::star::document::XFilter
|-
| xmloff.Impress.XMLMetaExporter::com::sun::star::document::XFilter
|-
| xmloff.Draw.XMLContentExporter::com::sun::star::document::XFilter
|-
| xmloff.Draw.XMLMetaExporter::com::sun::star::document::XFilter
|-
| xmloff.Draw.XMLSettingsImporter::com::sun::star::document::XFilter

| rowspan="2" | [http://qa.openoffice.org/issues/show_bug.cgi?id=87695 87695]
| xmloff.Draw.XMLStylesExporter
| rowspan="2" | Implementation
| rowspan="2" |
|-
| xmloff.Impress.XMLSettingsExporter
|-

|}

UnoAPITest/project/ModuleTests/module/svx

2008-05-13T19:41:58Z

Cn: /* Issues */ add issue

UnoAPITest/project/ModuleTests/module/sc

2008-05-13T19:38:30Z

Cn: /* Issues */ add issue

Cwscheckapi

2008-05-13T09:32:53Z

Cn: small changes

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== Test the modules ===
After a successful packaging the [[checkapi|runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s will be executed.
=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the '''logfile''' in an editor you like (note that the logfile could be up to '''10MB'''!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
The string '''checkModule(toolkit)''' you will find at the beginning and at the end of the test for toolit. Go to the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonControl'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code for XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-05-13T09:27:10Z

Cn: /* What has failed? */ two ways to go

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== Test the modules ===
After a successful packaging the [[runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s will be executed.
=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the logfile in an editor you like (note that the logfile could be up to 10MB!) and search for the string:
checkModule(toolkit)

Now you have to ways to go:
* follow the steps described in [[UnoAPITest]]
* follow the following steps:
This string you will find at the beginning and at the end of the test for toolit. Find the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonContro'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code in XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

UnoAPITest

2008-05-13T09:24:30Z

Cn: /* Parameter to the testrun */ be more specific

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=pipe,name=$USER;urp;" & # Unix
soffice "-accept=pipemname=%USERNAME%;urp;" # Windows
Note: Since [[cwscheckapi|CwsCheckAPI]] is available the connection via socket is not the default anymore.
DEPRECATED: "-accept=socket,host=0,port=8100;urp;"

The call dmake in your module:
cd $MODULE/qa/unoapi
dmake

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

<tt><pre><nowiki>
***** 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
</nowiki></pre></tt>
----

=== Explanations of the test result ===
**** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK
While running the [[UnoApiTest]] of ''<nowiki>svtools.AccessibleTreeListBoxEntry</nowiki>'' 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 ''<nowiki>svtools.AccessibleTabBar</nowiki>'' 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:
<nowiki>checkapi -o svtools.AccessibleTabBar</nowiki>
This shows you all failures in the test. If you like to run the test with the knownissues.xcl try this:
<nowiki>checkapi -o svtools.AccessibleTabBar -xcl $MODULE/qa/unoapi/knownissues.xcl</nowiki>

----

=== Parameter to the testrun ===
It is possible to use [[CheckAPI#Command_line_parameter|command line parameter]] in the UnoApiTest. You can also change some default parameter in the [[RunnerProps]] file.

[[Category:API]]
[[Category:UnoAPITest]]

UnoAPITest

2008-05-13T09:19:34Z

Cn: /* How to run the tests */ some corrections

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=pipe,name=$USER;urp;" & # Unix
soffice "-accept=pipemname=%USERNAME%;urp;" # Windows
Note: Since [[cwscheckapi|CwsCheckAPI]] is available the connection via socket is not the default anymore.
DEPRECATED: "-accept=socket,host=0,port=8100;urp;"

The call dmake in your module:
cd $MODULE/qa/unoapi
dmake

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

<tt><pre><nowiki>
***** 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
</nowiki></pre></tt>
----

=== Explanations of the test result ===
**** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK
While running the [[UnoApiTest]] of ''<nowiki>svtools.AccessibleTreeListBoxEntry</nowiki>'' 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 ''<nowiki>svtools.AccessibleTabBar</nowiki>'' 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:
<nowiki>checkapi -o svtools.AccessibleTabBar</nowiki>
This shows you all failures in the test. If you like to run the test with the knownissues.xcl try this:
<nowiki>checkapi -o svtools.AccessibleTabBar -xcl $MODULE/qa/unoapi/knownissues.xcl</nowiki>

----

=== 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.

[[Category:API]]
[[Category:UnoAPITest]]

UnoAPITest

2008-05-13T09:14:32Z

Cn: /* What should I do with ''unkown error'' ? */ add path to knownissues.xcl

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=pipe,name=$USER;urp;" & # Unix
soffice "-accept=pipemname=%USERNAME%;urp;" # Windows
cd $MODULE/qa/unoapi
dmake

Since [[cwscheckapi|CwsCheckAPI]] is available the connection via socket is not the default anymore.
DEPRECATED ./soffice "-accept=socket,host=0,port=8100;urp;"&

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:

<tt><pre><nowiki>
***** 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
</nowiki></pre></tt>
----

=== Explanations of the test result ===
**** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK
While running the [[UnoApiTest]] of ''<nowiki>svtools.AccessibleTreeListBoxEntry</nowiki>'' 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 ''<nowiki>svtools.AccessibleTabBar</nowiki>'' 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:
<nowiki>checkapi -o svtools.AccessibleTabBar</nowiki>
This shows you all failures in the test. If you like to run the test with the knownissues.xcl try this:
<nowiki>checkapi -o svtools.AccessibleTabBar -xcl $MODULE/qa/unoapi/knownissues.xcl</nowiki>

----

=== 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.

[[Category:API]]
[[Category:UnoAPITest]]

Cwscheckapi

2008-05-13T09:05:54Z

Cn: /* What has failed? */ some corrections

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== Test the modules ===
After a successful packaging the [[runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s will be executed.
=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the logfile in an editor you like (note that the logfile could be up to 10MB!) and search for the string:
checkModule(toolkit)
This string you will find at the beginning and at the end of the test for toolit. Find the second match and you will see something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backup' -> 'E:\temp\$USER\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished '''checkModule(toolkit)'''
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. Now find the lines which matches '''toolkit.UnoSpinButtonContro'''.
LOG> out > Creating: '''toolkit.UnoSpinButtonControl'''
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code in XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-05-13T08:59:02Z

Cn: /* Test is finished */ add "Test failed" informations

'''D R A F T'''

To avoid regressions in the UnoAPI '''CwsCheckApi''' must be executed as a step before '''readyForQA'''.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl'' with the issue information.
*run the '''cwscheckapi''' script again. The result '''must''' PASSED.OK
==== approve an Exception ====
If you think you need an exception you have to inform your QA representative and your manager. An exception could break in the UnoAPI! But it also possible that the test itself needs an update.

==CwsCheckApi==
cwscheckapi is an commandline script. You will find it here:
$SRC_ROOT/solenv/bin/cwscheckapi[.btm]
It is similar to [[checkapi]] but it runs [[UnoAPITest]]s.
=== Office installation ===
At first we need an Office to test. Therefore an Office need to be installed. While Windows 2003 Terminal-Server makes trouble on installing an Office without user interaction, the cwscheckapi goes a different way. It pack (dmake PKGFORMAT=installed) a runnable office. You will think this not a correct installed office? You are right. The cwscheckapi should not test the installer, it should only test the UnoAPI. The Office will be installed here:
$TMP/$USERNAME/cwscheckapi/
=== Test the modules ===
After a successful packaging the [[runner]], which is the main application here, starts a query to [[EIS]] for all added modules to the CWS. If a module contains
$MODULE/qa/unoapi
all [[UnoAPITest]]s will be executed.
=== Test is finished ===
At the end of the test run you will get a test result. This should look like this:
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
LOG> ********** end test *************
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
Whole unit: PASSED.OK
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) done

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
Dienstag, 6. Mai 2008 12:09 Uhr CEST

==== Test is OK ====
Your cws get an attachment in [[EIS]] which look like this:
/var/tmp/UnoApiCwsStatuscws_$CWS_unxsoli.PASSED.OK.txt
All is OK :-)
==== Test is FAILED ====
***** State for complex.unoapi.CheckModuleAPI ******
'''checkModule(toolkit) - module failed'''

Whole unit: PASSED.FAILED
****************************************************
LOG> ********** end test *************
LOG> CheckModuleAPI.module(auto) PASSED.FAILED
LOG> Finished module(auto)
***** State for complex.unoapi.CheckModuleAPI ******
module(auto) - CheckModuleAPI.module(auto) PASSED.FAILED

Whole unit: PASSED.FAILED
****************************************************
Job -o complex.unoapi.CheckModuleAPI::module(auto) failed

A logfile could be found here: /tmp/$USERNAME/cwscheckapi/cwscheckapi.log
===== What has failed? =====
As you can see the module toolkit has failed. Open the logfile in an editor you like (not that the logfile could be up to 10MB!) and search for the string
checkModule(toolkit)
This string you will find at the beginning of the test for toolit and at the end. Above the second match you will find something like this:
LOG> out > Failures that appeared during scenario execution:
LOG> out > '''toolkit.UnoSpinButtonControl'''
LOG> out > 1 of 55 tests failed
LOG> out > Job -sce toolkit.sce done
LOG> out > endlocal
LOG> out > quit
LOG> out > =======================================================================
LOG> out > In case you noticed a failures of toolkit.AccessibleToolBoxItem make sure that the object bar is configured as text and not as icons
LOG> out > =======================================================================
LOG> [08.05.2008 - 22:41:15]PH:runCommand: waiting 76 seconds while command execution is ongoing... 9
LOG> [08.05.2008 - 22:42:31]PH:runCommand Could not detect changes in output stream!!!
LOG> [08.05.2008 - 22:42:31]PH:runCommand Process ist not finished but there are no changes in output stream.
LOG> [08.05.2008 - 22:42:36]PH:kill: process closed with exit code 0
LOG> verify output...
LOG> mached line: 1 of 55 tests failed
LOG> Module passed FAILED
LOG> ERROR: could not find '0 of [0-9]+? tests failed' in output
LOG> module failed
LOG> kill existing office...
[08.05.2008 - 22:42:37] try to get ProcessHandler
[08.05.2008 - 22:42:37] ProcessHandler != null
[08.05.2008 - 22:42:37] Trying to terminate the desktop
[08.05.2008 - 22:42:37] Desktop terminated
[08.05.2008 - 22:42:37] the Office has 15 seconds for closing...
[08.05.2008 - 22:42:52] OfficeProvider: User defined an application to destroy the started process.
Trying to execute: Z:\so-cwsserv02\qadev32\DEV300\wntmsci11.pro\bin.m8\kill.exe -9 soffice.bin
[08.05.2008 - 22:43:05] copy 'e:\temp\user_backupcn93815' -> 'E:\temp\cn93815\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\'
[08.05.2008 - 22:43:06] copy 'e:\temp\user_backupcn93815' -> 'E:\temp\cn93815\cwscheckapi\office\Sun\StarOffice 9\StarOffice9\user\' finished
[08.05.2008 - 22:43:06] try to get OfficeWatcher
[08.05.2008 - 22:43:06] OfficeWatcher finished
LOG> Finished checkModule(toolkit)
Here you can see that the UnoAPI-Test for '''toolkit.UnoSpinButtonControl''' has failed. You can search
LOG> out > Creating: toolkit.UnoSpinButtonControl
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state FAILED
LOG> out > LOG> addAdjustmentListener(): PASSED.FAILED
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() failed
LOG> out > LOG> removeAdjustmentListener(): PASSED.FAILED
LOG> out > LOG> Execute: setValue()LOG> out > Creating: toolkit.UnoSpinButtonControl
LOG> out > LOG> Log started 08.04.2008 - 22:40:49
LOG> out > LOG> creating a textdocument
LOG> out > LOG> creating a new environment for UnoControlSpinButton object
LOG> out > ImplementationName: com.sun.star.comp.toolkit.UnoSpinButtonControl
LOG> out > Environment created
LOG> out > UnoSpinButtonControl recreated
LOG> out > running: 'ifc.awt._XSpinValue'
LOG> out > LOG> Log started 08.04.2008 - 22:40:50
LOG> out > checking : _XSpinValue
LOG> out > LOG> Execute: addAdjustmentListener()
LOG> out > Method addAdjustmentListener() finished with state '''FAILED'''
LOG> out > LOG> addAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: removeAdjustmentListener()
LOG> out > LOG> starting required method: addAdjustmentListener()
LOG> out > LOG> ! Required method addAdjustmentListener() '''failed'''
LOG> out > LOG> removeAdjustmentListener(): '''PASSED.FAILED'''
LOG> out > LOG> Execute: setValue()
Now you have to fix the issue in your code in XSpinValue. If this is currently not possible you have to follow the [[Cwscheckapi#Exception_treatment|Exception treatment]].
Further details about the UnoAPI-Test status you can get at the [[UnoAPITest]]s site.

[[Category:API]]
[[Category:UnoAPITest]]
[[Category:cws]]

Cwscheckapi

2008-05-06T11:14:44Z

Cn: change uotput log

Cwscheckapi

2008-05-05T20:35:25Z

Cn: spelling

Checkapi

2008-05-05T20:27:32Z

Cn: /* Howto */ change connection string from socket to named pipes

The CheckApi script is a simple script to run the UnoApiTest""s inside a solar shell for one ImplementaionObject with one or more interface tests. The CheckApi is based on the runner (see http://qa.openoffice.org/qadevOOo_doc/index.html)

=== Howto ===
At first you have to run a connectable office. This could be done by:
./soffice "-accept=pipe,name=$USER;urp;" & # Unix
soffice "-accept=pipemname=%USERNAME%;urp;" # Windows

Since [[cwscheckapi|CwsCheckApi]] is available the connection via socket is not the default anymore.
DEPRECATED ./soffice "-accept=socket,host=0,port=8100;urp;"

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:

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.

Now you can start CheckApi with an object as argument to test :
checkapi -o <nowiki>sw.SwXBodyText</nowiki>
The ''runner'', which is called inside of the CheckApi, connects to the office and executes the UnoApiTest for the ImplementaionObject <nowiki>sw.SwXBodyText</nowiki>. Since CheckApi knows all interfaces of the ImplementationObject all correspond interface tests will be executed. At the end of such a test you will get a result of the test run.
<tt><pre><nowiki>
***** State for sw.SwXBodyText ******
Whole component: PASSED.OK
*************************************
Job -o sw.SwXBodyText done
</nowiki></pre></tt>
----

=== Examples ===
;<tt><nowiki>checkapi -o sw.SwXBodyText</nowiki></tt>:checks all interfaces on the ImplementationObject ''<nowiki>sw.SwXBodyText</nowiki>''

;<tt><nowiki>checkapi -o sw.SwXBodyText::com::sun::star::text::XText</nowiki></tt>:checks the interface ''<nowiki>com::sun::star::text::XText</nowiki>'' on the ImplementationObject ''<nowiki>sw.SwXBodyText</nowiki>''

;<tt><nowiki>checkapi -o sw.SwXBodyText::com::sun::star::text::XText,com::sun::star::text::XTextRange</nowiki></tt>:checks the interface ''<nowiki>com::sun::star::text::XText</nowiki>'' and the inteface ''<nowiki>com::sun::star::text::XTextRange</nowiki>'' on the ImplementationObject ''<nowiki>sw.SwXBodyText</nowiki>''

;<tt><nowiki>checkapi -o sw.SwXBodyText::com::sun::star::text::Text -log true</nowiki></tt>:checks all properties of the service ''<nowiki>com::sun::star::text::Text</nowiki>'' on the ImplementationObject ''<nowiki>sw.SwXBodyText</nowiki>'' with enhanced output.

;<tt>checkapi -p fwk</tt>:checks the module ''fwk'' with all its ImplementationObject's.

;<tt><nowiki>checkapi -sce myScenarioFile</nowiki></tt>:checks all objects and projects which described in the ScenarioFile.

-----

=== Parameter ===

To control the CheckApi you can use the RunnerProps file or some command line parameter.

The priority of the parameters are:
# command line parameter
# [[RunnerProps]] parameter
# defaults

-----

=== Command line parameter ===
;-log true: enhance the logging output
;-debug true: enabled the debugging mode: enhancing of output
;-p ''Project'':one complete project
;-sce ''[[ScenarioFile]]'':all jobs which are contained in the ScenarioFile
;-o ''Test-Object'':the ImplementationObject which should be tested
;-tdoc ''Test-Document-Path'':path where testdocuments could be found
;-<nowiki>AutoRestart true</nowiki>:forces to restart the office if one test crashes the office. Useful in [[ScenarioFile]]
;-<nowiki>KeepDocument</nowiki>:the tests normally close the documents which opened for testing purposes. If this flag is set to ''true'' all documents are available at the end of the test.
;-ini ''[[RunnerProps]]'': path to property file for CheckAPI. Default: $HOME/.runner.props

[[Category:Quality Assurance]]
[[Category:UNO-API]]

UnoAPITest

2008-05-05T20:24:45Z

Cn: /* How to run the tests */ change connection string from socket to named pipes

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=pipe,name=$USER;urp;" & # Unix
soffice "-accept=pipemname=%USERNAME%;urp;" # Windows
cd $MODULE/qa/unoapi
dmake

Since [[cwscheckapi|CwsCheckAPI]] is available the connection via socket is not the default anymore.
DEPRECATED ./soffice "-accept=socket,host=0,port=8100;urp;"&

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:

<tt><pre><nowiki>
***** 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
</nowiki></pre></tt>
----

=== Explanations of the test result ===
**** State for svtools.AccessibleTreeListBoxEntry ******
Whole component: PASSED(with known issues).OK
While running the [[UnoApiTest]] of ''<nowiki>svtools.AccessibleTreeListBoxEntry</nowiki>'' 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 ''<nowiki>svtools.AccessibleTabBar</nowiki>'' 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:
<nowiki>checkapi -o svtools.AccessibleTabBar</nowiki>
This shows you all failures in the test. If you like to run the test with the knownissues.xcl try this:
<nowiki>checkapi -o svtools.AccessibleTabBar -xcl knownissues.xcl</nowiki>

----

=== 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.

[[Category:API]]
[[Category:UnoAPITest]]

Cwscheckapi

2008-05-05T20:12:09Z

Cn: add content

Cwscheckapi

2008-05-05T18:42:12Z

Cn: draft

'''D R A F T'''

To avoid regressions in the UnoAPI [[Cwscheckapi|CwsCheckApi]] must be executed as final step on cws handling.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl''
==== Exception handling ====

[[Category:API]]
[[Category:UnoAPITest]]

Cwscheckapi

2008-05-05T18:41:31Z

Cn: add content

To avoid regressions in the UnoAPI [[Cwscheckapi|CwsCheckApi]] must be executed as final step on cws handling.

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and/or ''knownissues.xcl''
==== Exception handling ====

[[Category:API]]
[[Category:UnoAPITest]]

Cwscheckapi

2008-05-05T14:38:24Z

Cn: initla version

To avoid regressions in the UnoAPI [[cwscheckapi|CwsCheckApi]] must be executed as final step on cws handling

UnoAPITest/project/cwsTests

2008-05-05T14:34:45Z

Cn: /* CWS is ready */

This project accompanied the way of [[UnoAPITest]]s to be mandatory [[CWS]] tests.

== Project description ==
The goal of the project is to set up a mechanism to find regression in the API on a cws. This should be done by run the [[UnoAPITest]]s on added modules to a cws. In mostly all modules which support [[UnoApi|UnoAPI]] exist a qa/unoapi folder. This folder contains a make file which starts the [[UnoAPITest]]s related to this module.

To make it easy a simple script, f.e [[cwscheckapi]] (in coherence to [[checkapi]]) should do this job.

== Project Plan ==
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Task'''</center>
| bgcolor="#cccccc" |<center>'''Status'''</center>
| bgcolor="#cccccc" |<center>'''Milestone'''</center>

|-
| develop concept and identify needing tools
| bgcolor="#00ff00" | done
| bgcolor="#00c0ff" | M1

|-
| bgcolor="#e8e8e8" | basic console script checkcws
| bgcolor="#00ff00" | done
| bgcolor="#c0c0ff" | M2

|-
| query EIS for added modules
| bgcolor="#00ff00" | done
| bgcolor="#ffc0ff" | M3

|-
| bgcolor="#e8e8e8" | automatic Office installation
| bgcolor="#00ff00" | done
| bgcolor="#ffc0c0" | M4

|-
| deliver status to EIS
| bgcolor="#00ff00" | done
| bgcolor="#c0ffc0" | M5

|-
| bgcolor="#e8e8e8" | Bugfixing
| bgcolor="#00ff00" | started
| bgcolor="#ffffc0" | M6

|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |'''Milestone'''
| bgcolor="#cccccc" |'''Due'''

|-
| bgcolor="#00c0ff" | M1
| End of Dec. 07

|-
| bgcolor="#c0c0ff" | M2
| bgcolor="#e8e8e8" | Mid of Jan. 08

|-
| bgcolor="#ffc0ff" | M3
| End of Jan. 08

|-
| bgcolor="#ffc0c0" | M4
| bgcolor="#e8e8e8" | Mid of Feb. 08

|-
| bgcolor="#c0ffc0" | M5
| End of Feb. 08

|-
| bgcolor="#ffffc0" | M6
| bgcolor="#e8e8e8" | End of Mar. 08

|}

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[cwscheckapi]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and ''knownissues.xcl''
==== Exception handling ====
TODO

==CwsCheckApi==
cwscheckapi is an commandline script similar to [[checkapi]]. The runner query [[EIS]] for all added modules relayed to the CWS and execute the tests.

Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85368 85368]

=== Command line parameter ===
;-m ''Module''[,''Module'']: add the given modules to the test
;-log true: enhance the logging output
;-debug true: enabled the debugging mode: enhancing of output
;-tdoc ''Test-Document-Path'':path where testdocuments could be found
;-<nowiki>KeepDocument</nowiki>:the tests normally close the documents which opened for testing purposes. If this flag is set to ''true'' all documents are available at the end of the test.
;-ini ''[[RunnerProps]]'': path to property file for CheckAPI. Default: $HOME/.runner.props

=== Notes ===
* only pro versions
* named pipes for connecting the office with pro+platform
* add solenv to a cws and commit checkws in solenv/bin

== Automatic Office installation ==
=== Notes ===
* As the [[SmokeTest]] the [[cwscheckapi]] should be able to install the office automatically.
** the smoke test has no separate installation routine. It's much easier to install the office via UserlandScripts.
* $SOURCE_ROOT could be the setup root entry
* $SHIPDRIVE indicates the path to the seups of a master office
* $CWS_WORKSTAMP indicates a cws envirnment
* $SOL_TMP indicates a local environment
* support of local environments

=== Install-Sets ===
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
|+ '''find install sets'''
| bgcolor="#cccccc" |<center>'''Platform'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris Sparc'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris x86'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Linux'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Windows'''</center>

|-
| bgcolor="#cccccc" |<center>'''Language'''</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>

|-
| bgcolor="#cccccc" |<center>'''Office-Version'''</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>

|-
| rowspan="2" | setsolar
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | setcws
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" | ooO-Env.Set
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | local env.
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|}

=== Userland-Scripts ===
;setsolar: $SHIPDRIVE/$INPATH/UserScripts/$PKGFORMAT/{OfficeVersion}/install
;setcws: $SOLARVERSION/$INPATH/bin$$UPDMINOREXT/userscripts/install

== [[EIS]] ==
* communication via SOAP
** implementation in Java is not useful. Too many dependencies.
** best way is to call Perl scripts like [[cwsquery]] and pase the output
*** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85370 85370]
* the EIS should display test runs
** currently some tests attach result files to the CWS, f.e. PerformanceTests
** the EIS should have a extra data base for CWS tests
*** therefore EIS needs a new Interface -> [[User:bei]]
**** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85505 85505]
** the EIS should display successfully executed tests with a green bullet
** the EIS should support the possibility to set the "OK" status manual. See [[#runner]]

== runner ==
=== first step ===
The developer at Sun/StarOffice have some privileges that other don't have. This is f.e. an easier access to EIS.
* SOAP-Interface needet
** SOAP has too many dependencies. So cwsquery will be used.
* runner: change default connection string from socket to named pipes if possible
* complex Test complex.unoapi.CheckModuleAPI must be stabilized

=== second step ===
The SOAP-Interface of EIS needs https connections.
* implement https for community developer
* implement user/password login into EIS

[[Category:UnoAPITest/project]]
[[Category:API]]
[[Category:UnoAPITest]]
[[Category:CWS]]

UnoAPITest/project/cwsTests

2008-05-05T14:33:56Z

Cn: /* Notes */

This project accompanied the way of [[UnoAPITest]]s to be mandatory [[CWS]] tests.

== Project description ==
The goal of the project is to set up a mechanism to find regression in the API on a cws. This should be done by run the [[UnoAPITest]]s on added modules to a cws. In mostly all modules which support [[UnoApi|UnoAPI]] exist a qa/unoapi folder. This folder contains a make file which starts the [[UnoAPITest]]s related to this module.

To make it easy a simple script, f.e [[cwscheckapi]] (in coherence to [[checkapi]]) should do this job.

== Project Plan ==
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Task'''</center>
| bgcolor="#cccccc" |<center>'''Status'''</center>
| bgcolor="#cccccc" |<center>'''Milestone'''</center>

|-
| develop concept and identify needing tools
| bgcolor="#00ff00" | done
| bgcolor="#00c0ff" | M1

|-
| bgcolor="#e8e8e8" | basic console script checkcws
| bgcolor="#00ff00" | done
| bgcolor="#c0c0ff" | M2

|-
| query EIS for added modules
| bgcolor="#00ff00" | done
| bgcolor="#ffc0ff" | M3

|-
| bgcolor="#e8e8e8" | automatic Office installation
| bgcolor="#00ff00" | done
| bgcolor="#ffc0c0" | M4

|-
| deliver status to EIS
| bgcolor="#00ff00" | done
| bgcolor="#c0ffc0" | M5

|-
| bgcolor="#e8e8e8" | Bugfixing
| bgcolor="#00ff00" | started
| bgcolor="#ffffc0" | M6

|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |'''Milestone'''
| bgcolor="#cccccc" |'''Due'''

|-
| bgcolor="#00c0ff" | M1
| End of Dec. 07

|-
| bgcolor="#c0c0ff" | M2
| bgcolor="#e8e8e8" | Mid of Jan. 08

|-
| bgcolor="#ffc0ff" | M3
| End of Jan. 08

|-
| bgcolor="#ffc0c0" | M4
| bgcolor="#e8e8e8" | Mid of Feb. 08

|-
| bgcolor="#c0ffc0" | M5
| End of Feb. 08

|-
| bgcolor="#ffffc0" | M6
| bgcolor="#e8e8e8" | End of Mar. 08

|}

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[checkcws]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and ''knownissues.xcl''
==== Exception handling ====
TODO

==CwsCheckApi==
cwscheckapi is an commandline script similar to [[checkapi]]. The runner query [[EIS]] for all added modules relayed to the CWS and execute the tests.

Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85368 85368]

=== Command line parameter ===
;-m ''Module''[,''Module'']: add the given modules to the test
;-log true: enhance the logging output
;-debug true: enabled the debugging mode: enhancing of output
;-tdoc ''Test-Document-Path'':path where testdocuments could be found
;-<nowiki>KeepDocument</nowiki>:the tests normally close the documents which opened for testing purposes. If this flag is set to ''true'' all documents are available at the end of the test.
;-ini ''[[RunnerProps]]'': path to property file for CheckAPI. Default: $HOME/.runner.props

=== Notes ===
* only pro versions
* named pipes for connecting the office with pro+platform
* add solenv to a cws and commit checkws in solenv/bin

== Automatic Office installation ==
=== Notes ===
* As the [[SmokeTest]] the [[cwscheckapi]] should be able to install the office automatically.
** the smoke test has no separate installation routine. It's much easier to install the office via UserlandScripts.
* $SOURCE_ROOT could be the setup root entry
* $SHIPDRIVE indicates the path to the seups of a master office
* $CWS_WORKSTAMP indicates a cws envirnment
* $SOL_TMP indicates a local environment
* support of local environments

=== Install-Sets ===
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
|+ '''find install sets'''
| bgcolor="#cccccc" |<center>'''Platform'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris Sparc'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris x86'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Linux'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Windows'''</center>

|-
| bgcolor="#cccccc" |<center>'''Language'''</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>

|-
| bgcolor="#cccccc" |<center>'''Office-Version'''</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>

|-
| rowspan="2" | setsolar
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | setcws
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" | ooO-Env.Set
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | local env.
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|}

=== Userland-Scripts ===
;setsolar: $SHIPDRIVE/$INPATH/UserScripts/$PKGFORMAT/{OfficeVersion}/install
;setcws: $SOLARVERSION/$INPATH/bin$$UPDMINOREXT/userscripts/install

== [[EIS]] ==
* communication via SOAP
** implementation in Java is not useful. Too many dependencies.
** best way is to call Perl scripts like [[cwsquery]] and pase the output
*** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85370 85370]
* the EIS should display test runs
** currently some tests attach result files to the CWS, f.e. PerformanceTests
** the EIS should have a extra data base for CWS tests
*** therefore EIS needs a new Interface -> [[User:bei]]
**** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85505 85505]
** the EIS should display successfully executed tests with a green bullet
** the EIS should support the possibility to set the "OK" status manual. See [[#runner]]

== runner ==
=== first step ===
The developer at Sun/StarOffice have some privileges that other don't have. This is f.e. an easier access to EIS.
* SOAP-Interface needet
** SOAP has too many dependencies. So cwsquery will be used.
* runner: change default connection string from socket to named pipes if possible
* complex Test complex.unoapi.CheckModuleAPI must be stabilized

=== second step ===
The SOAP-Interface of EIS needs https connections.
* implement https for community developer
* implement user/password login into EIS

[[Category:UnoAPITest/project]]
[[Category:API]]
[[Category:UnoAPITest]]
[[Category:CWS]]

UnoAPITest/project/cwsTests

2008-05-05T14:33:15Z

Cn: /* checkcws */

This project accompanied the way of [[UnoAPITest]]s to be mandatory [[CWS]] tests.

== Project description ==
The goal of the project is to set up a mechanism to find regression in the API on a cws. This should be done by run the [[UnoAPITest]]s on added modules to a cws. In mostly all modules which support [[UnoApi|UnoAPI]] exist a qa/unoapi folder. This folder contains a make file which starts the [[UnoAPITest]]s related to this module.

To make it easy a simple script, f.e [[cwscheckapi]] (in coherence to [[checkapi]]) should do this job.

== Project Plan ==
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Task'''</center>
| bgcolor="#cccccc" |<center>'''Status'''</center>
| bgcolor="#cccccc" |<center>'''Milestone'''</center>

|-
| develop concept and identify needing tools
| bgcolor="#00ff00" | done
| bgcolor="#00c0ff" | M1

|-
| bgcolor="#e8e8e8" | basic console script checkcws
| bgcolor="#00ff00" | done
| bgcolor="#c0c0ff" | M2

|-
| query EIS for added modules
| bgcolor="#00ff00" | done
| bgcolor="#ffc0ff" | M3

|-
| bgcolor="#e8e8e8" | automatic Office installation
| bgcolor="#00ff00" | done
| bgcolor="#ffc0c0" | M4

|-
| deliver status to EIS
| bgcolor="#00ff00" | done
| bgcolor="#c0ffc0" | M5

|-
| bgcolor="#e8e8e8" | Bugfixing
| bgcolor="#00ff00" | started
| bgcolor="#ffffc0" | M6

|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |'''Milestone'''
| bgcolor="#cccccc" |'''Due'''

|-
| bgcolor="#00c0ff" | M1
| End of Dec. 07

|-
| bgcolor="#c0c0ff" | M2
| bgcolor="#e8e8e8" | Mid of Jan. 08

|-
| bgcolor="#ffc0ff" | M3
| End of Jan. 08

|-
| bgcolor="#ffc0c0" | M4
| bgcolor="#e8e8e8" | Mid of Feb. 08

|-
| bgcolor="#c0ffc0" | M5
| End of Feb. 08

|-
| bgcolor="#ffffc0" | M6
| bgcolor="#e8e8e8" | End of Mar. 08

|}

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[checkcws]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and ''knownissues.xcl''
==== Exception handling ====
TODO

==CwsCheckApi==
cwscheckapi is an commandline script similar to [[checkapi]]. The runner query [[EIS]] for all added modules relayed to the CWS and execute the tests.

Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85368 85368]

=== Command line parameter ===
;-m ''Module''[,''Module'']: add the given modules to the test
;-log true: enhance the logging output
;-debug true: enabled the debugging mode: enhancing of output
;-tdoc ''Test-Document-Path'':path where testdocuments could be found
;-<nowiki>KeepDocument</nowiki>:the tests normally close the documents which opened for testing purposes. If this flag is set to ''true'' all documents are available at the end of the test.
;-ini ''[[RunnerProps]]'': path to property file for CheckAPI. Default: $HOME/.runner.props

=== Notes ===
* only pro versions
* named pipes for connecting the office with pro+platform
* add solenv to a cws and commit checkws in solenv/bin

== Automatic Office installation ==
=== Notes ===
* As the [[SmokeTest]] the [[checkcws]] should be able to install the office automatically.
** the smoke test has no separate installation routine. It's much easier to install the office via UserlandScripts.
* $SOURCE_ROOT could be the setup root entry
* $SHIPDRIVE indicates the path to the seups of a master office
* $CWS_WORKSTAMP indicates a cws envirnment
* $SOL_TMP indicates a local environment
* support of local environments
=== Install-Sets ===
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
|+ '''find install sets'''
| bgcolor="#cccccc" |<center>'''Platform'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris Sparc'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris x86'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Linux'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Windows'''</center>

|-
| bgcolor="#cccccc" |<center>'''Language'''</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>

|-
| bgcolor="#cccccc" |<center>'''Office-Version'''</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>

|-
| rowspan="2" | setsolar
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | setcws
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" | ooO-Env.Set
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | local env.
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|}

=== Userland-Scripts ===
;setsolar: $SHIPDRIVE/$INPATH/UserScripts/$PKGFORMAT/{OfficeVersion}/install
;setcws: $SOLARVERSION/$INPATH/bin$$UPDMINOREXT/userscripts/install

== [[EIS]] ==
* communication via SOAP
** implementation in Java is not useful. Too many dependencies.
** best way is to call Perl scripts like [[cwsquery]] and pase the output
*** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85370 85370]
* the EIS should display test runs
** currently some tests attach result files to the CWS, f.e. PerformanceTests
** the EIS should have a extra data base for CWS tests
*** therefore EIS needs a new Interface -> [[User:bei]]
**** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85505 85505]
** the EIS should display successfully executed tests with a green bullet
** the EIS should support the possibility to set the "OK" status manual. See [[#runner]]

== runner ==
=== first step ===
The developer at Sun/StarOffice have some privileges that other don't have. This is f.e. an easier access to EIS.
* SOAP-Interface needet
** SOAP has too many dependencies. So cwsquery will be used.
* runner: change default connection string from socket to named pipes if possible
* complex Test complex.unoapi.CheckModuleAPI must be stabilized

=== second step ===
The SOAP-Interface of EIS needs https connections.
* implement https for community developer
* implement user/password login into EIS

[[Category:UnoAPITest/project]]
[[Category:API]]
[[Category:UnoAPITest]]
[[Category:CWS]]

UnoAPITest/project/cwsTests

2008-05-05T14:31:15Z

Cn: /* Project description */

This project accompanied the way of [[UnoAPITest]]s to be mandatory [[CWS]] tests.

== Project description ==
The goal of the project is to set up a mechanism to find regression in the API on a cws. This should be done by run the [[UnoAPITest]]s on added modules to a cws. In mostly all modules which support [[UnoApi|UnoAPI]] exist a qa/unoapi folder. This folder contains a make file which starts the [[UnoAPITest]]s related to this module.

To make it easy a simple script, f.e [[cwscheckapi]] (in coherence to [[checkapi]]) should do this job.

== Project Plan ==
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |<center>'''Task'''</center>
| bgcolor="#cccccc" |<center>'''Status'''</center>
| bgcolor="#cccccc" |<center>'''Milestone'''</center>

|-
| develop concept and identify needing tools
| bgcolor="#00ff00" | done
| bgcolor="#00c0ff" | M1

|-
| bgcolor="#e8e8e8" | basic console script checkcws
| bgcolor="#00ff00" | done
| bgcolor="#c0c0ff" | M2

|-
| query EIS for added modules
| bgcolor="#00ff00" | done
| bgcolor="#ffc0ff" | M3

|-
| bgcolor="#e8e8e8" | automatic Office installation
| bgcolor="#00ff00" | done
| bgcolor="#ffc0c0" | M4

|-
| deliver status to EIS
| bgcolor="#00ff00" | done
| bgcolor="#c0ffc0" | M5

|-
| bgcolor="#e8e8e8" | Bugfixing
| bgcolor="#00ff00" | started
| bgcolor="#ffffc0" | M6

|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
| bgcolor="#cccccc" |'''Milestone'''
| bgcolor="#cccccc" |'''Due'''

|-
| bgcolor="#00c0ff" | M1
| End of Dec. 07

|-
| bgcolor="#c0c0ff" | M2
| bgcolor="#e8e8e8" | Mid of Jan. 08

|-
| bgcolor="#ffc0ff" | M3
| End of Jan. 08

|-
| bgcolor="#ffc0c0" | M4
| bgcolor="#e8e8e8" | Mid of Feb. 08

|-
| bgcolor="#c0ffc0" | M5
| End of Feb. 08

|-
| bgcolor="#ffffc0" | M6
| bgcolor="#e8e8e8" | End of Mar. 08

|}

==Concept of mandatory UnoAPITests for CWS==
[[Image:UnoAPITest CWS flowchart.png|thumb|Flowchart for mandatory UnoAPITests in CWS]]
=== CWS is ready ===

If the CWS is ready the developer has to run [[checkcws]]. checkcws calls an [[UnoAPITest]] for all modules which are added to the cws. If the result is '''FAILED''' the developer has
* to fix the failure inside the implementation
* to get an [[#Exception|exception]]
To get the later one the developer must have good arguments why he/she is not able to fix the implementation.

If the UnoAPITest works fine with state state '''OK''' the CWS could be set '''readyForQA'''

=== Exception treatment ===
If an exception is '''approved''', the developer has to do the following:
*write a new Issue
*update ''$MODULE.sce'' and ''knownissues.xcl''
==== Exception handling ====
TODO

==checkcws==
checkcws is an commandline script similar to [[checkapi]]. The runner query [[EIS]] for all added modules relayed to the CWS and execute the tests.

Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85368 85368]

=== Command line parameter ===
;-m ''Module''[,''Module'']: add the given modules to the test
;-log true: enhance the logging output
;-debug true: enabled the debugging mode: enhancing of output
;-tdoc ''Test-Document-Path'':path where testdocuments could be found
;-<nowiki>KeepDocument</nowiki>:the tests normally close the documents which opened for testing purposes. If this flag is set to ''true'' all documents are available at the end of the test.
;-ini ''[[RunnerProps]]'': path to property file for CheckAPI. Default: $HOME/.runner.props

=== Notes ===
* only pro versions
* named pipes for connecting the office with pro+platform
* add solenv to a cws and commit checkws in solenv/bin

== Automatic Office installation ==
=== Notes ===
* As the [[SmokeTest]] the [[checkcws]] should be able to install the office automatically.
** the smoke test has no separate installation routine. It's much easier to install the office via UserlandScripts.
* $SOURCE_ROOT could be the setup root entry
* $SHIPDRIVE indicates the path to the seups of a master office
* $CWS_WORKSTAMP indicates a cws envirnment
* $SOL_TMP indicates a local environment
* support of local environments
=== Install-Sets ===
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; border: 1px #ffffff solid; border-collapse: collapse;"
|+ '''find install sets'''
| bgcolor="#cccccc" |<center>'''Platform'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris Sparc'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Solaris x86'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Linux'''</center>
| bgcolor="#cccccc" colspan="2" |<center>'''Windows'''</center>

|-
| bgcolor="#cccccc" |<center>'''Language'''</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>
| bgcolor="#00c0ff" |<center>en-US (default)</center>
| bgcolor="#00c0ff" | <center>other</center>

|-
| bgcolor="#cccccc" |<center>'''Office-Version'''</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>
| bgcolor="#80ff80" |<center>StarOffice (default)</center>
| bgcolor="#80ff80" | <center>OpenOffice.org</center>

|-
| rowspan="2" | setsolar
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" | <center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | setcws
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |<center>x</center>
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" | <center>x</center>
| bgcolor="#c0ffc0" |

|-
| rowspan="2" | ooO-Env.Set
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|-
| rowspan="2" bgcolor="#e8e8e8" | local env.
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |
| bgcolor="#81e0ff" |

|-
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |
| bgcolor="#c0ffc0" |

|}

=== Userland-Scripts ===
;setsolar: $SHIPDRIVE/$INPATH/UserScripts/$PKGFORMAT/{OfficeVersion}/install
;setcws: $SOLARVERSION/$INPATH/bin$$UPDMINOREXT/userscripts/install

== [[EIS]] ==
* communication via SOAP
** implementation in Java is not useful. Too many dependencies.
** best way is to call Perl scripts like [[cwsquery]] and pase the output
*** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85370 85370]
* the EIS should display test runs
** currently some tests attach result files to the CWS, f.e. PerformanceTests
** the EIS should have a extra data base for CWS tests
*** therefore EIS needs a new Interface -> [[User:bei]]
**** Issue [http://qa.openoffice.org/issues/show_bug.cgi?id=85505 85505]
** the EIS should display successfully executed tests with a green bullet
** the EIS should support the possibility to set the "OK" status manual. See [[#runner]]

== runner ==
=== first step ===
The developer at Sun/StarOffice have some privileges that other don't have. This is f.e. an easier access to EIS.
* SOAP-Interface needet
** SOAP has too many dependencies. So cwsquery will be used.
* runner: change default connection string from socket to named pipes if possible
* complex Test complex.unoapi.CheckModuleAPI must be stabilized

=== second step ===
The SOAP-Interface of EIS needs https connections.
* implement https for community developer
* implement user/password login into EIS

[[Category:UnoAPITest/project]]
[[Category:API]]
[[Category:UnoAPITest]]
[[Category:CWS]]

UnoAPITest/project/ModuleTests/module/sw

2008-05-05T10:44:27Z

Cn: /* Issues */ add issues