1 /*

     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:   ?Description*

    15 */

    16 

    17 

    18 

    19 

    20 #ifndef VIDEOSCHEDULER_APITEST_H

    21 #define VIDEOSCHEDULER_APITEST_H

    22 

    23 //  INCLUDES

    24 #include <StifLogger.h>

    25 #include <TestScripterInternal.h>

    26 #include <StifTestModule.h>

    27 #include <TestclassAssert.h>

    28 

    29 // CONSTANTS

    30 //const ?type ?constant_var = ?constant;

    31 

    32 // MACROS

    33 //#define ?macro ?macro_def

    34 #define TEST_CLASS_VERSION_MAJOR 0

    35 #define TEST_CLASS_VERSION_MINOR 0

    36 #define TEST_CLASS_VERSION_BUILD 0

    37 

    38 // Logging path

    39 _LIT( KVideoScheduler_ApiTestLogPath, "\\logs\\testframework\\VideoScheduler_ApiTest\\" );

    40 // Log file

    41 _LIT( KVideoScheduler_ApiTestLogFile, "VideoScheduler_ApiTest.txt" );

    42 _LIT( KVideoScheduler_ApiTestLogFileWithTitle, "VideoScheduler_ApiTest_[%S].txt" );

    43 

    44 _LIT( KTestModuleName, "VideoScheduler_ApiTest" );

    45 _LIT( KLogLocation, "In %S" );

    46 

    47 // FUNCTION PROTOTYPES

    48 //?type ?function_name(?arg_list);

    49 

    50 // FORWARD DECLARATIONS

    51 //class ?FORWARD_CLASSNAME;

    52 class CVideoScheduler_ApiTest;

    53 class CCseScheduledProgram;

    54 class CCseSchedulerApi;

    55 

    56 // DATA TYPES

    57 //enum ?declaration

    58 //typedef ?declaration

    59 //extern ?data_type;

    60 

    61 // CLASS DECLARATION

    62 

    63 /**

    64 *  CVideoScheduler_ApiTest test class for STIF Test Framework TestScripter.

    65 *  ?other_description_lines

    66 *

    67 *  @lib ?library

    68 *  @since ?Series60_version

    69 */

    70 NONSHARABLE_CLASS(CVideoScheduler_ApiTest) : public CScriptBase

    71     {

    72     public:  // Constructors and destructor

    73 

    74         /**

    75         * Two-phased constructor.

    76         */

    77         static CVideoScheduler_ApiTest* NewL( CTestModuleIf& aTestModuleIf );

    78 

    79         /**

    80         * Destructor.

    81         */

    82         virtual ~CVideoScheduler_ApiTest();

    83 

    84     public: // New functions

    85 

    86         /**

    87         * ?member_description.

    88         * @since ?Series60_version

    89         * @param ?arg1 ?description

    90         * @return ?description

    91         */

    92         //?type ?member_function( ?type ?arg1 );

    93         

    94         /**

    95          * CompareProgramsL 

    96          * @since ?Series60_version

    97          * @param aProgram1

    98          * @param aProgram2 

    99          * @return Symbian OS error code.

   100          */

   101         TInt ComparePrograms( CCseScheduledProgram& aProgram1, CCseScheduledProgram& aProgram2 );

   102 

   103         /**

   104         * LogMethod

   105         * @since ?Series60_version

   106         * @param aMethod Name of the method where this function is called

   107         * @return Nothing

   108         */        

   109         void LogMethod( TPtrC aMethod );

   110 

   111     public: // Functions from base classes

   112 

   113         /**

   114         * From CScriptBase Runs a script line.

   115         * @since ?Series60_version

   116         * @param aItem Script line containing method name and parameters

   117         * @return Symbian OS error code

   118         */

   119         virtual TInt RunMethodL( CStifItemParser& aItem );

   120 

   121     protected:  // New functions

   122 

   123         /**

   124         * ?member_description.

   125         * @since ?Series60_version

   126         * @param ?arg1 ?description

   127         * @return ?description

   128         */

   129         //?type ?member_function( ?type ?arg1 );

   130 

   131     protected:  // Functions from base classes

   132 

   133         /**

   134         * From ?base_class ?member_description

   135         */

   136         //?type ?member_function();

   137 

   138     private:

   139 

   140         /**

   141         * C++ default constructor.

   142         */

   143         CVideoScheduler_ApiTest( CTestModuleIf& aTestModuleIf );

   144 

   145         /**

   146         * By default Symbian 2nd phase constructor is private.

   147         */

   148         void ConstructL();

   149         

   150         // Prohibit copy constructor if not deriving from CBase.

   151         // ?classname( const ?classname& );

   152         // Prohibit assigment operator if not deriving from CBase.

   153         // ?classname& operator=( const ?classname& );

   154 

   155         /**

   156         * Frees all resources allocated from test methods.

   157         * @since ?Series60_version

   158         */

   159         void Delete();

   160 

   161         /**

   162         * Test methods are listed below.

   163         *

   164         * Methods starting with API_ test CCseSchedulerAPI class.

   165         *

   166         * Methods starting with Program_ test CCseScheduledProgram class. Test class has member

   167         * instance of this class and it's used when CCseSchedulerAPI methods need the program data.

   168         *

   169         * Default app uid for programs is 0x020202, all these will be removed 

   170         * when API_NewL is called without parameter 0. 

   171         */

   172 

   173         /**

   174         * API_NewL test method.

   175         * Creates also CCseScheduledProgram if parameter is not 0.  

   176         * 

   177         * @since ?Series60_version

   178         * @param aItem Script line containing parameters.

   179         * @return Symbian OS error code.

   180         */

   181         virtual TInt API_NewL( CStifItemParser& aItem );

   182         

   183         /**

   184         * API_AddSchedule test method.

   185         * @since ?Series60_version

   186         * @param aItem Script line containing parameters.

   187         * @return Symbian OS error code.

   188         */

   189         virtual TInt API_AddScheduleL( CStifItemParser& aItem );

   190 

   191         /**

   192         * API_RemoveSchedule test method.

   193         * @since ?Series60_version

   194         * @param aItem Script line containing parameters.

   195         * @return Symbian OS error code.

   196         */

   197         virtual TInt API_RemoveScheduleL( CStifItemParser& aItem );

   198 

   199         /**

   200         * API_RemoveSchedule test method.

   201         * @since ?Series60_version

   202         * @param aItem Script line containing parameters.

   203         * @return Symbian OS error code.

   204         */

   205         virtual TInt RemoveAllSchedulesL( CStifItemParser& aItem );

   206         

   207         /**

   208         * API_GetSchedule test method.

   209         * @since ?Series60_version

   210         * @param aItem Script line containing parameters.

   211         * @return Symbian OS error code.

   212         */

   213         virtual TInt API_GetScheduleL( CStifItemParser& aItem );

   214 

   215         /**

   216         * API_GetSchedulesByAppUid test method.

   217         * First schedule is copied to member variable.

   218         * 

   219         * @since ?Series60_version

   220         * @param aItem Script line containing parameters.

   221         * @return Symbian OS error code.

   222         */

   223         virtual TInt API_GetSchedulesByAppUidL( CStifItemParser& aItem );

   224 

   225         /**

   226         * API_GetOverlappingSchedules test method.

   227         * @since ?Series60_version

   228         * @param aItem Script line containing parameters.

   229         * @return Symbian OS error code.

   230         */

   231         virtual TInt API_GetOverlappingSchedulesL( CStifItemParser& aItem );

   232 

   233         /**

   234         * API_GetSchedulesByPluginUidL test method.

   235         * @since ?Series60_version

   236         * @param aItem Script line containing parameters.

   237         * @return Symbian OS error code.

   238         */

   239         virtual TInt API_GetSchedulesByPluginUidL( CStifItemParser& aItem );

   240         

   241         /**

   242         * API_GetSchedulesByTypeL test method.

   243         * @since ?Series60_version

   244         * @param aItem Script line containing parameters.

   245         * @return Symbian OS error code.

   246         */

   247         virtual TInt API_GetSchedulesByTypeL( CStifItemParser& aItem );

   248         

   249         /**

   250         * API_GetSchedulesByTimeL test method.

   251         * @since ?Series60_version

   252         * @param aItem Script line containing parameters.

   253         * @return Symbian OS error code.

   254         */

   255         virtual TInt API_GetSchedulesByTimeL( CStifItemParser& aItem );

   256         

   257         /**

   258         * Program_NewL test method.

   259         * @since ?Series60_version

   260         * @param aItem Script line containing parameters.

   261         * @return Symbian OS error code.

   262         */

   263         virtual TInt Program_NewL( CStifItemParser& aItem );

   264 

   265         /**

   266         * Program_NewLFromProgramL test method.

   267         * @since ?Series60_version

   268         * @param aItem Script line containing parameters.

   269         * @return Symbian OS error code.

   270         */

   271         virtual TInt Program_NewLFromProgramL( CStifItemParser& aItem );

   272         

   273         /**

   274         * Program_ExternalizeL test method.

   275         * @since ?Series60_version

   276         * @param aItem Script line containing parameters.

   277         * @return Symbian OS error code.

   278         */

   279         virtual TInt Program_ExternalizeLL( CStifItemParser& aItem );

   280 

   281         /**

   282         * Program_InternalizeL test method.

   283         * @since ?Series60_version

   284         * @param aItem Script line containing parameters.

   285         * @return Symbian OS error code.

   286         */

   287         virtual TInt Program_InternalizeLL( CStifItemParser& aItem );

   288 

   289         /**

   290         * Program_ExternalizeLength test method.

   291         * @since ?Series60_version

   292         * @param aItem Script line containing parameters.

   293         * @return Symbian OS error code.

   294         */

   295         virtual TInt Program_ExternalizeLengthL( CStifItemParser& aItem );

   296 

   297         /**

   298         * Program_SetPluginType test method.

   299         * @since ?Series60_version

   300         * @param aItem Script line containing parameters.

   301         * @return Symbian OS error code.

   302         */

   303         virtual TInt Program_SetPluginTypeL( CStifItemParser& aItem );

   304 

   305         /**

   306         * Program_SetName test method.

   307         * @since ?Series60_version

   308         * @param aItem Script line containing parameters.

   309         * @return Symbian OS error code.

   310         */

   311         virtual TInt Program_SetNameL( CStifItemParser& aItem );

   312 

   313         /**

   314         * Program_SetStartTime test method.

   315         * @since ?Series60_version

   316         * @param aItem Script line containing parameters.

   317         * @return Symbian OS error code.

   318         */

   319         virtual TInt Program_SetStartTimeL( CStifItemParser& aItem );

   320 

   321         /**

   322         * Program_SetEndTime test method.

   323         * @since ?Series60_version

   324         * @param aItem Script line containing parameters.

   325         * @return Symbian OS error code.

   326         */

   327         virtual TInt Program_SetEndTimeL( CStifItemParser& aItem );

   328 

   329         /**

   330         * Program_SetAppUid test method.

   331         * @since ?Series60_version

   332         * @param aItem Script line containing parameters.

   333         * @return Symbian OS error code.

   334         */

   335         virtual TInt Program_SetAppUidL( CStifItemParser& aItem );

   336 

   337         /**

   338         * Program_SetPluginUid test method.

   339         * @since ?Series60_version

   340         * @param aItem Script line containing parameters.

   341         * @return Symbian OS error code.

   342         */

   343         virtual TInt Program_SetPluginUidL( CStifItemParser& aItem );

   344 

   345         /**

   346         * Program_SetApplicationDataL test method.

   347         * @since ?Series60_version

   348         * @param aItem Script line containing parameters.

   349         * @return Symbian OS error code.

   350         */

   351         virtual TInt Program_SetApplicationDataLL( CStifItemParser& aItem );

   352 

   353         /**

   354         * Program_SetDbIdentifier test method.

   355         * @since ?Series60_version

   356         * @param aItem Script line containing parameters.

   357         * @return Symbian OS error code.

   358         */

   359         virtual TInt Program_SetDbIdentifierL( CStifItemParser& aItem );

   360 

   361         /**

   362         * Program_SetScheduleType test method.

   363         * @since ?Series60_version

   364         * @param aItem Script line containing parameters.

   365         * @return Symbian OS error code.

   366         */

   367         virtual TInt Program_SetScheduleTypeL( CStifItemParser& aItem );

   368 

   369         /**

   370         * Program_PluginType test method.

   371         * @since ?Series60_version

   372         * @param aItem Script line containing parameters.

   373         * @return Symbian OS error code.

   374         */

   375         virtual TInt Program_PluginTypeL( CStifItemParser& aItem );

   376 

   377         /**

   378         * Program_Name test method.

   379         * @since ?Series60_version

   380         * @param aItem Script line containing parameters.

   381         * @return Symbian OS error code.

   382         */

   383         virtual TInt Program_NameL( CStifItemParser& aItem );

   384 

   385         /**

   386         * Program_StartTime test method.

   387         * @since ?Series60_version

   388         * @param aItem Script line containing parameters.

   389         * @return Symbian OS error code.

   390         */

   391         virtual TInt Program_StartTimeL( CStifItemParser& aItem );

   392 

   393         /**

   394         * Program_EndTime test method.

   395         * @since ?Series60_version

   396         * @param aItem Script line containing parameters.

   397         * @return Symbian OS error code.

   398         */

   399         virtual TInt Program_EndTimeL( CStifItemParser& aItem );

   400 

   401         /**

   402         * Program_EndTime test method.

   403         * @since ?Series60_version

   404         * @param aItem Script line containing parameters.

   405         * @return Symbian OS error code.

   406         */

   407         virtual TInt Program_SetToFutureL( CStifItemParser& aItem );

   408         

   409         /**

   410         * Program_AppUid test method.

   411         * @since ?Series60_version

   412         * @param aItem Script line containing parameters.

   413         * @return Symbian OS error code.

   414         */

   415         virtual TInt Program_AppUidL( CStifItemParser& aItem );

   416 

   417         /**

   418         * Program_PluginUid test method.

   419         * @since ?Series60_version

   420         * @param aItem Script line containing parameters.

   421         * @return Symbian OS error code.

   422         */

   423         virtual TInt Program_PluginUidL( CStifItemParser& aItem );

   424 

   425         /**

   426         * Program_ApplicationData test method.

   427         * @since ?Series60_version

   428         * @param aItem Script line containing parameters.

   429         * @return Symbian OS error code.

   430         */

   431         virtual TInt Program_ApplicationDataL( CStifItemParser& aItem );

   432 

   433         /**

   434         * Program_DbIdentifier test method.

   435         * @since ?Series60_version

   436         * @param aItem Script line containing parameters.

   437         * @return Symbian OS error code.

   438         */

   439         virtual TInt Program_DbIdentifierL( CStifItemParser& aItem );

   440 

   441         /**

   442         * Program_ScheduleType test method.

   443         * @since ?Series60_version

   444         * @param aItem Script line containing parameters.

   445         * @return Symbian OS error code.

   446         */

   447         virtual TInt Program_ScheduleTypeL( CStifItemParser& aItem );

   448 

   449         /**

   450         * Program_DebugDump test method.

   451         * @since ?Series60_version

   452         * @param aItem Script line containing parameters.

   453         * @return Symbian OS error code.

   454         */

   455         virtual TInt Program_DebugDumpL( CStifItemParser& aItem );

   456 

   457         /**

   458          * Method used to log version of test class

   459          */

   460         void SendTestClassVersion();

   461 

   462         //ADD NEW METHOD DEC HERE

   463         //[TestMethods] - Do not remove

   464 

   465     public:     // Data

   466         // ?one_line_short_description_of_data

   467         //?data_declaration;

   468 

   469     protected:  // Data

   470         // ?one_line_short_description_of_data

   471         //?data_declaration;

   472 

   473     private:    // Data

   474 

   475         // ?one_line_short_description_of_data

   476         //?data_declaration;

   477 

   478         // Reserved pointer for future extension

   479         //TAny* iReserved;

   480 

   481     public:     // Friend classes

   482         //?friend_class_declaration;

   483     protected:  // Friend classes

   484         //?friend_class_declaration;

   485     private:    // Friend classes

   486         //?friend_class_declaration;

   487 

   488         CCseSchedulerApi* iApi;

   489         CCseScheduledProgram* iProgram;

   490         HBufC8* iExternalizeBuff;

   491         RArray<TUint32> iAddedProgramIds;

   492     };

   493 

   494 #endif      // VIDEOSCHEDULER_APITEST_H

   495 

   496 // End of File