TestFileSource Class Reference
[Client Testing Framework]

This code uses the ClientTest and RawFileSyncSource to test real synchronization against a server. More...

Inheritance diagram for TestFileSource:

[legend]Collaboration diagram for TestFileSource:

[legend]List of all members.

Public Member Functions
	TestFileSource (const std::string &id)
virtual int	getNumSources ()
	Data sources are enumbered from 0 to n-1 for the purpose of testing.
virtual void	getSourceConfig (int source, Config &config)
virtual ClientTest *	getClientB ()
	The instance to use as second client.
virtual bool	isB64Enabled ()
	Returning true enables tests which only work if the server is a Funambol server which supports the "b64" encoding of items on the transport level.
virtual int	sync (const int *activeSources, SyncMode syncMode, const CheckSyncReport &checkReport, long maxMsgSize, long maxObjSize, bool loSupport, const char *encoding=0)
	Execute a synchronization with the selected sync sources and the selected synchronization options.

---

Detailed Description

This code uses the ClientTest and RawFileSyncSource to test real synchronization against a server.

More than one RawFileSyncSource can be active at once and each of them may (but does not have to be) used for different kinds of data. The name of the source determines which data is stored in it: it must be something supported by the ClientTest class, because that is where the test data comes from.

At least the following kinds of data are currently supported by the ClientTest class (see ClientTest::getTestData() for more information):

• vcard30 = vCard 3.0 contacts
• vcard21 = vCard 2.1 contacts
• ical20 = iCalendar 2.0 calendar events
• vcal10 = vCalendar 1.0 calendar events
• itodo20 = iCalendar 2.0 tasks

Configuration is done by environment variables which indicate which part below the root node "client-test" of the the configuration tree to use; beyond that everything needed for synchronization is read from the configuration tree.

• CLIENT_TEST_SERVER = maps to name of root node in configuration tree
• CLIENT_TEST_SOURCES = comma separated list of active sources, names as listed above
• CLIENT_TEST_DELAY = number of seconds to sleep between syncs, required by some servers
• CLIENT_TEST_LOG = logfile name of a server, can be empty: if given, then the content of that file will be copied and stored together with the client log (only works on Unix)

For example, on Linux running

CLIENT_TEST_SERVER=funambol CLIENT_TEST_SOURCES=vcard21,vcal10 ./client-test

expects the following configuration layout:

~/.sync4j/client-test/
                      funambol_1/spds/
                                      syncml/config.text
                                      sources/
                                              vcard21/config.txt
                                              vcal10/config.txt
                      funambol_1/spds/
                                      <same as for funambol_1>

If any of the configuration nodes does not exist yet, then it will be created, but further information may have to be added, in particular:

• server URL
• server user name, password
• sources uri

The CLIENT_TEST_SERVER also has another meaning: it is used as hint by the synccompare.pl script and causes it to automatically ignore known, acceptable data modifications caused by sending an item to a server and back again. Currently the script recognizes "funambol", "scheduleworld", "synthesis" and "egroupware" as special server names.

The two configurations are used to simulate synchronization between two different clients.

The file sources will store their items in sub directories of a "client-data" directory created in the current working directory.

Here is an example of using the CLIENT_TEST_LOG:

CLIENT_TEST_SERVER=funambol \
CLIENT_TEST_LOG=/opt/Funambol-3.0/ds-server/logs/funambol_ds.log \
CLIENT_TEST_SOURCES=vcard21 \
   ./client-test

will create files with the suffix .client.A.log for synchronizations with the first client and .client.B.log for the second client. The base name of these files is unique, so the corresponding part of the server log is stored with the same base name and .server.log as suffix.

---

Member Function Documentation

virtual int TestFileSource::getNumSources

(

)

[inline, virtual]

Data sources are enumbered from 0 to n-1 for the purpose of testing.

This call returns n.

Implements ClientTest.

virtual ClientTest* TestFileSource::getClientB

(

)

[inline, virtual]

The instance to use as second client.

Returning NULL disables all checks which require a second client. The returned pointer must remain valid throughout the life time of the tests.

The second client must be configured to access the same server and have data sources which match the ones from the primary client.

Implements ClientTest.

virtual int TestFileSource::sync	(	const int *	activeSources,
		SyncMode	syncMode,
		const CheckSyncReport &	checkReport,
		long	maxMsgSize,
		long	maxObjSize,
		bool	loSupport,
		const char *	encoding = 0
	)			[inline, virtual]

Execute a synchronization with the selected sync sources and the selected synchronization options.

The log file in LOG has been set up already for the synchronization run and should not be changed by the client.

Parameters:

	activeSources	a -1 terminated array of sync source indices
	syncMode	the synchronization mode to be used
	checkReport	has to be called after a successful or unsuccessful sync, will dump the report and (optionally) check the result; beware, the later may throw exceptions inside CPPUNIT macros
	maxMsgSize	>0: enable the maximum message size, else disable it
	maxObjSize	same as maxMsgSize for maximum object size
	loSupport	if TRUE, then the sync is expected to enable Large Object support
	encoding	if non-empty, then let client library transform all items into this format (guaranteed to be not NULL)

Returns:

return code of SyncClient::sync()

Implements ClientTest.

---

The documentation for this class was generated from the following file:

• test/client-test.cpp

---