sl@0: // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file contains test classes and their implementations
sl@0: // to test CDiscoverer will not discover plug-ins on C: and E:
sl@0: // if the two drives are disabled by the patchable constants.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @internalComponent
sl@0: */
sl@0: #include "RegistryData.h"
sl@0: #include "Discoverer.h"
sl@0: #include "ImplementationInformation.h"
sl@0: #include "RegistryData.h"
sl@0: #include "Registrar.h"
sl@0: #include "RegistrarObserver.h"
sl@0: #include "../EcomTestUtils/EcomTestUtils.h"
sl@0: #include "DriveInfo.h"
sl@0: #include "EComPatchDataConstantv2.h"
sl@0: 
sl@0: #include <e32test.h>
sl@0: #include <f32file.h>
sl@0: #include <bautils.h>
sl@0: #include <startup.hrh>
sl@0: 
sl@0: _LIT (KDataDir, "C:\\private\\10009D8F\\ECom*");
sl@0: 
sl@0: // plugins to discover
sl@0: _LIT(KNewResourceFileNameC, "C:\\resource\\plugins\\EComExample5.rsc");
sl@0: _LIT(KNewDllFileNameC, "C:\\sys\\bin\\EComExample5.dll");
sl@0: _LIT(KNewResourceFileNameZ, "z:\\RAMOnly\\EComExample5.rsc");
sl@0: _LIT(KNewDllFileNameZ,"z:\\RAMOnly\\EComExample5.dll");
sl@0: 
sl@0: const TInt KOneSecond = 1000000;
sl@0: 
sl@0: LOCAL_D RTest test(_L("Disable drives"));
sl@0: LOCAL_D RFs					TheFs;
sl@0: LOCAL_D CTrapCleanup* 		TheTrapCleanup 		= NULL;
sl@0: 
sl@0: class CDerivedActiveScheduler;
sl@0: LOCAL_D CDerivedActiveScheduler* TheActiveScheduler	= NULL;
sl@0: 
sl@0: LOCAL_D TInt oomStep;
sl@0: 
sl@0: //It is used by some test methods which are called two times:
sl@0: //from normal test and from OOM test.
sl@0: static void LeaveIfErrNoMemoryL(TInt aError)
sl@0: 	{
sl@0: 	if(aError == KErrNoMemory)
sl@0: 		{
sl@0: 		User::Leave(aError);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: // Copies the Plugins to specific folder for testing purpose
sl@0: LOCAL_C void CopyPlugins()
sl@0: 	{
sl@0: 	TInt err=KErrNone;
sl@0: 	TRAP(err, EComTestUtils::FileManCopyFileL(KNewResourceFileNameZ, KNewResourceFileNameC));
sl@0: 	test(err==KErrNone);
sl@0: 	TRAP(err, EComTestUtils::FileManCopyFileL(KNewDllFileNameZ, KNewDllFileNameC));
sl@0: 	test(err==KErrNone);
sl@0: 	}
sl@0: 
sl@0: // Deleting plugin from the RAM for cleanup purpose
sl@0: LOCAL_C void DeleteTestPlugin(TAny* /* aUnused */)
sl@0: 	{
sl@0: 	TInt err=KErrNone;
sl@0: 	TRAP(err, EComTestUtils::FileManDeleteFileL(KNewResourceFileNameC));
sl@0: 	TRAP(err, EComTestUtils::FileManDeleteFileL(KNewDllFileNameC));
sl@0: 	}
sl@0: 
sl@0: // flags indicating a set of pre-conditions to fullfil before running
sl@0: // CDisableDrivesTest.
sl@0: enum TPreTestSetup
sl@0: 	{
sl@0: 	EPreTest_UnitializeCachedDriveInfo = 0x1,
sl@0: 	EPreTest_EnableAllDrives = 0x2,
sl@0: 	EPreTest_CopyPlugins = 0x4
sl@0: 	};
sl@0: 
sl@0: const TUint32 KStartupDiscoveryDrivesDisabledMask =
sl@0: 	EPreTest_UnitializeCachedDriveInfo | EPreTest_CopyPlugins;
sl@0: 
sl@0: const TUint32 KStartupDiscoveryDrivesEnabledMask =
sl@0: 	EPreTest_EnableAllDrives | EPreTest_CopyPlugins;
sl@0: 
sl@0: const TUint32 KRediscoveryDrivesDisabledMask =
sl@0: 	EPreTest_UnitializeCachedDriveInfo;
sl@0: 
sl@0: const TUint32 KRediscoveryDrivesEnabledMask =
sl@0: 	EPreTest_EnableAllDrives;
sl@0: 
sl@0: /**
sl@0: TRegistryData_StateAccessor class allows access to private and protected
sl@0: members of production code class CRegistryData, as its a friend class.
sl@0: */
sl@0: class TRegistryData_StateAccessor
sl@0: 	{
sl@0: public:
sl@0: 	TInt FindImplementation(CRegistryData& aRegistryData,
sl@0: 				const TUid aImplUid,
sl@0: 				const TUid aInterfaceUid,
sl@0: 				CRegistryData::CImplementationData*& aImplData) const;
sl@0: 	};
sl@0: 
sl@0: /** TRegistrar_StateAccessor class allows access to private members
sl@0: of CRegistrar. */
sl@0: class TRegistrar_StateAccessor
sl@0: 	{
sl@0: 	static void SetCompletedStateL(CRegistrar& aRegistrar,
sl@0: 								   TStartupStateIdentifier aKnownState);
sl@0: 	};
sl@0: 
sl@0: /** TDiscoverer_StateAccessor allows manipulation of CDiscoverer
sl@0: private members. */
sl@0: class TDiscoverer_StateAccessor
sl@0: 	{
sl@0: 	static void SetCompletedStateL(CDiscoverer& aDiscoverer,
sl@0: 								   CDiscoverer::TDiscovererState aState);
sl@0: 	};
sl@0: 
sl@0: /** TDriveInfo_StateAccessor class allows access to private members
sl@0: of CEComCachedDriveInfo. */
sl@0: class TDriveInfo_StateAccessor
sl@0: 	{
sl@0: public:
sl@0: 	static void ClearCachedDriveInfo();
sl@0: 
sl@0: 	static void SetDriveDisableMaskL(TUint32 aMask);
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @return		KErrNone if found otherwise KErrNotFound
sl@0: @param		aRegistryData The CRegistryData class object
sl@0: @param		aImplUid The implementation to find.
sl@0: @param		aInterfaceUid If greater than 0 the interface associated with the
sl@0: 			implementation to find.
sl@0: @param		aImplData The found implementation data.
sl@0: @pre 		CRegistrar is fully constructed
sl@0: */
sl@0: TInt TRegistryData_StateAccessor::FindImplementation(CRegistryData& aRegistryData,
sl@0: 												const TUid aImplUid,
sl@0: 												const TUid aInterfaceUid,
sl@0: 												CRegistryData::CImplementationData*& aImplData) const
sl@0: 	{
sl@0: 	return aRegistryData.FindImplementation(aImplUid, aInterfaceUid, aImplData);
sl@0: 	}
sl@0: 
sl@0: /** Mark the static drive info array uninitialized. Then the
sl@0: next instantiation of CEComCachedDriveInfo will need to setup
sl@0: the drive info again.
sl@0: */
sl@0: void TDriveInfo_StateAccessor::ClearCachedDriveInfo()
sl@0: 	{
sl@0: 	CEComCachedDriveInfo::iInitialized = EFalse;
sl@0: 	}
sl@0: 
sl@0: /** Instantiate a CEComCachedDriveInfo object with a special drive
sl@0: mask. The object is destroyed right away but the static drive info
sl@0: array is fixed to the special mask.
sl@0: @param aMask the drive disable mask to set.
sl@0: */
sl@0: void TDriveInfo_StateAccessor::SetDriveDisableMaskL(TUint32 aMask)
sl@0: 	{
sl@0: 	// Set this bool to false otherwise ConstructL will do nothing.
sl@0: 	CEComCachedDriveInfo::iInitialized = EFalse;
sl@0: 
sl@0: 	CEComCachedDriveInfo* ptr = new (ELeave) CEComCachedDriveInfo();
sl@0: 	CleanupStack::PushL(ptr);
sl@0: 	ptr->ConstructL(TheFs, aMask);
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: /** Need a CActive to wait for CDiscoverer dir change notifiers. */
sl@0: class CSimpleTimer : public CTimer
sl@0: 	{
sl@0: public:
sl@0: 	inline CSimpleTimer(TInt aPriority);
sl@0: 	inline void ConstructL();
sl@0: 	inline void StartTimer(TTimeIntervalMicroSeconds32 aTimeInterval);
sl@0: 
sl@0: private:
sl@0: 	void RunL();
sl@0: 	};
sl@0: 
sl@0: inline CSimpleTimer::CSimpleTimer(TInt aPriority)
sl@0: 	: CTimer(aPriority)
sl@0: 	{
sl@0: 	CActiveScheduler::Add(this);
sl@0: 	}
sl@0: 
sl@0: inline void CSimpleTimer::ConstructL()
sl@0: 	{
sl@0: 	CTimer::ConstructL();
sl@0: 	}
sl@0: 
sl@0: inline void CSimpleTimer::StartTimer(TTimeIntervalMicroSeconds32 aTimeInterval)
sl@0: 	{
sl@0: 	After(aTimeInterval);
sl@0: 	}
sl@0: 
sl@0: void CSimpleTimer::RunL()
sl@0: 	{
sl@0: 	CActiveScheduler::Stop();
sl@0: 	}
sl@0: 
sl@0: /** Avoid E32User::Case 47 panic in OOM test */
sl@0: class CDerivedActiveScheduler : public CActiveScheduler
sl@0: 	{
sl@0: public:
sl@0: 	virtual void Error(TInt aError) const;
sl@0: 	};
sl@0: 
sl@0: void CDerivedActiveScheduler::Error(TInt aError) const
sl@0: 	{
sl@0: 	Halt(aError);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The implementation of the abstract Registrar Observer class,
sl@0: used for recieving notifications of registry changes.
sl@0: Stub class(for CEComServer) used for the creation of CRegistrar class object.
sl@0: CEComServer class acts as observer for CRegistrar.
sl@0: */
sl@0: class CTestRegistrarObserver : public MRegistrarObserver // codescanner::missingcclass
sl@0: 	{
sl@0: public:
sl@0: 	// This function is used by RegistrarObserver (i.e.CEComServer) to notify its
sl@0: 	// clients(REComSession objects) that some change has happened in Registry.
sl@0: 	// Here we have no clients to notify, so no implementaion.
sl@0: 	void Notification( TInt /*aNotification*/ ) {}
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: Test class for object CRegistrar.
sl@0: This class provides the parameters and behaviour that
sl@0: allows this class to behave normally under a test
sl@0: scenario.
sl@0: */
sl@0: class CDisableDrivesTest : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static CDisableDrivesTest* NewL(TBool aDrivesEnabled);
sl@0: 	virtual ~CDisableDrivesTest();
sl@0: 	void startupDiscoveryL();
sl@0: 	void RediscoveryL();
sl@0: 
sl@0: private:
sl@0: 	CDisableDrivesTest(TBool aDrivesEnabled);
sl@0: 	void ConstructL();
sl@0: 	void WaitForDiscovererAOL();
sl@0: 
sl@0: public:
sl@0: 	/** The instance of the class under test */
sl@0: 	CRegistrar* iRegistrar;
sl@0: 
sl@0: 	/** The instance of the State Accessor class */
sl@0: 	TRegistrar_StateAccessor* iStateAccessor;
sl@0: 
sl@0: 	/** The registry data instance required to construct a CRegistrar object */
sl@0: 	CRegistryData* iRegistryData;
sl@0: 
sl@0: 	/** The instance of the Registry Data State Accessor class */
sl@0: 	TRegistryData_StateAccessor* iRegistryDataStateAccessor;
sl@0: 
sl@0: 	/** The instance of the observer of CRegistrar class */
sl@0: 	MRegistrarObserver* iRegistrarObserver;
sl@0: 
sl@0: 	/** The destination for the data discovered during a parse */
sl@0: 	CRegistryData::CDllData* iDllData;
sl@0: 
sl@0: 	/** Unique Id of the ECOM dll */
sl@0: 	TUid    iDllUid;
sl@0: 
sl@0: 	/** Unique Id of an interface implementation */
sl@0: 	TUid	iImplementationUid;
sl@0: 
sl@0: 	/** Unique Id of an interface */
sl@0: 	TUid	iInterfaceUid;
sl@0: 
sl@0: 	/** The drive on which interface implementations can be found */
sl@0: 	TDriveUnit	iDriveUnit;
sl@0: 
sl@0: 	/** Ecom plugin which contains interface implementations. Used in Registration APIs.*/
sl@0: 	TEntry		iDllEntry;
sl@0: 
sl@0: 	TBool		iDrivesEnabled;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: Standardised safe construction which
sl@0: leaves nothing on the cleanup stack.
sl@0: 
sl@0: @post		CDisableDrivesTest is fully constructed and initialised.
sl@0: */
sl@0: CDisableDrivesTest* CDisableDrivesTest::NewL(TBool aDrivesEnabled)
sl@0: 	{
sl@0: 	CDisableDrivesTest* self = new (ELeave) CDisableDrivesTest(aDrivesEnabled);
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standardized default c'tor
sl@0: 
sl@0: @post		CDisableDrivesTest is fully constructed.
sl@0: */
sl@0: CDisableDrivesTest::CDisableDrivesTest(TBool aDrivesEnabled)
sl@0: :	CBase(),
sl@0: 	iDriveUnit(EDriveC),
sl@0: 	iDrivesEnabled(aDrivesEnabled)
sl@0: 	{
sl@0: 	iDllUid.iUid			= 0x101F847B; // Dlluid for Ecom plugin EComExample5.dll
sl@0: 	iInterfaceUid.iUid		= 0x10009DC0; // Interface uid for interface contained in above plugin
sl@0: 	iImplementationUid.iUid = 0x101f847C; // Implementaion uid for above interface
sl@0: 	TUid uid1 = {0};
sl@0: 	TUid uid2 = {0};
sl@0: 	iDllEntry.iType = TUidType(uid1, uid2, iDllUid);//Setting Dlluid to plugin entry
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Destructor.
sl@0: 
sl@0: @post		This object is properly destroyed.
sl@0: */
sl@0: CDisableDrivesTest::~CDisableDrivesTest()
sl@0: 	{
sl@0: 	delete iDllData;
sl@0: 	delete iRegistrar;
sl@0: 	delete iRegistryData;
sl@0: 	delete iRegistrarObserver;
sl@0: 	delete iStateAccessor;
sl@0: 	delete iRegistryDataStateAccessor;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standardized 2nd(Initialization) phase of two phase construction.
sl@0: 
sl@0: @post		CDisableDrivesTest is fully constructed.
sl@0: */
sl@0: void CDisableDrivesTest::ConstructL()
sl@0: 	{
sl@0: 	CRegistryData::CDriveData* driveData=NULL;
sl@0: 	iRegistrarObserver = new (ELeave) CTestRegistrarObserver;
sl@0: 	iStateAccessor	   = new (ELeave) TRegistrar_StateAccessor;
sl@0: 	iRegistryDataStateAccessor	   = new (ELeave) TRegistryData_StateAccessor;
sl@0: 	iRegistryData	   = CRegistryData::NewL(TheFs);
sl@0: 	iRegistrar		   = CRegistrar::NewL(*iRegistryData, *iRegistrarObserver, TheFs);
sl@0: 	iDllData		   = CRegistryData::CDllData::NewLC(driveData);
sl@0: 	CleanupStack::Pop(iDllData);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID		SYSLIB-ECOM-CT-3541
sl@0: @SYMTestCaseDesc 	Verify ECOM's patchdata scheme works.
sl@0: @SYMTestPriority 	High
sl@0: @SYMTestActions  	Check the value of the constant KDiscoveryDisabledDriveList.
sl@0: @SYMTestExpectedResults It should be 0x14 in hw.
sl@0: @SYMCR CR1049
sl@0: */
sl@0: void PatchableConstantTest()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-3541 Patch constant value "));
sl@0: 
sl@0: 	// check the patchable constant has the patched value.
sl@0: #ifdef __ARMCC__
sl@0: 	test(KDiscoveryDisabledDriveList == 0x14);
sl@0: #else
sl@0: 	// On emulator the constant is not patchable. Thus the RTest links
sl@0: 	// with a different .cpp file.
sl@0: 	test(KDiscoveryDisabledDriveList == 0x00800004);
sl@0: #endif
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID		SYSLIB-ECOM-CT-4014
sl@0: @SYMTestCaseDesc 	Check that the patchables for custom resolver caching
sl@0:     can be patched.
sl@0: @SYMTestPriority 	High
sl@0: @SYMTestActions  	Check the values of KCustomResolverCacheSize and
sl@0: 	KCustomResolverCacheTimeout
sl@0: @SYMTestExpectedResults disabledrivestest.hby sets KCustomResolverCacheSize
sl@0: 	to 1182 and KCustomResolverCacheTimeout to 4001182. Note that this test
sl@0: 	only runs on hw.
sl@0: @SYMCR CR1182
sl@0: */
sl@0: void CR1182PatchableConstantTest()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-4014 CR1182 patchable constants "));
sl@0: 
sl@0: 	// check the patchable constants have the patched values.
sl@0: #ifdef __ARMCC__
sl@0: 	test(KCustomResolverCacheSize == 1182);
sl@0: 	test(KCustomResolverCacheTimeout == 4001182);
sl@0: #else
sl@0: 	test.Printf(_L("This test only runs in armv5."));
sl@0: #endif
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID		SYSLIB-ECOM-CT-3542
sl@0: @SYMTestCaseDesc 	Check that CDiscoverer will not discover plug-ins in disabled drives at boot time.
sl@0: @SYMTestPriority 	High
sl@0: @SYMTestActions  	Use CRegistrar::ProcessSSAEventL to trigger boot up discovery.
sl@0: @SYMTestExpectedResults No plugins registered if C: drive is disabled. In the
sl@0: 	control test, C: is enabled and the plugin is registered.
sl@0: @SYMCR CR1049
sl@0: */
sl@0: void CDisableDrivesTest::startupDiscoveryL()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-3542 "));
sl@0: 
sl@0: 	// Do not scan ReadOnly internal drive in OOM. Will take an hour.
sl@0: 	__UHEAP_SETFAIL(RHeap::ENone, 0);
sl@0: 
sl@0: 	iRegistrar->ProcessSSAEventL(EStartupStateCriticalStatic);
sl@0: 
sl@0: 	if (oomStep)
sl@0: 		{
sl@0: 		__UHEAP_SETFAIL(RHeap::EDeterministic, oomStep);
sl@0: 		}
sl@0: 
sl@0: 	iRegistrar->ProcessSSAEventL(EStartupStateNonCritical);
sl@0: 
sl@0: 	CRegistryData::CImplementationData *implementationData=NULL;
sl@0: 	TUid dummyUid;
sl@0: 	dummyUid.iUid = 0;
sl@0: 
sl@0: 	TInt err = iRegistryDataStateAccessor->FindImplementation(*iRegistryData, iImplementationUid, dummyUid, implementationData);
sl@0: 	::LeaveIfErrNoMemoryL(err);
sl@0: 
sl@0: 	if (iDrivesEnabled)
sl@0: 		{
sl@0: 		test(err == KErrNone);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		test(err == KErrNotFound);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID		SYSLIB-ECOM-CT-3543
sl@0: @SYMTestCaseDesc 	Check that CDiscoverer will not discover plug-ins via dir
sl@0: 	change notification if drive is disabled.
sl@0: @SYMTestPriority 	High
sl@0: @SYMTestActions  	After startup discovery completed, copy .rsc to
sl@0: 	C:\resource\plugins and the .dll to C:\sys\bin.
sl@0: @SYMTestExpectedResults The plugin is not registered if C: is disabled. In the
sl@0: 	control test, C: is enabled and the plugin is registered.
sl@0: @SYMCR CR1049
sl@0: */
sl@0: void CDisableDrivesTest::RediscoveryL()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-3543 "));
sl@0: 	// Do not scan ReadOnly internal drive in OOM. Will take an hour.
sl@0: 	__UHEAP_SETFAIL(RHeap::ENone, 0);
sl@0: 
sl@0: 	iRegistrar->ProcessSSAEventL(EStartupStateNonCritical);
sl@0: 
sl@0: 	if (oomStep)
sl@0: 		{
sl@0: 		__UHEAP_SETFAIL(RHeap::EDeterministic, oomStep);
sl@0: 		}
sl@0: 
sl@0: 	CopyPlugins();
sl@0: 	CleanupStack::PushL(TCleanupItem(DeleteTestPlugin, NULL));
sl@0: 
sl@0: 	WaitForDiscovererAOL();
sl@0: 
sl@0: 	CRegistryData::CImplementationData *implementationData=NULL;
sl@0: 	TUid dummyUid = KNullUid;
sl@0: 
sl@0: 	TInt err = iRegistryDataStateAccessor->FindImplementation(*iRegistryData, iImplementationUid, dummyUid, implementationData);
sl@0: 	::LeaveIfErrNoMemoryL(err);
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(1);
sl@0: 
sl@0: 	if (iDrivesEnabled)
sl@0: 		{
sl@0: 		test(err == KErrNone);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		test(err == KErrNotFound);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CDisableDrivesTest::WaitForDiscovererAOL()
sl@0: 	{
sl@0: 	// Yield priority to CDiscoverer's AO
sl@0: 	CSimpleTimer* timer = new(ELeave) CSimpleTimer(CActive::EPriorityLow);
sl@0: 	CleanupStack::PushL(timer);
sl@0: 	timer->ConstructL();
sl@0: 	timer->StartTimer(KOneSecond * 2);
sl@0: 	CActiveScheduler::Start();
sl@0: 	CleanupStack::PopAndDestroy(timer);
sl@0: 	}
sl@0: 
sl@0: typedef void (CDisableDrivesTest::*ClassFuncPtrL) (void);
sl@0: 
sl@0: /**
sl@0: Wrapper function to call all test functions
sl@0: 
sl@0: @param	aTestFuncL pointer to test function
sl@0: @param	aUseZeroMask if false, let the test use the patchable constant else
sl@0: 	initialize the static drive info array with zero, i.e. enabled all.
sl@0: @param	aTestDesc test function name
sl@0: */
sl@0: LOCAL_C void DoBasicTestL(ClassFuncPtrL aTestFuncL, const TUint32 aTaskMask, const TDesC& aTestDesc)
sl@0: 	{
sl@0: 	test.Next(aTestDesc);
sl@0: 
sl@0: 	__UHEAP_MARK;
sl@0:   	// find out the number of open handles
sl@0: 	TInt startProcessHandleCount;
sl@0: 	TInt startThreadHandleCount;
sl@0: 	RThread().HandleCount(startProcessHandleCount, startThreadHandleCount);
sl@0: 
sl@0: 	// A series of tasks to perform before calling the test method.
sl@0: 
sl@0: 	// Delete the previous data files to ensure rediscover from scratch
sl@0: 	TRAP_IGNORE(EComTestUtils::FileManDeleteFileL(KDataDir));
sl@0: 
sl@0: 	// The two flags below are mutually exclusive.
sl@0: 	if (aTaskMask & EPreTest_UnitializeCachedDriveInfo)
sl@0: 		{
sl@0: 		TDriveInfo_StateAccessor::ClearCachedDriveInfo();
sl@0: 		}
sl@0: 	else if (aTaskMask & EPreTest_EnableAllDrives)
sl@0: 		{
sl@0: 		TDriveInfo_StateAccessor::SetDriveDisableMaskL(0);
sl@0: 		}
sl@0: 
sl@0: 	if (aTaskMask & EPreTest_CopyPlugins)
sl@0: 		{
sl@0: 		CopyPlugins();
sl@0: 		User::After(KOneSecond);
sl@0: 		CleanupStack::PushL(TCleanupItem(DeleteTestPlugin, NULL));
sl@0: 		}
sl@0: 
sl@0: 	// All set to start the test
sl@0: 	TBool drivesEnabled = (aTaskMask & EPreTest_EnableAllDrives) != 0;
sl@0: 	CDisableDrivesTest* disableDrvTest = CDisableDrivesTest::NewL(drivesEnabled);
sl@0: 	CleanupStack::PushL(disableDrvTest);
sl@0: 
sl@0: 	(disableDrvTest->*aTestFuncL)();
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(disableDrvTest);
sl@0: 
sl@0: 	if (aTaskMask & EPreTest_CopyPlugins)
sl@0: 		{
sl@0: 		CleanupStack::PopAndDestroy(1);
sl@0: 		}
sl@0: 
sl@0: 	// check that no handles have leaked
sl@0: 	TInt endProcessHandleCount;
sl@0: 	TInt endThreadHandleCount;
sl@0: 	RThread().HandleCount(endProcessHandleCount, endThreadHandleCount);
sl@0: 
sl@0: 	test(startProcessHandleCount == endProcessHandleCount);
sl@0: 	test(startThreadHandleCount  == endThreadHandleCount);
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Wrapper function to call all OOM test functions
sl@0: 
sl@0: @param aTestFuncL pointer to OOM test function
sl@0: @param aTaskMask  indicates tasks need to be done before entering
sl@0: 	the OOM loop.
sl@0: @param	aTestDesc test function name
sl@0: */
sl@0: //LOCAL_C void DoOOMTestL(ClassFuncPtrL aTestFuncL,
sl@0: //						const TUint32 aTaskMask,
sl@0: //						const TDesC& aTestDesc)
sl@0: //	{
sl@0: //	test.Next(aTestDesc);
sl@0: 
sl@0: //	TInt err(KErrNone);
sl@0: 	// A series of tasks to perform before calling the test method.
sl@0: 
sl@0: 	// Delete the previous data files to ensure rediscover from scratch
sl@0: //	TRAP(err, EComTestUtils::FileManDeleteFileL(KDataDir));
sl@0: 
sl@0: 	// The two flags below are mutually exclusive.
sl@0: //	if (aTaskMask & EPreTest_UnitializeCachedDriveInfo)
sl@0: //		{
sl@0: //		TDriveInfo_StateAccessor::ClearCachedDriveInfo();
sl@0: //		}
sl@0: //	else if (aTaskMask & EPreTest_EnableAllDrives)
sl@0: //		{
sl@0: //		TDriveInfo_StateAccessor::SetDriveDisableMaskL(0);
sl@0: //		}
sl@0: 
sl@0: //	if (aTaskMask & EPreTest_CopyPlugins)
sl@0: //		{
sl@0: //		CopyPlugins();
sl@0: //		User::After(KOneSecond);
sl@0: //		CleanupStack::PushL(TCleanupItem(DeleteTestPlugin, NULL));
sl@0: //		}
sl@0: 
sl@0: //	TBool drivesEnabled = (aTaskMask & EPreTest_EnableAllDrives) != 0;
sl@0: //	oomStep = 0;
sl@0: 
sl@0: //	do
sl@0: //		{
sl@0: //		__UHEAP_MARK;
sl@0:   		// find out the number of open handles
sl@0: //		TInt startProcessHandleCount;
sl@0: //		TInt startThreadHandleCount;
sl@0: //		RThread().HandleCount(startProcessHandleCount, startThreadHandleCount);
sl@0: 
sl@0: 		// Need to create object here as ECom has embedded TRAPs
sl@0: 		// that will fail the test if memory not available
sl@0: //		CDisableDrivesTest* disableDrvTest = CDisableDrivesTest::NewL(drivesEnabled);
sl@0: //		CleanupStack::PushL(disableDrvTest);
sl@0: 
sl@0: 		// Setting Heap failure for OOM test
sl@0: //		__UHEAP_SETFAIL(RHeap::EDeterministic, ++oomStep);
sl@0: 
sl@0: //		TRAP(err, (disableDrvTest->*aTestFuncL)());
sl@0: 
sl@0: //		__UHEAP_SETFAIL(RHeap::ENone, 0);
sl@0: 
sl@0: //		CleanupStack::PopAndDestroy(disableDrvTest);
sl@0: //		disableDrvTest = NULL;
sl@0: 
sl@0: 		// check that no handles have leaked
sl@0: //		TInt endProcessHandleCount;
sl@0: //		TInt endThreadHandleCount;
sl@0: //		RThread().HandleCount(endProcessHandleCount, endThreadHandleCount);
sl@0: 
sl@0: //		test(startProcessHandleCount == endProcessHandleCount);
sl@0: //		test(startThreadHandleCount  == endThreadHandleCount);
sl@0: 
sl@0: //		__UHEAP_MARKEND;
sl@0: //		} while(err == KErrNoMemory);
sl@0: 
sl@0: //	if (aTaskMask & EPreTest_CopyPlugins)
sl@0: //		{
sl@0: //		CleanupStack::PopAndDestroy(1);
sl@0: //		}
sl@0: 
sl@0: //	test(err == KErrNone);
sl@0: //	test.Printf(_L("- server succeeded at heap failure rate of %i\n"), oomStep);
sl@0: //	}
sl@0: 
sl@0: LOCAL_C void DoTestsL()
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 
sl@0: 	// Basic tests
sl@0: 	PatchableConstantTest();
sl@0: 	CR1182PatchableConstantTest();
sl@0: 
sl@0: 	DoBasicTestL(&CDisableDrivesTest::startupDiscoveryL,
sl@0: 				KStartupDiscoveryDrivesDisabledMask,
sl@0: 				_L("startupDiscoveryL scan disabled"));
sl@0: 
sl@0: 	// Control step to proof that the method is sound.
sl@0: 	DoBasicTestL(&CDisableDrivesTest::startupDiscoveryL,
sl@0: 				KStartupDiscoveryDrivesEnabledMask,
sl@0: 				_L("startupDiscoveryL scan enabled"));
sl@0: 
sl@0: 	DoBasicTestL(&CDisableDrivesTest::RediscoveryL,
sl@0: 				KRediscoveryDrivesDisabledMask,
sl@0: 				_L("RediscoveryL scan disabled"));
sl@0: 
sl@0: 	// Control step to proof that the method is sound.
sl@0: 	DoBasicTestL(&CDisableDrivesTest::RediscoveryL,
sl@0: 				KRediscoveryDrivesEnabledMask,
sl@0: 				_L("RediscoveryL scan enabled"));
sl@0: 
sl@0: 	// OOM tests are left in here as instructed by the component owner.
sl@0: 	// In case we need to investigate OOM issues in the future then the
sl@0: 	// SWE can follow the instructions below to run OOM test manually:
sl@0: 	//
sl@0: 	// CDiscoverer::CDirScanner::DoScanDriveL in discoverer.cpp ignores
sl@0: 	// all errors from RFs::GetDir().
sl@0: 	// Go there and manually add if (error == KErrNoMemory) User::LeaveNoMemory()
sl@0: 	// Also the three RunError of the CActive in discoverer.cpp need to return
sl@0: 	// KErrNoMemory instead of panic.
sl@0: 	// NB: after adding the above changes, some OOM tests in t_discoverer and
sl@0: 	// t_registrar will timeout in ONB (RTests are given 40 minutes to run but OOM
sl@0: 	// test on discovery takes couple hours).
sl@0: 	// But if these changes are manual and not submitted in perforce, then
sl@0: 	// there is no effect on ONB.
sl@0: 
sl@0: //	DoOOMTestL(&CDisableDrivesTest::startupDiscoveryL,
sl@0: //				KStartupDiscoveryDrivesDisabledMask,
sl@0: //				_L("OOM startupDiscoveryL scan disabled"));
sl@0: 
sl@0: //	DoOOMTestL(&CDisableDrivesTest::startupDiscoveryL,
sl@0: //				KStartupDiscoveryDrivesEnabledMask,
sl@0: //				_L("OOM startupDiscoveryL scan enabled"));
sl@0: 
sl@0: //	DoOOMTestL(&CDisableDrivesTest::RediscoveryL,
sl@0: //				KRediscoveryDrivesDisabledMask,
sl@0: //				_L("OOM RediscoveryL scan disabled"));
sl@0: 
sl@0: 	// Control step to proof that the method is sound.
sl@0: //	DoOOMTestL(&CDisableDrivesTest::RediscoveryL,
sl@0: //				KRediscoveryDrivesEnabledMask,
sl@0: //				_L("OOM RediscoveryL scan enabled"));
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: //Initialise the Active Scheduler
sl@0: LOCAL_C void SetupL()
sl@0: 	{
sl@0: 	// Construct and install the Active Scheduler. The Active Schedular is needed
sl@0: 	// by components used by this test as they are ActiveObjects.
sl@0: 	TheActiveScheduler = new(ELeave)CDerivedActiveScheduler;
sl@0: 	CActiveScheduler::Install(TheActiveScheduler);
sl@0: 	}
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 
sl@0: 	test.Printf(_L("\n"));
sl@0: 	test.Title();
sl@0: 	test.Start( _L("Disable scanning on selected drives via patchable constant") );
sl@0: 
sl@0: 	TheTrapCleanup = CTrapCleanup::New();
sl@0: 
sl@0: 	// Connect the file server instance
sl@0: 	User::LeaveIfError(TheFs.Connect());
sl@0: 
sl@0: 	TRAPD(err, SetupL());
sl@0: 	test(err == KErrNone);
sl@0: 
sl@0: 	// Call the main tests
sl@0: 	TRAP(err, DoTestsL());
sl@0: 	test(err == KErrNone);
sl@0: 
sl@0: 	delete TheActiveScheduler;
sl@0: 	delete TheTrapCleanup;
sl@0: 
sl@0: 	TheFs.Close();
sl@0: 
sl@0: 	test.End();
sl@0: 	test.Close();
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	return (KErrNone);
sl@0: 	}