1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/mmtestenv/mmtestfw/Source/TestFrameworkClient/TestUtils.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,602 @@
1.4 +// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This contains file utilities which can be called from Test Framework scripts
1.18 +//
1.19 +//
1.20 +
1.21 +// EPOC includes
1.22 +#include <e32base.h>
1.23 +#include <f32file.h>
1.24 +
1.25 +// Test system includes
1.26 +#include <testframework.h>
1.27 +
1.28 +// do not export if Unit Testing
1.29 +#if defined (__TSU_TESTFRAMEWORK__)
1.30 +#undef EXPORT_C
1.31 +#define EXPORT_C
1.32 +#endif
1.33 +
1.34 +
1.35 +/**
1.36 + *
1.37 + * Initialise the test utilities.
1.38 + *
1.39 + * @param "CLog* aLogSystem"
1.40 + * The logger the test utilities are to use.
1.41 + *
1.42 + * @xxxx
1.43 + *
1.44 + */
1.45 +EXPORT_C CTestUtils* CTestUtils::NewL(CLog* aLogSystem)
1.46 + {
1.47 + CTestUtils* self = new(ELeave) CTestUtils;
1.48 + self->Construct(aLogSystem);
1.49 + return self;
1.50 + }
1.51 +
1.52 +/**
1.53 + *
1.54 + * Initialise the test utilities (second phase).
1.55 + *
1.56 + * @param "CLog* aLogSystem"
1.57 + * The logger the test utilities are to use.
1.58 + *
1.59 + * @xxxx
1.60 + *
1.61 + */
1.62 +void CTestUtils::Construct(CLog* aLogSystem)
1.63 + {
1.64 + iLogSystem = aLogSystem;
1.65 + }
1.66 +
1.67 +/**
1.68 + *
1.69 + * Run the test utilities inside a trap harness.
1.70 + *
1.71 + * @param "const TDesC& aText"
1.72 + * Test string giving the utility to run.
1.73 + *
1.74 + * @xxxx
1.75 + *
1.76 + */
1.77 +EXPORT_C void CTestUtils::RunUtils(const TDesC& aText)
1.78 + {
1.79 + TRAPD(r, RunUtilsL(aText));
1.80 +
1.81 + if (r != KErrNone)
1.82 + {
1.83 + WARN_PRINTF3(_L("Warning: Test Utils : %S left, error %d"), &aText, r);
1.84 + }
1.85 + }
1.86 +
1.87 +/**
1.88 + *
1.89 + * Run the test utilities inside a trap harness.
1.90 + *
1.91 + * @param "const TDesC& aText"
1.92 + * Test string giving the utility to run.
1.93 + *
1.94 + * @xxxx
1.95 + *
1.96 + */
1.97 +void CTestUtils::RunUtilsL(const TDesC& aText)
1.98 + {
1.99 + // use Tlex to decode the cmd line
1.100 + TLex lex(aText);
1.101 +
1.102 + // step over the keyword
1.103 + lex.NextToken();
1.104 +
1.105 + // get util required
1.106 + TPtrC token;
1.107 + token.Set(lex.NextToken());
1.108 +
1.109 + if (token.FindF( _L("ChangeDir")) == 0)
1.110 + {
1.111 + User::Panic(_L("ChangeDir is not supported on EKA2"), KErrNotSupported);
1.112 + }
1.113 + else if (token.FindF( _L("CopyFile")) == 0)
1.114 + {
1.115 + // get the parameter
1.116 + TPtrC file1 = lex.NextToken();
1.117 + TPtrC file2 = lex.NextToken();
1.118 +
1.119 + CopyFileL(file1, file2);
1.120 + }
1.121 + else if (token.FindF( _L("CopyAndInvertFile")) == 0)
1.122 + {
1.123 + // get the parameter
1.124 + TPtrC file1 = lex.NextToken();
1.125 + TPtrC file2 = lex.NextToken();
1.126 +
1.127 + CopyAndInvertFileL(file1, file2);
1.128 + }
1.129 + else if (token.FindF( _L("MkDir")) == 0)
1.130 + {
1.131 + // get the parameter
1.132 + token.Set(lex.NextToken());
1.133 +
1.134 + MakeDirL(token);
1.135 + }
1.136 + else if (token.FindF( _L("Delete")) == 0)
1.137 + {
1.138 + // get the parameter
1.139 + token.Set(lex.NextToken());
1.140 +
1.141 + DeleteFileL(token);
1.142 + }
1.143 + else if (token.FindF( _L("MakeReadWrite")) == 0)
1.144 + {
1.145 + // get the parameter
1.146 + token.Set(lex.NextToken());
1.147 +
1.148 + MakeReadWriteL(token);
1.149 + }
1.150 + else
1.151 + {
1.152 + ERR_PRINTF2(_L("Failed to decode RUN_UTILS command : %S"), &aText);
1.153 + User::Leave(KErrNotFound);
1.154 + }
1.155 + }
1.156 +
1.157 +
1.158 +/**
1.159 + *
1.160 + * Test utility : make new directory
1.161 + *
1.162 + * @param "const TDesC& aDirname"
1.163 + * New directory path.
1.164 + *
1.165 + * @xxxx
1.166 + *
1.167 + */
1.168 +void CTestUtils::MakeDirL(const TDesC& aDirname)
1.169 + {
1.170 + // parse the filenames
1.171 + _LIT(KDefault,"C:\\");
1.172 + TParse fullFileName;
1.173 + TInt returnCode = fullFileName.Set(aDirname, &KDefault, NULL);
1.174 + if (returnCode != KErrNone)
1.175 + {
1.176 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.177 + ERR_PRINTF3(_L("Failed to decode full path name %S - %S"),
1.178 + &fullFileName.FullName(),
1.179 + &errortxt);
1.180 + User::Leave(returnCode);
1.181 + }
1.182 +
1.183 + // connect to file server
1.184 + returnCode = iFs.Connect();
1.185 + if (returnCode != KErrNone)
1.186 + {
1.187 + ERR_PRINTF1(_L("Error connecting to file server"));
1.188 + User::Leave(returnCode);
1.189 + }
1.190 +
1.191 + // now create the new directory
1.192 + returnCode = iFs.MkDirAll(fullFileName.DriveAndPath());
1.193 + if ((returnCode != KErrNone) && (returnCode != KErrAlreadyExists))
1.194 + {
1.195 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.196 +
1.197 + ERR_PRINTF3(_L("Error %S making directory %S"),
1.198 + &errortxt,
1.199 + &fullFileName.FullName());
1.200 + iFs.Close();
1.201 + User::Leave(returnCode);
1.202 + }
1.203 + if(returnCode == KErrNone)
1.204 + {
1.205 + // display full (including path) file name
1.206 + INFO_PRINTF2( _L("Made directory %S"), &fullFileName.FullName());
1.207 + }
1.208 + else
1.209 + {
1.210 + INFO_PRINTF2( _L("directory already exists %S"), &fullFileName.FullName());
1.211 + }
1.212 + iFs.Close();
1.213 + }
1.214 +
1.215 +
1.216 +/**
1.217 + *
1.218 + * Test utility : copy a file
1.219 + *
1.220 + * @param "const TDesC& aOld"
1.221 + * Source file.
1.222 + *
1.223 + * @param "const TDesC& aNew"
1.224 + * Destination file.
1.225 + *
1.226 + * @xxxx
1.227 + *
1.228 + */
1.229 +void CTestUtils::CopyFileL (const TDesC& aOld,const TDesC& aNew)
1.230 + {
1.231 + // connect to file server
1.232 + TInt returnCode = iFs.Connect();
1.233 + if (returnCode != KErrNone)
1.234 + {
1.235 + ERR_PRINTF1(_L("Error connecting to file server"));
1.236 + User::Leave(returnCode);
1.237 + }
1.238 +
1.239 + // create a file manager
1.240 + CFileMan* fileMan = CFileMan::NewL(iFs);
1.241 + CleanupStack::PushL(fileMan);
1.242 +
1.243 + // parse the filenames
1.244 + TParse parseSource;
1.245 + returnCode = parseSource.Set(aOld, NULL, NULL);
1.246 + if (returnCode != KErrNone)
1.247 + {
1.248 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.249 + ERR_PRINTF3( _L("Failed to parse %S - %S"),
1.250 + &aOld,
1.251 + &errortxt);
1.252 + iFs.Close();
1.253 + User::Leave(returnCode);
1.254 + }
1.255 +
1.256 + // parse the filenames
1.257 + TParse parseTarget;
1.258 + returnCode = parseTarget.Set(aNew, NULL, NULL);
1.259 + if (returnCode != KErrNone)
1.260 + {
1.261 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.262 + ERR_PRINTF3(_L("Failed to parse %S - %S"),
1.263 + &aNew,
1.264 + &errortxt);
1.265 + iFs.Close();
1.266 + User::Leave(returnCode);
1.267 + }
1.268 +
1.269 + // do the copy
1.270 + returnCode = fileMan->Copy(parseSource.FullName(),
1.271 + parseTarget.FullName(),
1.272 + CFileMan::EOverWrite | CFileMan::ERecurse);
1.273 +
1.274 + if (returnCode != KErrNone)
1.275 + {
1.276 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.277 +
1.278 + ERR_PRINTF4(_L("Failed to copy %S to %S - %S"),
1.279 + &parseSource.FullName(),
1.280 + &parseTarget.FullName(),
1.281 + &errortxt);
1.282 + iFs.Close();
1.283 + User::Leave(returnCode);
1.284 + }
1.285 +
1.286 + INFO_PRINTF3(_L("Copied file from %S to %S"),
1.287 + &parseSource.FullName(),
1.288 + &parseTarget.FullName());
1.289 +
1.290 + iFs.Close();
1.291 + CleanupStack::PopAndDestroy(fileMan);
1.292 + }
1.293 +
1.294 +
1.295 +/**
1.296 + *
1.297 + * Test utility : invert a file and copy it to a tartget file
1.298 + *
1.299 + * @param "const TDesC& aOld"
1.300 + * Source file.
1.301 + *
1.302 + * @param "const TDesC& aNew"
1.303 + * Destination file.
1.304 + * Will contain the inverted file
1.305 + *
1.306 + *
1.307 + * @xxxx
1.308 + *
1.309 + */
1.310 +void CTestUtils::CopyAndInvertFileL (const TDesC& aOld,const TDesC& aNew)
1.311 + {
1.312 +
1.313 + TRAPD(error, DoCopyAndInvertL(aOld, aNew));
1.314 +
1.315 + if (error != KErrNone)
1.316 + {
1.317 + TPtrC errortxt = CLog::EpocErrorToText(error);
1.318 + ERR_PRINTF2(_L("Failed to copy Files - %S"), &errortxt);
1.319 + User::Leave(error);
1.320 + }
1.321 +
1.322 + }
1.323 +
1.324 +
1.325 +
1.326 +
1.327 +/**
1.328 + *
1.329 + * Test utility : Do the invert and copy of a source file
1.330 + * into a target file.
1.331 + *
1.332 + * @param "const TDesC& aOld"
1.333 + * Source file.
1.334 + *
1.335 + * @param "const TDesC& aNew"
1.336 + * Destination file.
1.337 + * Will contain the inverted file
1.338 + *
1.339 + *
1.340 + * @xxxx
1.341 + *
1.342 + */
1.343 +void CTestUtils::DoCopyAndInvertL (const TDesC& aOld,const TDesC& aNew)
1.344 + {
1.345 + // connect to file server
1.346 + TInt returnCode = iFs.Connect();
1.347 + if (returnCode != KErrNone)
1.348 + {
1.349 + ERR_PRINTF1(_L("Error connecting to file server"));
1.350 + User::Leave(returnCode);
1.351 + }
1.352 + CleanupClosePushL(iFs);
1.353 +
1.354 + // parse the filenames
1.355 + TParse parseSource;
1.356 + User::LeaveIfError(parseSource.Set(aOld, NULL, NULL));
1.357 +
1.358 + // parse the filenames
1.359 + TParse parseTarget;
1.360 + User::LeaveIfError(parseTarget.Set(aNew, NULL, NULL));
1.361 +
1.362 + RFile sourceFile;
1.363 +
1.364 + // open the source file for reading
1.365 + User::LeaveIfError(sourceFile.Open(iFs, parseSource.FullName(), EFileRead));
1.366 + CleanupClosePushL(sourceFile);
1.367 +
1.368 + RFile targetFile;
1.369 +
1.370 + // open the target file for writing
1.371 + User::LeaveIfError(targetFile.Replace(iFs, parseTarget.FullName(), EFileWrite));
1.372 + CleanupClosePushL(targetFile);
1.373 +
1.374 + const TInt KSizeOfInvertBuf = 256;
1.375 +
1.376 + // Buffers used for read,invert and write to the target file
1.377 + TBuf8<KSizeOfInvertBuf> invertBuffer;
1.378 + TInt8 byteBuf;//A temp byte size buffer
1.379 +
1.380 + //Invert the source file and copy it into the target file
1.381 + do
1.382 + {
1.383 + User::LeaveIfError(sourceFile.Read(invertBuffer));
1.384 +
1.385 + for (TInt index=0; index<invertBuffer.Length(); index++)
1.386 + {
1.387 + byteBuf = invertBuffer[index];
1.388 + byteBuf ^= 0xFF; //inverting the buf bits
1.389 + invertBuffer[index] = byteBuf;
1.390 + }
1.391 + User::LeaveIfError(targetFile.Write(invertBuffer));
1.392 + }
1.393 + while (invertBuffer.Length() != 0);
1.394 +
1.395 +
1.396 + // Flush the data to the target file
1.397 + User::LeaveIfError(targetFile.Flush());
1.398 +
1.399 + // display full (including path) file name
1.400 + INFO_PRINTF3(_L("Copied and Inverted successfully file %S to file %S"),
1.401 + &parseSource.FullName(),
1.402 + &parseTarget.FullName());
1.403 +
1.404 + //closing the files
1.405 + CleanupStack::PopAndDestroy(3, &iFs);
1.406 +
1.407 + }
1.408 +
1.409 +
1.410 +
1.411 +
1.412 +
1.413 +/**
1.414 + *
1.415 + * Test utility : delete a file
1.416 + *
1.417 + * @param "const TDesC& aFile"
1.418 + * File to be deleted.
1.419 + *
1.420 + * @xxxx
1.421 + *
1.422 + */
1.423 +void CTestUtils::DeleteFileL (const TDesC& aFile)
1.424 + {
1.425 + // parse the filenames
1.426 + _LIT(KDefault,"C:\\xxxxx.xxx");
1.427 + TParse fullFileName;
1.428 + TInt returnCode = fullFileName.Set(aFile, &KDefault, NULL);
1.429 + if (returnCode != KErrNone)
1.430 + {
1.431 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.432 + ERR_PRINTF3(_L("Failed to decode full path name %S - %S"),
1.433 + &fullFileName.FullName(),
1.434 + &errortxt);
1.435 + User::Leave(returnCode);
1.436 + }
1.437 +
1.438 + // connect to file server
1.439 + returnCode = iFs.Connect();
1.440 + if (returnCode != KErrNone)
1.441 + {
1.442 + ERR_PRINTF1(_L("Error connecting to file server"));
1.443 + User::Leave(returnCode);
1.444 + }
1.445 +
1.446 + // now do the delete
1.447 + returnCode = iFs.Delete(fullFileName.FullName());
1.448 + if (returnCode != KErrNone)
1.449 + {
1.450 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.451 + ERR_PRINTF3(_L("Error %S deleting %S"),
1.452 + &errortxt,
1.453 + &fullFileName.FullName());
1.454 + iFs.Close();
1.455 + User::Leave(returnCode);
1.456 + }
1.457 +
1.458 + // display full (including path) file name
1.459 + INFO_PRINTF2(_L("Deleted %S"), &fullFileName.FullName());
1.460 + iFs.Close();
1.461 + }
1.462 +
1.463 +
1.464 +/**
1.465 + *
1.466 + * Test utility : make a file read-write (clear the read-only attribute)
1.467 + *
1.468 + * @param "const TDesC& aFile"
1.469 + * File to be made read-write.
1.470 + *
1.471 + * @xxxx
1.472 + *
1.473 + */
1.474 +void CTestUtils::MakeReadWriteL (const TDesC& aFile)
1.475 + {
1.476 + // parse the filenames
1.477 + _LIT(KDefault,"C:\\xxxxx.xxx");
1.478 + TParse fullFileName;
1.479 + TInt returnCode = fullFileName.Set(aFile, &KDefault, NULL);
1.480 + if (returnCode != KErrNone)
1.481 + {
1.482 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.483 + ERR_PRINTF3(_L("Failed to decode full path name %S - %S"),
1.484 + &fullFileName.FullName(),
1.485 + &errortxt);
1.486 + User::Leave(returnCode);
1.487 + }
1.488 +
1.489 + // connect to file server
1.490 + returnCode = iFs.Connect();
1.491 + if (returnCode != KErrNone)
1.492 + {
1.493 + ERR_PRINTF1(_L("Error connecting to file server"));
1.494 + User::Leave(returnCode);
1.495 + }
1.496 +
1.497 + // now do the delete
1.498 + returnCode = iFs.SetAtt(fullFileName.FullName(), 0, KEntryAttReadOnly);
1.499 +
1.500 + // check for errors
1.501 + if (returnCode != KErrNone )
1.502 + {
1.503 + TPtrC errortxt = CLog::EpocErrorToText(returnCode);
1.504 +
1.505 + ERR_PRINTF3(_L("Error %S making %S read-write"),
1.506 + &errortxt,
1.507 + &fullFileName.FullName());
1.508 + iFs.Close();
1.509 + User::Leave(returnCode);
1.510 + }
1.511 +
1.512 + // display full (including path) file name
1.513 + INFO_PRINTF2(_L("Made %S read-write"), &fullFileName.FullName());
1.514 + iFs.Close();
1.515 + }
1.516 +
1.517 +/**
1.518 + *
1.519 + * General logging function for test utils.
1.520 + *
1.521 + * @param "TRefByValue<const TDesC16> aFmt"
1.522 + * Printf-style format.
1.523 + *
1.524 + * @param "..."
1.525 + * Variable print parameters
1.526 + *
1.527 + * @xxxx
1.528 + *
1.529 + */
1.530 +void CTestUtils::Log(TRefByValue<const TDesC16> aFmt, ...)
1.531 + {
1.532 +
1.533 + VA_LIST aList;
1.534 + VA_START(aList, aFmt);
1.535 +
1.536 + if(iLogSystem)
1.537 + iLogSystem->Log(aFmt, aList);
1.538 +
1.539 + VA_END(aList);
1.540 + }
1.541 +
1.542 +/**
1.543 + *
1.544 + * General logging function for test utils, with severity.
1.545 + *
1.546 + * @param "TInt aSeverity"
1.547 + * Severity level required to log
1.548 + *
1.549 + * @param "TRefByValue<const TDesC16> aFmt"
1.550 + * Printf-style format.
1.551 + *
1.552 + * @param "..."
1.553 + * Variable print parameters
1.554 + *
1.555 + * @xxxx
1.556 + *
1.557 + */
1.558 +void CTestUtils::Log(TInt /* aSeverity */, TRefByValue<const TDesC16> aFmt, ...)
1.559 + {
1.560 + VA_LIST aList;
1.561 + VA_START(aList, aFmt);
1.562 +
1.563 + // NB : Test Utils log regardless of severity (as they are tied to no suite)
1.564 + if(iLogSystem)
1.565 + iLogSystem->Log(aFmt, aList);
1.566 +
1.567 + VA_END(aList);
1.568 + }
1.569 +
1.570 +/**
1.571 + *
1.572 + * Traceable logging function for test utils.
1.573 + *
1.574 + * @param "const TText8* aFile"
1.575 + * Source code file name
1.576 + *
1.577 + * @param "TInt aLine"
1.578 + * Source code line
1.579 + *
1.580 + * @param "TInt aSeverity"
1.581 + * Severity level required to log
1.582 + *
1.583 + * @param "TRefByValue<const TDesC16> aFmt"
1.584 + * Printf-style format.
1.585 + *
1.586 + * @param "..."
1.587 + * Variable print parameters
1.588 + *
1.589 + * @xxxx
1.590 + *
1.591 + */
1.592 +void CTestUtils::LogExtra(const TText8* aFile, TInt aLine, TInt aSeverity,
1.593 + TRefByValue<const TDesC16> aFmt,...)
1.594 + {
1.595 + VA_LIST aList;
1.596 + VA_START(aList, aFmt);
1.597 +
1.598 + // NB : Test Utils log regardless of severity (as they are tied to no suite)
1.599 + if(iLogSystem)
1.600 + iLogSystem->LogExtra(aFile, aLine, aSeverity, aFmt, aList);
1.601 +
1.602 + VA_END(aList);
1.603 + }
1.604 +
1.605 +