wiki:Testsuites

Managing ODF testsuites

Officeshots supports running ODF testsuites. A testsuite consists of a series of ODF documents that will be processed like regular documents uploaded to Officeshots. Unlike regular documents, a testsuite will be rendered by all applications that volunteer to participate in them. Their jobs will never expire and they will be automatically updated when new applications are added (this is handled by the BackgroundDaemon in a cron job, see also CoreConfiguration).

Adding new testsuites

To add a new test suite, follow the Testsuites link in the menu. At the bottom of the list of existing testsuites there is a link to add a new testsuite. A testsuite consists of three fields:

name
The name of the resu suite.
source
A path to a directory that contains the testsuite source ODF files. This path should be relative to the www/app/files/ directory on the server and it should not end in a trailing slash.
root
A path to a directory where you want to store all the testsuite results. This path should be relative to the www/app/files/ directory on the server and it should not end in a trailing slash.

Importing testsuite documents

After a new testsuite has been added on the server, the documents need to be imported (synchonised) into Officeshots. This process will also create all the gallery pages that will be used to display the testsuite results in Officeshots. This is a manual process that needs to be done every time your source documents change.

Go to your www/app directory and execute the following command:

../cake/console/cake suites sync

You must run this import process with the same privileges as the webserver. The imported files will later need to read and written to by Officeshots. For Debian systems this means that this process must run as user www-data.

If you want to run this process from a different location then you must pass the -app argument, with the full path to www/app. For example:

path/to/cake/console/cake -app /var/www/www.officehots.org/www/app suites sync

Then simply follow the on-screen instructions.

The synchronisation process can generate a lot of output when debugging is turned on.

Updating validator results

When a new ODF validator is added to Officeshots, you most likely want to add this validator to all the testsuite documents that have already been imported, not just to the new testsuite documents. To add the new validator to existing testsuite documents, run the following command from your www/app directory:

../cake/console/cake validators missing

Then simply follow the on-screen instructions to select the proper testsuites and validators.

The ODF validators are constantly being worked on. At times it may be necessary to discard old validator results for one or more testsuites and regenerate them. You can do this by running the following command from your www/app directory on the server:

../cake/console/cake validators rerun

If you want to run this process from a different location then you must pass the -app argument, with the full path to www/app. For example:

path/to/cake/console/cake -app /var/www/www.officehots.org/www/app validators rerun

Then simply follow the on-screen instructions to select a subset of testsuites and validators that you want to rerun.

Last modified 9 years ago Last modified on 05/31/10 17:00:24