+ + + + + string + + + + + value + + + + Title commmand requires test title as an argument + + +Specifies a verbal description for a test case. + +title testcasedescription + +Arguments: +test case description: A verbal description for a test case. + + + + + + + value + + + + Timeout keyword should have a timeout value as an argument + + +Specifies a timeout value for a test case. +Timeout value is passed in milliseconds. + +timeout value + +Arguments: +value:Timeout value,passed in milliseconds. + + + + + + + + + normal + + + high + + + low + + + Priority value + + + + + Priority keyword should have a priority value as an argument + + +Specifies the priority value of the test case. The value can be either an integer +or the string "high", "normal" or "low". Negative values are low and positive +values are high. + + + + + + + setresultdescriptionValue + + + + Setresultdescription has invalid argument + + +Sets the description of the current executed test case. +In case of error situation, it will be shown to user in test report. + +setresultdescription setresultdescriptionValue + + + + + + + TestClassName + + + TestObjectName + + + + Create has invalid argument + + +Creates keyword is used to create a new instance of a test class. + +create TestClassName TestObjectName + +Arguments: +Test class name: The test class name for the new object. +Test object name: The name of the created new instance of the test class. + + + + + + + KernelTestClassName + + + TestObjectName + + + + Createkernel has invalid argument + + +Creates a new instance of a kernel test class. + +createkernel KernelTestClassName TestObjectName + +Arguments: +Test class name: The test class name for the new object. It's the first argument. +Test object name: The name of the created new instance of the test class. + + + + + + + TestObjectName + + + + Delete has invalid argument + + +Deletes an instance of a test class + +delete TestObjectName + +Arguments: +Test object name: The name of the instance of the test class that is deleted. + + + + + + + errorCode + + + + + optionalErrorCode + + + + "allownextresult" keyword must be followed by an error code + + +Adds valid result values for a method and for asynchronous commands. +The default value for the expected result is 0 + +allownextresult errorCode + +Arguments: +A Symbian OS error codes: A Symbian OS error codes, which is allowed from the next method or waittestclass completion. +Optional Error Code: Optional.Multiple error codes, separated by space, can be passed. + + + + + + + errorCode + + + + + optionalErrorCode + + + + "allowerrorcodes" keyword must be followed by an error code + + +Adds valid result values for a method and for asynchronous commands. +The default value for the expected result is 0 + +allowerrorcodes errorCode + +Arguments: +A Symbian OS error codes: A Symbian OS error codes, which is allowed from the next method or waittestclass completion. +Optional Error Code: Optional.Multiple error codes, separated by space, can be passed. + + + + + + + + TestObjectName + + + + Delete has invalid argument + + +Pauses test case running until the specified test class object calls the +Signal function to proceed with the test case execution again. + +waittestclass TestObjectName + +Arguments: +Test object name: The name of the instance of the test class, +which must call Signal() to proceed with the test case execution. + + + + + + + pauseValue + + + + "pause" keyword takes number of miliseconds as an argument" + + +Pauses test case running. + +pause pauseValue + +Arguments: +pauseValue: The timeout for the pause, specified in milliseconds. + + + + + + + loopTimes + + + + + msec + + + + "loop" keyword must be followed by the loop count + + +Repeats a section of the test case file for the specified number of iterations. +The section to be repeated is enclosed with the loop and endloop keywords. + +loop loopTimes msec + +Arguments: +Loop times: The loop count, that is, the number of times that the loop is executed. +Msec: Optional.This keyword says that ‘Loop times’ argument stands for the time in milliseconds during which loop will be looped + + + + + + + String + + + + + yes + + + + incorrect "print" value + + +Specifies a description to print, for example, to print progress information to the UI. + +print string + +Arguments: +Print string: The string that want to be printed. + + + + + + "endloop" keyword takes no arguments + + +The endloop keyword is used to specify the end of a looped section. + +endloop + + + + + + + + + on + + + off + + + + + "oomignorefailure" keyword must be followed by an on/off value + + +Used for OOM testing. +Defines if a test class’s building block execution result is checked or ignored. + +Arguments: +Indication for the result check: The possible values are on and off: +on indicates that the building block execution result will be ignored. +off (default) indicates that the building block execution result will be checked and errors will be handled. + + + + + + + CountValue + + + + "oomheapfailnext" keyword must be followed by a failure rate + + +Used for OOM testing. +Defines that heap allocation failure occurs in the test thread. + +oomheapfailnext CountValue + +Arguments: +Count value (rate): The failure rate. Heap allocation fails every time that is given as an argument. +The given argument will be increased by one because the Test Scripter LOOP_COUNTER range starts from 0. +The oomheapfailnext range starts from 1. + + + + + + + + + random + + + truerandom + + + deterministic + + + none + + + failnext + + + + CountValue + + + + "oomheapsetfail" keyword must be followed by the type of failure and a count value + + +Used for OOM testing. +Defines that heap allocation failure occurs in the test thread. +The user can define the failure type and count (rate). + +Arguments: +The type of failure to be simulated: The supported value are: random, truerandom, deterministic, none, failnext +Count value (rate): The given argument will be increased by one because the Test Scripter LOOP_COUNTER range starts from 0. + The oomheapsetfail range starts from 1 + + + + + + + "oomheaptonormal" takes no parameter + + +Used for OOM testing. +Ends OOM testing and normal testing continues. + +oomheaptonormal + + + + + + + objectName + + + + start + + + stop + + + + + + + activeobject + + + thread + + + + + cpuload + + + filesystemreadc + + + filesystemreadd + + + filesystemreade + + + filesystemreadz + + + filesystemwritec + + + filesystemwrited + + + filesystemwritee + + + filesystemfillandemptyc + + + filesystemfillandemptyd + + + filesystemfillandemptye + + + + idleTime + + + activeTime + + + + syntax error error + + +Interferes the testing. + +Arguments: +object name: Object name that is used for starting and stopping interference operations. +command: Command for STIF Test Interference control. +The supported values are: +-start +-stop. + +category: Interference category. The supported values are: +-activeobject +-thread. + +type: Interference type. +The supported values are: +-cpuload +-filesystemreadc +-filesystemreadd +-filesystemreade +-filesystemreadz +-filesystemwritec +-filesystemwrited +-filesystemwritee +-filesystemfillandemptyc +-filesystemfillandemptyd +-filesystemfillandemptye + +idle time: Idle time in milliseconds. +active time: Active time in milliseconds. +set priority: Optional. Set priority for thread or active object. + + + + + + + + start + + + stop + + + + + measurementplugin01 + + + measurementplugin02 + + + measurementplugin03 + + + measurementplugin04 + + + measurementplugin05 + + + stifbappeaprofiler + + + + + + STIFTestMeasurementParameters + + + + + "measurement" keyword must be follwed by a command, type and optionaly parameters + + +easures the testing. + +Arguments: +STIF Test measurement command: Commad for STIF Test Measurement control. The supported values are: start for starting test measurement, stop for stopping test measurement. It also releases all allocated resources. +STIF Test measurement type: Test measurement type. +The supported values are: measurementplugin01, measurementplugin02, measurementplugin03, measurementplugin04, measurementplugin05, bappeaprofiler +STIF Test measurement parameters: Test measurement module configuring etc. user and test measurement module specific. + + + + + + + varName + + + varValue + + + + "var" keyword requires variable name and value + + +Assigns a text value to a specified variable. It can be then used in other part of the script. + +var varName varValue + + + + + + + + callsubValue + + + + "callsub" keyword requires subroutine name as the only agrument + + +Makes TestScripter executing pointed section of script. + +Section which will be called must start with [Sub name] and end with [EndSub] tags, where name is the identifier of the sub. +The execution of the sub will continue until its end is reached. There is possibility to call a sub from another sub. + +callsub callsubValue + + + + + + + requestValue + + + + "request" keyword must be follwed by an event name + + +Requests an event. If someone wants to use an event, it must first be requested, and after that it can be waited. +After the event is not used anymore, it must be released. + +request requestValue + +Arguments: +Event: The event name. + + + + + + + waitValue + + + + "wait" keyword must be follwed by an event name + + +Waits for an event. +A request must be called before wait, and wait blocks until the requested event is set. +Wait may proceed immediately if the requested event is a state event and already pending (for example, a phone call is already active). + +wait waitValue + +Arguments: +Event: The event name. + + + + + + + + releaseValue + + + + "release" keyword must be follwed by an event name + + +Releases an event. +Every requested event must be released explicitly when it is not used anymore. + +release releaseValue + +Arguments: +Event: The event name. + + + + + + + + setValue + + + + + state + + + + "set" keyword must be follwed by an event name + + +Sets an event. Every set state event must be explicitly unset. + +set setValue state + +Arguments: +Event: The event name. +State: Optional. If a state is given, sets the state event, otherwise sets an indication event. + + + + + + + unsetValue + + + + "unset" keyword must be follwed by an event name + + +The unset keyword is used to unset a state event. +Every set state event must be unset. +Indication events cannot be unset. unset blocks until everyone who has requested the specified event has released the event. + +unset unsetValue + +Arguments: +Event: The event name. + + + + + + + "bringtoforeground" keyword takes no arguments + + +Brings UI component container to foreground described in below. + +bringtoforeground + + + + + + "sendtobackground" keyword takes no arguments + + +Sends UI component container to background. + +sendtobackground + + + + + + + presskeyValue + + + + + presskeyValue + + + + "presskey" keyword takes Key code as an argument. + + +Sends key event to tested UI component. + +presskey presskeyValue + +Arguments: +Key code Single character or constant defined in TKeyCode enumeration. Must be defined if keycode and keyscancode is not defined + +keycode: Numeric value or constant defined in TKeyCode enumeration. If it is defined, then mandatory argument may be omitted +keyscancode: Numeric key value or constant defined in TStdScanCode enumeration. If it is defined, then mandatory argument or keycode argument may be omitted +modifier: One of the constant values defined in TEventModifier enumeration +repeats: Count of auto repeats generated. 0 means an event without repeats. 1 or more means "this many auto repeat events". In most cases this value is ignored and treated as a single event. +local: Sends key event to focused UI control, constructed under CCoeEnv delivered by STIF. +global: Sends key event to focused UI control ( constructed under any CCoeEnv, not necessarily CCoeEnv delivered by STIF ) e.g press left softkey of global message box + + + + + + + + + typetextValue + + + + "typetext" keyword takes text as an argument. + + +Sends text to tested UI component. + +typetext typetextValue + +Arguments: +text: Text in quotation marks which should be send to UI component + + + + + + + + + sendpointereventValue + + + + + SendpointereventValue + + + + "sendpointerevent" keyword takes Event type and positon as an arguments. + + +Sends pointer event to tested UI component. + +sendpointerevent sendpointereventValue + +Arguments: +Event type: Pointer event type. +Fallowing pointer even types are sypported: EButton1, EButton2, EButton3, EPointerMove, EPointerSwitchOn, EButton1Down, EButton1Up, EButton2Down, EButton2Up, EButton3Down, EButton3Up +x: Pointer x co-ordinate +y: Pointer y co-ordinate + + + + + + + + + TestLibDLLName + + + DllObjectName + + + + Create has invalid argument + + +Loads STF specific test harness library. + +using TestLibDLLName DllObjectName + +Arguments: +DLL name: The test harness library name. +DLL object name: The alias of the created new instance of the test harness library. + + + + + + + PanicNumber + + + + "expectedpanic" keyword takes one panic number argument + + +Declares valid panic result value for a test case. It indicates that the test case MUST panic with this specified panic code in execution, and only can be used once with a single parameter. +NOTE: expectedpanic does not support UI Testing. + +expectedpanic PanicNumber + +Arguments: +Panic Number, An single integer, which represents the expected panic number. + + + + + + + + + "canceliferror" keyword takes no arguments + + +Cancels the execution of the remaining test cases if one of the executed test cases has failed. +This keyword is normally used to stop the test case execution when some of the test cases are long running. + +canceliferror + + + + + + + testmodule + + + configfile + + + TestCaseNumber + + + + + expect + + + testid + + + ini + + + category + + + timeout + + + title + + + + "run" keyword takes test module name, configuration file and test case number as argumets + + +Starts a specified test case. It has several mandatory and optional arguments. + +run testmodule configfile TestCaseNumber expect testid ini category timeout title + +Arguments: +testmodule: The test module name. +configfile: The test case configuration file. +Test case number: The test case number to be executed from configfile. + +Optional arguments: +expect: The expected result (0 = KErrNone). +testid: Test case identification, which is used by other keywords to identify the test case (). +ini: The initialization file for test module (). +category: The result category; either normal, leave, panic, exception or timeout. +timeout: Test case timeout (not supported yet). +title: Test case title. + + + + + + + + testid + + + + "cancel" keyword takes test an identification of a test case as an argument + + +Cancels a started test case. +The test case is cancelled by immediately killing the thread that executes the test case. + +cancel testid + +Arguments: +testid: The test ID from the run command. + + + + + + + testid + + + + + time + + + + "pausetest" keyword takes testid as mandatory argument. + + +Pauses a test case. The test case is paused by pausing the thread that executes +the test case. The pausetest keyword has one mandatory argument + +pausetest testid time + +Arguments: +testid: the test ID from the run command. +time: (optional) Pause time in milliseconds. After this time, resume is called automatically (if not given, resume needs to be called explicitly). + + + + + + + testid + + + + "resume" keyword takes an identification of a test case as an argument + + +Resumes a paused test case. + +resume testid + +Arguments: +testid: The test ID from the run command. + + + + + + + testid + + + + "complete" keyword takes an identification of a test case as an argument + + +Waits and blocks a running test case. This keyword is used to have a started test case wait to complete. +It blocks until the test case has finished. + +complete testid + +Arguments: +testid: The test ID from the run command. + + + + + + + SlaveType + + + SlaveName + + + + "allocate" keyword must be follwed by slave type ans slave name + + +Allocates a slave, for example for running a test case on a remote phone. +It uses Remote Control Protocol (RPC). +The slave must always be allocated first before it can be used. + +Arguments: +Slave type: The type of the slave. +STIF only supports slave phone. phone indicates that slave phone is also running STIF. +Other types must be handled by the slave implementation, i.e. when implementing separate support for external network simulator. + +Slave name: A unique name for the slave. + + + + + + + + + SlaveName + + + + "free" keyword must be follwed by slave name + + +Frees a slave. Every allocated slave must be freed with free when it becomes unused. + +Arguments: +Slave type: The type of the slave. +STIF only supports slave phone. phone indicates that slave phone is also running STIF. +Other types must be handled by the slave implementation, i.e. when implementing separate support for external network simulator. + + + + + + + + objectName + + + + run + + + request + + + wait + + + set + + + unset + + + set + + + release + + + + module + + + + + testmodule + + + configfile + + + testCaseNumber + + + expect + + + testid + + + ini + + + category + + + timeout + + + title + + + + syntax error error + + +Starts the execution of a test case in a slave and also to request and release events from the slave. +Other test case controlling for remote test cases is done with the same keywords as for the local test cases. + +Arguments: +Slave name: The slave name, the same that was given for allocate. +Command name: The remote command name +supported commands: +-run +-request +-wait +-set +-unset +-release + + + + + + + + + + filename + + + + missing mandatory argument: filename. + + +Includes a file. + +Must be written in capital letters and must start from the first column of the line. +File name (with path and extension) must follow INCLUDE command. Rest of line would be ignored. +All files included from Unicode file should also be in Unicode format (and vice versa). +Loops in includes are not allowed (for example incorrect situation is when file A includes file B and file B includes file A). In that case, the second include will be ignored, but STF parser will continue working). + + + + + + + + + + TestClassName + + + TestObjectName + + + + syntax error + + +Creates an object, wihch can be shared to other test cases in the same test script file. + +createshareobj TestClassName TestObjectName + +Arguments: +Test Class Name: The test class name for the new object. +Test Object Name: the name of the created new instance of the test class + + + + + + + TestObjectName + + + + syntax error + + +Restores an object, which has been created by the createshareobj keyword. + +restoreshareobj TestObjectName + +Arguments: +Test Object Name: the name of the instance of the test class + + + + + + + TestObjectName + + + + syntax error + + +Deletes an instance of a test class created with createshareobj. + +deleteshareobj TestObjectName + +Arguments: +Test Object Name: the name of the instance of the test class + + + + + +