ClientTest


Classes
class	ClientTestFactory
class	ClientOutputter
class	ClientListener
Functions
template<class T , class V >
int	countEqual (const T &container, const V &value)
void	simplifyFilename (string &filename)
const string &	getCurrentTest ()
int	main (int argc, char *argv[])
virtual void	LocalTests::addTests ()
virtual std::string	LocalTests::insert (CreateSource createSource, const char *data, bool relaxed=false)
virtual void	LocalTests::update (CreateSource createSource, const char *data, bool check=true)
virtual void	LocalTests::deleteAll (CreateSource createSource)
virtual void	LocalTests::compareDatabases (const char *refFile, SyncSource &copy, bool raiseAssert=true)
virtual int	LocalTests::insertManyItems (CreateSource createSource, int startIndex=1, int numItems=0, int size=-1)
virtual void	LocalTests::testOpen ()
virtual void	LocalTests::testIterateTwice ()
virtual void	LocalTests::testSimpleInsert ()
virtual void	LocalTests::testLocalDeleteAll ()
virtual void	LocalTests::testComplexInsert ()
virtual void	LocalTests::testLocalUpdate ()
virtual void	LocalTests::testChanges ()
virtual void	LocalTests::testImport ()
virtual void	LocalTests::testImportDelete ()
virtual void	LocalTests::testManyChanges ()
virtual void	LocalTests::testLinkedItemsParent ()
virtual void	LocalTests::testLinkedItemsChild ()
virtual void	LocalTests::testLinkedItemsParentChild ()
virtual void	LocalTests::testLinkedItemsChildParent ()
virtual void	LocalTests::testLinkedItemsChildChangesParent ()
virtual void	LocalTests::testLinkedItemsRemoveParentFirst ()
virtual void	LocalTests::testLinkedItemsRemoveNormal ()
virtual void	LocalTests::testLinkedItemsInsertParentTwice ()
virtual void	LocalTests::testLinkedItemsInsertChildTwice ()
virtual void	LocalTests::testLinkedItemsParentUpdate ()
virtual void	LocalTests::testLinkedItemsUpdateChild ()
virtual void	LocalTests::testLinkedItemsInsertBothUpdateChild ()
virtual void	LocalTests::testLinkedItemsInsertBothUpdateParent ()
	SyncTests::SyncTests (const std::string &name, ClientTest &cl, std::vector< int > sourceIndices, bool isClientA=true)
	SyncTests::~SyncTests ()
virtual void	SyncTests::addTests ()
virtual void	SyncTests::compareDatabases ()
virtual void	SyncTests::deleteAll (DeleteAllMode mode=DELETE_ALL_SYNC)
virtual void	SyncTests::doCopy ()
virtual void	SyncTests::refreshClient ()
virtual void	SyncTests::testDeleteAllRefresh ()
virtual void	SyncTests::testRefreshSemantic ()
virtual void	SyncTests::testRefreshStatus ()
virtual void	SyncTests::testUpdate ()
virtual void	SyncTests::testComplexUpdate ()
virtual void	SyncTests::testDelete ()
virtual void	SyncTests::testMerge ()
virtual void	SyncTests::testTwinning ()
virtual void	SyncTests::testOneWayFromServer ()
virtual void	SyncTests::testOneWayFromClient ()
virtual void	SyncTests::testItems ()
virtual void	SyncTests::testAddUpdate ()
virtual void	SyncTests::testManyItems ()
virtual void	SyncTests::doVarSizes (bool withMaxMsgSize, bool withLargeObject, const char *encoding)
virtual void	SyncTests::sync (SyncMode syncMode, const std::string &logprefix="", CheckSyncReport checkReport=CheckSyncReport(), long maxMsgSize=0, long maxObjSize=0, bool loSupport=false, const char *encoding="")
virtual void	ClientTest::registerTests ()
	ClientTest::ClientTest (int serverSleepSec=0, const std::string &serverLog="")
virtual	ClientTest::~ClientTest ()
virtual LocalTests *	ClientTest::createLocalTests (const std::string &name, int sourceParam, ClientTest::Config &co)
virtual SyncTests *	ClientTest::createSyncTests (const std::string &name, std::vector< int > sourceIndices, bool isClientA=true)
static int	ClientTest::dump (ClientTest &client, SyncSource &source, const char *file)
static int	ClientTest::import (ClientTest &client, SyncSource &source, const char *file)
static bool	ClientTest::compare (ClientTest &client, const char fileA, const char fileB)
virtual void	ClientTest::postSync (int res, const std::string &logname)
static void	ClientTest::getTestData (const char *type, Config &config)
virtual void	CheckSyncReport::check (int res, SyncReport &report) const
Variables
ClientListener	syncListener

Detailed Description

Function Documentation

void SyncTests::addTests ( ) [virtual, inherited]

adds the supported tests to the instance itself

Definition at line 1602 of file ClientTest.cpp.

Referenced by ClientTestFactory::makeTest().

void LocalTests::addTests ( ) [virtual, inherited]

adds the supported tests to the instance itself; this is the function that a derived class can override to add additional tests

adds the supported tests to the instance itself

Reimplemented in EvolutionLocalTests.

Definition at line 183 of file ClientTest.cpp.

Referenced by ClientTestFactory::makeTest().

void CheckSyncReport::check	(	int	res,
		SyncReport &	report
	)			const `[virtual, inherited]`

checks that the sync completed as expected and throws CPPUnit exceptions if something is wrong

Parameters:

	res	return code from SyncClient::sync()
	report	the sync report stored in the SyncClient

Definition at line 3108 of file ClientTest.cpp.

References CLIENT, CLIENT_TEST_EQUAL, CheckSyncReport::clientAdded, CheckSyncReport::clientDeleted, CheckSyncReport::clientUpdated, SyncSourceReport::getItemReportFailedCount(), SyncSourceReport::getItemReportSuccessfulCount(), SyncSourceReport::getSourceName(), SyncSourceReport::getState(), SyncReport::getSyncSourceReport(), SERVER, CheckSyncReport::serverAdded, CheckSyncReport::serverDeleted, CheckSyncReport::serverUpdated, SOURCE_INACTIVE, and SyncReport::toString().

Referenced by TestEvolution::sync().

ClientTest::ClientTest	(	int	serverSleepSec = `0`,
		const std::string &	serverLog = `""`
	)			`[inherited]`

Definition at line 2551 of file ClientTest.cpp.

Referenced by TestEvolution::sync().

bool ClientTest::compare	(	ClientTest &	client,
		const char *	fileA,
		const char *	fileB
	)			`[static, inherited]`

utility function for comparing vCard and iCal files with the external synccompare.pl Perl script

Reimplemented in TestEvolution.

Definition at line 2621 of file ClientTest.cpp.

Referenced by getTestData().

void SyncTests::compareDatabases ( ) [protected, virtual, inherited]

compare databases of first and second client

Definition at line 1663 of file ClientTest.cpp.

References SyncTests::accessClientB, SOURCE_ASSERT_NO_FAILURE, and SyncTests::sources.

Referenced by SyncTests::doCopy(), SyncTests::doVarSizes(), SyncTests::testAddUpdate(), SyncTests::testComplexUpdate(), SyncTests::testCopy(), SyncTests::testItems(), SyncTests::testManyItems(), SyncTests::testTwinning(), and SyncTests::testUpdate().

void LocalTests::compareDatabases	(	const char *	refFile,
		SyncSource &	copy,
		bool	raiseAssert = `true`
	)			`[virtual, inherited]`

takes two databases, exports them, then compares them using synccompare

Parameters:

	refFile	existing file with source reference items, NULL uses a dump of sync source A instead
	copy	a sync source which contains the copied items, begin/endSync will be called
	raiseAssert	raise assertion if comparison yields differences (defaults to true)

Definition at line 417 of file ClientTest.cpp.

References SyncSource::beginSync(), LocalTests::client, ClientTest::Config::compare, LocalTests::config, LocalTests::createSourceA, ClientTest::Config::dump, SyncSource::endSync(), getCurrentTest(), simplifyFilename(), SOURCE_ASSERT_EQUAL, and SOURCE_ASSERT_NO_FAILURE.

Referenced by LocalTests::testImport().

template<class T , class V >

int countEqual	(	const T &	container,
		const V &	value
	)			`[inline]`

Definition at line 821 of file ClientTest.cpp.

LocalTests * ClientTest::createLocalTests	(	const std::string &	name,
		int	sourceParam,
		ClientTest::Config &	co
	)			`[virtual, inherited]`

Creates an instance of LocalTests (default implementation) or a class derived from it. LocalTests provides tests which cover the SyncSource interface and can be executed without a SyncML server. It also contains utility functions for working with SyncSources.

A ClientTest implementation can, but doesn't have to extend these tests by instantiating a derived class here.

Reimplemented in TestEvolution.

Definition at line 2567 of file ClientTest.cpp.

Referenced by ClientTestFactory::makeTest(), and SyncTests::SyncTests().

SyncTests * ClientTest::createSyncTests	(	const std::string &	name,
		std::vector< int >	sourceIndices,
		bool	isClientA = `true`
	)			`[virtual, inherited]`

Creates an instance of SyncTests (default) or a class derived from it. SyncTests provides tests which cover the actual interaction with a SyncML server.

A ClientTest implementation can, but doesn't have to extend these tests by instantiating a derived class here.

Definition at line 2572 of file ClientTest.cpp.

Referenced by ClientTestFactory::makeTest(), and SyncTests::SyncTests().

void SyncTests::deleteAll ( DeleteAllMode mode = DELETE_ALL_SYNC ) [protected, virtual, inherited]

deletes all items locally and on server

Definition at line 1681 of file ClientTest.cpp.

References SyncTests::DELETE_ALL_REFRESH, SyncTests::DELETE_ALL_SYNC, SyncTests::sources, and SyncTests::sync().

Referenced by SyncTests::doCopy(), SyncTests::doVarSizes(), SyncTests::testAddUpdate(), SyncTests::testDeleteAllRefresh(), SyncTests::testDeleteAllSync(), SyncTests::testItems(), SyncTests::testManyItems(), SyncTests::testOneWayFromClient(), SyncTests::testOneWayFromServer(), SyncTests::testRefreshSemantic(), and SyncTests::testTwinning().

void LocalTests::deleteAll ( CreateSource createSource ) [virtual, inherited]

deletes all items locally via sync source

Definition at line 364 of file ClientTest.cpp.

References CreateSource::createSource, LocalTests::source, SOURCE_ASSERT, SOURCE_ASSERT_EQUAL, SOURCE_ASSERT_MESSAGE, and SOURCE_ASSERT_NO_FAILURE.

void SyncTests::doCopy ( ) [protected, virtual, inherited]

get both clients in sync with empty server, then copy one item from client A to B

Definition at line 1708 of file ClientTest.cpp.

References SyncTests::accessClientB, SyncTests::compareDatabases(), SyncTests::deleteAll(), SyncTests::sources, and SyncTests::sync().

Referenced by SyncTests::testComplexUpdate(), SyncTests::testCopy(), SyncTests::testDelete(), SyncTests::testMerge(), and SyncTests::testUpdate().

void SyncTests::doVarSizes	(	bool	withMaxMsgSize,
		bool	withLargeObject,
		const char *	encoding
	)			`[protected, virtual, inherited]`

implements testMaxMsg(), testLargeObject(), testLargeObjectEncoded() using a sequence of items with varying sizes

Definition at line 2370 of file ClientTest.cpp.

References SyncTests::accessClientB, SyncTests::compareDatabases(), SyncTests::deleteAll(), SyncTests::sources, and SyncTests::sync().

Referenced by SyncTests::testLargeObject(), SyncTests::testLargeObjectBin(), SyncTests::testLargeObjectEncoded(), and SyncTests::testMaxMsg().

int ClientTest::dump	(	ClientTest &	client,
		SyncSource &	source,
		const char *	file
	)			`[static, inherited]`

utility function for dumping items which are C strings with blank lines as separator

Definition at line 2577 of file ClientTest.cpp.

References SyncSource::getFirstItem(), SyncSource::getNextItem(), and SOURCE_ASSERT_NO_FAILURE.

Referenced by getTestData().

const string& getCurrentTest ( )

Definition at line 177 of file client-test-main.cpp.

References Sync4jListener::getCurrentTest(), and syncListener.

void ClientTest::getTestData	(	const char *	type,
		Config &	config
	)			`[static, inherited]`

A derived class can use this call to get default test cases, but still has to add callbacks which create sources and execute a sync session.

Some of the test cases are compiled into the library, other depend on the auxiliary files from the "test" directory. Currently supported types:

vcard30 = vCard 3.0 contacts
vcard21 = vCard 2.1 contacts
ical20 = iCal 2.0 events
vcal10 = vCal 1.0 events
itodo20 = iCal 2.0 tasks

Definition at line 2657 of file ClientTest.cpp.

Referenced by TestEvolution::getSourceConfig().

int ClientTest::import	(	ClientTest &	client,
		SyncSource &	source,
		const char *	file
	)			`[static, inherited]`

utility function for importing items with blank lines as separator

Definition at line 2591 of file ClientTest.cpp.

std::string LocalTests::insert	(	CreateSource	createSource,
		const char *	data,
		bool	relaxed = `false`
	)			`[virtual, inherited]`

opens source and inserts the given item; can be called regardless whether the data source already contains items or not

The type of the item is unset; it is assumed that the source can handle that.

Parameters:

relaxed

if true, then disable some of the additional checks after adding the item

Returns:: the UID of the inserted item

Definition at line 239 of file ClientTest.cpp.

References LocalTests::source, SOURCE_ASSERT, and SOURCE_ASSERT_NO_FAILURE.

int LocalTests::insertManyItems	(	CreateSource	createSource,
		int	startIndex = `1`,
		int	numItems = `0`,
		int	size = `-1`
	)			`[virtual, inherited]`

insert artificial items, number of them determined by TEST_EVOLUTION_NUM_ITEMS unless passed explicitly

Parameters:

	createSource	a factory for the sync source that is to be used
	startIndex	IDs are generated starting with this value
	numItems	number of items to be inserted if non-null, otherwise TEST_EVOLUTION_NUM_ITEMS is used
	size	minimum size for new items

Returns:: number of items inserted

insert artificial items, number of them determined by config.numItems unless passed explicitly

Parameters:

	createSource	a factory for the sync source that is to be used
	startIndex	IDs are generated starting with this value
	numItems	number of items to be inserted if non-null, otherwise config.numItems is used
	size	minimum size for new items

Returns:: number of items inserted

Definition at line 454 of file ClientTest.cpp.

References LocalTests::config, LocalTests::createSourceA, ClientTest::Config::numItems, ClientTest::Config::sizeProperty, SOURCE_ASSERT_EQUAL, SOURCE_ASSERT_NO_FAILURE, ClientTest::Config::templateItem, and ClientTest::Config::uniqueProperties.

Referenced by LocalTests::testManyChanges().

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 194 of file client-test-main.cpp.

References Sync4jListener::addAllowedFailures(), Sync4jListener::hasFailed(), and syncListener.

USE_NAMESPACE void ClientTest::postSync	(	int	res,
		const std::string &	logname
	)			`[virtual, inherited]`

This is called after successful sync() calls (res == 0) as well as after unsuccessful ones (res != 1). The default implementation sleeps for the number of seconds specified when constructing this instance and copies the server log if one was named.

Parameters:

	res	result of sync()
	logname	base name of the current sync log (without ".client.[AB].log" suffix)

Definition at line 2635 of file ClientTest.cpp.

References serverLogFileName, and serverSleepSeconds.

Referenced by SyncTests::sync().

void SyncTests::refreshClient ( ) [protected, virtual, inherited]

replicate server database locally: same as SYNC_REFRESH_FROM_SERVER, but done with explicit local delete and then a SYNC_SLOW because some servers do no support SYNC_REFRESH_FROM_SERVER

Definition at line 1733 of file ClientTest.cpp.

References SyncTests::sources, and SyncTests::sync().

Referenced by SyncTests::testAddUpdate(), SyncTests::testItems(), SyncTests::testManyItems(), SyncTests::testOneWayFromServer(), and SyncTests::testTwinning().

void ClientTest::registerTests ( ) [virtual, inherited]

This function registers tests using this instance of ClientTest for later use during a test run.

The instance must remain valid until after the tests were run. To run them use a separate test runner, like the one from client-test-main.cpp.

Definition at line 2545 of file ClientTest.cpp.

void simplifyFilename ( string & filename )

Definition at line 68 of file client-test-main.cpp.

void SyncTests::sync	(	SyncMode	syncMode,
		const std::string &	logprefix = `""`,
		CheckSyncReport	checkReport = `CheckSyncReport()`,
		long	maxMsgSize = `0`,
		long	maxObjSize = `0`,
		bool	loSupport = `false`,
		const char *	encoding = `""`
	)			`[protected, virtual, inherited]`