sl@0: /*
sl@0: * Copyright (c) 2004-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 the License "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: 
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file 
sl@0: */
sl@0: #define __INCLUDE_CAPABILITY_NAMES__
sl@0: #include <e32capability.h>
sl@0: 
sl@0: #include "captestframeworkstep.h"
sl@0: #include "captestframework.h"
sl@0: 
sl@0: #include <test/testexecutelog.h>
sl@0: #include <s32file.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: 
sl@0: CCapTestFrameworkStep::CCapTestFrameworkStep(TThoroughness aThoroughness)
sl@0: 	: iThoroughness(aThoroughness)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CCapTestFrameworkStep::~CCapTestFrameworkStep()
sl@0: 	{
sl@0: 	iLibrary.Close();
sl@0: 	iFs.Close();	
sl@0: 	}
sl@0: 	
sl@0: TVerdict CCapTestFrameworkStep::doTestStepPreambleL()
sl@0: 	{
sl@0: 	User::LeaveIfError(iFs.Connect());
sl@0: 	User::LeaveIfError(iFs.ShareProtected());
sl@0: 	
sl@0: 	if (EFalse==GetStringFromConfig(ConfigSection(), _L("DllName"), iDllName))
sl@0: 		{
sl@0: 		return EFail;
sl@0: 		}
sl@0: 
sl@0: 	GetBoolFromConfig(ConfigSection(), _L("OmitTCBCapInComplementSet"), iOmitTCBCapInComplementSet);
sl@0: 
sl@0: 	SetupFactoryL();
sl@0: 	return EPass;
sl@0: 	}
sl@0: 
sl@0: TVerdict CCapTestFrameworkStep::doTestStepL()
sl@0: 	{
sl@0: 	for (iCurrentTest=0; iCurrentTest < iFactory->NumberOfTests(); ++iCurrentTest)
sl@0: 		{
sl@0: 		INFO_PRINTF1(_L(""));
sl@0: 		INFO_PRINTF2(_L("Running %S"), &iFactory->Test(iCurrentTest)->Name());
sl@0: 		INFO_PRINTF1(_L("Assumed to require:"));
sl@0: 		INFO_PRINTF2(_L("\tSid: %x"), iFactory->Test(iCurrentTest)->SidRequired());
sl@0: 		INFO_PRINTF2(_L("\tVid: %x"), iFactory->Test(iCurrentTest)->VidRequired());
sl@0: 		PrintCapabilitySet(iFactory->Test(iCurrentTest)->CapabilitiesRequired(), _L("\tCapabilities: "));
sl@0: 		RunTestStepL(iFactory->Test(iCurrentTest));
sl@0: 		}
sl@0: 	
sl@0: 	return EPass;
sl@0: 	}
sl@0: 
sl@0: void CCapTestFrameworkStep::RunTestStepL(MCapabilityTest* aTest)
sl@0: 	{
sl@0: 	// figure out capabilities required
sl@0: 	TCapabilitySet capsRequired=aTest->CapabilitiesRequired();
sl@0: 	TUid sidRequired=aTest->SidRequired();
sl@0: 	TUid vidRequired=aTest->VidRequired();
sl@0: 	
sl@0: 	RArray<TTestEnvironment> capTestEnvs;
sl@0: 	CleanupClosePushL(capTestEnvs);
sl@0: 	
sl@0: 	GenerateEnvironmentsL(capsRequired, sidRequired, vidRequired, capTestEnvs);
sl@0: 
sl@0: 	// for all cap sets needed
sl@0: 	for (TInt i=0; i < capTestEnvs.Count(); ++i)
sl@0: 		{
sl@0: 		INFO_PRINTF1(_L("With:"));
sl@0: 		INFO_PRINTF2(_L("\tSid: %x"), capTestEnvs[i].iSid);
sl@0: 		INFO_PRINTF2(_L("\tVid: %x"), capTestEnvs[i].iVid);
sl@0: 		PrintCapabilitySet(capTestEnvs[i].iCaps, _L("\tCapabilities: "));
sl@0: 
sl@0: 		// Set the capabilities of the helper
sl@0: 		SetupHelperL(capTestEnvs[i]);
sl@0: 
sl@0: 		// run the helper and check results
sl@0: 		RunHelperL(iCurrentTest, capTestEnvs[i].iExpectPass);
sl@0: 		}
sl@0: 	
sl@0: 	CleanupStack::PopAndDestroy(&capTestEnvs);
sl@0: 	}
sl@0: 
sl@0: void CCapTestFrameworkStep::RunHelperL(TInt aTestNumber, TBool aShouldPass)
sl@0: 	{
sl@0: 	RProcess p;
sl@0: 	
sl@0: 	//Launching process
sl@0: 	User::LeaveIfError(p.Create(_L("tempcaptestframeworkhelper.exe"), KNullDesC));
sl@0: 
sl@0: 	p.SetParameter(KDllNameTransferSlot, iDllName);
sl@0: 	p.SetParameter(KShouldPassTransferSlot, aShouldPass);
sl@0: 	p.SetParameter(KTestNumberTransferSlot, aTestNumber);
sl@0: 	
sl@0: 	_LIT(KLogFileName , "\\captestframework.txt");
sl@0: 	TDriveUnit sysDrive(RFs::GetSystemDrive());
sl@0: 	
sl@0: 	TBuf<128> logFileNameOnSysDrive = sysDrive.Name();
sl@0: 	logFileNameOnSysDrive.Append(KLogFileName);
sl@0: 	p.SetParameter(KLogFileNameTransferSlot, logFileNameOnSysDrive);
sl@0: 	
sl@0: 	// Wait for the test to finish
sl@0: 	TRequestStatus s;
sl@0: 	TRequestStatus& a=s;
sl@0: 	p.Logon(a);
sl@0: 	p.Resume();
sl@0: 	User::WaitForRequest(a);
sl@0: 	p.Close();
sl@0: 
sl@0: 	// Extract the info from the logfile
sl@0: 	RFileReadStream logFile;
sl@0: 	logFile.Open(iFs, logFileNameOnSysDrive, 0);
sl@0: 	CleanupClosePushL(logFile);
sl@0: 
sl@0: 	while (ETrue)
sl@0: 		{
sl@0: 		TInt32 pass=logFile.ReadInt32L();
sl@0: 		if (pass==ETestsEnded)
sl@0: 			{
sl@0: 			break;	// end of file
sl@0: 			}
sl@0: 		else if (pass==EFileEnd)
sl@0: 			{
sl@0: 			// reached end of file marker, with no success
sl@0: 			SetTestStepResult(EFail);
sl@0: 			break;	
sl@0: 			}
sl@0: 		else if (pass==ETestFailed)
sl@0: 			{
sl@0: 			HBufC* text=HBufC::NewL(logFile, KMaxTInt);
sl@0: 			ERR_PRINTF2(_L("%S"), text);
sl@0: 			delete text;
sl@0: 			}
sl@0: 		else if (pass==ETestPassed)
sl@0: 			{
sl@0: 			HBufC* text=HBufC::NewL(logFile, KMaxTInt);
sl@0: 			INFO_PRINTF2(_L("%S"), text);
sl@0: 			delete text;
sl@0: 			}
sl@0: 		}	
sl@0: 
sl@0: 	CleanupStack::PopAndDestroy(&logFile);
sl@0: 	}
sl@0: 
sl@0: void CCapTestFrameworkStep::SetupHelperL(const TTestEnvironment& aEnvironment)
sl@0: 	{
sl@0: 	RProcess p;
sl@0: // SETCAP source_exe capability [-SID secureId] [-VID vendorId] [destination_path]
sl@0: 	_LIT(KArgsFormat, "captestframeworkhelper.exe  %X -SID %X -VID %X tempcaptestframeworkhelper.exe");
sl@0: 
sl@0: // The 'capability' command line argument is the hexadecimal value of the
sl@0: // capabilities when they are represented as a bit-field. E.g. the 3 capabilities
sl@0: // LocalServices, ReadUserData and WriteUserData would together have a value of:
sl@0: //
sl@0: // (1<<ECapabilityLocalServices) | (<<ECapabilityReadUserData) | (1<<ECapabilityWriteUserData)
sl@0: //
sl@0: // Which in hexadecimal is '1c000'
sl@0:  
sl@0:  	const TCapabilitySet& aCapSet=aEnvironment.iCaps;
sl@0: 	TInt caps=0;
sl@0: 	for (TInt c = 0; c < ECapability_Limit; ++c)
sl@0: 		{
sl@0: 		if (aCapSet.HasCapability(TCapability(c)))
sl@0: 			{
sl@0: 			caps+=(1<<c);
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	TBuf<512> cmdLine;
sl@0: 	cmdLine.Format(KArgsFormat, caps, aEnvironment.iSid, aEnvironment.iVid);
sl@0: 
sl@0: 	User::LeaveIfError(p.Create(_L("setcap.exe"), cmdLine));
sl@0: 	
sl@0: 	// Wait for setcap to finish
sl@0: 	TRequestStatus s;
sl@0: 	TRequestStatus& rs=s;
sl@0: 	p.Logon(rs);
sl@0: 
sl@0: 	p.Resume();
sl@0: 	User::WaitForRequest(rs);
sl@0: 	p.Close();
sl@0: 	}
sl@0: 
sl@0: void CCapTestFrameworkStep::PrintCapabilitySet(const TCapabilitySet& aCapSet, const TDesC& aExtra)
sl@0: 	{
sl@0: 	TBuf<512> string;
sl@0: 	string.AppendFormat(_L("%S"), &aExtra);
sl@0: 	for (TInt c = 0; c < ECapability_Limit; ++c)
sl@0: 		{
sl@0: 		if (aCapSet.HasCapability(TCapability(c)))
sl@0: 			{
sl@0: 			string.Append(' ');
sl@0: 			const char *p=CapabilityNames[c];
sl@0: 			
sl@0: 			while(*p)
sl@0: 				{
sl@0: 				string.Append(*p++);
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	if (string.Length()==aExtra.Length())
sl@0: 		{
sl@0: 		string.AppendFormat(_L("None"));
sl@0: 		}
sl@0: 	INFO_PRINTF1(string);
sl@0: 	}
sl@0: 
sl@0: 
sl@0: void CCapTestFrameworkStep::GenerateEnvironmentsL(const TCapabilitySet& aCapsNeeded, const TUid& aSidNeeded, const TUid& aVidNeeded, RArray<TTestEnvironment>& aEnvironments)
sl@0: 	{
sl@0: 	for (TUid sid={0}; sid.iUid <= aSidNeeded.iUid; sid.iUid+= aSidNeeded.iUid ? aSidNeeded.iUid : 1) // if no sid is needed then only do check once
sl@0: 		{
sl@0: 		TBool shouldPass=ETrue;
sl@0: 
sl@0: 		if (sid!=aSidNeeded)
sl@0: 			{
sl@0: 			shouldPass=EFalse;
sl@0: 			}
sl@0: 		
sl@0: 		for (TUid vid={0}; vid.iUid <= aVidNeeded.iUid; vid.iUid+= aVidNeeded.iUid ? aVidNeeded.iUid : 1)
sl@0: 			{
sl@0: 			if (vid!=aVidNeeded)
sl@0: 				{
sl@0: 				shouldPass=EFalse;
sl@0: 				}
sl@0: 			
sl@0: 			//For each IPC, your test should implement the following:
sl@0: 			//
sl@0: 			// If an IPC is controlled by one capability only, the test code should run 
sl@0: 			//first with the required capability only and second with the complement set
sl@0: 			//of the required capability. If the first test is successful and the second 
sl@0: 			//a failure, the IPC value is proven to be controlled by the required capability
sl@0: 			//only. 
sl@0: 			//
sl@0: 			// If an IPC is controlled by n capabilities, the test code should run first with
sl@0: 			//exact n required capabilities and after with any combination of all subsets of 
sl@0: 			//n-1 capabilities with the complement set. 
sl@0: 			//
sl@0: 			// For example, ABC controls an IPC. The full list of capabilities is 
sl@0: 			//A, B, C, D, E and F. Test code with ABC must be successful, while test code
sl@0: 			//with ABDEF, ACDEF, BCDEF must all fail.
sl@0: 			//
sl@0: 			// So, the number of tests to run to validate a IPC is the combination of n 
sl@0: 			//capabilities, n-1 at a time (i.e. n!/(n-1)! )  plus 1 exact positive test,
sl@0: 			//therefore a total of n+1 tests.
sl@0: 			
sl@0: 			// possibly positive case (depends on Sid and Vid settings)
sl@0: 			aEnvironments.Append(TTestEnvironment(aCapsNeeded, sid, vid, shouldPass));
sl@0: 
sl@0: 			if (iThoroughness == EBasicChecks) // will fail when cap set is empty, but there is no TCapabilitySet::NotEmpty exported, write a replacement copy
sl@0: 				{
sl@0: 				// Just add one with no caps and expect to fail
sl@0: 				TCapabilitySet noCaps;
sl@0: 				aEnvironments.Append(TTestEnvironment(noCaps, sid, vid, EFalse));
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				// Thorough, cap sets as per comment above 
sl@0: 				for (TInt c = 0; c < ECapability_Limit; ++c)
sl@0: 					{
sl@0: 					if (aCapsNeeded.HasCapability(TCapability(c)))
sl@0: 						{
sl@0: 						// Need to add a new one with (aCapsNeeded / c) | ~aCapsNeeded
sl@0: 						TCapabilitySet caps(aCapsNeeded);
sl@0: 						caps.RemoveCapability(TCapability(c)); // take cap c away
sl@0: 						caps.Union(InvertCapSet(aCapsNeeded)); // add in complement
sl@0: 
sl@0: 						aEnvironments.Append(TTestEnvironment(caps, sid, vid, EFalse)); // add to sets, should fail
sl@0: 						}
sl@0: 					}
sl@0: 				} // end thorough cap tests
sl@0: 			
sl@0: 			} // end vid loop
sl@0: 		
sl@0: 		} // end sid loop
sl@0: 	}
sl@0: 
sl@0: 
sl@0: TVerdict CCapTestFrameworkStep::doTestStepPostambleL()
sl@0: 	{
sl@0: 	return EPass;
sl@0: 	}
sl@0: 
sl@0: // helper functions
sl@0: TCapabilitySet CCapTestFrameworkStep::InvertCapSet(const TCapabilitySet& aCapSet)
sl@0: 	{
sl@0: 	TCapabilitySet ret;
sl@0: 	ret.SetEmpty();
sl@0: 
sl@0: 	for (TInt c = 0; c < ECapability_Limit; ++c)
sl@0: 		{
sl@0: 		if (c == ECapabilityTCB && iOmitTCBCapInComplementSet)
sl@0: 			{
sl@0: 			continue;
sl@0: 			}
sl@0: 		if (!aCapSet.HasCapability(TCapability(c)))
sl@0: 			{
sl@0: 			ret.AddCapability(TCapability(c));
sl@0: 			}
sl@0: 		}
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: MCapabilityTestFactory* CCapTestFrameworkStep::SetupFactoryL()
sl@0: 	{
sl@0: 	User::LeaveIfError(iLibrary.Load(iDllName));
sl@0: 	
sl@0: 	TLibraryFunction testFactory=iLibrary.Lookup(1);
sl@0: 	iFactory=reinterpret_cast<MCapabilityTestFactory*>(testFactory());
sl@0: 	
sl@0: 	return iFactory;
sl@0: 	}
sl@0: 
sl@0: // TCapSetTestInfo
sl@0: TTestEnvironment::TTestEnvironment(const TCapabilitySet& aCaps, TUid aSid, TUid aVid, TBool aExpectPass)
sl@0: 	: iCaps(aCaps), iSid(aSid), iVid(aVid), iExpectPass(aExpectPass)
sl@0: 	{
sl@0: 	}