// Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "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:

//

#include <e32test.h>

#include <e32def.h>

#include <e32def_private.h>

#include <d32resmanus.h>

#ifdef PRM_ENABLE_EXTENDED_VERSION

#define LDD_NAME _L("resourcecontrollerextended.ldd")

#else

#define LDD_NAME _L("resourcecontrol.ldd")

#endif

#ifdef PRM_ENABLE_EXTENDED_VERSION

#define PDD_NAME _L("resourcecontrollerextended.pdd")

#else

#define PDD_NAME _L("resourcecontroller.pdd")

#endif

//#define PIRATE_THREAD_TESTS

_LIT(testableResourceName,"SymbianSimulResource");

#ifdef RESMANUS_KERN

_LIT(testName,"t_resmanuskern");

#else

_LIT(testName,"t_resmanus");

#endif

TBuf<16> gTestName(testName);

GLDEF_D RBusDevResManUs gChannel;

TUint8 KNoOfGetStateRequests = 5;

TUint8 KNoOfSetStateRequests = 4;

TUint8 KNoOfNotifyRequests = 7;

#define MAX_NUM_REQUESTS 8		// Must be (at least) one greater than the largest of 

								// KNoOfGetStateRequests, KNoOfSetStateRequests, KNoOfNotifyRequests

#ifdef _DEBUG

TUint gLongLatencyResource;

TBool gHaveAsyncRes = EFalse;

TInt gAsyncResStateDelta = 0;

TUint gSharedResource;

TBool gHaveSharedRes = EFalse;

TInt gSharedResStateDelta = 0;

#else

// The UREL version of the driver will not implement the arrays and functionality required

// to determine the async and shared resources to use at runtime. The values provided here

// have been pre-determined to operate successfully with the simulated PSL.

//

TUint gLongLatencyResource = 6;

TBool gHaveAsyncRes = ETrue;

TInt gAsyncResStateDelta = -1;

TUint gSharedResource = 12;

TBool gHaveSharedRes = ETrue;

TInt gSharedResStateDelta = -1;

#endif

TBool gUseCached = EFalse;

class RTestSafe: public RTest

	{

public:

	RTestSafe(const TDesC &aTitle) :

		RTest(aTitle), iCleanUpLevelMask (0), iFailHdnFunc(NULL)

		{

		}

	RTestSafe(const TDesC &aTitle, void(*func)(RTestSafe &aTest)) :

		RTest(aTitle), iFailHdnFunc(func)

		{

		}

	// new version of operator(int), which calls our cleanup handler if check has failed

	void operator()(TInt aResult)

		{

		if(!aResult && iFailHdnFunc)

			iFailHdnFunc(*this);

		RTest::operator ()(aResult);

		}

	void operator()(TInt aResult, TInt aLineNum)

		{

		if(!aResult && iFailHdnFunc)

			iFailHdnFunc(*this);

		RTest::operator ()(aResult, aLineNum);

		}

	void operator()(TInt aResult, TInt aLineNum, const TText* aFileName)

		{

		if(!aResult && iFailHdnFunc)

			iFailHdnFunc(*this);

		RTest::operator ()(aResult, aLineNum, aFileName);

		}

	// new version of End, which calls handler before exit..

	void End()

		{

		if(iFailHdnFunc)

			iFailHdnFunc(*this);

		RTest::End();

		}

	void SetCleanupFlag(TUint aFlag)

		{

		iCleanUpLevelMask |= 1 << aFlag;

		}

	TBool CleanupNeeded(TUint aFlag)

		{

		return (iCleanUpLevelMask & (1 << aFlag)) >> aFlag;

		}

	TUint iCleanUpLevelMask;

	void (*iFailHdnFunc)(RTestSafe &aTest);

	};

// cleanup handler

enum TCleanupLevels

	{

	EPddLoaded = 0,

	ELddLoaded,

	EChannelOpened

	};

void TestCleanup(RTestSafe &aTest)

	{

	// cleanup for all 3 levels..

	if(aTest.CleanupNeeded(EChannelOpened))

		{

		gChannel.Close();

		}

	if(aTest.CleanupNeeded(ELddLoaded))

		{

		User::FreeLogicalDevice(KLddRootName);

		}

	if(aTest.CleanupNeeded(EPddLoaded))

		{

		User::FreePhysicalDevice(PDD_NAME);

		}

	}

// global gTest object..

RTestSafe gTest(testName, &TestCleanup);

LOCAL_C TInt CheckCaps()

	{

	TInt r = KErrNone;

	RDevice d;

	TPckgBuf<TCapsDevResManUs> caps;

	r = d.Open(KLddRootName);

	if(r == KErrNone)

		{

		d.GetCaps(caps);

		d.Close();

		TVersion ver = caps().version;

		if(ver.iMajor != 1 || ver.iMinor != 0 || ver.iBuild != KE32BuildVersionNumber)

			{

			gTest.Printf(_L("Capabilities returned wrong version"));

			gTest.Printf(_L("Expected(1, 0, %d), got (%d , %d, %d)"),

			                KE32BuildVersionNumber, ver.iMajor, ver.iMinor, ver.iBuild);

			r = KErrGeneral;

			}

		}

	return r;

	}

LOCAL_C TInt OpenChannel(TDesC16& aName, RBusDevResManUs& aChannel)

	{

	TInt r = KErrNone;

	// API accepts 8-bit descriptors, only - so convert name accordingly

	TBuf8<MAX_RESOURCE_NAME_LENGTH+1>EightBitName;

	EightBitName.Copy(aName);

    r=(aChannel.Open(EightBitName));

    if (r!=KErrNone)

		gTest.Printf(_L("OpenChannel: Handle for channel %S error code =0x%x\n"),&aName,r);

	else

		gTest.Printf(_L("OpenChannel: Handle for channel %S =0x%x\n"),&aName,aChannel.Handle());

	return r;

	}

LOCAL_C TInt HelperResources()

//

// Helper method to support OpenAndRegisterChannel

// Invokes GetNoOfResources, GetAllResourcesInfo and GetResourceIdByName

//

	{

	TInt r = KErrNone;

	__KHEAP_MARK;

	// Check what resources are available

    gTest.Printf(_L("**Test GetNoOfResources\n"));

	TUint numResources=0;

	if((r=gChannel.GetNoOfResources(numResources))!=KErrNone)

		{

		gTest.Printf(_L("GetNoOfResources for test channel returned %d\n"),r);

		return r;

		}

	gTest.Printf(_L("Number of resources = %d (=0x%x)\n"),numResources,numResources);

	// Read the resource information

    gTest.Printf(_L("**Test GetAllResourcesInfo\n"));

	// To support the GetAllResourcesInfo testing, instantiate TResourceInfoBuf objects

	// and reference via an RSimplePointerArray

	TUint bufSize = numResources;

	RSimplePointerArray<TResourceInfoBuf> infoPtrs(bufSize);

	for(TUint i=0;i<bufSize;i++)

		{

		TResourceInfoBuf *info = new TResourceInfoBuf();

		if((r=infoPtrs.Insert(info, i))!=KErrNone)

			{

			gTest.Printf(_L("GetAllResourcesInfo infoPtrs.Insert at index %d returned %d\n"),i,r);

			}

		}

	TUint updateNumResources=numResources;

	if((r=gChannel.GetAllResourcesInfo(&infoPtrs,updateNumResources))!=KErrNone)

		{

		gTest.Printf(_L("GetAllResourcesInfo for channel returned %d\n"),r);

		return r;

		}

	gTest.Printf(_L("Updated number of resources = %d\n"),updateNumResources);

#ifdef _DEBUG

	// Print resource names

	{

	TBuf16<MAX_RESOURCE_NAME_LENGTH+1>name;

	for(TUint i=0; i<updateNumResources; i++)

		{

		TResourceInfoBuf* currRes = infoPtrs[i];

		name.Copy((*currRes)().iName);

		name.PtrZ();

		gTest.Printf(_L("Resource %d name = %S \n"),i,&name);

		};

	}

#endif

	// Select a resource to use, then pass its name to GetResourceIdByName

	// to check that the corresponding resource ID is acquired.

	TResourceInfo currRes = (*infoPtrs[0])(); 

	if(updateNumResources>1)

		currRes=(*infoPtrs[1])();// First resource may be a dummy

	TUint resourceId;

	gTest.Printf(_L("Invoking GetResourceIdByName for last resource name extracted \n"));

	if((r=gChannel.GetResourceIdByName(currRes.iName, resourceId))!=KErrNone)

		{

		gTest.Printf(_L("GetResourceIdByName for channel returned %d \n"),r);

		return r;

		}

	gTest.Printf(_L("GetResourceIdByName gave ID = %d\n"),resourceId);

	infoPtrs.Close();

	__KHEAP_MARKEND;

	return r;

	}

LOCAL_C TInt CheckForSimulatedResources()

//

// Get the name of the first resource - if it does not match the expected name

// then the testing must not proceed, so return the relevant error code

//

	{

    TInt r = KErrNone;

	TResourceInfoBuf buffer;

	if((r=gChannel.GetResourceInfo(1, &buffer))!=KErrNone)	// first resource ID = 1

		{

		gTest.Printf(_L("CheckForSimulatedResources, candidate get resource info returned %d\n"),r);

		return r;

		}

	// Check the name of the resource

	TBuf16<MAX_RESOURCE_NAME_LENGTH+1>name;

	name.Copy(buffer().iName);

	name.PtrZ();

	if((r=name.Compare(testableResourceName))!=KErrNone)

		{

		gTest.Printf(_L("Resource name = %S, require %S \n"),&name,&testableResourceName);

		r=KErrNotSupported;

		}

	return r;

	}

//----------------------------------------------------------------------------------------------

//! @SYMTestCaseID      KBASE-T_RESMANUS-0607

//! @SYMTestType        UT

//! @SYMPREQ            PREQ1398

//! @SYMTestCaseDesc    This test case tests channel opening and initialisation APIs.

//! @SYMTestActions     0) Call Open API with a valid name.

//! 

//!						1) Call Open API for two more channels 

//!						(to demonstrate multiple clients (channels) can be supported concurrently).

//! 

//!						2) Call Open with an oversized name. 

//! 

//!						3) Call GetNoOfResources API

//! 

//!						4) Call GetAllResourcesInfo API

//! 

//!						5) Call GetResourceIdByName API for last of resource names gathered

//!						in previous step

//! 

//!						6) Call Initialise API on the channel originally created, with non-zero arguments.

//!

//! @SYMTestExpectedResults 0) API should return with KErrNone, exits otherwise.

//!						1) API should return with KErrNone, exits otherwise.

//!						2) API should return with KErrBadName, exits otherwise.

//!						3) API should return with KErrNone, exits otherwise.

//!						4) API should return with KErrNone, exits otherwise.

//!						5) API should return with KErrNone, exits otherwise.

//!						6) API should return with KErrNone, exits otherwise.

//!

//! @SYMTestPriority        High

//! @SYMTestStatus          Implemented

//----------------------------------------------------------------------------------------------

LOCAL_C TInt OpenAndRegisterChannel()

//

// Test Open and Initialise functionality

// Also invokes Resource inspection methods via HelperResource

//

    {

    TInt r;

	if((r=OpenChannel(gTestName, gChannel))!=KErrNone)

		return r;

	// Check that the simulated resources required to support this testing are present

	// If not, close the channel and return the propagated error code.

	if((r=CheckForSimulatedResources())!=KErrNone)

		{

		gChannel.Close();

		return r;

		}

	__KHEAP_MARK; // gTestName will remain open (allocated) when heap is checked

	// Open a couple of additional channels to prove that more than one

	// can exist

	_LIT(tempStr1,"temp1");

	TBufC<16> tempName1(tempStr1);

	_LIT(tempStr2,"temp2");

	TBufC<16> tempName2(tempStr2);

	RBusDevResManUs channelTwo;

	RBusDevResManUs channelThree;

	if((r=OpenChannel(tempName1, channelTwo))!=KErrNone)

		return r;

	if((r=OpenChannel(tempName2, channelThree))!=KErrNone)

		return r;

	// The following test requires manual enabling in resource controller of macro

	// DEBUG_VERSION - this is not done by default, so test is deactivated here.

	//

#if 0

	// Test rejection if try a name already in use

	//

	// (For UREL builds, duplicate names are allowed; but

	//  for UDEB builds, they are monitored and rejected)

	//

	RBusDevResManUs channelSameName;

	r=OpenChannel(tempName1, channelSameName);

	channelSameName.Close(); // Channel not used after here

    if (r==KErrNone)

		{

		gTest.Printf(_L("Error: Handle for re-used name channel =0x%x\n"),channelSameName.Handle());

		return KErrGeneral;

		}

	else if(r!=KErrCouldNotConnect)

		{

		gTest.Printf(_L("Error: re-used name gave unexpected error code =0x%x\n"),r);

		return r;

		}

	else // if(r==KErrCouldNotConnect)

		{

		gTest.Printf(_L("Re-used channel name rejected with correct error code\n"));

		}

#endif // if 0

	// Test oversized name rejection

	_LIT(longStr,"1abcdefghijklmnopqrstuvwxyz2abcdefghijklmnopqrstuvwxyz3abcdefghijklmnopqrstuvwxyz4abcdefghijklmnopqrstuvwxyz5abcdefghijklmnopqrstuvwxyz6abcdefghijklmnopqrstuvwxyz7abcdefghijklmnopqrstuvwxyz8abcdefghijklmnopqrstuvwxyz9abcdefghijklmnopqrstuvwxyz10abcdefghijklmnopqrstuvwxyz");

	TBufC<271> longName(longStr);

	// API accepts 8-bit descriptors for names, only

	TBuf8<271>longName_8Bit;

	longName_8Bit.Copy(longName);

	RBusDevResManUs channelLong;

    r=(channelLong.Open(longName_8Bit));

	channelLong.Close(); // Channel not used after here

    if (r==KErrNone)

		{

		gTest.Printf(_L("Error: Handle for oversize name channel =0x%x\n"),channelLong.Handle());

		return KErrGeneral;

		}

	else if(r!=KErrBadName)

		{

		gTest.Printf(_L("Error: oversized name gave unexpected error code =0x%x\n"),r);

		return r;

		}

	else // if(r==KErrBadName)

		{

		gTest.Printf(_L("Oversized name for channel rejected with correct error code\n"));

		}

	// Invokes GetNoOfResources, GetAllResourcesInfo and GetResourceIdByName

	if((r=HelperResources())!=KErrNone)

		return r;

	// Close the temporary channels

	// Do this before  channel registration to enable valid check of kernel heap

	channelTwo.Close();

	channelThree.Close();

	__KHEAP_MARKEND;

	// Channel registration

    gTest.Printf(_L("Invoking Initialise with values 0x%x, 0x%x, 0x%x\n"),KNoOfGetStateRequests,KNoOfSetStateRequests,KNoOfNotifyRequests);

    if ((r=gChannel.Initialise(KNoOfGetStateRequests,KNoOfSetStateRequests,KNoOfNotifyRequests))!=KErrNone)

		{

		gTest.Printf(_L("Initialise for channel returned %d\n"),r);

		return r;

		}

    return KErrNone;

    }

LOCAL_C TInt HelperClients()

//

// Helper method to support TestGetClientGetResourceInfo

// Invokes GetNoOfClients and GetNamesAllClients

//

	{

	__KHEAP_MARK;

	TInt r = KErrNone;

	TUint numClients = 0;

	TUint numAllClients = 0;

	//

	// GetNoOfClients - with aIncludeKern=EFalse

	//

	if((r=gChannel.GetNoOfClients(numClients, EFalse)) != KErrNone)

		{

		gTest.Printf(_L("GetNoOfClients (aIncludeKern==EFalse) returned %d\n"),r);

		return r;

		}

	gTest.Printf(_L("GetNoOfClients (aIncludeKern==EFalse) gave 0x%x clients\n"),numClients);

	//

	// GetNoOfClients - with aIncludeKern=ETrue

	//

	r=gChannel.GetNoOfClients(numAllClients, ETrue);

#ifdef RESMANUS_KERN

	if(r==KErrNone)

		gTest.Printf(_L("GetNoOfClients (aIncludeKern==ETrue) returned KErrNone\n"));

#else

	if(r==KErrPermissionDenied)

		gTest.Printf(_L("GetNoOfClients (aIncludeKern==ETrue) returned KErrPermissionDenied\n"));

#endif

	else

		{

		gTest.Printf(_L("GetNoOfClients (aIncludeKern==ETrue) returned %d"),r);

		return KErrGeneral;

		}

	// To support the GetNamesAllClients testing, instantiate TClientName objects

	// and reference via an RSimplePointerArray

	TUint bufSize = (numAllClients>numClients)?numAllClients:numClients;

	RSimplePointerArray<TClientName> infoPtrs(bufSize);

	for(TUint i=0;i<bufSize;i++)

		{

		TClientName *info = new TClientName();

		if((r=infoPtrs.Insert(info, i))!=KErrNone)

			{

			gTest.Printf(_L("GetNamesAllClients infoPtrs.Insert at index %d returned %d\n"),i,r);

			}

		}

	//

	// GetNamesAllClients - with aIncludeKern=EFalse

	//

	if((r=gChannel.GetNamesAllClients(&infoPtrs, numClients, EFalse)) != KErrNone)

		{

		gTest.Printf(_L("GetNamesAllClients (aIncludeKern==EFalse) returned %d\n"),r);

		return r;

		}

#ifdef _DEBUG

	else

		{

		gTest.Printf(_L("GetNamesAllClients (aIncludeKern==EFalse) returned KErrNone, names follow\n"));

		for(TUint i=0;i<numClients;i++)

			{

			TClientName *currName = infoPtrs[i];

			TBuf16<sizeof(TClientName)> name;

			name.Copy(*currName);

			gTest.Printf(_L("Client name %d = %S\n"),i,&name);

			}

		}

#endif