browserutilities/webutils/tsrc/public/adv/src/WebUtilsBCTestCases.cpp
changeset 0 dd21522fd290
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/browserutilities/webutils/tsrc/public/adv/src/WebUtilsBCTestCases.cpp	Mon Mar 30 12:54:55 2009 +0300
@@ -0,0 +1,422 @@
+/*
+* 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 the License "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:  ?Description
+*
+*/
+
+
+
+// INCLUDE FILES
+#include <e32math.h>
+#include "WebUtilsBCTest.h"
+
+// EXTERNAL DATA STRUCTURES
+//extern  ?external_data;
+
+// EXTERNAL FUNCTION PROTOTYPES  
+//extern ?external_function( ?arg_type,?arg_type );
+
+// CONSTANTS
+//const ?type ?constant_var = ?constant;
+
+// MACROS
+//#define ?macro ?macro_def
+
+// LOCAL CONSTANTS AND MACROS
+//const ?type ?constant_var = ?constant;
+//#define ?macro_name ?macro_def
+
+// MODULE DATA STRUCTURES
+//enum ?declaration
+//typedef ?declaration
+
+// LOCAL FUNCTION PROTOTYPES
+//?type ?function_name( ?arg_type, ?arg_type );
+
+// FORWARD DECLARATIONS
+//class ?FORWARD_CLASSNAME;
+
+// ============================= LOCAL FUNCTIONS ===============================
+
+// -----------------------------------------------------------------------------
+// ?function_name ?description.
+// ?description
+// Returns: ?value_1: ?description
+//          ?value_n: ?description_line1
+//                    ?description_line2
+// -----------------------------------------------------------------------------
+//
+/*
+?type ?function_name(
+    ?arg_type arg,  // ?description
+    ?arg_type arg)  // ?description
+    {
+
+    ?code  // ?comment
+
+    // ?comment
+    ?code
+    }
+*/
+
+// ============================ MEMBER FUNCTIONS ===============================
+
+// -----------------------------------------------------------------------------
+// CWebUtilsBCTest::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 TCaseInfo CWebUtilsBCTest::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 
+    *    WebUtilsBCTest.cpp file and to WebUtilsBCTest.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[] =
+        {
+        // To add new test cases, add new items to this array
+        
+        // NOTE: When compiled to GCCE, there must be Classname::
+        // declaration in front of the method name, e.g. 
+        // CDemoModule::PrintTest. Otherwise the compiler
+        // gives errors.
+                
+        ENTRY( "Complete constructed user agent string", CWebUtilsBCTest::UserAgentTest ),
+        ENTRY( "Complete constructed MMS user agent string", CWebUtilsBCTest::MMSUserAgentTest ),
+        ENTRY( "Reads the URL to UA profile from cenrep", CWebUtilsBCTest::URLToUserAgentTest ),
+        
+        };
+
+    // Verify that case number is valid
+    if( (TUint) aCaseNumber >= sizeof( KCases ) / 
+                               sizeof( TCaseInfoInternal ) )
+        {
+        // Invalid case, construct empty object
+        TCaseInfo null( (const TText*) L"" );
+        null.iMethod = NULL;
+        null.iIsOOMTest = EFalse;
+        null.iFirstMemoryAllocation = 0;
+        null.iLastMemoryAllocation = 0;
+        return null;
+        } 
+
+    // Construct TCaseInfo object and return it
+    TCaseInfo tmp ( KCases[ aCaseNumber ].iCaseName );
+    tmp.iMethod = KCases[ aCaseNumber ].iMethod;
+    tmp.iIsOOMTest = KCases[ aCaseNumber ].iIsOOMTest;
+    tmp.iFirstMemoryAllocation = KCases[ aCaseNumber ].iFirstMemoryAllocation;
+    tmp.iLastMemoryAllocation = KCases[ aCaseNumber ].iLastMemoryAllocation;
+    return tmp;
+
+    }
+
+/*
+-------------------------------------------------------------------------------
+
+    Class: CWebUtilsBCTest
+
+    Method: UserAgentTest
+
+    Description: Test To create UserAgent String.
+  
+    Parameters:  TTestResult& aErrorDescription: out:   
+                    Test result and on error case a short description of error
+
+    Return Values: HBufC8*: Always vale of UAStringBuf to indicate that test was valid
+
+    Errors/Exceptions: return Null if error
+
+    Status: Approved
+
+-------------------------------------------------------------------------------
+*/
+TInt CWebUtilsBCTest::UserAgentTest(TTestResult& aResult)
+    {
+    _LIT( KDefinition ,"State");
+    _LIT( KData ,"Test To create UserAgent String");
+    TestModuleIf().Printf( 0, KDefinition, KData );
+	
+	TInt ret = 0;
+        
+    HBufC8* result = iUserAgent->UserAgentL();
+
+
+    _LIT( KData2 ,"Finished");
+    TestModuleIf().Printf( 0, KDefinition, KData2 );
+    
+    if( result != NULL )
+	    {
+	    _LIT( KDescription , "Test case passed" );
+	    aResult.SetResult( KErrNone, KDescription );
+	    ret = KErrNone;
+	    }
+    else
+	    {
+	    _LIT( KDescription , "Test case failed" );
+	    aResult.SetResult( KErrGeneral, KDescription );
+	    ret = KErrGeneral;
+	    }
+
+    // Case was executed
+    return ret;
+    }
+
+/*
+-------------------------------------------------------------------------------
+
+    Class: CWebUtilsBCTest
+
+    Method: MMSUserAgentTest
+
+    Description: Test To create MMS UserAgent String.
+  
+    Parameters:  TTestResult& aErrorDescription: out:   
+                    Test result and on error case a short description of error
+
+    Return Values: HBufC8*: Always vale of UAStringBuf to indicate that test was valid
+
+    Errors/Exceptions: return Null if error
+
+    Status: Approved
+
+-------------------------------------------------------------------------------
+*/
+TInt CWebUtilsBCTest::MMSUserAgentTest(TTestResult& aResult)
+    {
+    _LIT( KDefinition ,"State");
+    _LIT( KData ,"Test To create MMS UserAgent String");
+    TestModuleIf().Printf( 0, KDefinition, KData );
+	
+	TInt ret = 0;
+        
+    HBufC8* result = iUserAgent->MMSUserAgentL();
+
+
+    _LIT( KData2 ,"Finished");
+    TestModuleIf().Printf( 0, KDefinition, KData2 );
+    
+    if( result != NULL )
+	    {
+	    _LIT( KDescription , "Test case passed" );
+	    aResult.SetResult( KErrNone, KDescription );
+	    ret = KErrNone;
+	    }
+    else
+	    {
+	    _LIT( KDescription , "Test case failed" );
+	    aResult.SetResult( KErrGeneral, KDescription );
+	    ret = KErrGeneral;
+	    }
+
+    // Case was executed
+    return ret;
+    }
+
+/*
+-------------------------------------------------------------------------------
+
+    Class: CWebUtilsBCTest
+
+    Method: URLToUserAgentTest
+
+    Description: Test To create MMS UserAgent String.
+  
+    Parameters:  TTestResult& aErrorDescription: out:   
+                    Test result and on error case a short description of error
+
+    Return Values: TInt: Always vale of UAStringBuf to indicate that test was valid
+
+    Errors/Exceptions: None
+
+    Status: Approved
+
+-------------------------------------------------------------------------------
+*/
+TInt CWebUtilsBCTest::URLToUserAgentTest(TTestResult& aResult)
+    {
+    _LIT( KDefinition ,"State");
+    _LIT( KData ,"Test for URL to UserAgent");
+    TestModuleIf().Printf( 0, KDefinition, KData );
+	
+	TBuf8<128> url = _L8("http://www.google.com");
+	TBuf8<128> url3G = _L8("http://www.yahoo.com");
+       
+    TInt result = iUserAgent->URLToUserAgentProfileL(url,url3G);
+
+
+    _LIT( KData2 ,"Finished");
+    TestModuleIf().Printf( 0, KDefinition, KData2 );
+    
+    if( result == KErrNone )
+	    {
+	    _LIT( KDescription , "Test case passed" );
+	    aResult.SetResult( KErrNone, KDescription );
+	    }
+    else
+	    {
+	    _LIT( KDescription , "Test case failed" );
+	    aResult.SetResult( KErrGeneral, KDescription );
+	    }
+
+    // Case was executed
+    return result;
+    }
+
+// -----------------------------------------------------------------------------
+// CWebUtilsBCTest::PrintTest
+// Simple printing to UI test.
+// -----------------------------------------------------------------------------
+//
+TInt CWebUtilsBCTest::PrintTest( 
+    TTestResult& aResult )
+    {
+     /* Simple print test */
+    _LIT( KPrintTest, "PrintTest" );
+    _LIT( KEnter, "Enter" );
+    _LIT( KOnGoing, "On-going" );
+    _LIT( KExit, "Exit" );
+
+    TestModuleIf().Printf( 0, KPrintTest, KEnter );
+           
+    TestModuleIf().Printf( 1, KPrintTest, KOnGoing );
+    
+    TestModuleIf().Printf( 0, KPrintTest, KExit );
+
+    // Test case passed
+
+    // Sets test case result and description(Maximum size is KStifMaxResultDes)
+    _LIT( KDescription, "PrintTest passed" );
+    aResult.SetResult( KErrNone, KDescription );
+
+    // Case was executed
+    return KErrNone;
+
+    }
+
+// -----------------------------------------------------------------------------
+// CWebUtilsBCTest::LoopTest
+// Another printing to UI test.
+// -----------------------------------------------------------------------------
+//
+TInt CWebUtilsBCTest::LoopTest( TTestResult& aResult )
+    {
+
+    /* Simple print and wait loop */
+    _LIT( KState, "State" );
+    _LIT( KLooping, "Looping" );
+
+    TestModuleIf().Printf( 0, KState, KLooping );
+
+    _LIT( KRunning, "Running" );
+    _LIT( KLoop, "%d" );
+    for( TInt i=0; i<10; i++)
+        {
+        TestModuleIf().Printf( 1, KRunning, KLoop, i);
+        User::After( 1000000 );
+        }
+
+    _LIT( KFinished, "Finished" );
+    TestModuleIf().Printf( 0, KState, KFinished );
+
+    // Test case passed
+
+    // Sets test case result and description(Maximum size is KStifMaxResultDes)
+    _LIT( KDescription, "LoopTest passed" );
+    aResult.SetResult( KErrNone, KDescription );
+
+    // Case was executed
+    return KErrNone;
+
+    }
+
+// -----------------------------------------------------------------------------
+// ?classname::?member_function
+// ?implementation_description
+// (other items were commented in a header).
+// -----------------------------------------------------------------------------
+//
+/*
+?type ?classname::?member_function(
+   ?arg_type arg,
+   ?arg_type arg )
+   {
+
+   ?code
+
+   }
+*/
+
+// ========================== OTHER EXPORTED FUNCTIONS =========================
+
+// -----------------------------------------------------------------------------
+// ?function_name implements...
+// ?implementation_description.
+// Returns: ?value_1: ?description
+//          ?value_n: ?description
+//                    ?description
+// -----------------------------------------------------------------------------
+//
+/*
+?type  ?function_name(
+    ?arg_type arg,  // ?description
+    ?arg_type arg )  // ?description
+    {
+
+    ?code
+
+    }
+*/
+//  End of File