sl@0: // Copyright (c) 2002-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 "TestFrameworkMain.h"
sl@0: #include "../../recog/TestFrameworkRecog.h"
sl@0: #include "script.h"
sl@0: #include "parseline.h"
sl@0: #include "Filename.h"
sl@0: #include "config.h"
sl@0: 
sl@0: // Hurricane emulator only - start all services which we require to run tests.
sl@0: // Future enhancement :- add these startups to TestUtils
sl@0: #if defined(__WINS__)
sl@0: IMPORT_C TInt FbsStartup();
sl@0: #endif
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Literals : program information and usage
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: _LIT(KTxtFrameworkStarting, "%S %S %S starting....");
sl@0: //_LIT(KTxtUseExample,"Usage:\nTESTFRAMEWORK [-C] [-F] <file.script> [file.ini]"); // EABI warning removal
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Compiler switches
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: #ifdef _WIN32
sl@0: _LIT(KTxtTarget,"WINS");
sl@0: #else 
sl@0: #ifdef __MARM_THUMB__ 
sl@0: _LIT(KTxtTarget,"THUMB");
sl@0: #else
sl@0: _LIT(KTxtTarget,"ARM4");
sl@0: #endif
sl@0: #endif
sl@0: 
sl@0: #ifdef _DEBUG
sl@0: _LIT(KTxtBuild,"udeb");
sl@0: #else
sl@0: _LIT(KTxtBuild,"urel");
sl@0: #endif
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * max length of command line
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: const TInt KMaxLenCmdLine = 256;
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Test Framework startup function.
sl@0:  * Creates an active scheduler for input if required, reads
sl@0:  * the command line, starts the main test loop.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void StartupL()
sl@0: 	{
sl@0: 	CActiveScheduler* pA=new(ELeave) CActiveScheduler;
sl@0: 	CleanupStack::PushL(pA);
sl@0: 	CActiveScheduler::Install(pA);
sl@0: 
sl@0: // Hurricane emulator only - start all services which we require to run tests.
sl@0: // Future enhancement :- add these startups to TestUtils
sl@0: #if defined(__WINS__)
sl@0: 	#ifndef EXCLUDE_FOR_UNITTEST
sl@0: 	FbsStartup();
sl@0: 	#endif // EXCLUDE_FOR_UNITTEST
sl@0: #endif
sl@0: 
sl@0: 	// read the command line into cmd
sl@0: 	TPtr16 cmd(REINTERPRET_CAST(TUint16*,User::AllocLC(KMaxLenCmdLine*2)), 0, KMaxLenCmdLine);
sl@0: 	cmd.Fill('\0', KMaxLenCmdLine);
sl@0: 
sl@0: 	User::CommandLine(cmd);
sl@0: 	cmd.UpperCase();
sl@0: 
sl@0: 	CTestFrameworkMain* tester = CTestFrameworkMain::NewLC();
sl@0: 	tester->StartTestingL(cmd);
sl@0: 
sl@0: 	// NOTE. Currently there is no need to start the active scheduler, as the input console is
sl@0: 	// now at the server. This will however change when AOs are implemented to replace
sl@0: 	// the main client loop.
sl@0: 
sl@0: 	// CActiveScheduler::Start();
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(3);	//tester, pA, cmd
sl@0: 	}
sl@0: 
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: 	{
sl@0: 
sl@0: 	__UHEAP_MARK;
sl@0: 	CTrapCleanup* cleanup = CTrapCleanup::New(); // get clean-up stack
sl@0: 	
sl@0: 	// start scheduler 
sl@0: 	TRAPD(error, StartupL());
sl@0: 	__ASSERT_ALWAYS(!error, User::Panic(_L("TestFramework"), error));
sl@0: 
sl@0: 	delete cleanup; // destroy clean-up stack
sl@0: 	__UHEAP_MARKEND;
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: // Instructions for Console Display
sl@0: // Please add new entries to the right hand column, 
sl@0: // Precede number and text with "\t "
sl@0: // Leave \n\ at end of each line except the last line
sl@0: //_LIT(KTxtMainInstructions, "Welcome to TestFramework. Press Q to quit ");	// EABI warning removal
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestFrameworkMain static constructor.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: CTestFrameworkMain* CTestFrameworkMain::NewLC()
sl@0: 	{
sl@0: 	CTestFrameworkMain* s = new(ELeave) CTestFrameworkMain;
sl@0: 	CleanupStack::PushL(s);
sl@0: 	s->ConstructL();
sl@0: 	return s;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestFrameworkMain first-phase constructor.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: CTestFrameworkMain::CTestFrameworkMain()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestFrameworkMain second-phase constructor.
sl@0:  * Loads log client and test utils.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestFrameworkMain::ConstructL()
sl@0: 	{
sl@0: 	iLogClient	  = CLog::NewL();
sl@0: 	iLogMode	  = ELogToConsole | ELogToFile;
sl@0: 	iTestUtils	  = CTestUtils::NewL(iLogClient);
sl@0: 	iGuardTimer   = KNoGuardTimer;	// default value
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestFrameworkMain destructor.
sl@0:  *
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: CTestFrameworkMain::~CTestFrameworkMain()
sl@0: 	{
sl@0: 	delete iTestUtils;
sl@0: 	delete iLogClient;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * CTestFrameworkMain - start testing.
sl@0:  * Calls main test loop.
sl@0:  *
sl@0:  * @param "const TDesC& aCmdLine"
sl@0:  *			The command line
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestFrameworkMain::StartTestingL(const TDesC& aCmdLine)
sl@0: 	{
sl@0: 	RunTestScriptL(aCmdLine);
sl@0: 
sl@0: 	RSemaphore sem;
sl@0: 	TInt err = sem.OpenGlobal(KRecogSemaphoreName);
sl@0: 	if (err==KErrNone)
sl@0: 		{
sl@0: 		// Tell the recognizer thread that we're finished
sl@0: 		sem.Signal();
sl@0: 		sem.Close();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Accessor : log client
sl@0:  *
sl@0:  * @return	"CLog*"
sl@0:  *			The log client
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: CLog* CTestFrameworkMain::LogClient() const
sl@0: 	{
sl@0: 	return iLogClient;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Main testing loop.
sl@0:  * Read a script file, parse it and execute each test step in turn.
sl@0:  *
sl@0:  * @param "const TDesC& aCmdLine"
sl@0:  *			The command line
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestFrameworkMain::RunTestScriptL(const TDesC& aCmdLine)
sl@0: 	{
sl@0: 	// use TLex to decode the cmd line
sl@0: 	TLex lex(aCmdLine);
sl@0: 	TPtrC token=lex.NextToken();
sl@0: 	
sl@0: 	// if there is no input filename on the cmd line, panic
sl@0: 	if (token.Length() == 0) 
sl@0: 		UsageL();
sl@0: 	else
sl@0: 		{
sl@0: 		// Process any options
sl@0: 		while(token.Length() > 1 && token[0] == '-')
sl@0: 			{
sl@0: 			switch(token[1])
sl@0: 				{
sl@0: 				case 'C':
sl@0: 				case 'c':
sl@0: 					// log to console ONLY
sl@0: 					iLogMode = ELogToConsole;
sl@0: 					break;
sl@0: 				case 'A':
sl@0: 				case 'a':
sl@0: 					iLogMode |= ELogConsoleFull;
sl@0: 					break;
sl@0: 				case 'F':
sl@0: 				case 'f':
sl@0: 					// log to file ONLY
sl@0: 					iLogMode = ELogToFile; 
sl@0: 					break;
sl@0: 				case 'P':
sl@0: 				case 'p':
sl@0: 					// log to port AS WELL AS to console / file
sl@0: 					iLogMode |= ELogToPort;
sl@0: 					break;
sl@0: 				//This stops the emulator from thowing int 3 if a panic occurs in debug builds
sl@0: 				case 'T':
sl@0: 				case 't':
sl@0: 					User::SetJustInTime(EFalse);
sl@0: 				// -S flag removed - was for old Unit Test mode only
sl@0: 				// -A 'automated mode' removed - it's always automated
sl@0: 					break;
sl@0: 				case 'G':
sl@0: 				case 'g':
sl@0: 					{
sl@0: 					// ** guard timer override - get numeric value that follows
sl@0: 					TPtrC val = &token[2];
sl@0: 					TLex lexTimeOut(val);
sl@0: 					if (lexTimeOut.Val(iGuardTimer) != KErrNone)
sl@0: 						UsageL();
sl@0: 					}
sl@0: 					break;
sl@0: 				case 'm':
sl@0: 				case 'M':
sl@0: 					{
sl@0: 					if (token.Length()<=2)
sl@0: 						{
sl@0: 						// only -m found. must be -m<arg> with no space
sl@0: 						UsageL();
sl@0: 						}
sl@0: 					TPtrC restOfLine = &token[2]; // this will be rest of command line
sl@0: 					TLex argument(restOfLine);
sl@0: 					TPtrC matchString = argument.NextToken(); // will be the argument itself
sl@0: 					ASSERT(matchString.Length()>1);
sl@0: 					iTestMatchString = matchString;
sl@0: 					}
sl@0: 					break;
sl@0: 				case 'Q':
sl@0: 				case 'q':
sl@0: 					{
sl@0: 					// This flag has been removed.  This block is just to ensure that if used it wont panic
sl@0: 					}
sl@0: 					break;
sl@0: 
sl@0: 				default:
sl@0: 					UsageL();
sl@0: 					return;
sl@0: 				}
sl@0: 
sl@0: 			token.Set(lex.NextToken());
sl@0: 			}
sl@0: 
sl@0: 		// save the input filename
sl@0: 		CFileName* scriptFileName = CFileName::NewLC();
sl@0: 		*scriptFileName = token;
sl@0: 
sl@0: 		// make the log file name from the script file name
sl@0: 		CFileName* logFileName = CFileName::NewLC();
sl@0: 		*logFileName = token;
sl@0: 		RDebug::Print(_L("TestFrameWorkMain.cpp: RunTestScriptL 1"));
sl@0: 		// open the log file
sl@0: 		iLogClient->OpenLogFileL(logFileName->FileName(), iLogMode);
sl@0: 		RDebug::Print(_L("TestFrameWorkMain.cpp: RunTestScriptL 2"));	
sl@0: 		iLogClient->LogExtra(__FILE8__, __LINE__, ESevrInfo,
sl@0: 				KTxtFrameworkStarting, &KTxtVersion(), &KTxtTarget(), &KTxtBuild());
sl@0: 		RDebug::Print(_L("TestFrameWorkMain.cpp: RunTestScriptL 3"));
sl@0: 		// create a ParseScript object
sl@0: 		CScript* parseScript = CScript::NewLC(iTestUtils, 
sl@0: 											  iLogClient, 
sl@0: 											  iGuardTimer,
sl@0: 											  iTestMatchString);
sl@0: 		RDebug::Print(_L("TestFrameWorkMain.cpp: RunTestScriptL 4"));
sl@0: 		// parse all scripts
sl@0: 		do
sl@0: 			{
sl@0: 			// get the next file
sl@0: 			*scriptFileName = token;
sl@0: 				
sl@0: 			// read in the script file
sl@0: 			if ( parseScript->OpenScriptFile(scriptFileName))
sl@0: 				{
sl@0: 				// process it
sl@0: 				parseScript->ExecuteScriptL();
sl@0: 				// display results summary
sl@0: 				parseScript->DisplayResults();
sl@0: 				}
sl@0: 			// get the next
sl@0: 			token.Set(lex.NextToken());
sl@0: 			} while ( token.Length()!=0 );
sl@0: 		RDebug::Print(_L("TestFrameWorkMain.cpp: RunTestScriptL 5"));
sl@0: 		CleanupStack::PopAndDestroy(parseScript);
sl@0: 
sl@0: 		// close the logging system
sl@0: 		iLogClient->CloseLogFile();
sl@0: 
sl@0: 		CleanupStack::PopAndDestroy(logFileName);
sl@0: 		CleanupStack::PopAndDestroy(scriptFileName);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Display command line format.
sl@0:  * 
sl@0:  * @xxxx
sl@0:  *
sl@0:  */
sl@0: void CTestFrameworkMain::UsageL()
sl@0: 	{
sl@0: 	// If command line is erroneous, raise a panic. 
sl@0: 	// At this point, there may be no log outputs at all.
sl@0: 	User::Panic(_L("TestFramework"), 2);
sl@0: 	}