// Copyright (c) 2007-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 "httptestutils.h"

#include "httptestcore.h"

#if !defined __E32BASE_H__

#include <e32base.h>

#endif

// for StartC32()

#if !defined __C32COMM_H__

#include <c32comm.h>

#endif

#if !defined __IN_SOCK_H__

#include <in_sock.h>

#endif

//

//	Constants

_LIT(KTestPanic, "HttpTestUtils");

const TInt KFailedTestsGranularity = 10;

const TInt KMaxLogEntrySize = 256;

#if defined (__WINS__)

#define PDD_NAME		_L("ECDRV")

#else

#define PDD_NAME		_L("EUART1")

#define PDD2_NAME		_L("EUART2")

#define PDD3_NAME		_L("EUART3")

#define PDD4_NAME		_L("EUART4")

#endif

#define LDD_NAME		_L("ECOMM")

const TInt KMaxTempBuffize = 256;

_LIT(KTestFileInputBase, "HttpTest");

_LIT(KPathSep,"\\");

//

//	CHTTPTestUtils

//

CHTTPTestUtils::CHTTPTestUtils(const TDesC& aTitle)

	: iTest(aTitle)

//

//	Default c'tor

	{

	iTest.Title();

	iCanStartTest = ETrue;

	}

CHTTPTestUtils::~CHTTPTestUtils()

//

//	D'tor

	{

	TTime endtime;

	endtime.UniversalTime();

	// Do resource handle leak test?

	if (iDoResourceLeakTest)

		ResourceLeakTest();

	//	End of tests - see if failed or ok

	if (iFailedTests->Count())

		{

		TestHarnessFailed();

		}

	else

		{

		TestHarnessComplete();

		}

	//	Log finish time

	TDateTime t = endtime.DateTime();

	LogIt(_L("Ended @ %d:%d:%d:%d"),t.Hour(),t.Minute(),t.Second(),t.MicroSecond());

	TTime difftime(endtime.Int64() - iStartTime.Int64());

	t = difftime.DateTime();

	LogIt(_L("Execution time %d:%d:%d:%d"),t.Hour(),t.Minute(),t.Second(),t.MicroSecond());

	//	Close test harness

	iTest.Close();

	//	Cleanup

	iFailedTests->ResetAndDestroy();

	delete iFailedTests;

	// Close fileserver connection

	iFs.Close();

	}

EXPORT_C CHTTPTestUtils* CHTTPTestUtils::NewLC(const TDesC& aTitle)

//

//	Static factory c'tor

	{

	CHTTPTestUtils* self = new (ELeave) CHTTPTestUtils(aTitle);

	CleanupStack::PushL(self);

	self->ConstructL(aTitle);

	return self;

	}

EXPORT_C CHTTPTestUtils* CHTTPTestUtils::NewL(const TDesC& aTitle)

//

//	Static factiry c'tor

	{

	CHTTPTestUtils* self = CHTTPTestUtils::NewLC(aTitle);

	CleanupStack::Pop();

	return self;

	}

void CHTTPTestUtils::CreateLogFiles(const TDesC& aTestName)

	{

	TBuf<128> logName(aTestName);

	DefaultLogFileName(logName);

	__OPEN_LOG2(logName);

	logName.Append(_L(".SUMMARY"));

	TInt error = iTestSummaryLogger.Connect();

	if(error == KErrNone)

		{

		TParse p;

		p.Set(logName, NULL, NULL);

		iTestSummaryLogger.CreateLog(KHttpLogsDirName, p.NameAndExt(), EFileLoggingModeOverwrite);

		iTestSummaryLogger.SetDateAndTime(ETrue, ETrue);

		iTestSummaryLogger.Write(KTestHeader);

		}

	else

		User::InfoPrint(_L("Log file create failed"));

	}

void CHTTPTestUtils::ConstructL(const TDesC& aTitle)

//

//	Non-trivial c'tor

	{

	iCurrentTest=NULL;

	//	Create iFailedTests

	iFailedTests = new (ELeave) CArrayPtrFlat<CTestInfo> (KFailedTestsGranularity);

	//	Start up logging server connection

	CreateLogFiles(aTitle);

	iStartTime.UniversalTime();

	TDateTime t = iStartTime.DateTime();

	LogIt(_L("Started @ %d:%d:%d:%d"),t.Hour(),t.Minute(),t.Second(),t.MicroSecond());

	// Find number of open resource handles

	TInt processHandleCount=0;

	RThread().HandleCount(processHandleCount,iStartHandleCount);

	// Connect to file server for test scripts, ini-files etc.

	User::LeaveIfError(iFs.Connect());

	}

EXPORT_C void CHTTPTestUtils::JustStartTestL(const TDesC& aName)

	{

	if (iCanStartTest)

		{

		iCurrentTest= CTestInfo::NewL(aName, iTestCount, 0);

		//	Stop new test being started until this one has ended

		iCanStartTest = EFalse;

		}

	else

		{

		//	Panic client - bad usage - not allowed to nest tests

		Panic(EBadStartTest);

		}

	}

EXPORT_C void CHTTPTestUtils::StartTestL(const TDesC& aName)

//

//	Logs start of test aName

	{

	if (iCanStartTest)

		{

		// Add this test to failed test list - set errorcode to zero

		CTestInfo* temp = CTestInfo::NewLC(aName, iTestCount + 1, 0);

		iFailedTests->AppendL(temp);

		CleanupStack::Pop();	//	temp

		iCurrentTest= temp;

		// Increase RTest's test depth by Start-ing - increment test count

		iTest.Start(aName);

		++iTestCount;

		// Stop new test being started until this one has ended

		iCanStartTest = EFalse;

		TBuf<KMaxFileName + 4> buf;

		buf.Format(KTestStartingWithDesc, iTestCount, &aName);

		WriteComment(buf);

		// Reset iStepNumber - start at 1

		iStepNumber = 1;

		}

	else

		{

		// Panic client - bad usage - not allowed to nest tests

		Panic(EBadStartTest);

		}

	}

EXPORT_C void CHTTPTestUtils::NextStep(const TDesC& aStepName)

//

//	Logs the next step in a test - for informative use.

	{

	if (!iCanStartTest)

		{

		TBuf<KMaxFileName + 4> buf;

		buf.Format(KNextTestStepWithDesc, iTestCount, iStepNumber, &aStepName);

		WriteComment(buf);

		iTest.Next(aStepName);

		++iStepNumber;

		}

	else

		{

		//	Panic client - bad usage - test not started

		Panic(EBadStartTest);

		}

	}

EXPORT_C void CHTTPTestUtils::JustEndTest()

	{

	//	Allow new test to start

	iCurrentTest = NULL;

	iCanStartTest = ETrue;

	}

EXPORT_C void CHTTPTestUtils::EndTest(TInt aErrorCode)

//

//	Logs end of test

	{

	if (!iCanStartTest)

		{

		//	Get ptr to this test's entry in failed list - will be the last entry

		TBuf<KMaxFileName + 4> buf;

		TInt index = iFailedTests->Count();

	    CTestInfo* ptr = iFailedTests->At(--index);

		if (aErrorCode)

			{

			//	Set the error code

			ptr->SetErrorCode(aErrorCode);

			buf.Format(KTestFailed, iTestCount, aErrorCode);

			iTest.Printf(KRTestFailed, aErrorCode);

			}

		else

			{

			//	Remove entry from list of failed tests

			delete ptr;

			iFailedTests->Delete(index);

			buf.Format(KTestPassed, iTestCount);

			}

		WriteComment(buf);

		// Decrease RTest's test depth by End-ing

		iTest.End();

		//	Allow new test to start. There's no iCurrentTest until StartTestL is invoked again

		iCurrentTest = NULL;

		iCanStartTest = ETrue;

		}

	else

		{

		//	Panic client - bad usage - test not started

		Panic(EBadEndTest);

		}

	}

EXPORT_C void CHTTPTestUtils::LogIt(TRefByValue<const TDesC> aFmt, ...)

//	Messages to the front end emulator and to the WAP log

	{

	VA_LIST list;

	VA_START(list,aFmt);

	TBuf<2*KMaxFileName> buf;

	buf.Zero();

	if(iCurrentTest)

		buf.Append(iCurrentTest->Name());

	buf.Append(_L(">  "));

	buf.AppendFormatList(aFmt,list,this);

	VA_END(list);

	//write to the console and file, if not silent

	if (!iSilent)

		WriteComment(buf);

	else	// otherwise log to the file only

		__LOG(buf);

	}

EXPORT_C void CHTTPTestUtils::Overflow(TDes& aDes)

	{

	_LIT(KErrOverflowMsg, "...");

	if( aDes.MaxLength() >= KErrOverflowMsg().Length() + aDes.Length() )

		aDes.Append(KErrOverflowMsg);

	}

EXPORT_C void CHTTPTestUtils::operator()(TInt aResult,TInt aLineNum)

//

//	Overload operator ()

	{

	iTest(aResult, aLineNum);

	}

EXPORT_C void CHTTPTestUtils::operator()(TInt aResult)

//

//	Overload operator ()

	{

	iTest(aResult);

	}

EXPORT_C void CHTTPTestUtils::PressAnyKey()

//

//	Request a key press from user and wait - unless we are running a script or we are being silent

	{

	if (!iScriptRunning && !iSilent)

		{

		iTest.Printf(TRefByValue<const TDesC>_L("\nPress a key"));	

		iTest.Getch();

		}

	}

EXPORT_C void CHTTPTestUtils::DumpData(const TDesC8& aData, TBool logIt)

//

//	Do a formatted dump of binary data, optionally logging it

	{

	// Iterate the supplied block of data in blocks of 16 bytes

	TInt pos = 0;

	TBuf<KMaxLogEntrySize> logLine;

	TBuf<KMaxLogEntrySize> anEntry;

	while (pos < aData.Length())

		{

		anEntry.Format(TRefByValue<const TDesC>_L("%04x : "), pos);

		logLine.Append(anEntry);

		// Hex output

		TInt offset;

		for (offset = 0; offset < 16; offset++)

			{

			if (pos + offset < aData.Length())

				{

				TInt nextByte = aData[pos + offset];

				anEntry.Format(TRefByValue<const TDesC>_L("%02x "), nextByte);

				logLine.Append(anEntry);

				}

			else

				{

				anEntry.Format(TRefByValue<const TDesC>_L("   "));

				logLine.Append(anEntry);

				}

			}

			anEntry.Format(TRefByValue<const TDesC>_L(": "));

			logLine.Append(anEntry);

		// Char output

		for (offset = 0; offset < 16; offset++)

			{

			if (pos + offset < aData.Length())

				{

				TInt nextByte = aData[pos + offset];

				if ((nextByte >= 32) && (nextByte <= 127))

					{

					anEntry.Format(TRefByValue<const TDesC>_L("%c"), nextByte);

					logLine.Append(anEntry);

					}

				else

					{

					anEntry.Format(TRefByValue<const TDesC>_L("."));

					logLine.Append(anEntry);

					}

				}

			else

				{

				anEntry.Format(TRefByValue<const TDesC>_L(" "));

				logLine.Append(anEntry);

				}

			}

			if (logIt)

				{

				LogIt(TRefByValue<const TDesC>_L("%S"), &logLine);

				}

			else if (!iSilent)

				{

				iTest.Printf(TRefByValue<const TDesC>_L("%S\n"), &logLine);	

				}

			logLine.Zero();

		// Advance to next 16 byte segment

		pos += 16;

		}

	}

EXPORT_C void CHTTPTestUtils::GetAnEntry(const TDesC& ourPrompt, TDes& currentstring)

//

//	Get an input string from the user, displaying a supplied prompt and default string value

	{

	// If we're scripting, try reading from script first

	TInt readScriptErr = KErrNotFound;

	if (iScriptRunning)

		{

		readScriptErr = ReadLineFromScript(currentstring);

		}

	if (!readScriptErr)

		return;

	// Either not scripting, or hit end of script - continue with user input

	TBuf16<KMaxUserEntrySize> ourLine;

	TBuf<KMaxUserEntrySize> tempstring;				//tempstring is a unicode descriptor

										//create a temporary buffer where the

										//unicode strings are stored in order to 

										//be displayed

	ourLine.Zero ();

	tempstring.Copy(currentstring);		//Copy current string to Unicode buffer

	TKeyCode key = EKeyNull;						//current string buffer is 8 bits wide.

										//Unicode string bufffer (tempstring) is 16 bits wide.

	for (;;)

		{

		if (ourLine.Length () == 0)

			{

			iTest.Console()->SetPos (0, iTest.Console()->WhereY ());

			iTest.Console()->Printf (_L ("%S"), &ourPrompt);

			if (tempstring.Length () != 0)						//get tempstring's number of items

				iTest.Console()->Printf (_L (" = %S"), &tempstring);	//if not zero print them to iTest.Console()

			iTest.Console()->Printf (_L (" : "));

			iTest.Console()->ClearToEndOfLine ();

			}

		key = iTest.Getch();

		  if (key == EKeyBackspace)

				{

					if (ourLine.Length() !=0)

					{

						ourLine.SetLength(ourLine.Length()-1);

						iTest.Console()->Printf (_L ("%c"), key);

						iTest.Console()->SetPos(iTest.Console()->WhereX(),iTest.Console()->WhereY());

						iTest.Console()->ClearToEndOfLine();

					}	// end if (ourLine.Length() !=0)

				}	// end if (key == KeyBackSpace)

		  if (key == EKeyDelete) 			

				{

					ourLine.Zero();

					iTest.Console()->SetPos (0, iTest.Console()->WhereY ());

					iTest.Console()->ClearToEndOfLine ();

					tempstring.Copy(ourLine);

					break;

				}

		  if (key == EKeyEnter)

			break;

		  if (key < 32)

			{

			continue;

			}

		ourLine.Append (key);

		iTest.Console()->Printf (_L ("%c"), key);

		iTest.Console()->SetPos(iTest.Console()->WhereX(),iTest.Console()->WhereY());

		iTest.Console()->ClearToEndOfLine();

		if (ourLine.Length () == ourLine.MaxLength ())

			break;

		}	// end of for statement

	if ((key == EKeyEnter) && (ourLine.Length () == 0))

		tempstring.Copy (currentstring);				//copy contents of 8 bit "ourLine" descriptor

	iTest.Console()->SetPos (0, iTest.Console()->WhereY ());		

	iTest.Console()->ClearToEndOfLine ();

	iTest.Console()->Printf (_L ("%S"), &ourPrompt);

	if ((key == EKeyEnter) && (ourLine.Length() !=0))

		tempstring.Copy(ourLine);

	if (tempstring.Length () != 0)						//if temstring length is not zero

		{

		iTest.Console()->Printf (_L (" = %S\n"), &tempstring);	//print the contents to iTest.Console()

		LogIt(_L ("%S = %S\n"), &ourPrompt, &tempstring);

		}

	else

		//iTest.Console()->Printf (_L (" is empty"));

	iTest.Console()->Printf (_L ("\n"));

	currentstring.Copy(tempstring);						//copy 16 bit tempstring descriptor back 

	}

EXPORT_C TInt CHTTPTestUtils::GetSelection(const TDesC& ourPrompt, const TDesC& validChoices)

//

//	Present the user with a list of options, and get their selection

	{

	// If we're scripting, try reading from script first

	TInt readScriptErr = KErrNotFound;

	if (iScriptRunning)

		{

		TBuf<1> oneCharBuf;

		readScriptErr = ReadLineFromScript(oneCharBuf);

		if (!readScriptErr)

			{

			return validChoices.Locate((TChar)oneCharBuf[0]);

			}

		}

	// Either not scripting, or hit end of script - continue with user input

	TKeyCode key = EKeyNull;

	iTest.Console()->SetPos (0, iTest.Console()->WhereY ());

	Print(ourPrompt);

	iTest.Console()->Printf(_L("[%S] :"), &validChoices);

	TInt retVal = KErrNotFound;

	while (retVal == KErrNotFound)

		{

		key = iTest.Getch();

		// Check that key is in the list of valid choices

		retVal = validChoices.Locate((TChar)key);

		}

	iTest.Console()->Printf(_L("%c\n\n"), key);

	return retVal;

	}