sl@0: // Copyright (c) 2008-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: //
sl@0: 
sl@0: #include <e32test.h>
sl@0: #include <bautils.h>
sl@0: #include <barsread2.h>
sl@0: #include <barsc2.h>
sl@0: #include <baspi.h>
sl@0: 
sl@0: LOCAL_D RTest TheTest(_L("T_SPI"));
sl@0: LOCAL_D RFs TheFs;
sl@0: 
sl@0: //Test files
sl@0: _LIT(KTestDirectoryPath,"z:\\system\\data\\");
sl@0: _LIT(KRscExtension,".rsc");
sl@0: _LIT(KXipSpiFile,"z:\\system\\data\\Spi_ECom.SPI");
sl@0: _LIT(KNonXipSpiFile, "c:\\system\\data\\Spi_ECom.SPI");
sl@0: _LIT(KXipSpi_EcomRsc1,"z:\\system\\data\\Spi_EcomRsc1.rsc");
sl@0: _LIT(KXipSpi_EcomRsc2,"z:\\system\\data\\Spi_EcomRsc2.rsc");
sl@0: _LIT(KXipSpi_EcomRsc3,"z:\\system\\data\\Spi_EcomRsc3.rsc");
sl@0: _LIT(KNonXipSpi_EcomRsc1,"c:\\system\\data\\Spi_EcomRsc1.rsc");
sl@0: _LIT(KNonXipSpi_EcomRsc2,"c:\\system\\data\\Spi_EcomRsc2.rsc");
sl@0: _LIT(KNonXipSpi_EcomRsc3,"c:\\system\\data\\Spi_EcomRsc3.rsc");
sl@0: 
sl@0: //----------------------UTILITY FUNCTIONS----------------------------------
sl@0: LOCAL_C void CopyFileL(const TDesC& aFrom,const TDesC& aTo)
sl@0: 	{
sl@0: 	TheFs.Delete(aTo);
sl@0: 	CFileMan* man=CFileMan::NewL(TheFs);
sl@0: 	TInt r=man->Copy(aFrom,aTo, CFileMan::ERecurse);
sl@0: 	delete man;
sl@0: 	User::LeaveIfError(r);
sl@0: 	User::LeaveIfError(TheFs.SetAtt(aTo,0,KEntryAttReadOnly)); // clear RO
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void DeleteFile(const TDesC& aFileName)
sl@0: 	{
sl@0: 	// make sure the file is read/write
sl@0: 	TInt err = TheFs.SetAtt(aFileName, 0, KEntryAttReadOnly);
sl@0: 	if(err != KErrNone)
sl@0: 		{
sl@0: 		RDebug::Print(_L("error changing attributes file = %d"),err);
sl@0: 		}
sl@0: 	// delete the file
sl@0: 	err = BaflUtils::DeleteFile(TheFs, aFileName);
sl@0: 	if(err != KErrNone)
sl@0: 		{
sl@0: 		RDebug::Print(_L("error deleting file = %d"),err);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: LOCAL_C TInt FileSizeL(const TDesC& aFileName)
sl@0: 	{
sl@0: 	RFile file;
sl@0: 	CleanupClosePushL(file);
sl@0: 	User::LeaveIfError(file.Open(TheFs, aFileName, EFileRead));
sl@0: 	TInt size = 0;
sl@0: 	User::LeaveIfError(file.Size(size));
sl@0: 	CleanupStack::PopAndDestroy(&file);
sl@0: 	return size;
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void DeleteTestFile()
sl@0: 	{
sl@0: 	DeleteFile(KNonXipSpiFile);
sl@0: 	DeleteFile(KNonXipSpi_EcomRsc1);
sl@0: 	DeleteFile(KNonXipSpi_EcomRsc2);
sl@0: 	DeleteFile(KNonXipSpi_EcomRsc3);
sl@0: 	}
sl@0: 
sl@0: //Test macroses and functions
sl@0: LOCAL_C void Check(TInt aValue, TInt aLine)
sl@0: 	{
sl@0: 	if(!aValue)
sl@0: 		{
sl@0: 		::DeleteTestFile();
sl@0: 		TheTest(EFalse, aLine);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: #define TEST(arg) ::Check((arg), __LINE__)
sl@0: 
sl@0: //---------------------TEST CASE for RResoureArchive------------------
sl@0: // Tests for RResourceArchive
sl@0: /*
sl@0: (1) Test Loading SPI file through RResourceArchive and retrieving the first rsc block
sl@0: 	from XIP media(e.g NOR flash) in basic and OOM environment.
sl@0: (2) Test Loading SPI file through RResourceArchive and retrieving the first rsc block
sl@0: 	from NON-XIP media(e.g NAND flash) in basic and OOM environment.
sl@0: (3) Test the Reset() functionality to ensure proper reset functionality by comparing the
sl@0: 	content of the rsc file
sl@0: (4)	Test Loading some test SPI(with 2-3 random rsc file), interpret the content of rsc file
sl@0: 	through RResourceReader and compare it with the results when opening each rsc file
sl@0: 	separately.
sl@0: (5) Test Loading some non-spi file using RResourceArchive expecting a KErrCorrupt to be
sl@0: 	returned
sl@0: */
sl@0: class RStaticPluginInfoTest
sl@0: 	{
sl@0: public:
sl@0: 	static void TestCase1L();
sl@0: 	static void TestCase2L();
sl@0: 	static void TestCase3L();
sl@0: 	static void TestCase4L();
sl@0: 	static void TestCase5L();
sl@0: private:
sl@0: 	static void TestOpenNextL(const TDesC& aFileName);
sl@0: 	static void TestComparisonL(const TDesC& aFileName);
sl@0: 	};
sl@0: 
sl@0: void RStaticPluginInfoTest::TestCase1L()
sl@0: 	{
sl@0: 	TheTest.Next(_L("Test case 1 Loading/Reading SPI file from XIP media\n"));
sl@0: 	TestOpenNextL(KXipSpiFile);
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestCase2L()
sl@0: 	{
sl@0: 	TheTest.Next(_L("Test case 2 Loading/Reading SPI file from Non-XIP media\n"));
sl@0: 	TestOpenNextL(KNonXipSpiFile);
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestCase3L()
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 	TheTest.Next(_L("Test case 3 Testing functionality of the Reset() function\n"));
sl@0: 	RResourceArchive testArchiveIter;
sl@0: 	testArchiveIter.OpenL(TheFs,KXipSpiFile);
sl@0: 
sl@0: 	RResourceReader theReader1;
sl@0: 	RResourceReader theReader3;
sl@0: 
sl@0: 	HBufC* rscName1=NULL;
sl@0: 	HBufC* rscName2=NULL;
sl@0: 	HBufC* rscName3=NULL;
sl@0: 
sl@0: 	CResourceFile* rscArchive1=testArchiveIter.NextL(rscName1);
sl@0: 	TEST(rscArchive1!=NULL);
sl@0: 
sl@0: 	CResourceFile* rscArchive2=testArchiveIter.NextL(rscName2);
sl@0: 	TEST(rscArchive2!=NULL);
sl@0: 
sl@0: 	testArchiveIter.Reset();
sl@0: 
sl@0: 	CResourceFile* rscArchive3=testArchiveIter.NextL(rscName3);
sl@0: 	TEST(rscArchive3!=NULL);
sl@0: 
sl@0: 	//Check to ensure that rscArchive3 content is the same as rscArchive1
sl@0: 	theReader1.OpenLC(rscArchive1,1);
sl@0: 	theReader3.OpenLC(rscArchive3,1);
sl@0: 	TEST(rscArchive1->UidType()==rscArchive3->UidType());
sl@0: 	TEST(rscName1->CompareF(rscName3->Des())==0);
sl@0: 	TEST(theReader1.ReadInt32L()==theReader3.ReadInt32L());
sl@0: 
sl@0: 	delete rscName1;
sl@0: 	delete rscName2;
sl@0: 	delete rscName3;
sl@0: 	delete rscArchive1;
sl@0: 	delete rscArchive2;
sl@0: 	delete rscArchive3;
sl@0: 
sl@0: 	testArchiveIter.Close();
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(&theReader3);
sl@0: 	CleanupStack::PopAndDestroy(&theReader1);
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestCase4L()
sl@0: 	{
sl@0: 	TheTest.Next(_L("Test case 4 Testing comparison of spi and rsc read CResourceFiles\n"));
sl@0: 	TestComparisonL(KXipSpiFile);
sl@0: 	TestComparisonL(KNonXipSpiFile);
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestCase5L()
sl@0: 	{
sl@0: 	TheTest.Next(_L("Test case 5 Testing opening a non-spi file\n"));
sl@0: 	__UHEAP_MARK;
sl@0: 	RResourceArchive testArchiveIter;
sl@0: 	TRAPD(err,testArchiveIter.OpenL(TheFs,KXipSpi_EcomRsc1));
sl@0: 	TEST(err==KErrCorrupt);
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestComparisonL(const TDesC& aFileName)
sl@0: 	{
sl@0: 	__UHEAP_MARK;
sl@0: 	RResourceArchive testArchiveIter;
sl@0: 	testArchiveIter.OpenL(TheFs,aFileName);
sl@0: 	TUid spiType=testArchiveIter.Type();
sl@0: 	TEST(spiType.iUid=0x10205C2C);
sl@0: 
sl@0: 	CResourceFile* spiRscArchive=NULL;
sl@0: 	HBufC* rscName=NULL;
sl@0: 	spiRscArchive=testArchiveIter.NextL(rscName);
sl@0: 	while (spiRscArchive)
sl@0: 		{
sl@0: 		TFileName fullRscName;
sl@0: 		fullRscName.Append(KTestDirectoryPath);
sl@0: 		fullRscName.Append(rscName->Des());
sl@0: 		fullRscName.Append(KRscExtension);
sl@0: 		TInt rscFileSize=FileSizeL(fullRscName);
sl@0: 
sl@0: 		//Creating a CResourceFile by opening the individual rsc file
sl@0: 		CResourceFile* existingRscArchive=CResourceFile::NewL(TheFs,fullRscName,0,rscFileSize);
sl@0: 		//Now perform general comparison
sl@0: 		TEST(spiRscArchive->UidType()==existingRscArchive->UidType());
sl@0: 		TEST(spiRscArchive->Offset()==existingRscArchive->Offset());
sl@0: 		//Now perform interpreting and comparing the rsc content
sl@0: 		RResourceReader rscReader;
sl@0: 		RResourceReader spiRscReader;
sl@0: 		spiRscReader.OpenLC(spiRscArchive,1);
sl@0: 		rscReader.OpenLC(existingRscArchive,1);
sl@0: 		//Now perform all the read results and comparison between the two CResourceFile
sl@0: 		const TUid KUidEComResourceFormatV2 = {0x101FB0B9};
sl@0: 		TInt resourceFormatVersion=0;
sl@0: 		resourceFormatVersion+=0;
sl@0: 		//Comparison of Rsc uid
sl@0: 		TUid rscUid = {rscReader.ReadInt32L()};
sl@0: 		TEST(rscUid.iUid==spiRscReader.ReadInt32L());
sl@0: 		if(rscUid==KUidEComResourceFormatV2)
sl@0: 			{
sl@0: 			resourceFormatVersion = 2;
sl@0: 			TUid dllUid={rscReader.ReadInt32L()};
sl@0: 			TEST(dllUid.iUid==spiRscReader.ReadInt32L());
sl@0: 			}
sl@0: 		//Comparison of number of interfaces
sl@0: 		TInt numberOfInterface=rscReader.ReadInt16L();
sl@0: 		TEST(numberOfInterface==spiRscReader.ReadInt16L());
sl@0: 		//Comparison of the each interface uid and implementations under this interface
sl@0: 		for(TInt iFace = 0; iFace < numberOfInterface; ++iFace)
sl@0: 			{
sl@0: 			//Comparison of each interface Uid
sl@0: 			const TUid interfaceUid = {rscReader.ReadInt32L()};
sl@0: 			TEST(interfaceUid.iUid==spiRscReader.ReadInt32L());
sl@0: 			//Comparison of number of implementations under this interface
sl@0: 			const TInt numImplementations = rscReader.ReadInt16L();
sl@0: 			TEST(numImplementations==spiRscReader.ReadInt16L());
sl@0: 			for(TInt impl = 0; impl < numImplementations; ++impl)
sl@0: 				{
sl@0: 				//Comparison of some of the implementation content
sl@0: 				const TUid impUid  = {rscReader.ReadInt32L()};
sl@0: 				TEST(impUid.iUid==spiRscReader.ReadInt32L());
sl@0: 				const TInt version = rscReader.ReadInt8L();
sl@0: 				TEST(version==spiRscReader.ReadInt8L());
sl@0: 				}
sl@0: 			}
sl@0: 		delete existingRscArchive;
sl@0: 		existingRscArchive=NULL;
sl@0: 		delete spiRscArchive;
sl@0: 		spiRscArchive=NULL;
sl@0: 		delete rscName;
sl@0: 		rscName=NULL;
sl@0: 		CleanupStack::PopAndDestroy(&rscReader);
sl@0: 		CleanupStack::PopAndDestroy(&spiRscReader);
sl@0: 		spiRscArchive=testArchiveIter.NextL(rscName);
sl@0: 		}
sl@0: 	testArchiveIter.Close();
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 	}
sl@0: 
sl@0: void RStaticPluginInfoTest::TestOpenNextL(const TDesC& aFileName)
sl@0:     {
sl@0:     //---------Basic testing-------------------------------
sl@0: 	__UHEAP_MARK;
sl@0: 
sl@0: 	RResourceArchive testArchiveIter;
sl@0: 	testArchiveIter.OpenL(TheFs,aFileName);
sl@0: 	TUid spiType=testArchiveIter.Type();
sl@0: 	TEST(spiType.iUid==0x10205C2C);
sl@0: 	HBufC* rscName=NULL;
sl@0: 	CResourceFile* rscArchive=testArchiveIter.NextL(rscName);
sl@0: 
sl@0: 	delete rscArchive;
sl@0: 	rscArchive=NULL;
sl@0: 	delete rscName;
sl@0: 	rscName=NULL;
sl@0: 	testArchiveIter.Close();
sl@0: 
sl@0: 	__UHEAP_MARKEND;
sl@0: 
sl@0: 	//-----------OOM testing--------------------------------
sl@0: 	TInt err;
sl@0: 	TInt tryCount = 0;
sl@0: 	tryCount=tryCount;
sl@0: 	RResourceArchive testArchiveIter1;
sl@0: 	testArchiveIter1.OpenL(TheFs,aFileName);
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: 		__UHEAP_SETFAIL(RHeap::EDeterministic, ++tryCount);
sl@0: 		TRAP(err,rscArchive=testArchiveIter1.NextL(rscName));
sl@0: 		__UHEAP_SETFAIL(RHeap::ENone, 0);
sl@0: 
sl@0: 		delete rscArchive;
sl@0: 		rscArchive=NULL;
sl@0: 
sl@0: 		delete rscName;
sl@0: 		rscName=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: 	testArchiveIter1.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID SYSLIB-BAFL-CT-0094
sl@0: @SYMTestCaseDesc Testing for the functionality of RResourceArchive
sl@0: @SYMTestPriority High
sl@0: @SYMTestActions  Test loading and reading Spi file through Xip and Non-Xip media
sl@0: 				 Test interpreting and comparing rsc content through read from
sl@0: 				 spi file and from individual rsc file.
sl@0: 				 Test all exported functionality of this class in general and
sl@0: 				 OOM conditions.
sl@0: @SYMTestExpectedResults The test must not fail.
sl@0: @SYMPREQ 806 Eliminate scanning for plugins on startup
sl@0: */
sl@0: LOCAL_C void DoAllTestsL()
sl@0: 	{
sl@0: 	TheTest.Next(_L(" @SYMTestCaseID:SYSLIB-BAFL-CT-0094 "));
sl@0: 	CleanupClosePushL(TheFs);
sl@0: 	User::LeaveIfError(TheFs.Connect());
sl@0: 
sl@0: 	TheTest.Printf(_L("Copying SPI files to RAM\r\n"));
sl@0: 	//Copying test spi file and individual rsc files that are included inside spi
sl@0: 	CopyFileL(KXipSpiFile,KNonXipSpiFile);
sl@0: 	CopyFileL(KXipSpi_EcomRsc1,KNonXipSpi_EcomRsc1);
sl@0: 	CopyFileL(KXipSpi_EcomRsc2,KNonXipSpi_EcomRsc2);
sl@0: 	CopyFileL(KXipSpi_EcomRsc3,KNonXipSpi_EcomRsc3);
sl@0: 
sl@0: 	//Start running all the TestCase
sl@0: 	RStaticPluginInfoTest::TestCase1L();
sl@0: 	RStaticPluginInfoTest::TestCase2L();
sl@0: 	RStaticPluginInfoTest::TestCase3L();
sl@0: 	RStaticPluginInfoTest::TestCase4L();
sl@0: 	RStaticPluginInfoTest::TestCase5L();
sl@0: 
sl@0: 	//Clearing all the test files we have copied to C
sl@0: 	DeleteTestFile();
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(1, &TheFs);
sl@0: 	}
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: 	{
sl@0:     __UHEAP_MARK;
sl@0:     CTrapCleanup *cleanup=CTrapCleanup::New();
sl@0: 	TheTest.Title();
sl@0: 	TheTest.Start(_L("Testing RResourceArchive"));
sl@0:     TRAPD(err,DoAllTestsL());
sl@0:     TheTest.Printf(_L("Error code is %d\n"),err);
sl@0:     TEST(err==KErrNone);
sl@0:     TheTest.End();
sl@0:     TheTest.Close();
sl@0:     delete cleanup;
sl@0:     __UHEAP_MARKEND;
sl@0: 	return(0);
sl@0:     }
sl@0: