Last Modified 2013-11-11 by Jan Schneider

How to write a SyncML test case

The SyncML package contains a testing script to replay prerecorded test sessions. This allows the developers to check if changes break things for one particular phone. So it would be great to have test cases for as many phones as possible.

Each test case should be for one database (like calendar or addressbook, but not both). The exception is for phones that handle tasks and calendar in one database like the P900 does. Here you should create test entries for tasks and calendar at the same time to see if it works properly.

Here's how to create a test case:

  • Preparations in Horde:
    • create a user "syncmltest" with password "syncmltest" in horde. If the user's already there first delete and then recreate to get a fresh start.
    • create at least one test entry in the app you want to test (kronolith|nag|mnemo|turba). The entry should be named like "server##" (e.g. server1) and the description should contain an umlaut for charset testing. If you're creating a test case for the calendar, you should create at least two: one with an all day event and one with a normal (like 2hour) event. Generally the entries should make use of as many features (alarms, due dates, ...) as possible.
    • Preparations in the Client (PDA/Outlook/whatever)
    • Create at least one test entry named "client##". The database must only contain this single entry (so you might need to do a backup of your phone first). Other than that the same information as for the test entries in horde above apply (umlauts, all day events).
    • Clean /tmp/sync: rm/tmp/sync/
    • Clean Horde SyncML Data. Login as user syncmltest and go to http:[yourinstall]/horde/services/portal/syncml.php. Use the button "Delete all SyncML Data" to delete all data for the syncmltest user.
    • Do a first sync run
    • In Horde: rename all the "client..." entries to "client...s" ("s" to identify a client entry edited in the server). Create a new simple entry like "server99"
    • In the client: rename all the "server..." entries to "server...c". Create a new simple entry named "client99"
    • Do second sync run
    • Do a third sync run. This should do nothing
    • In the client, delete server99
    • in the server, delete client99
    • do a fourth sync run
    • do a fifth sync run. This should do nothing.
    • The test itself is now finished. Create an archive of all the stuff in /tmp/sync and mail it to karsten --at-- horde.org to verify the testcase and afterwards add it to cvs.

For developers:

  • If the phone uses wbxml this must be converted to xml first: for a in *.wbxml; do wbxml2xml -m 0 -o `basename $a .wbxml`.xml $a; done
    • Or for better readability: for a in *.wbxml; do wbxml2xml -m 0 -o - $a | tidy -xml -indent > `basename $a .wbxml`.xml; done
    • References to the installation that created the test case should be removed: data like http://horeinstall.com/horde/rpc.php should be renamed to http://example.com/rpc.php
    • All *.xml go into a directory under framework/syncml/tests with name testcase_[descriptionoftestcase]
    • In framework/syncml/tests do a ./testsync.php --dir=testcase_[descriptionoftestcase] to run the test.