// Copyright (c) 2005-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:

//

#include <e32base.h>

#include <e32test.h>

#include <e32debug.h>

#include <f32file.h>

#include <startupdomaindefs.h>

#include <ecom/ecompanics.h>

#include "EComServer.h"

#include "TestHarnessDomainMember.h"

#include "StartupStateObserverObject.h"

#include "ServerStartupManager.h"

#include "EcomTestUtils.h"

#include "EcomTestIniFileUtils.h"

#include "EcomTestCompTestabilityUtils.h"

static RFs TheFs;

static RTest TheTest(_L("T_ServerStartupMgr"));

//

//

//Test macroes and functions

//

//

static void Check(TInt aValue, TInt aLine)

	{

	if(!aValue)

		{

		TheTest(EFalse, aLine);

		}

	}

static  void Check(TInt aValue, TInt aExpected, TInt aLine)

	{

	if(aValue != aExpected)

		{

		RDebug::Print(_L("*** Expected error: %d, got: %d\r\n"), aExpected, aValue);

		TheTest(EFalse, aLine);

		}

	}

#define TEST(arg) ::Check((arg), __LINE__)

#define TEST2(aValue, aExpected) ::Check(aValue, aExpected, __LINE__)

//

//

//TServerStartupManager_StateAccessor class definition and methods

//

//

/**

@internalTechnology

Allows access to the protected and private data and operations

of CServerStartupMgr

*/

class TServerStartupManager_StateAccessor

	{

public:

	static TStartupStateIdentifier GetKnownStartupState(CServerStartupMgr& aServerStartupMgr, TDmDomainState aStartupState);

	static void SetKnownStartupState(CServerStartupMgr& aServerStartupMgr, TStartupStateIdentifier aState);

	static void TestStateAwareObjectsForState(CServerStartupMgr& aServerStartupMgr, TInt32 aState);

	static void SetStateAwareObjectsState(CServerStartupMgr& aServerStartupMgr, TInt32 aState);

	static void SetStateL(CServerStartupMgr& aServerStartupMgr, TInt aState);

	static void RunL(CServerStartupMgr& aServerStartupMgr);

	static TInt RunError(CServerStartupMgr& aServerStartupMgr, TInt aError);

	};

void TServerStartupManager_StateAccessor::TestStateAwareObjectsForState

		(CServerStartupMgr& aServerStartupMgr, TInt32 aState)

	{

	int i;

	const RPointerArray<MStartupStateObserver> observerList =

		aServerStartupMgr.iObserverList;

	for(i=0; i<observerList.Count(); i++)

		{

		CStartupStateObserver* observerObject =

			static_cast<CStartupStateObserver*>(observerList[i]);

		TEST2((TInt32)observerObject->GetState(), aState);

		}

	}

void TServerStartupManager_StateAccessor::SetStateAwareObjectsState

		(CServerStartupMgr& aServerStartupMgr, TInt32 aState)

	{

	int i;

	const RPointerArray<MStartupStateObserver> observerList =

		aServerStartupMgr.iObserverList;

	for(i=0; i<observerList.Count(); i++)

		{

		CStartupStateObserver* observerObject =

			static_cast<CStartupStateObserver*>(observerList[i]);

		observerObject->SetState((CStartupStateObserver::TSsoState)aState);

		}

	}

TStartupStateIdentifier TServerStartupManager_StateAccessor::GetKnownStartupState

		(CServerStartupMgr& aServerStartupMgr, TDmDomainState aStartupState)

	{

	return aServerStartupMgr.GetKnownStartupState(aStartupState);

	}

void TServerStartupManager_StateAccessor::SetKnownStartupState(CServerStartupMgr& aServerStartupMgr, TStartupStateIdentifier aState)

	{

	aServerStartupMgr.iCurrentStartupState = aState;

	}

void TServerStartupManager_StateAccessor::SetStateL(CServerStartupMgr& aServerStartupMgr, TInt aState)

	{

	aServerStartupMgr.ChangeStartupStateL(aState);

	}

void TServerStartupManager_StateAccessor::RunL(CServerStartupMgr& aServerStartupMgr)

	{

	aServerStartupMgr.RunL();

	}

TInt TServerStartupManager_StateAccessor::RunError(CServerStartupMgr& aServerStartupMgr,TInt aError)

	{

	return aServerStartupMgr.RunError(aError);

	}

//

//

//Helper functions

//

//

/**

*

* Function is used for each state change of InitialiseL() testing.

* It checks whether:

* 	    - For each state RequestTransitionNotification() is called

*		- For EStartupStateUndefined or EStartupStateNonCritical state

*		  Requestion of notification is cancelled .

* 	    - Each MStartupServerStateObserver object is set to their

* 	      corresponding state

* @param aServerStartupMgr the server startup manager being tested

* @param aNewState the domain state to be tested

* @param aObserverObjCurrentState the current state of all the observer objects

* registered to aServerStartupMgr

* @param aExpectedRequestTransitionNotification expected result from

* IsTransitionNotificationRequestedL() call to check whether RequestTransitionNotification()

* was called

* @param aExpectedCancelRequestNotification expected result from

* IsCancelRequestNotification() call to check whether Request of Notification

* was cancelled.

* @param aObserverObjExpectedState the expected new state for all of the MStartupServerStateObserver

* @param aExpectedStartupState the expected new state for the CServerStartupManager

* after RunL is called.

*/

void CheckForInitialiseStateChangeL(CServerStartupMgr& aServerStartupMgr,

							  TInt aNewState,

							  CStartupStateObserver::TSsoState aObserverObjCurrentState,

							  TBool aExpectedRequestTransitionNotification,

							  TBool aExpectedCancelRequestNotification,

  							  CStartupStateObserver::TSsoState aObserverObjExpectedState,

  							  TStartupStateIdentifier aExpectedStartupState,

  							  TBool aSsaEnabled)

	{

	//reset the server startup manager flags

	aServerStartupMgr.ResetRequestTransitionNotificationL();

	//set the new/tested state for server startup manager

	TServerStartupManager_StateAccessor::SetKnownStartupState

		(aServerStartupMgr, EStartupStateUndefined);

	//set the new/tested state for the domain

	TServerStartupManager_StateAccessor::SetStateL

		(aServerStartupMgr, aNewState);

	//set the current state for all of the MStartupServerStateObserver objects

	TServerStartupManager_StateAccessor::SetStateAwareObjectsState

		(aServerStartupMgr, aObserverObjCurrentState);

	//call InitialiseL()

	aServerStartupMgr.InitialiseL(aSsaEnabled);

	//test if RequestTransitionNotification() is called

	TEST2(aServerStartupMgr.IsTransitionNotificationRequestedL(), aExpectedRequestTransitionNotification);

	//test if Request of Notification is cancelled

	TEST2(aServerStartupMgr.IsRequestNotificationCancelledL(), aExpectedCancelRequestNotification);

	//test if MStartupStateObserver objects are set to expected state

	TServerStartupManager_StateAccessor::TestStateAwareObjectsForState

		(aServerStartupMgr, aObserverObjExpectedState);

	//test if CServerStartupManager is set to expected state

	TEST2(aServerStartupMgr.CurrentStartupState(), aExpectedStartupState);

	}

/**

*

* Function is used for each state change of RunL() testing.

* It checks whether:

* 	    - AcknowledgeLastStateL() is called for each state.

* 	    - RequestTransitionNotification() is called for all states.

*		- For EStartupStateUndefined or EStartupStateNonCritical state

*		  Requestion of notification is cancelled.

* 	    - Each MStartupServerStateObserver object is set to their

* 	      corresponding state

* @param aServerStartupMgr the server startup manager being tested

* @param aNewState the domain state to be tested

* @param aObserverObjCurrentState the current state of all the observer objects

* registered to aServerStartupMgr

* @param aExpectedRequestTransitionNotification expected result from

* IsTransitionNotificationRequestedL() call to check whether RequestTransitionNotification()

* was called

* @param aExpectedCancelRequestNotification expected result from

* IsCancelRequestNotification() call to check whether Request of Notification

* was cancelled.

* @param aExpectedAcknowledgeLastState expected result from IsLastStateAcknowledged()

* call to check whether AcknowledgeLastStateL() was called

* @param aObserverObjExpectedState the expected new state for all of the MStartupServerStateObserver

* after RunL is called.

* @param aExpectedStartupState the expected new state for the CServerStartupManager

* after RunL is called.

*/

void CheckForRunLStateChangeL(CServerStartupMgr& aServerStartupMgr,

							  TInt aNewState,

							  CStartupStateObserver::TSsoState aObserverObjCurrentState,

							  TBool aExpectedRequestTransitionNotification,

							  TBool aExpectedCancelRequestNotification,

							  TBool aExpectedAcknowledgeLastState,

  							  CStartupStateObserver::TSsoState aObserverObjExpectedState,

  							  TStartupStateIdentifier aExpectedStartupState)

	{

	//reset the server startup manager flags

	aServerStartupMgr.ResetLastStateAcknowledgedL();

	aServerStartupMgr.ResetRequestTransitionNotificationL();

	//set the current state for CDmDomain

	TServerStartupManager_StateAccessor::SetStateL

		(aServerStartupMgr, aNewState);

	//set the current state for all of the MStartupServerStateObserver objects

	TServerStartupManager_StateAccessor::SetStateAwareObjectsState

		(aServerStartupMgr, aObserverObjCurrentState);

	//call RunL()

	TRAPD(err, TServerStartupManager_StateAccessor::

				RunL(aServerStartupMgr));

	if(aNewState == EStartupStateUndefined)

		{

		TEST2(err, KErrBadHandle);

		}

	else

		{

		TEST2(err, KErrNone);

		}

	//test if RequestTransitionNotification() is called

	TEST2(aServerStartupMgr.IsTransitionNotificationRequestedL(), aExpectedRequestTransitionNotification);

	//test if Request of Notification is cancelled

	TEST2(aServerStartupMgr.IsRequestNotificationCancelledL(), aExpectedCancelRequestNotification);

	//test if AcknowledgeLastStateL() is called

	TEST2(aServerStartupMgr.IsLastStateAcknowledgedL(), aExpectedAcknowledgeLastState);

	//test if MStartupStateObserver objects are set to expected state

	TServerStartupManager_StateAccessor::TestStateAwareObjectsForState

		(aServerStartupMgr, aObserverObjExpectedState);

	//test if CServerStartupManager is set to expected state

	TEST2(aServerStartupMgr.CurrentStartupState(), aExpectedStartupState);

	}

//

//

//Tests

//

//

/**

@SYMTestCaseID		SYSLIB-ECOM-CT-0178

@SYMTestCaseDesc 	Check that the CServerStartupMgr::GetKnownStartupState() works correctly.

@SYMTestPriority 	High

@SYMTestActions  	Set knownStartupState to EStartupStateUndefined, EStartupStateCriticalStatic,

EStartupStateCriticalDynamic, EStartupStateNonCritical. Call GetKnownStartupState() to see if

correct known startup state is returned.

@SYMTestExpectedResults The test must not fail.

@SYMPREQ PREQ967

*/

void GetKnownStartupState_TestL()

	{

	TheTest.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-0178 "));

	TUint32 i;

	static const TUint32 KTestCount = 11;

	TInt32 testStates[] = { EStartupStateUndefined, EStartupStateUndefined+1,

							EStartupStateCriticalStatic-1, EStartupStateCriticalStatic, EStartupStateCriticalStatic+1,

							EStartupStateCriticalDynamic-1, EStartupStateCriticalDynamic, EStartupStateCriticalDynamic+1,

							EStartupStateNonCritical-1, EStartupStateNonCritical, EStartupStateNonCritical+1};

	//Test results

	TInt32 resultStates[] = {EStartupStateUndefined, EStartupStateUndefined,

							 EStartupStateUndefined, EStartupStateCriticalStatic, EStartupStateCriticalStatic,

							 EStartupStateCriticalStatic, EStartupStateCriticalDynamic, EStartupStateCriticalDynamic,

							 EStartupStateCriticalDynamic, EStartupStateNonCritical, EStartupStateNonCritical};

	EnableSsa(TheTest, TheFs);

	CServerStartupMgr* serverStartupMgr =

		new(ELeave) CServerStartupMgr(KDmHierarchyIdStartup, KDmIdRoot, TheFs);

	CleanupStack::PushL(serverStartupMgr);

	//check for all the test states

	for(i=0; i<KTestCount; i++)

		{

		TEST2(TServerStartupManager_StateAccessor::GetKnownStartupState(*serverStartupMgr, testStates[i]),

		      resultStates[i]);

		}

	CleanupStack::Pop(serverStartupMgr);

	delete serverStartupMgr;

	ResetSsa(TheTest, TheFs);

	}

/**

@SYMTestCaseID		SYSLIB-ECOM-CT-0179

@SYMTestCaseDesc 	Check that the CServerStartupMgr::InitialiseL() works for the non SSA case correctly.

@SYMTestPriority 	High

@SYMTestActions  	Set SSA to false. Then check that all the MStartupStateObserver

objects registered to server startup manager has switched to the correct known start-up state

as a result of InitialiseL()

@SYMTestExpectedResults The test must not fail.

@SYMPREQ PREQ967

*/

void InitialiseL_NonSsa_TestL()

	{

	TheTest.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-0179 "));

	TestEnableDisableSsaL(TheTest, TheFs);

	DisableSsa(TheTest, TheFs);

	//Create some MStartupServerStateObserver objects

	CStartupStateObserver* dummyObject1 = CStartupStateObserver::NewLC();

	CStartupStateObserver* dummyObject2 = CStartupStateObserver::NewLC();

	CStartupStateObserver* dummyObject3 = CStartupStateObserver::NewLC();

	CServerStartupMgr* serverStartupMgr =

		new(ELeave) CServerStartupMgr(KDmHierarchyIdStartup, KDmIdRoot, TheFs);

	CleanupStack::PushL(serverStartupMgr);

	//Register MStartupServerStateObserver objects

	serverStartupMgr->RegisterObserverL(dummyObject1);

	serverStartupMgr->RegisterObserverL(dummyObject2);

	serverStartupMgr->RegisterObserverL(dummyObject3);

	TServerStartupManager_StateAccessor::SetKnownStartupState

		(*serverStartupMgr, EStartupStateUndefined);

	TServerStartupManager_StateAccessor::SetStateL

		(*serverStartupMgr, EStartupStateUndefined);

	serverStartupMgr->InitialiseL(EFalse);

	//Now that CDmDomain::ConstructL() is called check that each

	//MStartupServerStateObserver object is set to

	//TSsoState::SsoAllPluginsInternalized

	TServerStartupManager_StateAccessor::TestStateAwareObjectsForState

		(*serverStartupMgr, CStartupStateObserver::SsoAllPluginsInternalized);

	TEST2(serverStartupMgr->CurrentStartupState(), EStartupStateNonCritical);

	CleanupStack::Pop(serverStartupMgr);

	delete serverStartupMgr;

	CleanupStack::PopAndDestroy(dummyObject3);

	CleanupStack::PopAndDestroy(dummyObject2);

	CleanupStack::PopAndDestroy(dummyObject1);

	ResetSsa(TheTest, TheFs);

	}

/**

@SYMTestCaseID		SYSLIB-ECOM-CT-0180

@SYMTestCaseDesc 	Check that the CServerStartupMgr::InitialiseL() works for the SSA case correctly.

@SYMTestPriority 	High

@SYMTestActions  	Set SSA to true. Then check that all the MStartupStateObserver

objects registered to server startup manager has switched to the correct known start-up

state as a result of InitialiseL(). Next check that correct actions have been taken

when known startup state for server startup manager is set to all possible values

and after InitialiseL() has been called.

@SYMTestExpectedResults The test must not fail.

@SYMPREQ PREQ967

*/

void InitialiseL_Ssa_TestL()

	{

	TheTest.Next(_L(" @SYMTestCaseID:SYSLIB-ECOM-CT-0180 "));

	TestEnableDisableSsaL(TheTest, TheFs);

	EnableSsa(TheTest, TheFs);

	//Create some MStartupServerStateObserver objects

	CStartupStateObserver* dummyObject1 = CStartupStateObserver::NewLC();

	CStartupStateObserver* dummyObject2 = CStartupStateObserver::NewLC();

	CStartupStateObserver* dummyObject3 = CStartupStateObserver::NewLC();

	CServerStartupMgr* serverStartupMgr =

		new(ELeave) CServerStartupMgr(KDmHierarchyIdStartup, KDmIdRoot, TheFs);

	CleanupStack::PushL(serverStartupMgr);

	//Register MStartupServerStateObserver objects

	serverStartupMgr->RegisterObserverL(dummyObject1);

	serverStartupMgr->RegisterObserverL(dummyObject2);

	serverStartupMgr->RegisterObserverL(dummyObject3);

	//initialise the domain

	//set the state for CDmDomain

	TServerStartupManager_StateAccessor::SetStateL

		(*serverStartupMgr, EStartupStateCriticalStatic);

	serverStartupMgr->InitialiseL(ETrue);

	//Now that CDmDomain::ConstructL() is called check that each

	//MStartupServerStateObserver object is set to

	//TSsoState::SsoCriticalPlugingsInternalized

	TServerStartupManager_StateAccessor::TestStateAwareObjectsForState

		(*serverStartupMgr, CStartupStateObserver::SsoCriticalPlugingsInternalized);

	// Following tests ensure that

	//    - For each state RequestTransitionNotification() is called

	//	  - For EStartupStateUndefined or EStartupStateNonCritical

	//	  the request of notification is cancelled.

	//    - Each MStartupServerStateObserver object is set to their

	//      corresponding state

	//Test for EStartupStateUndefined

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateUndefined,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							ETrue,

							CStartupStateObserver::SsoAllPluginsInternalized,

							EStartupStateNonCritical,ETrue);

	//Test for a user defined state

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateCriticalStatic-1,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							EFalse,

							CStartupStateObserver::SsoNoPluginsInternalized,

							EStartupStateUndefined,ETrue);

	//Test for EStartupStateCriticalStatic

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateCriticalStatic,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							EFalse,

							CStartupStateObserver::SsoCriticalPlugingsInternalized,

							EStartupStateCriticalStatic,ETrue);

	//Test for a user defined state

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateCriticalDynamic-1,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							EFalse,

							CStartupStateObserver::SsoCriticalPlugingsInternalized,

							EStartupStateCriticalStatic,ETrue);

	//Test for EStartupStateCriticalDynamic

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateCriticalDynamic,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							EFalse,

							CStartupStateObserver::SsoCriticalPlugingsInternalized,

							EStartupStateCriticalDynamic,ETrue);

	//Test for a user defined state

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateNonCritical-1,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							EFalse,

							CStartupStateObserver::SsoCriticalPlugingsInternalized,

							EStartupStateCriticalDynamic,ETrue);

	//Test for EStartupStateNonCritical

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateNonCritical,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							ETrue,

							CStartupStateObserver::SsoAllPluginsInternalized,

							EStartupStateNonCritical,ETrue);

	//Test for a user defined state

	CheckForInitialiseStateChangeL(*serverStartupMgr, EStartupStateNonCritical+1,

							CStartupStateObserver::SsoNoPluginsInternalized,

							ETrue,

							ETrue,

							CStartupStateObserver::SsoAllPluginsInternalized,

							EStartupStateNonCritical,ETrue);

	CleanupStack::Pop(serverStartupMgr);

	delete serverStartupMgr;

	CleanupStack::PopAndDestroy(dummyObject3);

	CleanupStack::PopAndDestroy(dummyObject2);

	CleanupStack::PopAndDestroy(dummyObject1);

	ResetSsa(TheTest, TheFs);

	}

/**

@SYMTestCaseID		SYSLIB-ECOM-CT-0181

@SYMTestCaseDesc 	Check that the CServerStartupMgr::RunL() works correctly.

@SYMTestPriority 	High

@SYMTestActions  	Set SSA to true. Then check that correct actions have