// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// This file contains test classes and their implementations

// to test production class CRegistrar. Where necessary stubs

// are implemented to help in writing test harness using RTest.

// 

//

#include "RegistryData.h"

#include "EComErrorCodes.h"

#include "EComUidCodes.h"

#include "ImplementationInformation.h"

#include "RegistryData.h"

#include "Registrar.h"

#include "RegistrarObserver.h"

#include "../EcomTestUtils/EcomTestUtils.h"

#include "EComEntryBase.h"

#include "DriveInfo.h"

#include <e32test.h>

#include <f32file.h>

#include <bautils.h>

#include <startup.hrh>

#include "baspi.h"

_LIT (KDataDir, "C:\\private\\10009D8F\\ECom*");

//We need two different entry RSC and the SPI to fully test CRegistrar

//------------------------------NEW TYPE----------------------------------------

const TUid NewDllUid={0x101F847B};

_LIT(KNewResourceFileNameOnly,"EComExample5.rsc");

_LIT(KNewResourceFileNameC, "C:\\resource\\plugins\\EComExample5.rsc");

_LIT(KNewDllFileNameC, "C:\\sys\\bin\\EComExample5.dll");

_LIT(KNewResourceFileNameZ, "z:\\RAMOnly\\EComExample5.rsc");

_LIT(KNewDllFileNameZ,"z:\\RAMOnly\\EComExample5.dll");

//We need IIC type 3 RSC to fully test CRegistrar

//------------------------------IIC TYPE 3----------------------------------------

const TUid Type3DllUid = {0x10009E3E};

_LIT(KType3ResourceFileNameOnly,"EComExample12.rsc");

_LIT(KType3ResourceFileNameC, "C:\\resource\\plugins\\EComExample12.rsc");

_LIT(KType3DllFileNameC, "C:\\sys\\bin\\EComExample12.dll");

_LIT(KType3ResourceFileNameZ, "z:\\RAMOnly\\EComExample12.rsc");

_LIT(KType3DllFileNameZ,"z:\\RAMOnly\\EComExample12.dll");

//We need IIC type 3 RSC with data exceed maximum to fully test CRegistrar

//------------------------------IIC TYPE 3----------------------------------------

_LIT(KType3BadDataResourceFileNameOnly,"EComExampleBadData.rsc");

_LIT(KType3BadDataResourceFileNameC, "C:\\resource\\plugins\\EComExampleBadData.rsc");

_LIT(KType3BadDataDllFileNameC, "C:\\sys\\bin\\EComExampleBadData.dll");

_LIT(KType3BadDataResourceFileNameZ, "z:\\RAMOnly\\EComExampleBadData.rsc");

_LIT(KType3BadDataDllFileNameZ,"z:\\RAMOnly\\EComExampleBadData.dll");

_LIT(KType3BadData1ResourceFileNameOnly,"EComExampleBadData1.rsc");

_LIT(KType3BadData1ResourceFileNameC, "C:\\resource\\plugins\\EComExampleBadData1.rsc");

_LIT(KType3BadData1DllFileNameC, "C:\\sys\\bin\\EComExampleBadData1.dll");

_LIT(KType3BadData1ResourceFileNameZ, "z:\\RAMOnly\\EComExampleBadData1.rsc");

_LIT(KType3BadData1DllFileNameZ,"z:\\RAMOnly\\EComExampleBadData1.dll");

_LIT(KType3BadData2ResourceFileNameOnly,"EComExampleBadData2.rsc");

_LIT(KType3BadData2ResourceFileNameC, "C:\\resource\\plugins\\EComExampleBadData2.rsc");

_LIT(KType3BadData2DllFileNameC, "C:\\sys\\bin\\EComExampleBadData2.dll");

_LIT(KType3BadData2ResourceFileNameZ, "z:\\RAMOnly\\EComExampleBadData2.rsc");

_LIT(KType3BadData2DllFileNameZ,"z:\\RAMOnly\\EComExampleBadData2.dll");

//We need IIC type 2 RSC to fully test CRegistrar

//------------------------------IIC TYPE 2----------------------------------------

_LIT(KType2ResourceFileNameOnly,"EComExample14.rsc");

_LIT(KType2ResourceFileNameC, "C:\\resource\\plugins\\EComExample14.rsc");

_LIT(KType2DllFileNameC, "C:\\sys\\bin\\EComExample14.dll");

_LIT(KType2ResourceFileNameZ, "z:\\RAMOnly\\EComExample14.rsc");

_LIT(KType2DllFileNameZ,"z:\\RAMOnly\\EComExample14.dll");

//------------------------------LEGACY TYPE-------------------------------------

// spi test file

_LIT(KEComSpiTestFilePathAndName, "Z:\\Test\\Data\\EcomTest.spi");

// spi test file for testing IIC Type3

_LIT(KEComSpiTestFileType3PathAndName, "Z:\\Test\\Data\\ecomtesttype3.spi");

const TInt KOneSecond = 1000000;

const TUid interfaceUidExample12 = {0x10009E36};

const TUid extendedInterfaceUid1 = {0x10009E44};

const TUid extendedInterfaceUid2 = {0x10009E45};

const TUid extendedInterfaceUid3 = {0x10009E46};

LOCAL_D RTest test(_L("t_Registrar.exe"));

LOCAL_D RFs					TheFs;

LOCAL_D CTrapCleanup* 		TheTrapCleanup 		= NULL;

LOCAL_D CActiveScheduler*	TheActiveScheduler	= NULL;

// Used for supressing warning in OOM tests

#define __UNUSED_VAR(var) var = var

//It is used by some test methods which are called two times:

//from normal test and from OOM test.

static void LeaveIfErrNoMemory(TInt aError)

	{

	if(aError == KErrNoMemory)

		{

		User::Leave(aError);

		}

	}

/**

TRegistrar_StateAccessor class allows access to private and protected

members of production code class CRegistrar, as its a friend class.

*/

class TRegistrar_StateAccessor

	{

public:

	void DiscoveriesBegin(CRegistrar& aRegistrar);

	void DiscoveriesComplete(CRegistrar& aRegistrar, TBool aSuccessful);

	void DriveRemovedL(CRegistrar& aRegistrar, TDriveUnit aDriveUnit);

	void DriveReinstatedL(CRegistrar& aRegistrar, TDriveUnit aDriveUnit);

	void RegisterDiscoveryL(CRegistrar& aRegistrar,const TDriveName& aDrive, CPluginBase*& aEntry,TBool aDatFileExists);

	void ParseL(CRegistrar& aRegistrar,

				CPluginBase*& aEntry,

				CRegistryData::CDllData& aDll);

	void ParseRegistrationDataL(CRegistrar& aRegistrar,

				CPluginBase*& aEntry,

				TDriveUnit& aDriveUnit,

				TBool aUpdate,

				TInt aRegistryDriveIndex,

				CRegistryData::CDriveData* aDriveData);

	CRegistrar::TRegistrarState State(CRegistrar& aRegistrar);

	};

/**

Parses the resource file associated with an

Interface Implementation Collection for the plugin entry.

@param		aRegistrar The CRegistrar class object under test

@param		aEntry an ecom entry discovered

@param		aDll CRegistrar::CDllData object in which parsed data needs to be stored

@pre 		CRegistrar should be fully constructed.

@post		The resource file is parsed and the data is added to 'aDll'.

 */

void TRegistrar_StateAccessor::ParseL(CRegistrar& aRegistrar,

									  CPluginBase*& aEntry,

									  CRegistryData::CDllData& aDll)

	{

	aRegistrar.ParseL(aEntry,aDll);

	}

/**

Determines if the directory entry for an Interface Implementation

Collection requires registration. Parses and registers the plugin entry

associated with the resource file if entry is not already registered.

@param		aRegistrar The CRegistrar class object under test

@param		aEntry Directory entry for the Interface Impplementation Collection.

@param		aRscFileName Resource file from which to extract the data

@param		aDrive Drive on which registry data has been found on

@param		aUpdate Flag indicating if this is an update, or new entry.

@param		aRegistryDriveIndex Index within the registry data

			for the branch that the registry entry was found within.

@pre 		CRegistrar is fully constructed.

@post		The Interface Implementation Collection entry has been processed appropriately.

*/

void TRegistrar_StateAccessor::ParseRegistrationDataL(CRegistrar& aRegistrar,

														CPluginBase*& aEntry,

														TDriveUnit& aDrive,

														TBool aUpdate,

														TInt aRegistryDriveIndex,

														CRegistryData::CDriveData* aDriveData)

	{

	aRegistrar.ParseRegistrationDataL(aEntry, aDrive,aUpdate, aRegistryDriveIndex, aDriveData);

	}

/**

Overload of the MDiscovererObserver callback method.

The cue that a registry update is about to occur.

@param		aRegistrar The CRegistrar class object under test

@pre 		CRegistrar is fully constructed

@post		The Registry data manager has been informed that its internal

			data is out of date.

*/

void TRegistrar_StateAccessor::DiscoveriesBegin(CRegistrar& aRegistrar)

	{

	aRegistrar.DiscoveriesBegin();

	}

/**

Overload of the MDiscovererObserver callback method.

The cue that a registry update is done.

@param		aRegistrar The CRegistrar class object under test

@param		aSuccessful The registry data has been updated successfully

@pre 		CRegistrar is fully constructed

@post		The current registry data and the internal access indexes have been rebuilt.

*/

void TRegistrar_StateAccessor::DiscoveriesComplete(CRegistrar& aRegistrar,

												   TBool aSuccessful)

	{

	aRegistrar.DiscoveriesComplete(aSuccessful, EPluginProcessingTypeAll);

	}

/**

Overload of the MDiscovererObserver callback method.

Signals registry that the registered Interface Implementation

Collections stored upon the specified drive are no

longer available for use.

@param		aRegistrar The CRegistrar class object under test

@param		aDrive	The drive identifier.

@pre 		CRegistrar is fully constructed.

@post		The registered Interface Implementation Collections

			stored upon the specified drive are no

			longer available for use.

*/

void TRegistrar_StateAccessor::DriveRemovedL(CRegistrar& aRegistrar,

											 TDriveUnit aDrive)

	{

	aRegistrar.DriveRemovedL(aDrive);

	}

/**

Overload of the MDiscovererObserver callback method.

Signals registry that the registered Interface

Implementation Collections stored upon the specified drive are again

available for use.

@param		aRegistrar The CRegistrar class object under test

@param		aDrive	The drive identifier.

@pre 		CRegistrar is fully constructed.

@post		The registered Interface Implementation Collections

			stored upon the specified drive are again

			made available for use.

*/

void TRegistrar_StateAccessor::DriveReinstatedL(CRegistrar& aRegistrar,

												   TDriveUnit aDrive)

	{

	aRegistrar.DriveReinstatedL(aDrive);

	}

/**

Overload of the MDiscovererObserver callback method.

Adds the specified Interface Implementation Collection Entry to the registry.

@param		aRegistrar The CRegistrar class object under test

@param		aDirEntry The plugin entry to register.

@pre 		CRegistrar is fully constructed

@post		The plugin entry is registered.

*/

void TRegistrar_StateAccessor::RegisterDiscoveryL(CRegistrar& aRegistrar,

												  const TDriveName& aDrive,

												  CPluginBase*& aEntry,

												  TBool aDatFileExists )

	{

	aRegistrar.RegisterDiscoveryL(aDrive,aEntry,aDatFileExists);

	}

/**

Retrieves the object's current state.

@return 	TCRegistarState the CRegistrar's current state.

@pre		CRegistrar is fully constructed.

@post 		the CRegistrar's current state has been returned.

*/

CRegistrar::TRegistrarState TRegistrar_StateAccessor::State(CRegistrar& aRegistrar)

	{

	return aRegistrar.State();

	}

/**

TRegistryData_StateAccessor class allows access to private and protected

members of production code class CRegistryData, as its a friend class.

*/

class TRegistryData_StateAccessor

	{

public:

	TInt FindImplementation(CRegistryData& aRegistryData,

				const TUid aImplUid,

				const TUid aInterfaceUid,

				CRegistryData::CImplementationData*& aImplData) const;

	};

/**

@return		KErrNone if found otherwise KErrNotFound

@param		aRegistryData The CRegistryData class object

@param		aImplUid The implementation to find.

@param		aInterfaceUid If greater than 0 the interface associated with the

			implementation to find.

@param		aImplData The found implementation data.

@pre 		CRegistrar is fully constructed

*/

TInt TRegistryData_StateAccessor::FindImplementation(CRegistryData& aRegistryData,

												const TUid aImplUid,

												const TUid aInterfaceUid,

												CRegistryData::CImplementationData*& aImplData) const

	{

	return aRegistryData.FindImplementation(aImplUid, aInterfaceUid, aImplData);

	}

/**

The implementation of the abstract Registrar Observer class,

used for recieving notifications of registry changes.

Stub class(for CEComServer) used for the creation of CRegistrar class object.

CEComServer class acts as observer for CRegistrar.

*/

	{

public:

	// This function is used by RegistrarObserver (i.e.CEComServer) to notify its

	// clients(REComSession objects) that some change has happened in Registry.

	// Here we have no clients to notify, so no implementaion.

	void Notification( TInt /*aNotification*/ ) {}

	};

/**

Test class for object CRegistrar.

This class provides the parameters and behaviour that

allows this class to behave normally under a test

scenario.

*/

class CRegistrarTest : public CBase

	{

public:

	static CRegistrarTest* NewL(TBool aIsFullDiscovery);

	virtual ~CRegistrarTest();

	const CImplementationInformation * GetImplementationDataL();

	void EnableDisableTestL();

	void ResumeSuspendTestL();

	void DiscoveriesBegin_Register_CompleteTestL();

	void DriveRemovedReinstatedTestL();

	void ParseTestL();

	void ParseType2TestL();

	void ParseType3TestL();

	void ParseType3BadDataTestL();

	void ParseRegistrationDataTestL();

	void ParseRegistrationDataType3TestL();

	void StateTransitionTestL();

	void ParseSpiRegistrationDataTestL();

	void ParseSpiRegistrationDataType3TestL();

	void ParseSpiTestL();

	void ParseSpiType3TestL();

private:

	CRegistrarTest();

	void ConstructL(TBool aIsFullDiscovery);

	void ParseBadDataTestL(const TDesC& aRscFullName, const TDesC& aRscNameOnly);

public:

	/** The instance of the class under test */

	CRegistrar* iRegistrar;

	/** The instance of the State Accessor class */

	TRegistrar_StateAccessor* iStateAccessor;

	/** The registry data instance required to construct a CRegistrar object */

	CRegistryData* iRegistryData;

	/** The instance of the Registry Data State Accessor class */

	TRegistryData_StateAccessor* iRegistryDataStateAccessor;

	/** The instance of the observer of CRegistrar class */

	MRegistrarObserver* iRegistrarObserver;

	/** The destination for the data discovered during a parse */

	CRegistryData::CDllData* iDllData;

	/** Unique Id of the ECOM dll */

	TUid    iDllUid;

	/** Unique Id of an interface implementation */

	TUid	iImplementationUid;

	/** Unique Id of an interface */

	TUid	iInterfaceUid;

	/** The drive on which interface implementations can be found */

	TDriveUnit	iDriveUnit;

	/** Ecom plugin which contains interface implementations. Used in Registration APIs.*/

	TEntry		iDllEntry;

	};

/**

Standardised safe construction which

leaves nothing on the cleanup stack.

@param		aIsFullDiscovery whether the constructor make full discovery

@post		CRegistrarTest is fully constructed and initialised.

*/

CRegistrarTest* CRegistrarTest::NewL(TBool aIsFullDiscovery)

	{

	CRegistrarTest* self = new (ELeave) CRegistrarTest();

	CleanupStack::PushL(self);

	self->ConstructL(aIsFullDiscovery);

	CleanupStack::Pop(self);

	return self;

	}

/**

Standardized default c'tor

@post		CRegistrarTest is fully constructed.

*/

CRegistrarTest::CRegistrarTest()

:	CBase(),

	iDriveUnit(EDriveC)

	{

	iDllUid.iUid			= 0x101F847B; // Dlluid for Ecom plugin EComExample5.dll

	iInterfaceUid.iUid		= 0x10009DC0; // Interface uid for interface contained in above plugin

	iImplementationUid.iUid = 0x101f847C; // Implementaion uid for above interface

	TUid uid1 = {0};

	TUid uid2 = {0};

	iDllEntry.iType = TUidType(uid1, uid2, iDllUid);//Setting Dlluid to plugin entry

	}

/**

Destructor.

@post		This object is properly destroyed.

*/

CRegistrarTest::~CRegistrarTest()

	{

	delete iDllData;

	delete iRegistrar;

	delete iRegistryData;

	delete iRegistrarObserver;

	delete iStateAccessor;

	delete iRegistryDataStateAccessor;

	}

/**

Standardized 2nd(Initialization) phase of two phase construction.

@param		aIsFullDiscovery whether the constructor make full discovery

@post		CRegistrarTest is fully constructed.

*/

void CRegistrarTest::ConstructL(TBool aIsFullDiscovery)

	{

	CRegistryData::CDriveData* driveData=NULL;

	iRegistrarObserver = new (ELeave) CTestRegistrarObserver;

	iStateAccessor	   = new (ELeave) TRegistrar_StateAccessor;

	iRegistryDataStateAccessor	   = new (ELeave) TRegistryData_StateAccessor;

	iRegistryData	   = CRegistryData::NewL(TheFs);

	iRegistrar		   = CRegistrar::NewL(*iRegistryData, *iRegistrarObserver, TheFs);

	if(aIsFullDiscovery)

		{

		iRegistrar->ProcessSSAEventL(EStartupStateNonCritical);

		}

	iDllData		   = CRegistryData::CDllData::NewLC(driveData);

	CleanupStack::Pop(iDllData);

	}

/**

Returns information of a particular interface implementation.

@return		Information on the requested implementation

@pre 		This object is fully constructed

*/

const CImplementationInformation * CRegistrarTest::GetImplementationDataL()

	{

	CRegistryData::CImplementationData *implementationData=NULL;

	TUid dummyUid;

	dummyUid.iUid = 0;

	User::LeaveIfError(iRegistryDataStateAccessor->FindImplementation(*iRegistryData, iImplementationUid,

																dummyUid, implementationData));

	return implementationData->iImplInfo;

	}

/**

The test executes by first Disabling the Implementation then by

Enabling it.

@SYMTestCaseID          SYSLIB-ECOM-CT-0727

@SYMTestCaseDesc	    Tests for enabling and disabling the Implementation

@SYMTestPriority 	    High

@SYMTestActions  	    Fetch the Implementation information for testing for iImplementationUid

                        Disable and enable the implementation for the unique UID

@SYMTestExpectedResults The test must not fail.

@SYMREQ                 REQ0000

*/

void CRegistrarTest::EnableDisableTestL()

	{

	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-0727 "));

	const CImplementationInformation *implimentationInfo = NULL;

	// Get the Implementation information for testing for iImplementationUid.

	// Implementation for iImplementationUid should be registered to

	// run this test successfully.

	TRAPD(err, implimentationInfo = GetImplementationDataL());

	::LeaveIfErrNoMemory(err);

	test(err == KErrNone);

	test(implimentationInfo != NULL);

	// Disable the implementaion

	err = iRegistrar->Disable(iImplementationUid);

	::LeaveIfErrNoMemory(err);

	test(KErrNone == err);

	test(implimentationInfo->Disabled());//It should be disabled

	// Enable the implementaion

	err = iRegistrar->Enable(iImplementationUid);

	::LeaveIfErrNoMemory(err);