sl@0: // Copyright (c) 2005-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: // t_validateRegistrty.cpp
sl@0: // This file contains the code to test the feature of validate registry for ECom when only a
sl@0: // RSC file is removed. It is for DEF073338: ECom Incorrectly Validates Registry using DLL Existence
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32test.h>
sl@0: #include <e32panic.h>
sl@0: #include <f32file.h>
sl@0: #include <bautils.h>
sl@0: #include "../EcomTestUtils/EcomTestUtils.h"
sl@0: 
sl@0: #include <ecom/ecom.h>
sl@0: #include "EComUidCodes.h"
sl@0: #include "Interface.h" // interface to Plugins
sl@0: #define UNUSED_VAR(a) a = a
sl@0: 
sl@0: // RAM Only RSC and DLL for testing purpose.
sl@0: _LIT(KEComPluginDLL,		"Z:\\RAMOnly\\DefectPlugin.dll");
sl@0: _LIT(KEComPluginRSC,		"Z:\\RAMOnly\\DefectPlugin.rsc");
sl@0: 
sl@0: _LIT(KEComPluginDLLOnC,			"C:\\sys\\bin\\DefectPlugin.dll");
sl@0: _LIT(KEComPluginRSCOnC,			"C:\\Resource\\Plugins\\DefectPlugin.rsc");
sl@0: // This Rsc file is just used to trigger a ECom rediscovery.
sl@0: _LIT(KEComInvalidRscOnZ, "z:\\RAMOnly\\InvalidSIDPlugin.rsc");
sl@0: _LIT(KEComInvalidRscOnC, "c:\\resource\\plugins\\InvalidSIDPlugin.rsc");
sl@0: 
sl@0: const TInt KOneSecond = 1000000;
sl@0: 
sl@0: LOCAL_D RTest test(_L("t_validateRegistry.exe"));
sl@0: 
sl@0: /**
sl@0: Kill Ecom Server for testing purposes
sl@0: */
sl@0: static void KillEComServerL()
sl@0: 	{
sl@0: 	//Need to ensure that the EComServer process is killed before even starting this test by using
sl@0:    	//the EComTestUtils library
sl@0:    	_LIT(KEComServerProcessName,"ecomserver");
sl@0:    	TRAPD(error, EComTestUtils::KillProcessL(KEComServerProcessName));
sl@0:    	UNUSED_VAR(error);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Copies the Plugins to specific folder for testing purpose
sl@0: */
sl@0: LOCAL_C void CopyPlugin()
sl@0: 	{
sl@0: 	test.Printf(_L("\nCopying plugins into C drive... "));
sl@0: 	TInt err=KErrNone;
sl@0: 	TRAP(err, EComTestUtils::FileManCopyFileL(KEComPluginDLL, KEComPluginDLLOnC));
sl@0: 	test(err==KErrNone);
sl@0: 	TRAP(err, EComTestUtils::FileManCopyFileL(KEComPluginRSC, KEComPluginRSCOnC));
sl@0: 	test(err==KErrNone);
sl@0: 	// Give ECOM a chance to discover new plugins.
sl@0: 	// Otherwise ListImplementationsL could fail to find requested implementations.
sl@0: 	User::After(KOneSecond * 3);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Deletes Plugin from the RAM for cleanup purpose
sl@0: */
sl@0: LOCAL_C void DeletePlugin()
sl@0: 	{
sl@0: 	test.Printf(_L("\nRemoving plugins to clean environment... "));
sl@0: 	TInt err=KErrNone;
sl@0: 	TRAP(err, EComTestUtils::FileManDeleteFileL(KEComPluginDLLOnC));
sl@0: 	test(err==KErrNone || err==KErrNotFound);
sl@0: 	TRAP(err, EComTestUtils::FileManDeleteFileL(KEComPluginRSCOnC));
sl@0: 	test(err==KErrNone || err==KErrNotFound);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID			SYSLIB-ECOM-CT-1489
sl@0: @SYMTestCaseDesc		Tests to ensure that only the RSC file is deleted, then the corresponding
sl@0: 						DLL should be deleted from the registry.
sl@0: 
sl@0: @SYMTestPriority		High
sl@0: @SYMTestActions			First kill the ECom Server, then copy the plugin to C drive.
sl@0: 						Next call REComSession::ListImplementations() to start up ecom server
sl@0: 						and check the discovery result. delete the plugin RSC file, which
sl@0: 						triggers ecom rediscovery.
sl@0: 						Now call REComSession::ListImplementations() and check if the
sl@0: 						plugin is deleted.
sl@0: @SYMTestExpectedResults	The test must not fail.
sl@0: */
sl@0: 
sl@0: /**
sl@0: The following plugin will be used for test and copied to the C drive.
sl@0: 
sl@0: Interface UID		DLL	UID		Imp. UID	Version		DllFile                                  RSCFile
sl@0: ------------------------------------------------------------------------------------------------------------------------------------------
sl@0: 0x102797A1		0x102797A0	0x102797A2	      1			C:\\sys\\bin\\DefectPlugin.dll      C:\\resource\\plugins\\DefectPlugin.RSC
sl@0: 
sl@0: **/
sl@0: 
sl@0: LOCAL_C void ValidateRegistryAgainstRscL()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-1489 "));
sl@0: 	__UHEAP_MARK;
sl@0: 	// before strating the test, kill the EcomServer which is probably running from
sl@0: 	// the previous tests.
sl@0: 	KillEComServerL();
sl@0: 	DeletePlugin();
sl@0: 	// copy the plugin to C drive.
sl@0: 	CopyPlugin();
sl@0: 
sl@0: 	TUid interfaceUid={0x102797A1};
sl@0: 	RImplInfoPtrArray implArray;
sl@0: 	// normal discovery, ECom should discover the plugin
sl@0: 	REComSession::ListImplementationsL(interfaceUid, implArray);
sl@0: 
sl@0: 	test(implArray.Count()==1);
sl@0: 	//Check that the implementation uid returned matched the specs above
sl@0: 	TUid implUid = implArray[0]->ImplementationUid();
sl@0: 	TInt version = implArray[0]->Version();
sl@0: 	TInt drive = implArray[0]->Drive();
sl@0: 	// imp. uid
sl@0: 	test(implUid.iUid == 0x102797A2);
sl@0: 	// version
sl@0: 	test(version == 1);
sl@0: 	// C drive
sl@0: 	test(drive == EDriveC);
sl@0: 
sl@0: 	// ECom Server is running.
sl@0: 	// Delete the plugin RSC file but not the corresponding DLL file, ECom rediscovery is triggered.
sl@0: 	TRAPD(err, EComTestUtils::FileManDeleteFileL(KEComPluginRSCOnC));
sl@0: 	test(err==KErrNone);
sl@0: 
sl@0: 	// Give ECOM a chance to do the rediscovery.
sl@0: 	// Otherwise ListImplementationsL could fail.
sl@0: 	User::After(KOneSecond * 3);
sl@0: 	REComSession::ListImplementationsL(interfaceUid, implArray);
sl@0: 	// Since the RSC file is deleted, the corresponding DLL should be deleted
sl@0: 	// from the ECom registry.
sl@0: 	test(implArray.Count()==0);
sl@0: 
sl@0: 	//clean up
sl@0: 	implArray.ResetAndDestroy();
sl@0: 	REComSession::FinalClose();
sl@0: 	KillEComServerL();
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID			SYSLIB-ECOM-CT-1490
sl@0: @SYMTestCaseDesc		Tests to ensure that if the DLL file is deleted and trigger a ECom rediscovery, then the corresponding
sl@0: 						DLL should be deleted from the registry.
sl@0: 
sl@0: @SYMTestPriority		High
sl@0: @SYMTestActions			First kill the ECom Server, then copy the plugin to C drive.
sl@0: 						Next call REComSession::ListImplementations() to start up ecom server
sl@0: 						and check the discovery result. delete the plugin DLL file, and copy a RSC file to
sl@0: 						c:\resource\plugins\,which triggers ecom rediscovery.
sl@0: 						Now call REComSession::ListImplementations() and check if the
sl@0: 						plugin is deleted.
sl@0: @SYMTestExpectedResults	The test must not fail.
sl@0: */
sl@0: 
sl@0: /**
sl@0: The following plugin will be used for test and copied to the C drive.
sl@0: 
sl@0: Interface UID		DLL	UID		Imp. UID	Version		DllFile                                  RSCFile
sl@0: ------------------------------------------------------------------------------------------------------------------------------------------
sl@0: 0x102797A1		0x102797A0	0x102797A2	      1			C:\\sys\\bin\\DefectPlugin.dll      C:\\resource\\plugins\\DefectPlugin.RSC
sl@0: 
sl@0: **/
sl@0: LOCAL_C void ValidateRegistryAgainstDllL()
sl@0: 	{
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-1490 "));
sl@0: 	__UHEAP_MARK;
sl@0: 	// before strating the test, kill the EcomServer which is probably running from
sl@0: 	// the previous tests.
sl@0: 	KillEComServerL();
sl@0: 	// copy the plugin to C drive.
sl@0: 	CopyPlugin();
sl@0: 
sl@0: 	TUid interfaceUid={0x102797A1};
sl@0: 	RImplInfoPtrArray implArray;
sl@0: 	// normal discovery, ECom should discover the plugin
sl@0: 	REComSession::ListImplementationsL(interfaceUid, implArray);
sl@0: 
sl@0: 	test(implArray.Count()==1);
sl@0: 	//Check that the implementation uid returned matched the specs above
sl@0: 	TUid implUid = implArray[0]->ImplementationUid();
sl@0: 	TInt version = implArray[0]->Version();
sl@0: 	TInt drive = implArray[0]->Drive();
sl@0: 	// imp. uid
sl@0: 	test(implUid.iUid == 0x102797A2);
sl@0: 	// version
sl@0: 	test(version == 1);
sl@0: 	// C drive
sl@0: 	test(drive == EDriveC);
sl@0: 
sl@0: 	// ECom Server is running.
sl@0: 	// delete the plugin DLL file not the RSC file, ECom rediscovery is NOT triggered.
sl@0: 	TRAPD(err, EComTestUtils::FileManDeleteFileL(KEComPluginDLLOnC));
sl@0: 	test(err==KErrNone);
sl@0: 
sl@0: 	// copy a RSC file to C:\resource\plugin\ to cause a ECom rediscovery.
sl@0: 	TRAP(err, EComTestUtils::FileManCopyFileL(KEComInvalidRscOnZ, KEComInvalidRscOnC));
sl@0: 	test(err==KErrNone);
sl@0: 	// Give ECOM a chance to do the rediscovery.
sl@0: 	// Otherwise ListImplementationsL could fail.
sl@0: 	User::After(KOneSecond * 3);
sl@0: 
sl@0: 	REComSession::ListImplementationsL(interfaceUid, implArray);
sl@0: 	// Since the DLL file is deleted, the corresponding DLL should be deleted
sl@0: 	// from the ECom registry.
sl@0: 	test(implArray.Count()==0);
sl@0: 
sl@0: 	//clean up
sl@0: 	implArray.ResetAndDestroy();
sl@0: 	REComSession::FinalClose();
sl@0: 	KillEComServerL();
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: typedef void (*ClassFuncPtrL) (void);
sl@0: 
sl@0: /**
sl@0: Wrapper function to call all test functions
sl@0: 
sl@0: @param		testFuncL pointer to test function
sl@0: @param		aTestDesc test function name
sl@0: */
sl@0: LOCAL_C void DoBasicTestL(ClassFuncPtrL testFuncL, 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: 	//Call the test function
sl@0: 	(*testFuncL)();
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(startThreadHandleCount  == endThreadHandleCount);
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: LOCAL_C void DoTestsL()
sl@0: 	{
sl@0: 	//don't change the order of the tests!
sl@0: 	__UHEAP_MARK;
sl@0: 	// Basic tests
sl@0: 	DoBasicTestL(&ValidateRegistryAgainstRscL, _L("ValidateRegistryAgainstRscL"));
sl@0: 	DoBasicTestL(&ValidateRegistryAgainstDllL, _L("ValidateRegistryAgainstDllL"));
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 
sl@0: 	test.Title();
sl@0: 	test.Start(_L("Validate Registry Tests."));
sl@0: 
sl@0: 	CTrapCleanup* cleanup = CTrapCleanup::New();
sl@0: 	CActiveScheduler* scheduler = new(ELeave)CActiveScheduler;
sl@0: 	CActiveScheduler::Install(scheduler);
sl@0: 
sl@0: 	TRAPD(err,DoTestsL());
sl@0: 	// Cleanup files
sl@0: 	if(err != KErrNone)
sl@0: 		{
sl@0: 		DeletePlugin();
sl@0: 		REComSession::FinalClose();
sl@0: 		}
sl@0: 
sl@0: 	test(err==KErrNone);
sl@0: 	DeletePlugin();
sl@0:     TRAPD(error,EComTestUtils::FileManDeleteFileL(KEComInvalidRscOnC));
sl@0:     UNUSED_VAR(error);
sl@0: 	delete scheduler;
sl@0: 	delete cleanup;
sl@0: 
sl@0: 	test.End();
sl@0: 	test.Close();
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	return(0);
sl@0: 	}