--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/phonebookui/Phonebook2/tsrc/UT_AddFavoritiesVisibility/src/UT_AddFavoritiesVisibility.cpp Wed Sep 01 12:29:52 2010 +0100
@@ -0,0 +1,594 @@
+/*
+* Copyright (c) 2002 - 2007 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: UT_AddFavoritiesVisibility class member functions
+*
+*/
+
+
+
+// [INCLUDE FILES] - do not remove
+#include <Stiftestinterface.h>
+#include "UT_AddFavoritiesVisibility.h"
+#include <SettingServerClient.h>
+#include <CVPbkContactTestUtils.h>
+#include <centralrepository.h>
+#include "stifunitmacros.h"
+#include "CPbk2AddFavoritesVisibilityImpl.h"
+#include "CCallbackTimer.h"
+
+
+// Logging path
+_LIT( KUT_AddFavoritiesVisibilityLogPath, "\\logs\\testframework\\UT_AddFavoritiesVisibility\\" );
+// Log file
+_LIT( KUT_AddFavoritiesVisibilityLogFile, "UT_AddFavoritiesVisibility.txt" );
+_LIT( KUT_AddFavoritiesVisibilityLogFileWithTitle, "UT_AddFavoritiesVisibility_[%S].txt" );
+
+#define GETPTR &
+#define ENTRY(str1,str2,func1,func2,func3) {(const TText*)(L##str1 L" [" L##str2 L"]"),GETPTR func1,GETPTR func2, GETPTR func3, 0,0,0}
+#define OOM_ENTRY(str1,str2,func1,func2,func3,a,b,c) {(const TText*)(L##str1 L" [" L##str2 L"]"), GETPTR func1,GETPTR func2, GETPTR func3,a,b,c}
+
+typedef void (CUT_AddFavoritiesVisibility::* TestFunction)();
+
+class TCaseInfoInternal
+ {
+ public:
+ const TText* iCaseName;
+ TestFunction iSetup;
+ TestFunction iMethod;
+ TestFunction iTeardown;
+ TBool iIsOOMTest;
+ TInt iFirstMemoryAllocation;
+ TInt iLastMemoryAllocation;
+ TPtrC CaseName() const {return TPtrC(iCaseName);};
+ };
+
+const TUint32 KPhonebookAddFavoritiesVisibility = 0x00000006;
+
+// ============================= LOCAL FUNCTIONS ===============================
+// ============================ MEMBER FUNCTIONS ===============================
+void CUT_AddFavoritiesVisibility::SetTCPromotionL(TInt aVal)
+ {
+ TInt res = iRepository->Set(KPhonebookAddFavoritiesVisibility, aVal);
+ STIF_ASSERT(res == KErrNone);
+ }
+
+void CUT_AddFavoritiesVisibility::CmdItemVisibilityChanged( TInt /*aCmdId*/, TBool aVisible )
+ {
+ iCallbackTimer->CallbackReceived(); // fall back to test case
+
+ iCallbackReceived = ETrue;
+ iCallbackRes = aVisible;
+
+ if(iTestLeave)
+ {
+ User::Leave(KErrGeneral); // This is to be trapped by class under test
+ }
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::CUT_AddFavoritiesVisibility
+// C++ default constructor can NOT contain any code, that
+// might leave.
+// -----------------------------------------------------------------------------
+//
+CUT_AddFavoritiesVisibility::CUT_AddFavoritiesVisibility()
+ {
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::ConstructL
+// Symbian 2nd phase constructor can leave.
+//
+// Note: If OOM test case uses STIF Logger, then STIF Logger must be created
+// with static buffer size parameter (aStaticBufferSize). Otherwise Logger
+// allocates memory from heap and therefore causes error situations with OOM
+// testing. For more information about STIF Logger construction, see STIF Users
+// Guide.
+// -----------------------------------------------------------------------------
+//
+void CUT_AddFavoritiesVisibility::ConstructL()
+ {
+ //Read logger settings to check whether test case name is to be
+ //appended to log file name.
+ RSettingServer settingServer;
+ TInt ret = settingServer.Connect();
+ if(ret != KErrNone)
+ {
+ User::Leave(ret);
+ }
+ // Struct to StifLogger settigs.
+ TLoggerSettings loggerSettings;
+ // Parse StifLogger defaults from STIF initialization file.
+ ret = settingServer.GetLoggerSettings(loggerSettings);
+ if(ret != KErrNone)
+ {
+ User::Leave(ret);
+ }
+ // Close Setting server session
+ settingServer.Close();
+ iAddTestCaseTitleToLogName = loggerSettings.iAddTestCaseTitle;
+
+ iStdLog = CStifLogger::NewL( KUT_AddFavoritiesVisibilityLogPath,
+ KUT_AddFavoritiesVisibilityLogFile);
+ iLog = iStdLog;
+
+ // Sample how to use logging
+ _LIT( KLogStart, "UT_AddFavoritiesVisibility logging starts!" );
+ iLog->Log( KLogStart );
+
+ iVersionLogged = EFalse;
+
+ if(!CActiveScheduler::Current())
+ {
+ iAS = new(ELeave) CActiveScheduler;
+ CActiveScheduler::Install(iAS);
+ }
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::NewL
+// Two-phased constructor.
+// -----------------------------------------------------------------------------
+//
+CUT_AddFavoritiesVisibility* CUT_AddFavoritiesVisibility::NewL()
+ {
+ CUT_AddFavoritiesVisibility* self = new (ELeave) CUT_AddFavoritiesVisibility;
+
+ CleanupStack::PushL( self );
+ self->ConstructL();
+ CleanupStack::Pop();
+
+ return self;
+
+ }
+
+// Destructor
+CUT_AddFavoritiesVisibility::~CUT_AddFavoritiesVisibility()
+ {
+ iLog = NULL;
+ delete iStdLog;
+ iStdLog = NULL;
+ delete iTCLog;
+ iTCLog = NULL;
+ delete iRepository;
+ delete iVisibilityImpl;
+ CActiveScheduler::Install(NULL);
+ delete iAS;
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::InitL
+// InitL is used to initialize the Test Module.
+// -----------------------------------------------------------------------------
+//
+TInt CUT_AddFavoritiesVisibility::InitL(
+ TFileName& /*aIniFile*/,
+ TBool /*aFirstTime*/ )
+ {
+ return KErrNone;
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::GetTestCasesL
+// GetTestCases is used to inquire test cases from the Test Module. Test
+// cases are stored to array of test cases. The Test Framework will be
+// the owner of the data in the RPointerArray after GetTestCases return
+// and it does the memory deallocation.
+// -----------------------------------------------------------------------------
+//
+TInt CUT_AddFavoritiesVisibility::GetTestCasesL(
+ const TFileName& /*aConfig*/,
+ RPointerArray<TTestCaseInfo>& aTestCases )
+ {
+
+ // Loop through all test cases and create new
+ // TTestCaseInfo items and append items to aTestCase array
+ for( TInt i = 0; Case(i).iMethod != NULL; i++ )
+ {
+
+ // Allocate new TTestCaseInfo from heap for a testcase definition.
+ TTestCaseInfo* newCase = new( ELeave ) TTestCaseInfo();
+
+ // PushL TTestCaseInfo to CleanupStack.
+ CleanupStack::PushL( newCase );
+
+ // Set number for the testcase.
+ // When the testcase is run, this comes as a parameter to RunTestCaseL.
+ newCase->iCaseNumber = i;
+
+ // Set title for the test case. This is shown in UI to user.
+ newCase->iTitle.Copy( Case(i).CaseName() );
+
+ // Append TTestCaseInfo to the testcase array. After appended
+ // successfully the TTestCaseInfo object is owned (and freed)
+ // by the TestServer.
+ User::LeaveIfError(aTestCases.Append ( newCase ) );
+
+ // Pop TTestCaseInfo from the CleanupStack.
+ CleanupStack::Pop( newCase );
+
+ }
+
+ return KErrNone;
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::RunTestCaseL
+// RunTestCaseL is used to run an individual test case specified
+// by aTestCase. Test cases that can be run may be requested from
+// Test Module by GetTestCases method before calling RunTestCase.
+// -----------------------------------------------------------------------------
+//
+TInt CUT_AddFavoritiesVisibility::RunTestCaseL(
+ const TInt aCaseNumber,
+ const TFileName& /*aConfig*/,
+ TTestResult& aResult )
+ {
+ iResult = &aResult;
+ if(!iVersionLogged)
+ {
+ SendTestModuleVersion();
+ iVersionLogged = ETrue;
+ }
+
+ // Return value
+ TInt execStatus = KErrNone;
+
+ // Get the pointer to test case function
+ const TCaseInfoInternal& tmp = Case ( aCaseNumber );
+
+ _LIT( KLogStartTC, "Starting testcase [%S]" );
+ TPtrC caseName = tmp.CaseName();
+ iLog->Log( KLogStartTC, &caseName);
+
+ // Check that case number was valid
+ if ( tmp.iMethod != NULL )
+ {
+ //Open new log file with test case title in file name
+ if(iAddTestCaseTitleToLogName)
+ {
+ //Delete test case logger if exists
+ if(iTCLog)
+ {
+ delete iTCLog;
+ iTCLog = NULL;
+ }
+
+ TFileName logFileName;
+ TName title;
+ TestModuleIf().GetTestCaseTitleL(title);
+
+ logFileName.Format(KUT_AddFavoritiesVisibilityLogFileWithTitle, &title);
+
+ iTCLog = CStifLogger::NewL(KUT_AddFavoritiesVisibilityLogPath,
+ logFileName);
+ iLog = iTCLog;
+ }
+
+
+ TInt err = KErrNone;
+ TRAP(err, ( this->*(tmp.iSetup) )());
+ if(err!=KErrNone)
+ {
+ _LIT( KDescription, "Setup failed" );
+ aResult.SetResult( err, KDescription );
+ execStatus = KErrNone;
+ }
+ else
+ {
+ aResult.iResult = KErrNone;
+ TRAP(err, ( this->*(tmp.iMethod) )());
+ if(err==KErrNone)
+ {
+ _LIT( KDescription, "Test passed" );
+ aResult.SetResult( err, KDescription );
+ }
+ else if ( aResult.iResult == KErrNone )
+ {
+ _LIT( KDescription, "Test failed" );
+ aResult.SetResult( err, KDescription );
+ }
+ TRAP(err, ( this->*(tmp.iTeardown) )());
+ if(err!=KErrNone)
+ {
+ _LIT( KDescription, "Teardown failed" );
+ aResult.SetResult( err, KDescription );
+ execStatus = KErrNone;
+ }
+ }
+ }
+ else
+ {
+ // Valid case was not found, return error.
+ execStatus = KErrNotFound;
+ }
+
+ // Return case execution status (not the result of the case execution)
+ return execStatus;
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::OOMTestQueryL
+// Used to check if a particular test case should be run in OOM conditions and
+// which memory allocations should fail.
+// -----------------------------------------------------------------------------
+//
+TBool CUT_AddFavoritiesVisibility::OOMTestQueryL(
+ const TFileName& /* aTestCaseFile */,
+ const TInt aCaseNumber,
+ TOOMFailureType& /* aFailureType */,
+ TInt& aFirstMemFailure,
+ TInt& aLastMemFailure )
+ {
+ _LIT( KLogOOMTestQueryL, "CUT_AddFavoritiesVisibility::OOMTestQueryL" );
+ iLog->Log( KLogOOMTestQueryL );
+
+ aFirstMemFailure = Case( aCaseNumber ).iFirstMemoryAllocation;
+ aLastMemFailure = Case( aCaseNumber ).iLastMemoryAllocation;
+
+ return Case( aCaseNumber ).iIsOOMTest;
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::OOMTestInitializeL
+// Used to perform the test environment setup for a particular OOM test case.
+// Test Modules may use the initialization file to read parameters for Test
+// Module initialization but they can also have their own configure file or
+// some other routine to initialize themselves.
+//
+// NOTE: User may add implementation for OOM test environment initialization.
+// Usually no implementation is required.
+// -----------------------------------------------------------------------------
+//
+void CUT_AddFavoritiesVisibility::OOMTestInitializeL(
+ const TFileName& /* aTestCaseFile */,
+ const TInt /* aCaseNumber */ )
+ {
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::OOMHandleWarningL
+// In some cases the heap memory allocation should be skipped, either due to
+// problems in the OS code or components used by the code being tested, or even
+// inside the tested components which are implemented this way on purpose (by
+// design), so it is important to give the tester a way to bypass allocation
+// failures.
+//
+// NOTE: User may add implementation for OOM test warning handling. Usually no
+// implementation is required.
+// -----------------------------------------------------------------------------
+//
+void CUT_AddFavoritiesVisibility::OOMHandleWarningL(
+ const TFileName& /* aTestCaseFile */,
+ const TInt /* aCaseNumber */,
+ TInt& /* aFailNextValue */ )
+ {
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::OOMTestFinalizeL
+// Used to perform the test environment cleanup for a particular OOM test case.
+//
+// NOTE: User may add implementation for OOM test environment finalization.
+// Usually no implementation is required.
+// -----------------------------------------------------------------------------
+//
+void CUT_AddFavoritiesVisibility::OOMTestFinalizeL(
+ const TFileName& /* aTestCaseFile */,
+ const TInt /* aCaseNumber */ )
+ {
+ }
+
+//-----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::SendTestModuleVersion
+// Method used to send version of test module
+//-----------------------------------------------------------------------------
+//
+void CUT_AddFavoritiesVisibility::SendTestModuleVersion()
+ {
+ TVersion moduleVersion;
+ moduleVersion.iMajor = TEST_MODULE_VERSION_MAJOR;
+ moduleVersion.iMinor = TEST_MODULE_VERSION_MINOR;
+ moduleVersion.iBuild = TEST_MODULE_VERSION_BUILD;
+
+ TFileName moduleName;
+ moduleName = _L("UT_AddFavoritiesVisibility.dll");
+
+ TestModuleIf().SendTestModuleVersion(moduleVersion, moduleName);
+ }
+
+// ========================== OTHER EXPORTED FUNCTIONS =========================
+
+// -----------------------------------------------------------------------------
+// LibEntryL is a polymorphic Dll entry point
+// Returns: CTestModuleBase*: Pointer to Test Module object
+// -----------------------------------------------------------------------------
+//
+EXPORT_C CTestModuleBase* LibEntryL()
+ {
+ return CUT_AddFavoritiesVisibility::NewL();
+
+ }
+
+// -----------------------------------------------------------------------------
+// SetRequirements handles test module parameters(implements evolution
+// version 1 for test module's heap and stack sizes configuring).
+// Returns: TInt: Symbian error code.
+// -----------------------------------------------------------------------------
+//
+EXPORT_C TInt SetRequirements( CTestModuleParam*& /*aTestModuleParam*/,
+ TUint32& /*aParameterValid*/ )
+ {
+
+ /* --------------------------------- NOTE ---------------------------------
+ USER PANICS occurs in test thread creation when:
+ 1) "The panic occurs when the value of the stack size is negative."
+ 2) "The panic occurs if the minimum heap size specified is less
+ than KMinHeapSize".
+ KMinHeapSize: "Functions that require a new heap to be allocated will
+ either panic, or will reset the required heap size to this value if
+ a smaller heap size is specified".
+ 3) "The panic occurs if the minimum heap size specified is greater than
+ the maximum size to which the heap can grow".
+ Other:
+ 1) Make sure that your hardware or Symbian OS is supporting given sizes.
+ e.g. Hardware might support only sizes that are divisible by four.
+ ------------------------------- NOTE end ------------------------------- */
+
+ // Normally STIF uses default heap and stack sizes for test thread, see:
+ // KTestThreadMinHeap, KTestThreadMinHeap and KStackSize.
+ // If needed heap and stack sizes can be configured here by user. Remove
+ // comments and define sizes.
+
+/*
+ aParameterValid = KStifTestModuleParameterChanged;
+
+ CTestModuleParamVer01* param = CTestModuleParamVer01::NewL();
+ // Stack size
+ param->iTestThreadStackSize= 16384; // 16K stack
+ // Heap sizes
+ param->iTestThreadMinHeap = 4096; // 4K heap min
+ param->iTestThreadMaxHeap = 1048576;// 1M heap max
+
+ aTestModuleParam = param;
+*/
+ return KErrNone;
+
+ }
+
+// -----------------------------------------------------------------------------
+// CUT_AddFavoritiesVisibility::Case
+// Returns a test case by number.
+//
+// This function contains an array of all available test cases
+// i.e pair of case name and test function. If case specified by parameter
+// aCaseNumber is found from array, then that item is returned.
+//
+// The reason for this rather complicated function is to specify all the
+// test cases only in one place. It is not necessary to understand how
+// function pointers to class member functions works when adding new test
+// cases. See function body for instructions how to add new test case.
+// -----------------------------------------------------------------------------
+//
+const TCaseInfoInternal& CUT_AddFavoritiesVisibility::Case (
+ const TInt aCaseNumber ) const
+ {
+
+ /**
+ * To add new test cases, implement new test case function and add new
+ * line to KCases array specify the name of the case and the function
+ * doing the test case
+ * In practice, do following
+ * 1) Make copy of existing test case function and change its name
+ * and functionality. Note that the function must be added to
+ * UT_AddFavoritiesVisibility.cpp file and to UT_AddFavoritiesVisibility.h
+ * header file.
+ *
+ * 2) Add entry to following KCases array either by using:
+ *
+ * 2.1: FUNCENTRY or ENTRY macro
+ * ENTRY macro takes two parameters: test case name and test case
+ * function name.
+ *
+ * FUNCENTRY macro takes only test case function name as a parameter and
+ * uses that as a test case name and test case function name.
+ *
+ * Or
+ *
+ * 2.2: OOM_FUNCENTRY or OOM_ENTRY macro. Note that these macros are used
+ * only with OOM (Out-Of-Memory) testing!
+ *
+ * OOM_ENTRY macro takes five parameters: test case name, test case
+ * function name, TBool which specifies is method supposed to be run using
+ * OOM conditions, TInt value for first heap memory allocation failure and
+ * TInt value for last heap memory allocation failure.
+ *
+ * OOM_FUNCENTRY macro takes test case function name as a parameter and uses
+ * that as a test case name, TBool which specifies is method supposed to be
+ * run using OOM conditions, TInt value for first heap memory allocation
+ * failure and TInt value for last heap memory allocation failure.
+ */
+
+ static TCaseInfoInternal const KCases[] =
+ {
+ // [test cases entries] - do not remove
+
+ // NOTE: When compiled to GCCE, there must be Classname::
+ // declaration in front of the method name, e.g.
+ // CUT_AddFavoritiesVisibility::PrintTest. Otherwise the compiler
+ // gives errors.
+ //Removed for raptor build
+ //#include "UT_AddFavoritiesVisibilitytesttable.cpp"
+
+ ENTRY("AlwaysON","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupAlwaysON,
+ CUT_AddFavoritiesVisibility::TestAlwaysOnL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("AlwaysOFF","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupAlwaysOFF,
+ CUT_AddFavoritiesVisibility::TestAlwaysOFFL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("FirstTimeUse","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupFirstTimeUse,
+ CUT_AddFavoritiesVisibility::TestFirstTimeUseL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("TCPromotionMinus1","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupTCPromotionMinus1,
+ CUT_AddFavoritiesVisibility::TestAlwaysOFFL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("TCPromotionMinus5000","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupTCPromotionMinus5000,
+ CUT_AddFavoritiesVisibility::TestAlwaysOFFL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("TCPromotion3","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupTCPromotion3,
+ CUT_AddFavoritiesVisibility::TestAlwaysOFFL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("TCPromotion9999","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupTCPromotion9999,
+ CUT_AddFavoritiesVisibility::TestAlwaysOFFL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ ENTRY("TestLeaveInClientCallback","CUT_AddFavoritiesVisibility",
+ CUT_AddFavoritiesVisibility::SetupAlwaysON,
+ CUT_AddFavoritiesVisibility::TestLeaveInClientCallbackL,
+ CUT_AddFavoritiesVisibility::Teardown),
+
+ };
+
+ // Verify that case number is valid
+ if( (TUint) aCaseNumber >= sizeof( KCases ) /
+ sizeof( TCaseInfoInternal ) )
+ {
+ // Invalid case, construct empty object
+ static const TCaseInfoInternal nullCase = {NULL, NULL, NULL,NULL,EFalse,0,0};
+ return nullCase;
+ }
+
+ return KCases[ aCaseNumber ];
+ }
+
+// End of File