testexecfw/useremul/Readme.txt
changeset 0 3e07fef1e154
equal deleted inserted replaced
-1:000000000000 0:3e07fef1e154
       
     1 ========================================
       
     2 =             SYMBIAN SIGNED           =
       
     3 ========================================
       
     4 Document version:	1.00(002), 25th of Nov 2009
       
     5 
       
     6 Contents
       
     7 SECTION 1 - QUICK CHECKS
       
     8 SECTION 2 - RELEASE NOTES
       
     9 SECTION 3 - USER GUIDE / DOCUMENTATION
       
    10 
       
    11 SECTION 1 - QUICK CHECKS
       
    12 ========================
       
    13 
       
    14 This file contains the following files
       
    15 	- This completed document
       
    16 	- UserEmulator_v4.2_2509.sis file
       
    17 	- UserEmulator.pkg
       
    18 	- ReleaseNotes_v4.2_2509.txt
       
    19   - OrangeUserEmulator.doc
       
    20 	
       
    21 Symbian signed submission criteria checklist:
       
    22 CHECK-01: Provided ReleaseNotes_v4.2_2509.txt
       
    23 CHECK-02: There are no embedded SIS files.
       
    24 CHECK-03: Yes. The application can be tested via its own UI.
       
    25 CHECK-04: The submitted SIS file is signed with the Publisher ID of France Telecom R&D UK LTD.
       
    26 CHECK-05: The SIS file contains correct version information that matches with the application's About box.
       
    27 CHECK-06: Capabilities: 
       
    28 		PowerMgmt     : Class TApaTaskList    -> EndTask 		
       
    29 		SwEvent       : Class RWsSession      -> SimulateRawEvent
       
    30 		LocalServices : Class CC32Server      -> CustomSecurityCheckL 	
       
    31 		ReadDeviceData: Publish and Subscribe Property
       
    32 		ProtServ
       
    33 		WriteDeviceData: CWsScreenDevice      -> SetScreenMode
       
    34 CHECK-07: No Backup required
       
    35 CHECK-08: Target platform UID: 
       
    36       Series 60 v 3.1 : 0x102032BE
       
    37 		  Series 60 v 3.2 : 0x102752AE
       
    38 		  Series 60 v 5.0 : 0x1028315F
       
    39 CHECK-09: Package UID: 0x2001C3AF (assuming application UID is referred to here)
       
    40 CHECK-10: Not Applicable
       
    41 CHECK-11: Not Applicable
       
    42 CHECK-12: Not Applicable
       
    43 CHECK-13: Application UID: 0x2001C3AF
       
    44 CHECK-14: UserEmulator_0x2001C3AF.exe
       
    45 CHECK-15: Not Applicable
       
    46 CHECK-16: Not accessing SIM card.
       
    47 CHECK-17: Not Applicable
       
    48 
       
    49 SECTION 2 - RELEASE NOTES
       
    50 =========================
       
    51 Application version:	4.2_2509
       
    52 
       
    53 Phone(s) concerned:	Nokia 6220, Nokia 5800 XpressMusic
       
    54 Release note:		This version is designed to work on Nokia 6220 and Nokia 5800 phones 
       
    55                 (And not just restricted to these phones). User Emulator is a tool for automated test creation, 
       
    56                 execution and management. It is capable of handling any key events (up/down/left/right arrow, 
       
    57                 selection key, LSK, RSK, Menu key, alpha/numeric keys, etc) and pointer events. This tool helps in 
       
    58                 writing, reusing and executing tests on the code under development. 
       
    59 		
       
    60 Phone(s) concerned:	All
       
    61 Release note:		This version is designed to work on series60 3.2 and 5.0 phones. 
       
    62                 User Emulator is a tool for automated test creation, 
       
    63                 execution and management. It is capable of handling any key events (up/down/left/right arrow, 
       
    64                 selection key, LSK, RSK, Menu key, alpha/numeric keys, etc) and pointer events. This tool helps in 
       
    65                 writing, reusing and executing tests on the code under development. 
       
    66 
       
    67 Please find additional release notes included in this zip file.
       
    68 
       
    69 SECTION 3 - USER GUIDE
       
    70 ======================
       
    71 User Emulator is a tool for automated test creation, execution and management. It is capable of handling any 
       
    72 key events (up/down/left/right arrow, selection key, LSK, RSK, Menu key, alpha/numeric keys, etc) and pointer events.
       
    73 This tool helps in writing, reusing and executing tests on the code under development.
       
    74 
       
    75 Menu Options 
       
    76 ------------
       
    77 After the application launch, any scripts available in the default settings path are displayed to the user. 
       
    78 This view is refreshed if there is any change in the settings path or addition/deletion of scripts.
       
    79 
       
    80 1. Run Scripts
       
    81 Script execution can start by selecting the Run Scripts menu option. Script selection can be made by clicking on a script name. 
       
    82 Single selection or multiple script selection option is available to the user. After the selection, file(s) are parsed using an XML 
       
    83 parser and appropriate actions are performed. Visual indications of scripts execution pass/fail/cancellation are displayed using icons on the screen.
       
    84 
       
    85 Green Icon: pass
       
    86 Red Icon: Fail
       
    87 Yellow Icon: Cancellation of script execution
       
    88 
       
    89 Script run starts on idle screen after the Menu application and idle screen reset.
       
    90 
       
    91 2. Select
       
    92 This option can be used for file selection and de-selection respectively. There is an option to select/de-select a single 
       
    93 file or multiple files at the same time.
       
    94 
       
    95 3. Record input
       
    96 This menu option allows users to start recording any key presses or screen taps. User has to enter a name for the recorded script. 
       
    97 The file name cannot contain any special characters. An error message is displayed to the user and a dialog is prompted to enter 
       
    98 correct filename. The file is stored in 'Scripts Path ' folder. Screenshot tag can be added dynamically in the script by pushing 
       
    99 the camera button once during script recording. Recording can be cancelled any time by pressing the power button once.
       
   100 Script recording starts on idle screen after the Menu application and idle screen reset.
       
   101 
       
   102 4. Random test run
       
   103 Starts the Random test on the device and sends random key presses and screen taps to the device. Random test can be stopped by pressing 
       
   104 the power button once.
       
   105 
       
   106 5. Settings
       
   107 This menu option launches a settings dialog that has configuration information for the User Emulator tool.
       
   108 
       
   109 •	Scripts Path: User can modify the storage path of the test scripts.
       
   110 •	Log Status: Logging option can be turned ON/OFF using this settings option.      
       
   111 •	Log File Path: Path for the log file that logs the script execution actions. This file also captures any system wide panics.  
       
   112 Note: User has to exit the tool in order to check the log files. Log files are overwritten every time the tool starts.
       
   113 •	Target for Random Test? Can be ON/OFF. 'ON' enables random tests on ID specified application(s). If it is in 'OFF' state then random test 
       
   114 will perform without starting an application at start time.
       
   115 •	App IDs of Random Test: If the previous option is 'ON' then 'Random test run' will start application(s) at the beginning of the test using these IDs.
       
   116 
       
   117 Note: A sample log file generated after a simple script execution is attached at the end of this document.
       
   118 
       
   119 6. System Info
       
   120 Option that gives the complete system information like OS-Version, UI-Version, Machine ID,IMEI No, Family, CPU, CPUSpeed, 
       
   121 Start-up reason, RAM, Free RAM and ROM available on the device.
       
   122 
       
   123 7. Help
       
   124 Help file describing the User Emulator tool usage
       
   125 
       
   126 8. About
       
   127 A brief about the tool
       
   128 
       
   129 
       
   130 Middle soft Key Options:
       
   131 ------------------------
       
   132 1.	Run Scripts
       
   133 User can call Run Scripts to run a script on focus. 
       
   134 
       
   135 Please find attached the OrangeUserEmulator.doc for more details.
       
   136 
       
   137 
       
   138 Installation
       
   139 ============
       
   140 Install the UserEmulator_v4.2_2509.sis file package on your phone through your favourite installation method 
       
   141 (e.g. the Nokia Phone Suite or through a Bluetooth file transfer).
       
   142 
       
   143 IMPORTANT NOTES:
       
   144 1. There is no backup required of this application
       
   145 
       
   146 2. UNI-08: Uninstall: The log files and screenshots generated from the User Emulator are not removed after the application uninstallation. 
       
   147    This tool is used as a stress test tool and the information gathered is used for further analysis. 
       
   148 
       
   149 3. If the log path is the Phone memory, and the path set is say any directory other than 
       
   150    "C:\\Data\\", log files are not visible using the Nokia native File Browser application. 
       
   151     This issue is not considered a fatal error because of it is a system limitation.
       
   152 
       
   153 4. In order to get the same results during script execution, all the screens on the device should be reset to 
       
   154    its initial state before script recording and playback. 
       
   155     o	Currently the tool supports basic reset functionality of resetting the Menu application's scroll bar, 
       
   156       closing any open applications on the device and resetting the idle screen. 
       
   157     o	If there are any changes to the application position in the Menu application or any changes on the 
       
   158       HomeScreen, the script when played back may not produce the same results. This is a known limitation of the tool.