Home

Eggplant Reference

1. 24 CUESOF LOCATON err 24 euren 24 Th lmag Pan S meer 25 ec d H 25 Image Name dizi 25 Where AA 25 Creating a New Folde c 25 Making an Image Collection o oooooconnnnncccnonnnoccccnnnnonnnccnn ie ered eer AENEAN EEREN NNNNA EAREN rra nn n nn cnn E ENNAN EENE 25 image Well cocoa ea 25 Search Type Pop Up Menu c ccceeceecceceeeeeeeeeeeceeaaeaaeceeeeeeeeeeececeaeaaeaaeeeeeeeeeeeeesecccaeaaeeeeeeeeeeeeesecsnesieaeees 25 Command Function Pop Up Menci n air its 26 Max Wait Field ai A A A a A iD 26 Cancel Buttons aaa 27 A RN 27 The Use Image Panel nia ll 27 File BLOWS OR amosir ie IL 27 Command Function Pop Up Merili nsiii esit ii aa edia e aaa aaaeaii 27 Max Wait FIC Ge cnn ra A A AA ada Aa it 27 erede iba 27 Insert BUOM m 27 zu Eus M 27 Generated Text Platforms ccceceeceeceeeeceeece eee ee eee eec eae E A TE E AR EE a 28 www testplant com EggPlant Reference Manual The Script UG ON ia 31 Creating and Editing Scripts eir A E RR tiers dd 31 AULO COM PICTON M 31
2. Tip To start the script in a paused state for debugging hold down Option as you choose Run Script Run Selection The Run Selection menu item runs only the selected part of a script in the active Script Editor or Run window This menu item is only available when there is selected text in the active window Tip To start the selected part of a script in a paused state for debugging hold down Option as you choose Run Selection Animation Animation highlights the current line of code in the Script Display area of the Run window as the script is running The script animation setting can be changed while a script is running with immediate effect it can also be modified temporarily by scripts as they run For more information see the ScriptAnimation in Global Properties Animation Off When you choose Animation Off the Display area of the Run window does not update as the script runs only the initial handler for the script is shown unless the execution is paused Animate Calls When you choose Animate Calls the Run window shows each script or handler as it is called but it does not highlight each line of the script Animate All When you choose Animate all the Run window highlights each line of each script or handler as it is run Note Animations cause scripts to execute more slowly because EggPlant is doing more work at the display level To improve script execution speed turn off all animations when you are not debug
3. When you choose Animation Off the Display area of the Run window does not update as the script runs only the initial handler for the script is shown unless the execution is paused Animate Calls When you choose Animate Calls the Run window shows each script or handler as it is called but it does not high www testplant com EggPlant Reference Manual 39 light each line of the script Animate All When you choose Animate All the Run window highlights each line of each script or handler as it is run Note Animation settings can also be modified temporarily by scripts For more information see the ScriptAnimation in Global Properties Tracing Pop Up Menu Tracing causes EggPlant to echo information about what the script is about to execute to the Log Area in the Run window This is similar to animation but it allows you to review all of the code that is executed during the script run interspersed with logged output This can provide more context when debugging a script You can change tracing settings at any time with immediate effect including while a script is running Note Tracing settings can also be modified temporarily by scripts For more information see the ScriptTracing in Global Properties Tracing Off When you choose Tracing Off only standard log messages are displayed in the Log Area of the Run window Trace Calls When you choose Trace Calls the Log Area of the Run window displays a message
4. About This Manual The EggPlant Reference Manual is designed to provide quick information about the EggPlant interface and script elements Appendices A E contain comprehensive lists of the EggPlant script elements suitable for printing Help and Additional Information The following manuals are available through the EggPlant Help viewer and the downloads page of the TestPlant web site The EggPlant Reference Manual describes the EggPlant interface and scripting processes and the SenseTalk com mands functions and global properties that are unique to EggPlant Using EggPlant is a collection of articles that cover a wide range of EggPlant topics EggPlant Tutorials is a series of five tutorials that introduce the scripting environment and often used commands and functions The Sense Talk Reference Manual is a comprehensive guide to the SenseTalk scripting language used in EggPlant For EggPlant updates news discussion forums and all available support resources please visit TestPlant support www testplant com EggPlant Reference Manual The EggPlant Menus This section describes the menus that are always present in the EggPlant menu bar The EggPlant menu The File menu The Edit menu The Run menu The Connection menu The Control menu The Window menu The Help menu The EggPlant Menu The EggPlant menu contains version and license information preferences and display options About Eg
5. Bold A yes or no value Underline A yes or no value Trim Whether or not extra space is trimmed away from the text The default value is yes Cache Whether a cached image is used if one is available A value of no forces EggPlant to generate the image over again every time it is called The default value is no www testplant com EggPlant Reference Manual 93 The CurrentTextPlatform Examples setoption currenttextplatform WinXP set the currenttextplatform generator to native Value The name of a text platform defined in Text preferences Default Set in Text preferences Description The CurrentTextPlatform determines the text platform that is used by a script Note This global property displays only the name of the current platform by default but it is still a property list You can assign values to CurrentTextPlatform keys just as you can with the TextPlatforms global property Tip To display the property list of the CurrentTextPlatform call the SenseTalk function StandardFormat The DefaultUseMarkup Examples setoption DefaultUseMarkup Yes set the defaultUseMarkup to No Value yes or no Default No Description The DefaultUseMarkup determines whether or not supported text markups are recognized in the Text property of a text property list When the DefaultUseMarkup is set to yes supported markups are used to format generated text images When the DefaultUseMarkup is set to no markups are treated a
6. Edit Script opens the Script Editor and selects the line that caused the error Continue Script If your script run is paused because of a script error Continue Script resumes the run umbnail view The top right section of the mages pane shows the selected image scaled to fit as necessary The image s Hot Spot is marked by red cross hairs you can change it by Command clicking in a new location You can also nudge the Hot Spot one pixel at a time with Command Arrow key Adding the Shift key moves the Hot Spot in ten pixel increments Info The nfo button opens and closes a panel that contains the following supplemental information about the selected image The Image Name ControlPanel tiff Hot Spot_ 34 7 Center Searching Type Text HJ Tolerance 58 Discrepancy 0 Image Description Image Size 69 x 14 File Size 582 Image info panel www testplant com EggPlant Reference Manual 46 Image Name This text field contains the name of the image Hot Spot The values in these fields represent the horizontal and vertical distance from the top left corner of the image to the Hot Spot measured in pixels You can move the Hot Spot by editing these values or Command clicking in the thumbnail view The Center button moves the Hot Spot to the center of the image Search Type This pop up menu contains the settings that determine how precisely the Viewer window must match the image for a succe
7. Imagelnto FUNCION er TEES 79 ImageHotSpot FUto sessa ciao cata otc aac rra Y o prx o bx ad lh dx Dey aug ac pud agus E e E 79 imagasize muere 79 IrnageColorAtbocatlon FUNCOM iria dai 80 Fourid Image Intormation FUNCIONS sissies et eiit rap i kd FU aerea exe E dd cd fe x Acero 80 Foundlmagelntfot FUNCION uta cte eee is eo detiene ea rd esee deine ua dea 80 FoundlmageLocation Function esses nnne emn nnne nnd sn antenne nens nnns nnne 81 FoundlmageName Function Deprecated eessisssseeiiiesseeesiee nhan ntn nha sahen a shakes sea a asked 81 FoundlmageNumber Function ccooooococccccccccccononononaonnnnnnnnnnnnnnnnnnnnn a nn nn nn nana nennen terns nsns d sn entente nr sensn senes 81 Sceript Commands and FUNCIONS tr Ratte n et EE nk ERE RC ERA AEN REINO RR uR RARA OIGA 81 PauseScript Command astro aa E E E REA E ET E EENDE 81 R n COMME a ia 82 RunWithNewResults COMMANG ccccccececeeeeeeeeceeceeeeeeeeeeeeeeceaaaaeaeeaeeeeeeeeeeeeeceeaaeaeeeeeeeeeeeseesecsiccasseeeeeeeeeees 82 OpenSuite and CloseSuite Commands cooccccccccnonononononcnccnnnnnnnnnnnnnnn nn E A nen nn nn nnn nn nn ran A EA 82 OpensSultes FUNCION nicol a 82 SetOption and SetOptions Commands sess enne A emeret nene n AAAA 83 GetOption GetOptioris F rctloris ocu te oot erae en be tute eua O Ra Rena E rd de CARE ke PM inde 83 Hide RunWindow Show RunWindow Command cccccceseeccec
8. Images directory and subfolders Command Function Pop Up Menu To insert a command or function into the script with your image choose it in the Command Function pop up menu To incorporate the image into the selected command or function in the script choose Add Image Max Wait Field To specify the maximum wait time associated with the Wait or WaitFor commands type the time in seconds in the Max Wait field Cancel Button To cancel the image selection and close the Use Image panel click the Cancel button Insert Button The nsert button completes the Use Image operation It inserts the generated command or function into the script executes the command if possible and closes the Use Image panel The Find Text Panel In the Find Text panel you can create text property lists descriptions of text that you can use in place of captured images To open the Find Text panel click the Find Text button in the Viewer window or choose Control menu gt Find Text The Find Text Panel contains two sets of text properties one for text platforms that use OCR Optical Character Recognition and one for platforms that dynamically generate images of your defined text www testplant com EggPlant Reference Manual 28 Generated Text Platforms Text String News Platform XP TIG H4 Style Menu KA Font Size 14 M Bold Text mmm Italic Background E Underline v Text Image Preview News Search Type Text
9. Increment A value of yes or true appends an automatically incremented number to the image The default value is no Imagelnfo A property list of additional information For more information see the ImageInfo function above Tip Incrementing is helpful if you are capturing several snapshots within a script as in a loop or frequently called handler The images can all have the same image name with the incremented number distinguishing them otherwise each image would overwrite the previous image with the same name ColorAtLocation Function Examples put ColorAtLocation 2 3 into theColor if ColorAtLocation foundImageLocation is ColorAtLocation 32 7 then Parameters One coordinate location Returns The color value of the pixel in the given location For more information see Working with Color in the Sense Talk Reference Manual www testplant com EggPlant Reference Manual 87 Behavior Returns the color value of the pixel in the given location Coordinates are relative to the top left corner of the Viewer window The top left corner is 0 0 with the x value increasing toward the right and the y value increas ing toward the bottom StartMovie Command currently Mac OS X only Example StartMovie User Documents MovieFile Parameters A file name for the movie you are capturing and optional file path Behavior Starts recording a movie of the Viewer window If you do not designate a file path
10. The File MON MVESUHMM T OPE Pell A mE Open SGript densos Open Recent SUbMeNU sasssa a a a a E aaa aA Ea A aa NOS Sas A A Spelling m Special Characters x ees rre rare stages A A iii Make Plain NOX ice neo rtr A ta TMG UD Run Script Abort Scripts erede at eee ed ER ve Eur AAA AAA FRUP SOIS CU OM TETTE DO Do LET EA THIN MEE Debug SOMipt P www testplant com EggPlant Reference Manual IV Debug Select oia O tree rere 8 Pause Script Continue Script 2 2 2 0 ccccccccecceeececceeccneceeeeeeeeeeeeeceeeaaeaaeceeeeeeeeeeesecsaeaaeaaeeeeeeeeeeeeesececccarcaseeeeseeees 9 SjceMjo reece 9 DISCOVER p EEL 9 Siete M M M M 9 Add Breakpoint Remove Breakpoint cccccceceeeeeeeeeencecaeeeeeeeeeeeeeeeecaaaeaeeeeeeeeeeeteeeeccaaeeeeeeeeeeeeeteeeeee 9 Remove All Breakpoints uu trennt A cade desde e EXER V E EVER e uc deer e AR naa 9 Bienen tein ERES 9 Connection Mr 9 Seo eia 10 D
11. The default choice in the Search Type pop up menu depends upon the image you are saving EggPlant attempts to choose the most appropriate search type for each image Tolerant is usually the best choice Text and Text amp Pulsing are never default choices Note You can adjust the tolerance of the Precise and Tolerant search types settings in Run Options preferences Command Function Pop Up Menu To insert a command or function into the script with your image choose the command or function in the Command Function pop up menu To insert the image into the script with no command or function choose Capture Image To insert the image into a selected command or function in the script choose Add Image Max Wait Field To specify the maximum wait time associated with the Wait or WaitFor commands type the time in seconds in the Max Wait field www testplant com EggPlant Reference Manual 27 Cancel Button To cancel the image capture and close the Capture panel click the Cancel button Save Button To complete the image capture and close the Capture panel click the Save button The Use Image Panel The Use Image panel is similar to a standard Open dialog with added script controls at the bottom You can open the Use Image panel by Option clicking any command that typically opens a Capture panel File Browser The upper portion of the Use Image panel is a standard file browser Use it to navigate between the current suite s
12. This pop up menu is only available when the image preview area is shown www testplant com EggPlant Reference Manual 30 Command Function Pop Up Menu To insert a command or function into the script with your text property list choose from the Command Function pop up menu The preview field below the pop up menu shows the text that is inserted into your script To incorporate the text image into the selected command or function in the script choose Add Image Max Wait Field To specify the maximum wait time associated with the Wait or WaitFor commands type the time in seconds in the Max Wait field Cancel Button To cancel the text property list and close the Find Text Panel click the Cancel button Save Button The Save button inserts the text property list into your script with the chosen command or function executes the command if applicable and then closes the Find Text panel www testplant com EggPlant Reference Manual 31 The Script Editor The Script Editor is the window in which you create and edit scripts To open the Script Editor choose File menu New Script or Open Script ODO amp Widgets suite CheckTest script E gt gt Insert e 12 params Test set myTest to item 1 of Test set my Result to true Put theTest amp myTest Repeat with each item outcome of keys myTest Put Moutcome amp outcome if myTest outcome is false then set myResult to false T
13. 38 Animation Pop Up Menu siii ab 38 EccTeTtellzoe2Bentuum e 39 opes 39 SNOW SMILE aca casings da A A A a AAN 39 Slow RESUS our Aaa 40 LETICIA E EET QD a iia 40 The Suite EditOf isa 41 The SChpls PANGS errors A tt DORA 41 Searching fora Optio an 41 Creating a MEW SCM Plot A bt tdi 42 Deleting SMS ii i 42 SR NOS 42 Rng aA logis EE 42 nis EM 42 The IMAGES PANG ERA ESL ias 42 Adding Images and Image Folders ccena e etra daa aranea crea dee na a E eda e cao 43 Searching for Images coe ee tt temi Cane iue tque tutem ictus doute iM Lic ute iue S EE eodd e cR LIE 43 www testplant com EggPlant Reference Manual Deleting Images and Image Folders icons na kr re dL E eL E E RR ERA LE FER EA E D 43 Creating New Image Folders sssssssssssssseeene enn nene en nenne nnn nnne r nnn neni nennen nnn nn nennen 44 The Image Doctor e 44 oT Deni RT naia 45 spe la reer 45 Deleting Images or Image Folders ooooocccconnocccccnnnconccccnonnnnnncnnn conc nnnnn nan n nr cnn nn emen eene ANANA Aaaa nananana aa 46 The Results PES cui a aida 46 The Script Name Run Date List oooocoonncocococccoccccccnccnncnnnnannnnnnnncnnnnnnnnnn nana nn nn nn adadi daaa d iaiia a nnne nnns nnne 47 Deleting Script
14. Doctor panel opens when an image fails you can choose to proceed with a corrected image or allow the script to fail Off The Image Doctor is not used during script execution Image Highlighting This menu item toggles image highlighting on checked or off unchecked When image highlighting is turned on images are highlighted in the Viewer window as they are found during a script execution Debug Script Debug Script runs the script in the active Script Editor or Run window starting in a paused state This allows you to step through the script and follow its execution closely The next line to be executed is highlighted in the Script Display area of the Run window While you are debugging you can use the toolbar buttons in the Run window to step through the script or allow it to continue at a normal rate For more information see The Run Window Note You can also use Debug Script by Option clicking the Run Script button in the Script Editor toolbar Debug Selection Debug Selection runs only the selected part of a script in the active Script Editor or Run window starting in a paused state This allows you to step through the script and follow its execution closely The next line to be executed is high lighted in the Script Display area of the Run window While you are debugging you can use the toolbar items on the Run window to step through the script or allow it to continue at a normal rate For more information see Th
15. EggPlant Reference Manual o Page Down Pause Break Printscreen Scroll Lock Shift down Tab Windows Windows Alt down All keys KeyUp command only All non modifier keys KeyUp command only pageDown pauseBreak printScreen scrollLock ShiftDown tab WindowsKey WindowsAltDown AllKeys AllNonModifierKeys www testplant com 8 EggPlant Reference Manual Appendix D Global Properties EggPlant Global Properties the ImageDoctor the FinalSuites the CurrentTextPlatform Te DENTAN the DefaultUseMarkup the Remote the ScriptLogging Re SEHDUADIP ation the ScriptTracing the TextPlatforms Behavior of the Image Doctor during script execution Auto Manual or Off The suite or suites that are searched for image or script resources after the script s own suite is searched The current text platform Whether or not supported text markups are used to format text images How much is written in the Log file Whether script tracing is turned on or off Property lists for all text platforms 109 www testplant com EggPlant Reference Manual 1 Run Option Global Properties the ForceScreenRefresh the ImageSearchDelay the KeyDownDelay the MouseDoubleClickDelay the MouseMoveMode Mouse path to the next given location Whether there is a screen refresh after every line Time between image searches Time between key pr
16. H4 Click B Max Wait Insert into ts suite CheckTest script Click Text Newst5tyle Menu TextFont Tahoma Cancel The Find Text Panel Text String Field The Text String field contains the actual text that appears in your image You must enter text here before you can insert the text property list Platform Pop up Menu The Platform pop up menu comprises the text platforms that you define in Text preferences Text platforms are usu ally distinguished by SUT operating system Choose the Generic text platform or a text platform that represents the SUT you are working with For more information about text platforms and TIGs see Using EggPlant More About Text Platforms www testplant com EggPlant Reference Manual 29 Style Pop Up Menu The Style pop up menu contains choices of predetermined text styles After you choose a style as a starting point you can change the individual attributes as needed For example if your text uses a SUT s standard menu font but displays it in red you can choose the menu style then change the text color to red You can define new styles in Text preferences Font and Size Fields In the Font and Size fields choose the font and size of your text if they differ from the chosen style Text and Background Color Wells To edit a text or background color click the respective color well and select a new color in the Colors panel Tip The color picker in the Co
17. ImageName is MenuButton the actual name of the image Property lists are always enclosed in parentheses with a colon between each key and its value Appendix D contains tables of the types of property lists used in EggPlant For more information see Property Lists in the SenseTalk Reference Manual Image references There are several ways to refer to images as command and function parameters image name image collection im age property list and text property list Image Name Image names are text strings and must be enclosed in quotation marks File extensions are optional www testplant com EggPlant Reference Manual 69 Example Click ImageOne Click ImageOne jpg Image Collection An Image Collection is a folder of related images that are all acceptable versions of a basic image For example an Image Collection might contain a normal image of a button a selected version and a disabled version Any image folder in your suite can be used as an Image Collection just keep in mind that EggPlant looks for every image in the Image Collection so a very large folder could slow down your script execution and cause EggPlant to find matches you are not interested in Image Collections are text strings just like image names Example Click SaveButton Note The functions ImageSize and ImageHotSpot cannot have Image Collections as parameters Collection Filters You can use the global property the Col
18. Log command executed Orange LogWarning Red LogError Green displayed in the last line Successful Test Red displayed in the last line Failed Test Searching for Log Entries To search for log entries type a search term such as a command or image name in the Search field above the Log Area To set the type of search filter click the magnifying glass in the Search field and choose All Entries Interesting www testplant com EggPlant Reference Manual 50 Entries or Warnings amp Errors from the pop up menu Interesting Entries include warnings errors exceptions log commands start and end Tip To save your search term as an item in the Search pop up menu press Return after you type the term Action Drop Down Menu The Action drop down menu above the Log Area contains several actions that you can perform on the selected Log entry in the Log Area Show Script Line Opens the Script Editor and highlights the line of the script associated with the selected Log entry Show Image Switches to the Images pane and shows the image associated with the selected Log entry Apply Fix For log entries that were generated by the Auto Doctor this action permanently applies an Auto Doctor fix to the selected image The Schedule pane The Schedule pane contains a list of current and upcoming script runs The scripts can come from any suite not just the active one A OO Windows_Tests sui
19. Manual 80 Returns Size in pixels width height Behavior This function returns the size in pixels given as width height of the given image If the image is not found an exception is raised ImageColorAtLocation Function Examples put ImageColorAtLocation myIcon 23 1 Returns the color at location 23 1 of the given image put ImageColorAtLocation myIcon imageHotSpot myIcon Returns the color at the hotspot of the named image Parameters One image name and one coordinate location Returns A color value For more information see Working with Color in the Sense Talk Reference Manual Behavior Returns the color value of a single pixel in the given image The coordinates of the pixel are relative to the top left corner of the image Found Image Information Functions The functions in this section return additional information about the last image that was found in the Viewer window They are particularly helpful with the any variants of commands and other functions when you do not necessarily know which image was found FoundImagelnfo Function Examples Put FoundImageInfo Displays imageInfo for the last image found Put FoundImageInfo s imageName into clickedImage Puts the name of the last image found into the variable ClickedImage Parameters None refers to the last image found Returns An image property list Behavior Returns an image property list for a single image or a list
20. at the image s normal tolerance setting and gradually raises the tolerance until the image is found in the Viewer window Alternate Types This version applies increasingly lenient search types until a match is found Discrepancy This version gradually increases the image s discrepancy setting until a match is found Status This column displays the found status of each diagnostic If the diagnostic is found in the Viewer window the screen coordinates of the image are displayed in the Status column Info This column displays information about how much each successful diagnostic changes the search criteria to produce www testplant com am atch Using the Diagnostics The Action drop down menu contains several ways to use a selected diagnostic EggPlant Reference Manual 45 Show Original Image This shows the diagnostic image with your original image overlaid to help you discern Th the difference between the two Fix Image This replaces your images original search criteria with the search criteria that produced the diagnostic image match Recapture Image This recaptures your image at the location where the diagnostic image is found Add Representation This turns your original image into an Image Collection and saves the diagnostic image as part of it For more information see Image Collection in EggPlant commands and functions Edit Script If you are using the Image Doctor as a result of a script error
21. behavior in Script Editor preferences Colorization By default each type of script element such as command variable and image name is written with a different color in the Script Editor This can make it easier to track what is happening in the script If you use incorrect syntax that is code that doesn t make sense to EggPlant the entire line or block that contains the error is not colored this is a visual cue that there is a problem in the script Colorization can be customized extensively in Script Editor preferences See Script preferences in Licenses and Preferences menu features The Edit and Format menus contain many of the features you find in word processors Use these menus for standard editing tasks such as finding text cutting and pasting and changing font styles Dynamic Breakpoints Dynamic breakpoints are markers that cause a script to pause for debugging at designated points To set a dynamic breakpoint in the Script Editor click in the column to the left of the script A black triangle appears next to the line denoting the breakpoint To change or remove a breakpoint drag the triangle to another line in the script or out of the script entirely The Script Editor Toolbar The Script Editor toolbar buttons are described below Since the toolbar can be customized you might not see all of the buttons on your own toolbar For more information see Customize below Save The Save button saves the c
22. by keyword See examples below Examples Generating modifiers and special keys on the SUT TypeText return Sends a Return keystroke to the SUT TypeText ControlKey AltKey Escape Holds the SUT s Control and Alt keys sends an Escape keystroke then releases the Control and Alt keys TypeText ControlKey q Holds the SUT s Control key sends a q keystroke and releases the Control key www testplant com EggPlant Reference Manual 77 For a complete list of these keywords see Appendix C TypeText Keywords Note When you are using the TypeText panel to create a command clicking the nsert button automatically encloses your text parameters in quotation marks Image searching Commands and Functions These commands and functions search for images in the Viewer window without performing any actions on the SUT Wait Command Example Wait 6 Waits for 6 seconds Wait 10 minutes Waits for 10 minutes Parameters A period of time The default unit is seconds Behavior Halts the next line of script execution for the given period of time WaitFor Command Example WaitFor 6 5 ImageOne ImageTwo WaitFor 10 milliseconds SomeImage Parameters A maximum wait time and one or more image references The default unit of maximum wait time is seconds You can also specify minutes and milliseconds Behavior Halts the next line of script execution until any one of the image parameters is found in the Viewe
23. clipboard without removing it from its original location After you copy text you can paste it using the Paste menu item Paste Paste inserts cut or copied text from the computer s clipboard into a script Note When you have a VNC connection open you can paste text between the local computer and the SUT Paste As Plain Text Paste As Plain Text works just like the Paste menu item except that it removes formatting such as font style and color before pasting the text Select All The Select All menu item selects every selectable item in the active window or all of the text in a text field Complete When you have typed at least two characters in the Script Editor Complete attempts to finish your current word using variables commands and names of scripts or images from your current suite If there is a single match the word is completed If there are multiple matches you can select the appropriate word from a list of options To cancel the Complete command without selecting any of the options press the Escape key Show Resource Show Resource opens the script or image selected in your text Option click is a shortcut for Show Resource www testplant com EggPlant Reference Manual Find Find displays a submenu of the following commands that search for text in your scripts Find The Find menu item opens the Find panel Find Next Find Next searches forward in the current document and displays the next occurrence o
24. corner of the image when it was captured in the Viewer window Description The image description in the Suite Editor Info panel FoundlmageLocation Function Example Click FoundImageLocation Parameters None refers to the last image found Returns Coordinates Behavior Returns screen coordinates for the Hot Spot of the last image that was found in the Viewer window FoundlmageName Function Deprecated Examples Put FoundImageName into variable Click FoundImageName Parameters None refers to the last image found Returns Image name Behavior Returns the name of the last image found Note FoundlmageName is deprecated Instead use Foundlmagelnfo s imageName or Foundlmagelnfo s imagePath FoundlImageNumber Function Example If FoundImageNumber is 2 then Parameters None refers to the last image found Returns One number representing the image s ordinal position in the parameter list of an any command or function Script Commands and Functions These commands and functions allow you to modify Run Options and control the execution of scripts PauseScript Command Example PauseScript Parameters None Behavior Pauses script execution before the next command The script remains paused until you manually con tinue step ahead or abort For more information see The Run Window www testplant com EggPlant Reference Manual 82 Note This command has no effect when EggPlant is run from
25. eve teg dd Fog redd dg 54 UNS Ver m 55 Sulte DESCUIDO a A A A A A ita 55 Results DIrEClO Vu A 55 Licenses and Preferences menn eee 56 The License Registry PA EL 0cooniniiii id dea ep dea 56 Entering New Llcerise ii eer aia 56 REMOVING Eze In EE 56 Requesting a Free Trial eiecit ette re LEER EE Genet ea FERREA EE LR RE E E SERRE E RD RA EE Pe ER RTL E 56 General preferences eniu sanni naan aaae a ARRE sls sss sensn nnn EREA 56 enr H 56 ien pd emBa rm 56 Ges fc e M 57 Default Suite Directory EE 57 Viewer Window preferences 5 rete ii A tan roba dE ta cede d Meee o ai 57 Live Mode Toggle Key Pop Up Menu sssssseee nem enne enne nennen enn nr rr ran nn nn crrnnannnnnccnnnns 57 Live Mode Cursor Pop Up MENU siii iii cia 57 Mouse Scroll Wheel Pop Up Menu 20 0 2 ccceceececeeeceecceee eee eeeeeeeceaeaaeaeeceeeeeeeeseeeeceaeaaeaeeeeeeeeesesessecscccaeeeeeeeeeeess 58 Mouse Right Click Key and Mouse Middle Click Key n 58 Other Live Mode preferences eese ete rea EE Fre YE iia 58 Capture MODS pU P 58 MVNC Dref rences n cite oer ale 58 Reverse CONNECTIONS e nr 58 VNG Encodings eessen e eee CARA A E cd 59 www testplant com VII Additional VNC Features oia ii ara 59 OCHIPE preferences RE 59 When a scriptis tU a
26. hairs it automatically turns black when it is positioned over a predominantly red image To move the Hot Spot in a Capture Area Command click or Command drag the cross hairs You can also nudge the Hot Spot in one pixel increments with Command Arrow Adding the Shift key moves the Hot Spot in ten pixel incre ments Capturing Images To capture an image of the Capture Area click the Capture Image button in the Viewer window toolbar or choose Control menu gt Capture Image For more information see The Capture Panel Full Screen Control With full screen control you can view the SUT as your entire desktop A small control panel provides access to the regular Viewer window features To open the control panel choose Control menu gt Control panel To customize the buttons displayed on the control panel right click in the panel and choose Viewer window items from the contextual menu To return to your own desktop click the Exit Full screen button or use the keyboard shortcut Option Command 1 www testplant com EggPlant Reference Manual GJ Control Panel Enter Full Screen Enter Observe Mode Scale To Fit The full screen control panel The Viewer Window Toolbar Most of the buttons in the Viewer window toolbar are also represented as menu items in the Contro menu The toolbar buttons are described below Since the toolbar can be customized you might not see all of the buttons on your
27. image references or a single coordinate location Behavior Double clicks the SUT mouse in the Hot Spot of the first location found EggPlant searches for images in the order in which they are listed www testplant com EggPlant Reference Manual 72 RightClick Command Example RightClick imageName SomeImage searchType Text RightClick 12 355 Parameters One or more image references or a single coordinate location Behavior Right clicks the SUT mouse in the Hot Spot of the first location found EggPlant searches for images in the order in which they are listed MouseButtonDown MouseButtonUp Commands Example MouseButtonDown 2 MouseButtonUp 4 Parameter A single mouse button number 1 8 Behavior Presses MouseButtonDown or releases MouseButtonUp the mouse button indicated by the parameter These commands are the only way to send mouse button events other than left and right clicks such as clicks on the middle button or pressing and holding the mouse button for a period of time Note For standard 3 button mice button 1 is the left button button 2 is the middle button and button 3 is the right button For some VNC servers buttons 4 and 5 control scroll wheel behavior ScrollWheelDown ScrollWheelUp Commands Example ScrollWheelDown 5 ScrollWheelUp 10 Parameter A single integer representing mouse wheel increments audible clicks on some mice Behavior Scrolls the mouse wheel up or down The actu
28. line to closely follow its execution Note When you run a selection results are not generated in the Results pane of the Suite Editor Line Jump Field In this field you can enter a line number and press Return to jump to that line in the script Add Comment Comment Uncomment w To insert a comment Comment into a script click the Add Comment button The text of the comment is not com piled as part of the script When you select text in a script the Add Comment button becomes Comment To format the selected text as a com ment click the Comment button Because comments are not compiled with the rest of the script you can use the comment button to temporarily disable parts of a script When you select a comment in the script the Add Comment button becomes Uncomment To remove the comment formatting the selected text click the Uncomment button The selected text is then treated as a regular part of the script Insert Pull Down Menu The nsert pull down menu contains image related commands and functions When you choose one of the items from this menu an Open File dialog allows you to select previously captured images as parameters to the chosen com mand or function Choose Additional Image to insert an image into your script with no new command or function To insert a text property list into the script shift click the Insert pull down menu www testplant com EggPlant Reference Manual 34 Note You can a
29. must be to a color in the Viewer window for EggPlant to consider it a match by tolerant or precise search type standards The value represents the difference between an RGB value in the image and the value of its corresponding location in the Viewer window Note The default values are appropriate for most situations Practical values can range from 0 to 100 but 80 is often the point that starts to generate a lot of false matches The ForceScreenRefresh Example SetOption ForceScreenRefresh true Default False Description The ForceScreenRefresh determines whether or not EggPlant refreshes the Viewer window after each command Note The ForceScreenRefresh is rarely necessary and dramatically slows down script execution however it might be helpful with a SUT that is generating a lot of screen artifacts or running software that does not display well through the VNC server www testplant com EggPlant Reference Manual 100 Running from the Command Line There are several reasons why you might want to run scripts or suites from the command line You can have one or more instances of EggPlant running tests from the command line while you continue to develop and run scripts in GUI mode You can add a command line call to EggPlant at the end of a product build script to perform a smoke test of the new build You can use the Unix crontab or at commands built into Mac OS X to schedule EggPlant scripts to run at specific ti
30. of the MouseMoveDelay value The MouseMoveDelay Example Set the MouseMoveDelay to 06 Value Time in seconds Default 0 01 Description The MouseMoveDelay determines the wait time between each step of a SUT s mouse move The MouseMoveMode Example SetOption MouseMoveMode 1 Value 0 1 or 2 Default 0 Description The MouseMoveMode determines the path a mouse takes to move from one location to the next as follows 0 The mouse moves in a straight line 1 The mouse moves horizontally then vertically 2 The mouse moves vertically then horizontally Note If the MouseMoveSpeed value is 0 the mouse jumps to the next location instantly and the MouseMoveMode value is irrelevant The ShouldRepositionMouse Example Set the ShouldRepositionMouse to True Values True or false Default True Description The ShouldRepositionMouse determines whether or not the SUT mouse moves to the lower right corner of the Viewer window or the coordinates of the RepositionPoint during image searches Repositioning the mouse prevents it from obscuring images elsewhere www testplant com EggPlant Reference Manual 99 The StandardlmageTolerance PreciselmageTolerance Example Set the StandardImageTolerance to 50 SetOption PreciselmageTolerance 4 Value An integer 0 255 StandardlmageTolerance Default 45 PreciselmageTolerance Default 1 Description These global properties determines how close an image s color
31. on the SUT RemoteClipboard Contents of the SUT clipboard RemoteScreenRectangle The coordinates of a rectangle the size of the entire Viewer window RemoteScreenSize The width and height of the Viewer window in pixels RunningFromCommandLine Whether or not the current script run was called in a command line ScriptResults A results property list for every run of the given or current script www testplant com EggPlant Reference Manual Appendix C TypeText Keywords TypeText Keywords 107 To press this key Type this keyword without quotation marks 0 1 9 on Keypad keypadO keypad1 keypad9 Alt Windows For Mac use Option AltKey Application key Windows applicationKey Arrow down downArrow Arrow left leftArrow Arrow right rightArrow Arrow up upArrow Backslash backslash Backspace Delete backspace Begin beginKey Command CommandKey Command down CommandDown Command up CommandUp Control ControlKey Control down ControlDown Control up ControlUp Decimal on Keypad keypadDecimal Delete forward deleteKey Divide on Keypad keypadDivide End endKey Enter enter Escape escape Function keys Ml Ws cok ES Home homeKey Insert insertKey Minus on Keypad keypadMinus Numlock numLock Option OptionKey www testplant com
32. pixels that may differ between an image and a match in the Viewer window Cliprectangle Coordinates that define a rectangle within the image any pixels outside the cliprectangle are disregarded for image matching ImageDescription The images description in the Suite Editor Images pane This value cannot be changed ImageSize Width and height in pixels This value cannot be changed ImagePath File path of the image file This value cannot be changed CaptureLocation Screen coordinates of the image when it was captured This value cannot be changed Results Properties key description LogFile The name and absolute path of the Log file Errors A count of errors logged for that run Warnings A count of the warnings logged for that run Exceptions A count of the EggPlant caught and uncaught exceptions raised Duration The length of time the script ran or has been running given in seconds RunDate The date and time the run was started Status The status of the run Success Failure or Running ReturnValue The returned value of any return statements www testplant com SendMail Properties EggPlant Reference Manual key description smtp_host required The host name or IP Address of the mail server smtp_type The authentication scheme used by the mail server On Mac OS X None Plain Login or CRAM MDS On Linux and Windows None or Pl
33. screen Instead Capture screen is useful for other purposes such as documen tation and interface design discussions Note The CaptureScreen command performs screen captures from within a script as opposed to the Capture screen button which performs screen captures independently of a script For more information See CaptureScreen in EggPlant commands and functions www testplant com EggPlant Reference Manual 24 Refresh Screen The Refresh screen button requests a full screen update from the SUT This is useful for cleaning up occasional arti facts drawing errors during scripting Note The Refresh screen button does not add a command to your script as opposed to the RefreshScreen script ing command For more information See The RefreshScreen command in EggPlant commands and functions Abort Script Abort Script stops a script in progress It stops before executing the next line of the script Cursor Location This field contains screen coordinates for the SUT cursor in the Viewer window You can move the cursor to a par ticular location by editing the coordinates in this field Customize The Customize button opens a panel in which you can select the buttons that are available in the Viewer window toolbar To add a button to the toolbar drag the button from the Customize panel to the toolbar To remove a button from the toolbar drag it off of the toolbar While the Customize panel is open you can also drag buttons
34. the command line Run Command Example Run OtherScript parameterl parameter2 Parameters One script name Behavior Calls another script Tip If the other script is located in the same suite as the current script or an associated helper suite and its name begins with a letter and contains only letters digits and underscores you can call it as a command in the cur rent script You do not have to use the Run command just the name of the script you are calling followed by any parameters RunWithNewResults Command Example RunWithNewResults SomeScript parameter parameter2 Parameters One script name and any parameters it requires to run Returns A results property list See ScriptResults below Behavior Runs another script that generates its own results log as opposed to scripts called with the Run com mand which are logged as part of the calling script The RunwithNewResults command returns a results property list similar to the ScriptResults function For more information see ScriptResults below If the called script fails the calling script does not automatically fail or raise an exception You can script this behav ior based on the returned Status property Tip You can use this command to write sophisticated master control scripts with actions based on the Status and ReturnValue properties For example you can call one script if the previous script succeeds and call a different script
35. the directory This is also used as the initial setting of the Folder global property at the beginning of each script run Viewer Window preferences The Viewer window preferences control the ways you can interact with the SUT through the Viewer window Live Mode Toggle Key Pop Up Menu Choose the key used for quick toggling between Capture Mode and Live Mode The default choice is Command Live Mode Cursor Pop Up Menu This setting determines the appearance of your cursor in the Viewer window Choose one of the following in the pop up menu Local Cursor This option displays the local EggPlant cursor in addition to any visible SUT cursor Guide Box This option displays the local cursor as a small guide box in addition to any visible SUT cursor None This option displays only the cursor that is native to the SUT and displayed by its VNC server www testplant com EggPlant Reference Manual 58 Mouse Scroll Wheel Pop Up Menu This setting determines whether mouse scrolling in a Viewer window is interpreted by the local Viewer window or by the active window in the Viewer window Choose one of the following Remote System This option sends mouse scrolling through to the Viewer window Local Window This option applies mouse scrolling to the Viewer window When the Viewer window does not have scroll bars mouse scrolling is sent through to the SUT Mouse Right Click Key and Mouse Middle Click Key These preferen
36. the pop up menu are native to the computer that is running EggPlant You can always type the names of fonts native to your SUTs Text and Background Color To edit a text or background color click the respective color well and select a new color in the Colors panel Tip The color picker in the Colors panel is especially useful for EggPlant it allows you to copy a color from any place in your display including the Viewer window To use the color picker click the magnifying glass in the Colors panel then click again wherever you see the color you would like to copy Text Attributes Select the Bold Italic and Underline checkboxes to define a text style with those attributes Sharing Text Platforms with Other Users All of the text platform information you define in Text preferences is stored in a property list within your user account Library Eggplant TextPlatform plist To share platform definitions with another user account copy this file into that account s Library Eggplant folder This folder is not created until the user changes a text preference Mail preferences These settings determine the default mail server EggPlant uses for the SendMail command www testplant com EggPlant Reference Manual SMTP Server In the SMTP Server field enter the host name or IP address of the server you use for sending e mail Authentication In the Authentication pop up menu choose None Plain Login or CRAM MD5 as appropria
37. the purpose of the script or other pertinent notes Statistics The bottom of the info panel displays the script s run history You can reset the Statistics area by clicking the Reset button The Images pane The Images pane contains a list of all of the image subfolders and images saved in the suite Image subfolders are displayed first followed by the images they contain www testplant com EggPlant Reference Manual 43 eoo Me Windows Tests suite Scripts Images Results Schedule Helpers Settings z Qu Search Names Image Name checkbox Close mingw ConnectionClosed ConnectionClosed tiff e Image Doctor ConnectionClosed_disa ConnectionList_tb Diagnostic Status Info Continue bt Do bt b FaanlantCammands th 1 Action The Images pane Adding Images and Image Folders There are two ways to add outside images to an EggPlant suite 1 Drag one or more images or image folders from another location into the image list in the Suite Editor 2 Click the Add button below the image list and select one or more images or image folders in the file browser Note EggPlant accepts the following image file formats TIFF ICNS ICO PICT GIF BMP PNG PDF and JPG JPEG Searching for Images To search for images in your suite type an image name or part of an image description in the Search field above the image list To set the type of search filter click the magnifying glass in the Search fie
38. treats the ReadText rectangle as a flat two color image The primary color is taken from the top left pixel of the rectangle or the ContrastColor property Pixels that fall within the ContrastTolerance value of that color are considered to have that color All other pixels are assigned the secondary color Text can be read in either color The default value of Contrast is off www testplant com EggPlant Reference Manual 75 ContrastColor color When Contrast is on ContrastColor is the color that is treated as the primary color of the ReadText rectangle If you do not set the ContrastColor property contrast color is taken from the top left pixel of the rectangle ContrastTolerance boolean When Contrast is on ContrastTolerance is a measure of how much a pixel can differ from the RGB value of the ContrastColor and still be considered the primary color The default MonoTolerance is 45 MultiLine boolean This property only applies when reading text near a point as opposed to reading text within a rectangle When MultiLine is on the readText function returns the line of text associated with your point and any subsequent lines that appear to belong to the same text block When MultiLine is off the ReadText function only returns the line of text associated with your point The default MultiLine is off SingleColumnMode boolean When SingleColumnMode is on the OCR engine presumes that there is only one column of text on the screen When Si
39. used in scripted text image generators Click Clicks the SUT mouse in a coordinate location or in the first image parameter found CloseSuite Ends the temporary suite availability of OpenSuite Connect Opens a VNC connection with a SUT makes it the active connection Disconnect Closes a VNC connection with a SUT DoubleClick Double clicks the SUT mouse in a coordinate location or in the first image parameter found Drag Clicks and holds the SUT mouse in the Hot Spot of the first location found DragAndDrop Clicks and holds the SUT mouse in the first location moves to subsequent locations releasing the mouse button on the last location Drop Moves the mouse to the given location and releases the mouse button Hide RemoteWindow Hides the Viewer window HighlightRectangle Draws a border around the given rectangle in the Viewer window KeyDown Presses and holds keys on the SUT keyboard KeyUp Releases keys that are held down on the SUT keyboard Log Inserts a comment into a script s Log file LogError Inserts a comment into a scripts Log file in red text LogWarning Inserts a comment into a script s Log file in orange text MouseButtonDown Presses the SUT mouse button MouseButtonUp Releases the SUT mouse button MoveTo Moves the SUT mouse to a coordinate location or to the first image parameter found MoveToEach Moves the SUT mouse to each of the given coordinate locations
40. AUtO gle cial tale P 32 GOON ZA OMS e 32 MIRI M M 32 IB e3sir seltqe EE 32 The Script Editor TOO Dal siisccsecsgsese Ad 32 SAV PT 32 Run Script Abort SCrIpt i i nana id ii rai 33 RUINS SIS CU OM ese sigs en 33 Line Jump Field viii aaa a 33 Add Comment Comment Uncomment sss eene nn nn nn nn nn nn nn anna nnnnnnnnnnnrnnrinnnannanees 33 Insert PulleDown Men usina diana 33 Handler Pop Up Menu ccccccccceceeeeee eee ei paapaa i aai i d aa ao a aaia 34 SNOW SUIE ersari a da A E AAA AA A AAA 34 SHOW IROSOURCS varita A A sc 34 SHOW IRESUIES voir ia 34 urinam 34 huobNIIefee m 34 Uo I Eea adat 34 Colors Fonts AMG PAN 34 The Un WU WW A T 35 SChipt Display Afe T NEEDED LL iaa Eaa 35 Dynamic Dre ak Pois sico A AAA AAA AS AA ES TA 35 Script frame Pop Up MORU vs ir 36 TNS LO pi EE 36 The Ad hoOc dO DOX viciosa ii AA A A A ii 36 The Run Window Toolbar ccccecceceeeeeeeeeeeceeeeeaeeceeeeeeeetee se RR RRE RR RR rn nr nsns nn enn nnns 37 RUM ScrpllAbort SCIIpt uii rere eve a a AAA ibi la doi a 37 RUN SIS CHO EL 37 Pause Continue iia iD t 37 SUAE UPC 38 Step eul M HT 38 EPI UT A A aio
41. All Show All Show All reveals the programs you have hidden with Hide Others See Hide Others above Quit EggPlant If a script is running Quit EggPlant displays a confirmation dialog before quitting the program You can choose to Quit Now Quit After Next Script Run or Cancel If there is no script running you can bring up this dialog by holding down Option while you quit If you click Quit After Next Script Run EggPlant delays the quit until the next script run is complete then quits without further confirmation To cancel a delayed quit choose Quit EggPlant again and click Cancel in the confirmation dialog The File Menu The File menu allows you to manage test suites and scripts there are menu items that create open close save revert and print New Suite New Suite creates a new test suite in the Suite Editor For more information see The Suite Editor Note You can name a default directory for new suites in the General preferences panel Open Suite Open Suite brings up an Open dialog in which you can select an existing suite to open www testplant com EggPlant Reference Manual New Script New Script creates opens the Script Editor for a new script for the active suite The new script appears in the Scripts pane of the Suite Editor Open Script Open Script brings up an Open dialog in which can select an existing script to open Open Recent Submenu Open Recent displays a subm
42. Click Delay This value represents the time between the release of the first click and the press of the second click of a DoubleClick command Mouse Move Speed This value represents the maximum distance the mouse cursor can move per segment Mouse Drag Speed This value represents the maximum distance the mouse cursor can drag per segment Mouse Move Delay This value represents the delay between segments of mouse movement www testplant com EggPlant Reference Manual 62 Movement Mode This pop up menu determines the path a mouse cursor takes when it moves from one place to another Choose Direct Horizontal Then Vertical or Vertical Then Horizontal The Keyboard pane The Keyboard preferences determine specific keyboard behavior in the Viewer window during script execution For more information see Global Properties Key Down Delay This value represents the length of time between a key press and release NextKeyDelay This value represents the delay between typed keystrokes Send shift key down for capitals Select this checkbox to have EggPlant hold the SUT s Shift key while typing capital letters If this checkbox is deselected EggPlant sends capital letter key codes to the SUT without using the Shift key The Screen pane The Screen preferences determine search time and image tolerance in the Viewer window Image Search Time The number in this field represents the maximum time that EggPlant searches for an
43. Default RGB value ConnectionInfo A connection property list EggPlantVersion The version number of your copy of EggPlant EverylmageLocation Coordinates of every occurrence of given images Foundlmagelnfo An image property list for the last image found FoundlmageLocation The location of the last image found FoundlmageName Name of the last image found This function is deprecated See foundimagelnfo FoundlmageNumber The position of the last image found within a series of given images GetOption The value of a given global property GetOptions The values of all Run Option global properties or given global properties ImageColorAtLocation The color of the pixel at a given location within an image Default RGB value ImageFound Whether a given image is found True or false ImageHotSpot The location of the Hot Spot in the given image Imagelnfo An image property list for the given image ImageLocation The location of the given image ImageSize An image width and height in pixels AllConnectionInfo A list of connection property lists for every SUT in the Connection List MouseLocation Coordinates of the current mouse cursor location OpenSuites A list of all suites available to the current script ReadTable The table data found within a given rectangle on the SUT ReadText The text content found within a given rectangle
44. ISCOMMOCT sei 10 eus 0 10 Pope ERR 10 Edit erelo In zoo p 10 e MH 10 The Control Menu tetro a Risa 10 Enter Capture Mode Enter Live MOde ttti rtr tg x ERE ae Lao EARN E ONE REALEN AMNES 10 Capture IMAG Cex cu trees treo e dre dy pda iii ee 10 BEIMIEDMMC I e 11 dura H a 11 ociipt Command SUMEN Ussassai nanain rated dd trote 11 Control Panel net reu aea he SRER A TANTA NER NUS eR SRESAgEE REIR MM ES E EXE ERE ERN ER Xe EUR aen ek y Ru read 11 Capture SCFeell ti base nde e e re PAR vy A e aU ee cae a d nde a dean ee ARE n MR A o 11 Refresh DIS Pl yeer nn an ash atees daauanmeesdgasadenes ysadendesiaguateentdeatanee ARE 11 Record Movie 7 Stop MOVIO iiss 2 dcn en ferite s eta d esee v t sees atl dpud ae x dde d Ra a dee a dade 11 Send Escape Codes and Function Keys erecti ettet enne necne ha sun trn aaa en nnda 11 The Window rt a ada 11 Close WIRndOW tree RES FS EEN E SRTEER SENE a a aa aa E A KA EN Pa dERE 11 ZOOM VVC OW OR H 12 Minimize WIDOW e LE 12 Bring Alto Front Arrange Iri Frodo dee dde 12 Hide Toolbar Show Toolbar ccceceececeeceeeeeeeeececcacaeceeeeeeeeesececeeaaaeaeeeeeee
45. NE Options crece roe t o A aa AA aa ERR FAR ERROR NUI E uedian A UH ARAS 102 www testplant com EggPlant Reference Manual Appendix A EggPlant Commands cecilia is 104 Eggplant Commands ria LE LR ALA c 104 Appendix B EggPlant FUNCUONS custodia 106 EggPlant FUNCION Simoca id AA AA cae ERR EE sede 106 Appendix C TypeText Keywords csscsssseeeeeeseeceeeeeeeneeeeeeeeeeeeeeeeeeeasesaaaeasesessssseseeeeeeeneeseeeees 107 Rhea deem M ENR 107 Appendix D Global Properties comisaria 109 EggPlant Global PrOpertles iicet rex ed e Dot DE d dera e A tt 109 Run Option Global Propertles et e EE Pe a aa a oia 110 Appendix E Property Lists 11 1o eneerie rn rro narra aaa A ANA A 111 CaptureScreen PEODpertles ett e e e o RARE Prades dea ae ee EA ea a dieux ve Rudd 111 Connection Properties rei a teer re ven br A e A FU P eer ELE conta ase vta Es 111 image Properes 4I EL 112 Results Properties e er HE eeu top xr eee ara 112 sendMall Properties 52 2 acca cin aede p th ERE a pau exea id X RR T MAD AR ETUR XR ERR Ua dada 113 JextPlattormPEODertles oett er e tere ete x a e RR Peru ea beue A d see Ad 113 Text Propertles erre ii AAA ini 114 TextStyle Prope nte P aida 115 Appendix F Pango Markup Talon tana 116 Pango Markup Tags Currently Mac OS X only sse inanon een nnnm nenne ener en nnns 116 www testplant com XI EggPlant Reference Manual
46. Names and Run Dates diee den e a ERR DER EA 47 The LOGAN Ca ii A Pa ERR RR LA EEE tensa RA Ne Eze REM Ra EEUU ER RR E ba 48 Log rea resource INKS ecirar 49 Additional log information in the text column cee e etter eee enne tees eeitie enne nennen nnns 49 Log Area coloniza 0 coord ere ttre reer rer rrr 49 Searching fOr LOG ENTES E 49 Action Drop Down Menu ssiri aar a A A E A EN Ar 50 The Schedule pane iconos iO A a a Ea 50 Adding Seripts to the Schedule o nac na tr cg t dd Y ng abd ev b ede dude 51 Providing a Script s Connection Details sssssseeeee eee enne nennen nennen enn 51 Changing the RUM Order deterret ete teas ocn o ocn id 51 Duplicating Scripts in a Schedule sssssssssssssssssesssee eene e nnne nennen nennen aaa 52 SIsfptegBI erzpecrfe e a dt a 52 Disabling and Removing Scripts from the Schedule oooooocccccnnocccconononcccccnnnncncnonan cnc nnnn nana eene 52 Running the Schedule ManuallY oct A ted nits 52 Running the Schedule at a Particular Time ssssssesssseeeeeeeeeenn nennen rr 53 he Helpers pale A eadera pna Patente nisus uer etre ex bu NERA te Uu daraus 53 Adding a Helper Sulte tr tx Fi eus a 54 Using a Relative Path Tor a Helper Suites otii ita 54 Removing a Helper Suite secs 2 rettet Ce recep veces ee Deu RE vnda teens outer once uus 54 The Settings Dalle cia ee etre tei ree lug
47. To temporarily disable a script in the schedule deselect its checkbox in the Run column This also disables the script s dependent scripts To permanently remove a selected script from the schedule click the Remove button Running the Schedule Manually To run the scripts in a scheduled list click the Run button If you provide connection information for a script EggPlant opens a VNC connection with the specified SUT before running the script If you do not provide connection informa tion the script is run on the currently active SUT If there is no connection information and no current VNC connec tion the script fails To run the entire batch of scripts more than once enter the appropriate number in the Repeat field before you click www testplant com EggPlant Reference Manual 53 the Run button Note If a script fails when it is run from the Schedules pane the failure is noted in the Status column of the Script List and EggPlant moves on to the next script there is no command or error that prevents a schedule from running to completion Running the Schedule at a Particular Time Here are two ways to run the script schedule at a designated time 1 Use the Unix crontab or at command 2 Include the command line call in a build script or some other shell script that is already running automatically This is often done to verify that a new build of an application does not have any defects before it is delivered to QA or oth
48. Vine desktop server on the active user ac count A Vine system server which runs as a root VNC server across all user accounts does not have access to the clipboard of any single account SetRemoteClipboard Command Example SetRemoteClipboard new clipboard contents Parameters One text string Behavior Puts given text into the SUT s clipboard From here you can paste it like any other text that is cut or cop ied in the SUT Note To use the clipboard on a Macintosh SUT be sure to connect to a Vine desktop server on the active user ac count A Vine system server which runs as a root VNC server across all user accounts does not have access to the clipboard of any single account TypeText Command Example TypeText Some Words TypeText lt lt Some Words with a Return gt gt TypeText AltKey x Parameters Text strings enclosed in quotation marks keywords for non character keys and text literals blocks of text in double angle brackets lt lt gt gt Behavior Sends keystrokes to the to SUT If modifier keys are sent they are released when the entire command has been executed To send a modifier that is not released automatically use the up and down modifier key words such as ShiftUp and ShiftDown To send any key that is not released automatically use the KeyDown and KeyUp commands TypeText Keywords To generate modifier keys and other non character keys in a script refer to them
49. aa 59 When a script is modified ooooooccnncnnnnnocincoononncnnnnnncnnnnnnnnn nn nn nn nn nn nn nr etn nn nnns nsns n nen nennen nr nns nsns nn enne 59 Reload breakpoints from last SaVe cei eret leas a EE aia EVER FEX AER x ERE EU YER ERR VERTS 60 Allow Text Drag and DrOP cooononccccnnnooccccconconccnccnnnnnccc cnn no nn cnc ran rre 60 Default Script POMC iii ida 60 SOME LOG FONT yoe a A A A ENET E TET Aga 60 The Indentation PANG DILLO LLL DEUM 60 The Colonization DAME err AA A A KR ERRR RA AA AAA ida 61 Enable syntax coloritig iio is 61 Run Option preferentes eric innata ARA naedeeauaadinnbsecavadsedanaunsanadaannass dae dnnsenadecuaavnnsaadanedeaiaaeandenssaee 61 The Mouse PAM ETE M 61 The Keyboard pal visitan an 62 The Screen PANE ii A A A Ad 62 image search A aii 62 The Systemi PANG dmca A A a 63 Text preferences t E RE ERR A rio 63 TEX ENDE MTM 64 Sharing Text Platforms with Other Users senorsericnonro noiniaii inn nemen mmn arras 65 Mall preferences cce dee aee td e et en eene AAA AA dsd 65 SII EESTI RE TO LEID 66 Authentication E saute AA A a dba 66 User Name and Password nissin aa aaa e RR re rrr tells ss e a enr ne nsns nnns 66 EggPlant Commands and Functions ccccccceeeeeeeeeeeeeeeneeeeneeeeeeeeeeeeeeeeeeeeeeeenaaeeneaeeeeeeeeeeeeeees 67 Command and Functio
50. ace of your own desktop Capture Screen Capture Screen takes a snapshot of the entire Viewer window of your SUT For more information see Capture Screen in The Viewer Window Refresh Display Refresh Screen requests a full screen update from the SUT This is useful for cleaning up occasional artifacts draw ing errors during scripting Record Movie Stop Movie Record movie opens a Save dialog in which you select a location to save your QuickTime movie Recording starts when you click the Save button For more information see Record movie in The Viewer window Send Escape Codes and Function Keys These items allow you to send commands to the SUT that would otherwise be intercepted by the EggPlant computer For example if you tried to type Control Alt Delete to force quit an application on your SUT your EggPlant computer would intercept that command and quit EggPlant Instead you could choose the Send Control Alt Delete menu item and the command would bypass your local system The Window Menu The Window menu contains items that allow you to manage EggPlant windows and toolbars Close Window The Close menu item closes the active window www testplant com EggPlant Reference Manual 12 Note To close all EggPlant windows at once hold down Option as you close a window Zoom Window For most windows Zoom Window enlarges the active window to the size of your display or returns it to its previous size The exc
51. aded from other scripts are both displayed in this font Click the Set button to select a font on your system This font is also used in the initial setting of the folder global property at the beginning of each script run For more information see Global Properties Script Log Font This is the font used to display script results and output in the Log Area of the Run window Click the Set button to select a font on your system The Indentation pane These settings control the automatic indention of text in the Script Editor Indent scripts automatically Select this checkbox to apply indention when you insert a comment paste text or press Return Indent control structures by Indent continuation lines by These preferences determine the size of your indentions Select Tab s or Space s and type the number of tabs or spaces to indent The Example Script area displays a preview of the way text appears with your current indention settings Continuation line refers to a long statement displayed across multiple lines To force a line break in a statement insert a backslash The Tab Key Pop Up Menu Choose an item in this pop up menu to determine the function of Tab in the Script Editor The tab key can trigger indention insert a tab space or both www testplant com EggPlant Reference Manual 61 The Colorization pane These settings control the automatic color coding of text in the Script Editor The Example Scrip
52. age of pixels with a percent sign or number of pixels with no percent sign by which the image and a match in the Viewer window can differ Pulsing boolean Whether or not the search type allows for a pulsing image CollectionFilter text string For Image Collections only CollectionFilter limits the images that are searched for www testplant com EggPlant Reference Manual 70 within an Image Collection For more information see Collection Filters above ClipRectangle rectangle With 0 0 being the top left corner of the image the cliprectangle is a pair of coordinates that define a rectangle within the captured image Only the pixels inside this rectangle are considered for image matches SearchRectangle rectangle With 0 0 being the top left corner of the screen the SearchRectangle is a pair of coordinates that define a rectangle in the Viewer window EggPlant only looks for this image within the defined rectangle Example Click ImageName CloseButton HotSpot 10 23 SearchType Tolerant Text Property List A text property list formerly text image property list is a description of text on the SUT Every text property list must contain the Text property which defines the actual text string you are looking for and any number of the additional properties described below Any property that is not included in the property list defaults to your Text preferences set tings Common Text Properties The follo
53. ain smtp user The user account on the mail server used if an smtp type is specified smtp password The password for login to the mail server used if an smtp type is specified To required One or more addresses separated by commas From required by some mail servers The user account sending the message Subject The subject line for the message Body or Message The text of the message Attachment A filename or list of filenames to attach to the e mail ReplyTo The default address to which a reply is sent CC One or more addresses to which a copy of the message is sent separated by commas Content Type A mime type For html e mail use the value text html The default is text plain TextPlatform Properties key description Name Name of the text platform Engine The text engine used by the platform Generator The text image generator TIG used by the platform The Generator property is deprecated Instead use Engine Styles A property list for each of the platform s text styles www testplant com Text Properties EggPlant Reference Manual key Text description Common text properties used in all text property lists The text string that you want to find on the SUT Required TextPlatform The name of the platform on which your text will be found TextS
54. al amount of scrolling per increment varies by mouse driver platform and application Tip An easy way to experiment with the mouse wheel of a SUT is to run a ScrollWheelUp or ScrollWheelDown com mand with a parameter of 1 MoveTo Command Example MoveTo ImageOne ImageTwo MoveTo 190 87 Parameters One or more image references or a single coordinate location Behavior Moves the SUT s mouse cursor to the Hot Spot of the first image found or in the location indicated by a coordinate pair MoveToEach Command Example MoveToEach ImageOne 780 91 ImageThree Parameters One or more image references or coordinate locations Behavior Moves the SUT s mouse to the locations indicated by the parameters in the order they are listed www testplant com EggPlant Reference Manual 73 Drag Command Example Drag ImageOne ImageTwo Drag 231 100 Parameters One or more image references or a single coordinate location Behavior Presses and holds the SUT s mouse button in the Hot Spot of the first image found or in the location indicated by a coordinate pair Drop Command Example Drop ImageOne Drop 231 100 Parameters One image reference or a single coordinate location Behavior Moves to the given location and releases the mouse button DragAndDrop Command Example DragAndDrop ImageOne ImageTwo 980 322 Parameters Two or more locations identified by image references or coor
55. al or Silent this command does nothing Tip Log entries can make it easier to determine where particular log events are occurring in the run LogWarning Command Example LogWarning Message to be recorded in log file Parameters One or more Log messages Behavior Behaves just like the Log command described above but displays the log entries in orange text Tip The Results pane of the Suite Editor displays the number of warnings associated with each script run Warnings are counted even when ScriptLogging is set to Minimal or Silent LogError Command Example LogError messageToBeRecordedInLogFile Parameters One or more Log messages www testplant com EggPlant Reference Manual 85 Behavior Behaves just like the Log and LogWarning commands described above but displays the log entries in red text and logs the script as a failure Note If the ScriptLogging global property is set to Silent no error messages are inserted into the log file but the error count for the run is still be incremented and the ultimate status of the run is Failure ScriptResults Function Example put ScriptResults someScript into currentStatus Parameters One script name If no script is named the function defaults to the current script Returns A results property list from every run of the given script Behavior Returns a results property list from every run of the given script in chronological order Each list contains the foll
56. ameters are not enclosed in quotation marks or parentheses Example ScrollWheelUp 10 Time Time parameters are measured in seconds unless you indicate otherwise SenseTalk understands the terms min utes seconds and milliseconds Examples Wait 75 Wait 1 minute 15 seconds www testplant com EggPlant Reference Manual 68 Coordinates When numbers are given as coordinates they are enclosed in parentheses Example Click 40 65 Adjusted Coordinates EggPlant also allows vector arithmetic to generate a location relative to a known position Examples Click 30 35 100 5 Click ImageLocation SomeButton 100 5 Strings Strings such as file names and text literals are enclosed in quotation marks Example Click CancelButton TypeText Here is some text Note Double angle brackets lt lt gt gt can enclose text that contains quotation marks and large blocks of text with return characters Property Lists Property lists define or identify objects by listing certain properties Each property comprises a key which identifies what the property represents and a value which defines the property for the object Example ImageName MenuButton HotSpot 10 23 The example above describes an image that is the same as the saved image called MenuButton but with a differ ent Hot Spot location 10 23 The key ImageName represents the saved image that this property list is based on The value of
57. and assier eiea ENEE EEE EE eee sine n nenne innen renes inen nnne nen 73 Mouse Location FUtiction uiii ierit mro A ue ER ELE e ER DE ED ELE Pd 73 Text Commands and EF UrictiOns o coo itt xen nne x Rare nadan RAR dada sgaanassneanahrecetcaduanvasteannectaacdeavesvecaaasanettenss 73 Capture lextlimage COMME 74 Key DOWN COMA a 74 KeyUp COMME 74 www testplant com EggPlant Reference Manual Read Table Function iii ened 74 ReadText FUNCION caian tdt di gi dd aid a 74 RemoteClipboard FUNCION wes uiii correre een ii etd AED ERE AAA ade 75 SetRemoteClipboard Command cccccccececeeeeeeeeeeeeeaaeceeeeeeeeeeeceeccaecaeceeeeeeeeseeseeseccaesaeeeeeeeeeeeeeseeseesisasees 76 Bede 76 Examples Generating modifiers and special keys on the SUT sssssssseeeemen 76 Image searching Commands and Functions esses eene nennen nnn nennen 77 iungere na a eaaa E AAA AAA dl 77 WaitFor Command asrorin e a AA erae dip AA aduan 77 WaitForAll Comma pe aaa eaa aaa aa aaa Aaa aad A E Aaa aa aaaea aai ie 77 RefreshScreen Command aiina na di da 78 ENS a aaar e aaa a a a E aaa a a a Ea 78 ImageLocation FUNCUON csi a AAA 78 EverylmageLocation Function cccccceceeeeceeceeceeceeeeeeeeeeeeeecaeeaaeaeeaeeeeeeeeseeseceaaaaeaeeeeeeeeeeeseesecececaeeeeeeeeeeess 78 Image IMTOFMAOMIFUNCUONS iaa O E ne dn ie eode eo dat 78
58. and image parameters OpenSuite Makes a suite available to the running script PauseScript Pauses script execution enters debug mode RefreshScreen Redraws the image of the SUT in the Viewer window RightClick Right clicks the SUT mouse in a coordinate location or in the first image parameter found Run Runs a given script RunWithNewResults Runs a given script generating a separate Log file for it ScrollWheelDown Scrolls the SUT mouse wheel down a given number of increments ScrollWheelUp Scrolls the SUT mouse wheel up a given number of increments SendMail Sends an e mail from within a script SetOption Modifies a global property value SetOptions Modifies multiple global property values SetRemoteClipboard Places text in the SUT clipboard ShowRemoteWindow Shows the Viewer window www testplant com EggPlant Reference Manual 105 StartMovie TraceScreenOn TraceScreenOff Wait WaitForAll Currently Mac OS X only Starts recording a movie in the Viewer window Turns screen captures before every command on and off Delays the next line of execution for the given length of time Delays execution of the next line until all given images are found www testplant com EggPlant Reference Manual Appendix B EggPlant Functions EggPlant Functions Function Returns ColorAtLocation The color of the pixel at a given location
59. and keystrokes are applied to your local computer not the SUT Note In Live Mode you can also copy and paste text between applications running on the SUT and your local computer www testplant com EggPlant Reference Manual 20 Capture Mode In Capture Mode you can capture images of your SUT and insert commands and functions into your current script You continue to receive display updates from the SUT but your mouse and keyboard events are applied to your local computer The Viewer window is dimmed in Capture Mode except for the Capture Area described below The Capture Area In Capture Mode the Capture Area shows the area that is included when you save an image It is the rectangle shown at normal brightness when the rest of the Viewer window is dimmed To move the Capture Area drag the edges You can also nudge the Capture Area one pixel at a time by pressing the Arrow keys Add the Shift key to move the Capture Area in ten pixel increments To resize the Capture Area drag the corners You can also nudge the size one pixel at a time with Option Arrow keys Add the Shift key to resize in ten pixel increments Note The Capture Area is drawn with a grey border to make it easier to see on dark backgrounds you can turn this border off in Viewer window preferences The Hot Spot The Hot Spot is the point that is clicked when a script executes a CLick command on an image The Hot Spot is typ ically marked with red cross
60. as it enters and leaves each script or handler Trace All When you choose Trace All the Log Area of the Run window displays every line of each script or handler prior to executing it Note Tracing cause scripts to execute more slowly because EggPlant is doing more work at the display level You can improve script execution speed by turning off tracing when you are not debugging Edit Script The Edit Script button opens the Script Editor for the script that is currently in the Run window If you have text se lected when you click this button EggPlant attempts to automatically select the same text in the Script Editor If the selected text has been edited since the last run EggPlant may not be able to find it in the Script Editor Show Suite The Show Suite button opens the current script s suite in the Suite Editor www testplant com EggPlant Reference Manual 40 Show Results The Show Results button opens the last recorded results for the current script in the Results pane of the Suite Editor Customize The Customize button brings up a panel in which you can select the buttons that are available in the Run window toolbar To add a button to the toolbar drag the button from the Customize panel to the toolbar To remove a button from the toolbar drag it off of the toolbar While the Customize panel is open you can also drag buttons to different locations within the toolbar www testplant com EggPlant Reference Manua
61. assword for the VNC server encrypted sshHost The host name or IP of a computer hosting an SSH connection sshUser The user account on the SSH host sshPass_code The password to the user account on the SSH server encrypted Visible Whether or not the Viewer window automatically opens upon connection Yes or No Status The status of the connection Connected or Not Connected Disconnect Command Example Disconnect serverID 192 168 1 20 port 5900 Disconnect Nightly Regression Disconnect Parameters An optional VNC connection identified by the SUT s name or connection property list Behavior Closes the VNC connection with the given SUT If no SUT is specified closes the active connection www testplant com EggPlant Reference Manual 89 HiglightRectangle command Example HighlightRectangle FoundImageLocation FoundImageLocation 50 10 HighlightRectangle FoundImageLocation FoundImageLocation 50 10 white Parameters One rectangle value Behavior Highlights the given rectangle in the Viewer window RemoteScreenRectangle function Example put RemoteScreenRectangle Parameters None Returns Coordinates Behavior Returns coordinates for a rectangle that shows the full size of the Viewer window RemoteScreenSize function Example put RemoteScreenSize Parameters None Returns The width and height of the Viewer window measured in pixels Behavior Returns the siz
62. ation Reverse Connections Select the Listen For Reverse Connections checkbox to allow SUTs to initiate VNC connections with the local com puter running EggPlant www testplant com EggPlant Reference Manual 59 VNC Encodings This is a list of the common encodings in which data is transferred over VNC connections The encodings appear in order from most compressed to least compressed and EggPlant always starts at the top of the list and attempts to use the most compressed encoding available Most computers experience the best VNC performance by using the fastest most compressed encoding available however if you feel that your processor s ability to decompress and draw data is more of a limiting factor than your connection speed you can disable the more compressed encodings Additional VNC Features Copy Rect allows faster updates in the Viewer window by redrawing only the portions of the SUT that have changed Rich Cursor allows faster updates in the Viewer window by receiving cursor updates as screen locations rather than re drawn cursors Rich Clipboards enables the clipboard exchange of files and rich text between EggPlant and Vine Server Script preferences Script preferences contain the controls for features that can make it easier for you to read and write scripts When a script is run This preference determines how EggPlant deals with unsaved script changes when you run a script Do nothing Select
63. ause to regain control before the Step Out ac tion has finished Add Breakpoint Remove Breakpoint The Set Breakpoint Remove Breakpoint commands insert or remove a dynamic breakpoint in the selected line of a script For more information see Dynamic Breakpoints in The Script Editor Remove All Breakpoints The Remove All Breakpoints command removes all breakpoints in all of your currently open scripts The Connection Menu The Connection menu contains items that allow you to open and close VNC connections to SUTs For more informa tion see The Connection List Connection List The Connection List menu item opens the Connection List in which you can manage and open VNC connections to your SUTs For more information see The Connection List www testplant com EggPlant Reference Manual 10 Connect The Connect menu item attempts to establish a VNC connection with the SUT selected in the Connection List Disconnect Disconnect closes the VNC connection with the SUT selected in the Connection List Check Availability Check Availability updates the availability status of SUTs in the Connection List Add Connection Add Connection opens the Add Edit panel in the Connection List allowing you to add a new SUT to the Connection List Edit Connection Edit Connection opens the Add Edit panel in the Connection List allowing you to edit the selected SUT Remove Remove deletes the selected SUT from the Connection Lis
64. by Option clicking the Run Script button This loads the script for ex ecution and immediately pauses it allowing you to step through line by line This is the same as choosing Run menu gt Debug Script Run Selection The Run Selection button executes only the selected part of a script The selection does not have to include an entire line of code but it must be syntactically complete and executable For example if you select the beginning of an if block you must select all the way through the end if statement You can run the selection in debug mode by Option clicking the Run Selection button This loads the selection for execution but immediately pauses it allowing you to step through it line by line to closely follow its execution Note When you run a selection results are not generated in the Results pane of the Suite Editor Pause Continue The Pause Continue buttons allow you to pause and continue execution whenever a script is running When the script execution is paused you can perform additional operations 1 Type commands in the Ad hoc Do Box See The Ad hoc Do Box above 2 Use the debug mode tools Step Into Step Over and Step Out See below 3 Interact with the Viewer window in Live Mode www testplant com EggPlant Reference Manual 38 Step Into The Step Into button executes the next line of a script then pauses If this line calls another script or handler the script steps into the first lin
65. ce set the modifier keys you can hold to change a left click to a right or middle click in the Viewer win dow If you are using a standard mouse you can just press your right and middle mouse buttons these settings are only important if you don t have a right or middle mouse button available Other Live Mode preferences Auto scroll window in Live Mode When this checkbox is selected the Viewer window scrolls in the appropriate direction when the cursor is moved outside the Viewer window Track mouse outside of window in Live Mode Select this checkbox to make the Viewer window cursor follow your mouse movement outside the Viewer window Always scale Viewer window proportionally Select this checkbox to maintain a true horizontal to vertical ratio when you scale the Viewer window size Deselect to allow disproportionate horizontal and vertical scaling Capture Mode Display capture rectangle border Select this checkbox to display a gray border around the Capture Area in Capture Mode The border can make it easier to see the Capture Area on dark backgrounds Detect pulsing images when capturing Select this checkbox to allow EggPlant to attempt to recognize pulsing images during image capture In general this is a useful feature however if you are working over a slow network connection pulsing detection can make your image captures impractically slow VNC preferences These preferences pertain to VNC connections and communic
66. d by some mail servers Subject The subject line for the message www testplant com EggPlant Reference Manual 86 Body or Message The text of the message Attachment A filename or list of filenames to attach to the e mail ReplyTo The default address to which a reply is sent CC One or more addresses to which a copy of the message is sent separated by commas Content Type The mime type for the body of the e mail To send html e mail set the Content Type to text html The default mime type is text plain Please note that you need quotation marks for both the key and the value of this property EggPlantVersion Function Example log EggPlantVersion Parameters None Returns The number of your version of EggPlant Behavior Returns the number of your version of EggPlant CaptureScreen Command Example CaptureScreen Name ImageFileName Rectangle 67 33 imagelocation OtherCorner Parameters An optional property list Behavior Captures a snapshot of the entire Viewer window or a rectangle indicated in the property list You can customize this command with a list of any number of the following properties Name An image file name and optional path information The default file name is Capture Screen saved in the Results directory Rectangle or Rect A pair of diagonal locations indicating a rectangle to capture The locations can be screen coordinates and or image locations
67. d on content and formatting attributes Shift clicking a command button also opens the Find Text panel For more information see The Find Text Panel Click DoubleClick RightClick MoveTo Drag Drop These command buttons perform three actions at once 1 They open the Capture panel to save an image of the current Capture Area To open the Use Image panel instead of a Capture panel Option click the button 2 They insert their respective command into the active script 3 They perform their respective action on the SUT Add Image The Add Image button takes a snapshot of the Capture Area and adds it to the line indicated by your insertion point in the Script Editor The exact location of the insertion point does not matter as long as it is in the correct line of the script The Add Image button is only available if the Viewer window is in Capture Mode WaitFor The WaitFor command causes a script to pause and wait for an image to appear in the Viewer window When you click the WaitFor button a Capture panel opens In the Maximum Wait text field enter the longest period of time in seconds that you want the script to wait for the image to appear in the Viewer window When you run the script the script executes the next command as soon as the WaitFor image appears If the im age does not appear in the maximum wait time the test fails Wait The Wait command causes a script to wait for a specified period of time before exec
68. dinate pairs Behavior Presses and holds the SUT s mouse button in the first location moves the mouse to subsequent loca tions and releases the mouse button in the final location MouseLocation Function Example put MouseLocation into StartingPoint Returns Coordinates of the current mouse location Behavior Returns the coordinates of the current mouse location Text Commands and Functions This section describes the EggPlant commands and functions that act upon the SUT s keyboard and clipboard www testplant com EggPlant Reference Manual 74 CaptureTextlmage Command Example CaptureTextImage text some words rectangle 0 0 50 20 Parameters One property list that must include a text property and a rectangle property and may include any other text properties Behavior The CaptureTextlmage command is only used in scripted text image generators Creates a text image of generated text The text image includes all of the properties you specify in the property list and fills in remain ing properties with default values from Text preferences For more information see TextStyle Properties under The TextPlatforms KeyDown Command Example KeyDown ControlKey CommandKey d Parameters Keyboard characters in quotation marks TypeText keywords with no quotation marks Behavior Presses and holds the given keys until they are released by a KeyUp command KeyUp Command Examples KeyUp ControlKey C
69. discovery of VNC servers When this checkbox is selected local computers that have Bonjour networking technology enabled automatically appear in your Connection List Note SUTs that are detected through Bonjour are not automatically saved to the Connection List To save a Bonjour detected SUT edit its connection information otherwise the SUT is removed from the Connection List when it is no longer detected on the network Other Options Automatically upgrade suites to the current version When this checkbox is selected EggPlant automatically changes any of your scripts that are effected by changes in SenseTalk commands and functions Bring the Run window forward when a script is run Select this checkbox to automatically open the Run window or bring it to front whenever a script is run Alert user when script execution fails Select this checkbox to see an alert dialog when a script fails This does not apply to scripts that are run as part of a Suite Editor schedule Store thumbnail icons for captured images Select this checkbox to generate preview images in file system views and preview areas Deselect this checkbox if you are using a file system or version control system that does not support resource forks Default Suite Directory This field contains the default location EggPlant presents when you open a New Suite Save As or Open dialog Type a file path in the text field or click the Browse button and navigate to
70. dow Use Overrides the EggPlant General Preference Bring the Run window forward when a script is run Requires a yes no value Example Applications Eggplant app Contents MacOS Eggplant AutoShowRunWindow yes www testplant com EggPlant Reference Manual 103 QuitAfterRun Use Runs the given script or suite then quits EggPlant Requires a yes no value A no value has the same result as omitting this option To cancel the quit choose EggPlant menu gt Quit then click the Cancel Quit button Example Applications Eggplant app Contents MacOS Eggplant QuitAfterRun yes RestoreConnection Use Overrides the EggPlant General Preference Reopen connections from last session Takes a yes no value Example Applications Eggplant app Contents MacOS Eggplant RestoreConnection yes ReopenDocuments Use Overrides the EggPlant General Preference Reopen suites and scripts from last session Takes a yes no value Example Applications Eggplant app Contents MacOS Eggplant ReopenDocuments no RunOnLaunch Use Runs the given scripts or suite when the EggPlant application is launched Example Applications Eggplant app Contents MacOS Eggplant RunOnLaunch Users Alex Alex Tests suite www testplant com EggPlant Reference Manual Appendix A EggPlant Commands Eggplant Commands Command Behavior CaptureScreen Takes a snapshot of the Viewer window CaptureTextlmage Creates a text image This command is only
71. dow showing the last known state of the SUT Run Window The Run Window menu item brings the Run window in front of all other windows If the Run window is minimized or closed choosing Run Window opens it www testplant com EggPlant Reference Manual 13 List of Open Windows The bottom of the Window menu contains a list of all open EggPlant windows except the Active Connection and Run windows which have their own entries in the Window menu above Choosing any window brings it to the front of all other windows This is useful for finding windows on a cluttered desk top The Help Menu The Help menu contains the EggPlant Help Viewer as well as channels through which you can provide feedback about EggPlant EggPlant Help The EggPlant Help Viewer allows you to search across all of the EggPlant help documents Using EggPlant EggPlant Reference Manual Getting Started EggPlant Tutorials and the SenseTalk Reference Manual Tip To show the EggPlant manuals in the Mac OS X Finder hold Option as you choose Help menu gt EggPlant Documentation Tutorial Answer Suite The tutorial answer suite contains the scripts and images used in EggPlant Tutorials EggPlant Examples EggPlant Examples is a discussion forum where you can also post questions and answers for other EggPlant users and TestPlant support Release Notes The Release Notes document contains information about the current release of EggPlant including changes tha
72. e or Command drag the cross hairs Note If the captured image is too large for the image well it is scaled down to fit The actual image is not affected but it may appear distorted in the Capture panel Search Type Pop Up Menu Search type describes the level of precision EggPlant requires to consider a part of the Viewer window a match for your target image In the Search Type pop up menu choose one of the following search types www testplant com EggPlant Reference Manual 26 Precise The Precise search type requires a very high degree of precision to consider an image matched in the Viewer win dow This is useful for images with subtle color differences or little contrast Tolerant The Tolerant search type accepts matches that have slightly different pixel colors caused by background and trans parency changes Tolerant searches are more forgiving than precise searches so they reduce the chance of a script failing because of a minor variation in rendering Pulsing The Pulsing search type allows for pixel colors that can change such as the pulsing buttons in Mac OS X Text The Text search type allows for dynamic font smoothing text anti aliasing in images that contain text If EggPlant sometimes fails to locate an image that contains text try changing the search type to Text Text amp Pulsing The Text amp Pulsing search type allows for both changing pixel colors and text anti aliasing The Default Search Type
73. e ui 95 The ImagesearchCounl trot icd i tias 96 The ImagesSearchbDelay 2 3 ti rrr rte aree NOA 96 TheKeyDowrnbelay 5 i tcu eescre eta vad a cenae A tue ta vac ev add 96 The Next ey De lay MUT 96 The Read TextSettigs succeed o oed sea co oto cess aa d vu ERR od dv o E dd You b e dk x kv dea odd 96 The SendShiftl orCaps ore yi I E RRE a IR TAN AN a A ar ARENIS A o NE ReT E SA SEHR RR A NA MK Ree 97 The Mouse click Del soii reete cede tesa cR eec te ee 97 The MouseDoubleClickDelay 2 tantura hino A 97 The MouseMOoVvesSpGeed e tl eere tg DU ERE RE ERO eR RR EA Rea aa O dt d sd 97 The MOUSED rag S POO 98 The MouseMove Delay nde deer A AE A E 98 The MotiseMove Mode coord 98 The ShouldReposition MOUSG rie ro po ttt tn ptit n tae n Sta X ERU x en a aee Ae T RR AI AR pe DATO Y x RE ME REN A dE 98 The StandardlmageTolerance PreciselmageTolerancoce sssssssssseeee eene 99 The ForeceScreenlseltresli uu dade A A t a e ed de rue dris 99 Running from the Command US ascii a tette terea bn sabe raoene sanant ceu EuE acetate 100 Running Scripts from the Command Line eeeeeeeeeeeeeeeeeeeeeeeeeenennnn nennen 101 Passing Parameters eiie PE Fe Ho AER REDE PE E E ER NE E EE E HD NE 101 R nscript Options e PE 101 Launching the EggPlant GUI from the Command Line sssssssssese enne 102 Command LI
74. e Run Window Note You can also use Debug Selection by Option clicking the Run Script button in the Script Editor toolbar www testplant com EggPlant Reference Manual Pause Script Continue Script The Pause Continue menu items pause and continue the current script execution This allows you to examine the state of the script and interact with the Viewer window in Live Mode Step Into Step Into executes the next line of a script then pauses If this line calls another script or handler the script steps into the first line of the called script or handler before pausing again Step Over performs a similar function with one exception If the line calls another script or handler Step Over ex ecutes the called script or handler entirely before pausing Step Over Like Step Into Step Over executes the next line of the script then pauses However if this line calls another script or handler that script or handler runs in its entirety stepping over it to the next line of original script before pausing again During the execution of the script or handler that is stepped over you can click Pause to regain control of the execu tion before the Step Over action has finished Step Out Step Out executes all of the remaining lines in the current script or handler then pauses Using Step Out on an initial handler is the same as clicking Continue During the execution of the code being stepped out of you can click P
75. e current suite For each script each test you ve run for each script by date and time the complete log for each test and images for any step in the log including full Screen images captured in cases of script failure www testplant com EggPlant Reference Manual 47 BOO cs Windows_Tests suite Scripts Images Results Schedule Helpers Settings z Script Name Run Y LaunchEggPlant LaunchEggPlant 9 10 8 00 30 AM Action Qi Search All Log Entries st Ti Message Image Text 1 08 START Running LaunchEggPlant script P 2 08 imagefo Unable to Find Image EggPlant ic 3 08 click EggPlant cog at 525 1178 4 08 log Launched EggPlant 4 le The Results pane The Script Name Run Date List Every script that you test is recorded in the Script Name list you can click a script name to show or hide the dates and times when that script was tested Script dates are color coded to denote test results Green Success Red Failure Black Aborted or Interrupted For each Run Date the list displays the number of errors warnings and exceptions that occurred in the run For more information see The ScriptLogging in Global Properties Resource Links Next to each script name and run date there is an arrow that links a results resource For scripts the arrow opens a CSV text file that contains overall statistics for the script For run dates the arrow opens the LogFile txt file which contains a line by line
76. e of the Viewer window as a list of two numbers indicating the screen width and height www testplant com EggPlant Reference Manual 90 Global Properties In SenseTalk global properties are predefined variables that determine behaviors of the run environment This section describes the two kinds of global properties that are specially defined for EggPlant EggPlant global properties and Run Option global properties EggPlant global properties pertain to the EggPlant application in general and Run Option global properties pertain to interactions with a SUT in the course of a test run Many of these global properties appear in the Text and Run Option preferences using them as global properties al lows you to change them on a script by script basis or even multiple times within a single script the SenseTalk Reference Manual provides more in depth information about global properties including a number of global properties that are not EggPlant specific but still useful in EggPlant scripting For example the colorFor mat global property Using Global Properties with SenseTalk Commands When you set a global property value with a SenseTalk command such as Set or Put use the word the before it the global property to distinguish it from an ordinary variable For more information see the SenseTalk Reference Manual Example set the searchrectangle to 1 2 2 3 Using Global Properties with SetOption and SetOptions When yo
77. e of the called script or handler before pausing again Note The Step Over button performs a similar function with one exception If the line calls another script or handler Step Over executes the called script or handler entirely before pausing Step Over Like Step Into Step Over executes the next line of the script then pauses However if this line calls another script or handler that script or handler runs in its entirety stepping over it to the next line of original script before pausing again During the execution of the script or handler that is stepped over you can click Pause to regain control of the execu tion before the Step Over command has finished Step Out Step Out executes all the remaining lines in the current script or handler then pauses Using Step Out on your initial handler is the same as clicking Continue During the execution of the code being stepped out of you can click Pause to regain control before the Step Out command has finished Animation Pop Up Menu Animation highlights the current line of code in the Script Display area of the Run window as the script is being run You can change animation settings at any time with immediate effect including while a script is running Animations cause scripts to execute more slowly because EggPlant is doing more work at the display level You can improve script execution speed by turning off all animations when you are not debugging Animation Off
78. e rn 17 Closing a VNC Connection with a SU T iioii iiem dida 18 The Viewer WINdOW nie 19 Eque c ELENA TT 19 ier Toro 20 The Capture AFGa outre AAA Rea 20 The IOUS POL eich Pm 20 Capturing Images etie e ena dent Aa LIES 20 Full Screen Control mecanico 20 The Viewer Window TOOlDar 1 retire roter A A A AAA 21 Enter Capture Mode Enter Live Mode ooooccccnncccooconcccncnncccnconnnonnnnnonnnnnnnnnnonnnnnnnn nn Irene nnn n nenne nennen ren nsns nns 21 Full Size Scale to eT 21 Capire IMAGE 0 A ee Agana hee ee ede Anes 21 Use IMJ isis ii A A AAA A AAA 21 A T meds panes a a A e A aai 22 Click DoubleClick RightClick Move To Drag DFOP ooooooccccccccccccoccnconconccnnnnnconcnnnnnnnnonnnnnnnnnnnnnnnnnnnnannnnnnnnnnnno 22 Add IMAG C cda a nage eens cated enchanted asta eds 22 MEL 22 A O 22 Bod 22 MOG rece D 23 COMMON ETE TID LLL IL LLLI Lm 23 Record Movie Stop Movie currently Mac OS X only nennen nnn 23 Capture ESISISSIPTTDITI II ITI ILLI LIE 23 REMESAS Cree ueteri abe e aaa Loue e cia 24 Dieppe
79. e specified string Tip To reset the CollectionFilter set the value to empty Example Set the CollectionFilter to empty The ImageDoctor Examples Set the ImageDoctor to Manual SetOption ImageDoctor Off Value Auto Manual or Off Default Manual Description The ImageDoctor global property determines how the Image Doctor works during script execution Auto The Image Doctor automatically attempts to correct image failures and continue the script execution The initial image failure is logged as a warning Manual The Image Doctor panel opens when an image fails you can choose to proceed with a corrected image or allow the script to fail Off The Image Doctor is not used during script execution The InitialSuites Example Set the InitialSuites to WindowsXP WindowsVista Value One or more suite names Default None Description The InitialSuites global property determines the first suite or suites that are searched for script or image resources called by the current script Suites named in the InitialSuites take precedence over the calling script s own suite The FinalSuites Examples Set the FinalSuites to FallBack SetOption ImageDoctor Off Value One or more suite names Default None www testplant com EggPlant Reference Manual 92 Description The FinalSuites global property determines the suite or suites that are searched for script or im age resources after the script s own sui
80. e treated as misspelled words Special Characters The Special Characters menu item opens a panel that allows you to insert special Unicode characters into your script Note Typing an international character in your script does not guarantee that it can be reproduced on the SUT The ability to send particular characters to a SUT depends on the capabilities of the SUT s operating system and VNC server Example 1 Your SUT and its VNC server both support unicode characters so any unicode character in your script can be typed on the SUT with no additional steps Example 2 Your SUT uses an American keyboard layout and when you type Asian characters you use an input method editor IME EggPlant would a so have to use the IME to send Asian characters to this SUT Example 3 Your SUT supports unicode characters but its VNC server does not It may be possible to find a VNC server that supports unicode characters otherwise EggPlant would need to use an IME to produce international characters on the SUT www testplant com EggPlant Reference Manual Make Plain Text This option converts older rich text scripts to plain text The Run Menu The Run menu contains controls for running and debugging scripts For more information see The Run Window Run Script Abort Script The Run Script menu item runs the script in the active Script Editor or Run window While a script is running the Run Script menu item becomes Abort Script
81. eeeceseecceeeceaesceceeeeceaeseeeeeeeauaseeeeeeaeaeseeeeeeeanes 83 Hide RemoteWindow Show RemoteWindow Commandqs ccccccssesececccecssecceeeceaeeceeeeeeaeeeeeeeeeeeaneeseeeeeanea 83 RunningFromCommandLine Function enne nennen nennen nnne 84 TracesScreen OMOT Comtiand das 84 Reporting Commands 22 ccena tad ataca edd a edd rendu dendi uenia AE a eue De e 84 Log Command iio ET 84 LogWarning Command crio tidad 84 EogError Comman zr tete rete ree vie Ether ceste eeu piu REM UD ce Ru emu ti 84 Sctiptisesults FUNCION uico teli cete trente br etait eei pace bl po a Des ace du inde 85 SendMallCOMMANA ici e a a a aa a a a a aa a eaa ania 85 EggPlantVersion FUNCION usina da 86 CaptureScreen Command 0 ccceceeceeececccee cee eee teen cede a EE aE AE a E aaa 86 ColorAtLocation FUNCION aiii Donc reas tas dora tera AA AA Y s t 86 StartMovie Command currently Mac OS X only cooonooocccnnnnoccccccononacccnnononco cono nano nenne eene EEE 87 StopMovie Command currently Mac OS X only cooioocccoocioniccinciccccrinanic rca 87 S T Commande and FUNCIONS a 87 AllConnectonlnfo FUnctlon ctc ntt A t t it d t kg v T d Mo dd 87 Connect Command reae vidatea dca ane teaasueracas and 87 Connectioninto FUNCION ais utc oce rote ii acea Pu Ed 88 Disconnect Command cuina a aa a aa a aeaa aa EN NEN REDE a Sn NERA Taa RUE RARE 88 HighghtRectangle COmimeang esso ncs n O OONO S 89 RemoteScreenRectangle function eiue ei
82. eeeeseseeceeccaaeeeeeeeeeeeseseeeeensisaneees 12 Customize Toolbar tetro radar ha nai aa aaa aenea A ense ose esed eee Dua ade 12 Active Connection eio aea aa A Rania 12 Ue eanaanys 12 List of Open WIndOWS reco nein reru a a Ea Aaa aa iaa 13 s Xaemu de M HUM 13 EggPlant Help E te tee pd eee aaa 13 RiUrer rvse f 13 EgoPlantiEXamples jscscceistecic ca UT 13 Release NotES canarias AS A iaa 13 Submit Question Report Bug Request Feature cooooooccccccccnccononoononcnnnnnnccnnnnnnnnnnnnnnnncnnnnnnnnnnnnannnnnnnnnnnos 13 Bii Xeeeig cec ais 14 A n e E Ea aa e aa aea aa a a A R 14 eE A E A E A E E 15 nor NN 15 ep OE 15 POLL sic Festa celtic be tea A rnv i bue el AAA E A e uut AE AA Dre eo ea 15 DOH OS ic EE 15 US E m 15 penus 15 Adding or Editing a SUT in the Connection List ssssssssseee enm nana 15 Changing Color Depth sonic a it 16 www testplant com EggPlant Reference Manual Opening Secure CONNECTIONS mmm i 16 Connecting to a SUT with SSH PPP cere etre eerie errr ee eee teeneee eee ennennri ninh hens rr enne rir RANNAN 16 Setting up SSH in the SUT s VNC Server Application sse nennen 17 Opening a VNC Connection with a SUT sssssssssssseeeneeeneeene een
83. eferences Removing a License Select the license in the Licenses Found list and click Remove Note You can not remove a license that is currently in use Requesting a Free Trial Click the Free Trial button to request a trial EggPlant license General preferences The General preferences control several basic housekeeping behaviors On Startup Reopen suites and scripts Select this checkbox to automatically reopen your last open suites and scripts when you launch EggPlant Restore previously open connections Select this checkbox to automatically reopen your last open VNC connections when you launch EggPlant If EggPlant cannot connect to a previously open SUT there is no alert or error message Connection List Update connection availability This pop up menu contains choices of how often SUT status in the Connection List is updated Regardless of your choice SUT status is always updated when you first open or close a VNC connection Maximum of open connections This pop up menu allows you to limit concurrent SUT connections to the chosen number Close Connection List upon opening a connection When this checkbox is selected EggPlant closes the www testplant com EggPlant Reference Manual 57 Connection List whenever you open a VNC connection Show alert when a connection fails When this checkbox is selected EggPlant prompts you to retry or cancel when a VNC connection fails Enable Bonjour
84. eggPlant v11 0 MAC OS X EggPlant Reference Manual Copyright 2011 TestPlant Inc Eggplant Reference Manual Trademarks Eggplant the Eggplant logos TestPlant and the TestPlant logo are trademarks or registered trade marks of TestPlant Inc Eggplant Reference Manual Eggplant Getting Started Using Eggplant Sense Talk Reference Manual and RITA Guide are copyrights of TestPlant Inc SenseTalk is a trademark or registered trademark of Thoughtful Software Inc Apple Mac Macintosh Mac OS X and QuickTime are trademarks or registered trademarks of Apple Computer Inc Windows and Window XP are trademarks or registered trademarks of Microsoft Corporation EggPlant Reference Manual EggPlant Reference Manual PTR esac ccs es et E A E About This MANUAL cuts A A i dese ene Wer ners kee eee Help and Additional Information sees eene em eren n nnn nnne nennen sensn sese nnn entente n nnne Dici eeurududglmee MAS The der u dusme M About EggPlahlt iie ce br te e a ere ax dee alus vue era Secure co aer Ee eras Pretfereiees a ouod creed A A ced bv est eai Sade lt a a Eicense Agreemiehl e id Se T A nannaa A a N EE E AEE A E Hide EggPlant ie ettet O A Sap ervigzee sdc
85. en TrimWhitespace is off ReadText may return text that starts or ends with whitespace characters The default TrimWhitespace is on ValidCharacters string The set of characters that may be returned by the ReadText function The ValidCharacters property overrides the TextLanguage property characters that are not part of ValidCharacters are not returned by the ReadText function By default all characters in your chosen TextLanguage are valid Behavior Returns the text in a given screen rectangle RemoteClipboard Function Examples Put RemoteClipboard 5 Put RemoteClipboard Parameters Optional maximum wait time Returns Text contents of the SUT clipboard Behavior Returns the current text contents of the SUT s clipboard The return is valid only if the clipboard has been used during the current VNC connection www testplant com EggPlant Reference Manual 76 Returning content that was recently placed on the clipboard If you include a maximum wait time for the RemoteClipboard function the function returns clipboard content that was added as a result of the ast action on the SUT If no new clipboard content is detected within the given time parameter an error is raised Returning any content that is on the clipboard If you do not specify a maximum wait time the RemoteClipboard function returns the last known contents of the SUT s clipboard Note To use the clipboard on a Macintosh SUT be sure to connect to a
86. ence Manual 63 search The number represents the maximum difference between an original pixel s RGB value and the RGB value of a presumed match in the Viewer window Note These image tolerance values affect your searches throughout every script you run in EggPlant If you need to change these values it is usually best to do it on a script by script basis The System pane The settings under the System pane allow you to configure how EggPlant interacts directly with the remote system Remote Work Interval The value in this fields represents the minimum delay between two commands that interact with the SUT For more information see the RemoteWorklnterval in Global Properties Force Screen Refresh Select this checkbox to force the Viewer window to redraw the SUT after every line of script executed For more information see The ForceScreenRefresh in Global Properties Text preferences These settings define the text platforms that are available for use in text property lists Each platform includes a Text Engine and any number of predefined text styles The Platform Pop Up Menu The Platform pop up menu contains the names of all of the operating systems for which you can currently create text property lists To display and edit the properties of a platform choose it in the Platform pop up menu Adding a Platform To define a new platform click the Add button The new platform is created with the same initial setting
87. enu of suites and scripts that have recently been opened Choose a suite or script from the submenu to open it To delete the list of files in the Open Recent submenu choose File menu gt Open Recent gt Clear menu Close The Close menu item closes the active window Note To close all EggPlant windows at once hold down Option as you close a window Save If the Script Editor is the active window the Save menu items saves the active script If a Suite Editor is the active window the Save menu item saves all open scripts in the active suite Save As The Save As menu item saves the active script under a new name that you specify Save All The Save All menu item saves all open scripts and suites Revert Revert reloads the last saved version of the active script in the Script Editor Print The Print menu item prints the active script The Edit Menu The Edit menu contains a standard menu items for editing and finding text in your scripts www testplant com EggPlant Reference Manual Undo Undo reverses the last change you made to the text in the Script Editor You can undo and redo many steps in the order in which they were performed Redo Redo reverses the Undo menu item Cut Cut removes selected text from your script and stores it in the computer s clipboard After you cut text you can paste it elsewhere using the Paste menu item Copy The Copy menu item copies selected text to the computer s
88. eption is the Viewer window which never grows larger than its contents Minimize Window Minimize Window sends the active window to the Dock You can minimize all EggPlant windows at once by holding down Option as you minimize a window To see the window again click it in the Dock or choose it in the Window menu Bring All to Front Arrange In Front Bring All To Front moves all open EggPlant windows in front of windows from other programs You can arrange the EggPlant windows in a cascading sequence by holding down the Option key as you choose Bring to Front Hide Toolbar Show Toolbar Hide Toolbar causes the toolbar of the active window to disappear If the active window s toolbar is already hidden the action becomes Show Toolbar The oblong toolbar button at the right end of the title bar is a shortcut to Hide Show Toolbar Customize Toolbar Customize Toolbar brings up a panel in which you can select the buttons that are available in the toolbar of the active window To add a button to the toolbar drag the button from the Customize panel to the toolbar To remove a button from the toolbar drag it off of the toolbar While the Customize panel is open you can also drag buttons to different locations within the toolbar Active Connection The Active Connection menu item brings up the Viewer window of the SUT you are currently working with If your VNC connection has been closed you can still bring up the Viewer win
89. er parts of the organization The Helpers pane The Helpers pane contains a list of the suites whose scripts images and helpers are available to the current suite helper suites Helper suites are useful as core suites with scripts and images that you use across several other suites The file path of each helper is displayed in the Path column red text indicates a file path that is no longer valid A OO Me Windows_Tests suite Helper Su ite Path Common Users pamela EggplantTe Widgets Users pamela EggplantTe Add i Remove gt The Helpers pane www testplant com EggPlant Reference Manual 54 Adding a Helper Suite There are two ways to add a helper in the Helpers pane Click the Add button and select a suite in the Add panel Drag the suite icon from the title bar of a Suite Editor to another suite s Helpers tab Using a Relative Path for a Helper Suite You can change the path of a helper suite to make it relative to your Home directory or your Default Suite Directory To start editing the path of the helper suite select the helper suite in your Helpers pane and click in the path Paths that start with tilde are relative to your Home directory Paths that start with a dot are relative to your Default Suite Directory Removing a Helper Suite To remove a helper suite select it and click the Remove button When you remove a helper suite scripts in the cur rent suite can no longe
90. ess and release Time between clicks of a double click Time between keystrokes Default settings used by the ReadText and ReadTable functions The location where the mouse cursor is moved during searches Whether the mouse is repositioned during searches www testplant com EggPlant Reference Manual 111 Appendix E Property Lists CaptureScreen Properties Name 000000 An image file name and optional path information in quotation marks L E Te E E lU Whether to append an automatically incremented number to the image true or false Connection Properties ServerlD required SUT host name IP address or display name Password Password of the SUT VNC server shi sshUser User account on the SSH host computer ColorDepth The color depth of the SUT in the Viewer window 8 16 32 www testplant com Image Properties EggPlant Reference Manual key description HotSpot Coordinates of the Hot Spot within the image ImageName Name of the image file File extension is not used SearchType Precise Tolerant or Text Searchrectangle Coordinates that define a rectangle in the Viewer window EggPlant only looks for this image within the defined rectangle Pulsing Whether the search type allows for pulsing true or false Tolerance The acceptable difference between color values in an image and a match in the Viewer window Discrepancy The percentage or absolute number of
91. eyDelay determines the wait time between keystrokes sent to the SUT The ReadTextSettings Example Set the readTextSettings to dpi 96 multiLine off Value a property list Default dpi 72 Description The ReadTextSettings is a property list of the default settings used for the ReadText and ReadTable functions www testplant com EggPlant Reference Manual 97 The SendShiftForCaps Example Set the SendShiftForCaps to yes Value Yes Always and Never Default Yes Description The SendShiftForCaps determines whether or not ShiftKeyDown is used for capital letters sent to the SUT Yes Sends the shift key to type capital letters in commands that do not include a modifier key parameter For example TypeText AltKey amp S would not send a shift to generate a capital S because doing so would change the result from A t s to Shift Alt s However TypeText Seattle would send a shift to type a capital S Always Sends the shift key to the SUT whenever a capital letter appears in a TypeText parameter Never Never sends shift to type a capital letter You can still send the shift key by specifically passing the ShiftKey parameter The MouseClickDelay Example SetOption MouseClickDelay 5 Value Time in seconds Default 0 02 Description The MouseClickDelay determines the wait time between mouseDown and mouseUp events sent to the SUT The MouseDoubleClickDelay Example Set the MouseClickDelay to 004 Va
92. f the current Find term Find Previous Find Previous searches backward in the current or previous document and displays the last occurrence of the Find term Use Selection for Find Use Selection for Find takes the selected text in the Script Editor as the current Find term Jump to Selection Jump to Selection scrolls through the current window to display the selected text If no text is selected Jump to Selection displays the current insertion point Spelling Spelling contains a submenu of standard items for checking spelling in the Script Editor Spelling The Spelling menu item checks the spelling in the current window or selected text and opens a dialog that suggests corrections You can step through the document using the Find Next button to locate other possible misspellings Check Spelling The Check Spelling menu item checks the spelling in the current window and highlights the next suspected misspelling Command click and right click are shortcuts for checking the spelling of selected text Check Spelling As You Type If Check Spelling As You Type is turned on the Script Editor checks your spelling as you type underlining suspected errors Misspelled words may only be marked briefly if you have the Update colors continuously while typing option turned on in Script Editor preferences Tip The spelling features are more useful if you add EggPlant scripting commands to your system dictionary Otherwise the commands ar
93. gPlant About EggPlant displays your current EggPlant version number followed by credits for the dedicated and talented EggPlant development team Preferences Preferences opens the Preferences panel which contains settings for advanced features in EggPlant Choose Preferences to fine tune your test environment For more information see Licenses and Preferences License Agreement License Agreement brings up a document describing the conditions under which you are licensed to use EggPlant Service Schedule Service Schedule describes the EggPlant Maintenance Service agreement Licenses Licenses opens the License Registry a table that provides information on the specific EggPlant licenses available and those in use on the network For more information see Licenses and Preferences www testplant com EggPlant Reference Manual Services The Services submenu provides access to services offered by other applications on your computer These may or may not be useful to EggPlant Hide EggPlant Hide EggPlant hides the EggPlant interface on your display and shows the program you used most recently To return to EggPlant click the EggPlant icon in the Dock Hide Others Hide Others hides the windows of all of the other programs you are currently running This is helpful for reducing on screen clutter when you are working with EggPlant To see a hidden program again click its icon in the Dock or choose EggPlant gt Show
94. ge used by the command or function in that step For a text prop erty list the word Textis shown followed by the text of the image If the step called the CaptureScreen command the name of the captured image is displayed If the step is the last step of a failed script Screen_Error file is displayed Resource link When the Image column displays the name of an image or movie on Mac OS X the Resource Link column contains a link to the related resource as shown in the table below www testplant com Log Area resource links EggPlant Reference Manual 49 Image column value Resource opens with Captured Image Image pane of the Suite Editor Generated text property list Your default image viewing program Screenshot Your default image viewing program Movie currently Mac OS X only QuickTime Text The Text column displays the additional information shown in the table below Additional log information in the text column Message or image value Associated text TypeText Keys that were typed in the Viewer window Image Coordinates where image was found Error Text of the exception that was thrown Command that changes option settings New setting values Colorization Some steps in the Log Area are colorized to indicate results The meaning of each color is shown in the following table Log Area colorization Color Meaning Blue
95. ging Tracing Script tracing causes EggPlant to echo information about what the script is about to execute to the Log Area in the Run window This is similar to script animation but it allows you to review all of the code that is executed during the script run interspersed with logged output This can provide more context when debugging a script The tracing setting can be changed while a script is running with immediate effect it can also be modified temporar ily by scripts as they run See the ScriptTracing in Global Properties www testplant com EggPlant Reference Manual Tracing Off When Tracing Off is selected only standard log messages are displayed in the Log Area of the Run window Trace Calls Trace Calls causes the Log Area of the Run window to display a message as it enters and leaves each script or handler Trace All Trace All causes the Log Area of the Run window to display every line of each script or handler prior to executing it Note Tracing cause scripts to execute more slowly because EggPlant is doing more work at the display level To improve script execution speed turn off tracing when you are not debugging Doctor The Doctor submenu contains options for the way the Image Doctor works during script execution Auto The Image Doctor automatically attempts to correct image failures and continue the script execution The initial image failure is logged as a warning Manual The Image
96. hanged at any time even while the script is running You can set a dynamic breakpoint in the Run window by clicking in the column to the Script Display area A black triangle appears next to the line denoting the breakpoint You can also set a breakpoint at your insertion point in the www testplant com EggPlant Reference Manual 36 script by choosing Run menu gt Set Breakpoint You can move a breakpoint by dragging the triangle to another line in the script or remove it by dragging it out of the column Script frame Pop up Menu The Script Frame pop up menu displays the handlers that are being executed listed in the reverse order in which they are called When script execution is paused you can select a different frame from this pop up menu to view it in the Script Display area and see which line it is currently executing This also sets the context for commands typed into the Ad hoc Do Box For example if you want to output the value of a variable that is present only in the script handler that started your execution you must make sure to select the very bottom frame numbered 1 The Log Area The Log Area is the lower half of the Run window As the script runs the Log Area displays the following information 1 The same information that is recorded in the script s permanent log See the Results pane in The Suite Editor 2 The output of Put commands that have no specific destination 3 Script tracing information whe
97. he Script Editor Creating and Editing Scripts There are several ways to insert commands and images into a script 1 Type commands functions and image names in the Script Editor 2 Click the command buttons in the Viewer window toolbar 3 Choose commands in the Control menu 4 Choose commands in the Script Editor nsert pull down menu See nsert below 5 Copy cut and paste with the Edit menu or associated keyboard shortcuts 6 Drag image script suite and SUT names into the Script Editor from other windows Auto completion When you have typed at least two characters in the Script Editor Complete attempts to finish your current word Possible completions include variables commands and names of scripts or images from your current suite To autocomplete a word press F5 or Option Escape or choose Edit menu Complete If there is a single word match EggPlant completes the word for you If more than one match is detected choose the appropriate word and press Return Tab or Right Arrow www testplant com EggPlant Reference Manual 32 To cancel the Complete command without selecting any of the choices press Escape Auto indenting Auto indenting puts tab or space characters inside control structures to make scripts easier to read Control struc tures include handlers repeat loops if then else and try catch commands By default the Script Editor updates indention when you press Return or Tab You can change this
98. her Command click and drag the script names www testplant com EggPlant Reference Manual 52 Duplicating Scripts in a Schedule To schedule additional runs of a script in the schedule Option drag the script name as if to move it You can even add the Option key when you are already dragging a script name The original script remains and a copy is created wherever you drop the script name To duplicate a range of scripts together Option Shift drag the script names To duplicate multiple nonsequential scripts Option Command click and drag the script names Setting Dependencies In the Schedules pane you can schedule a script to run only if the preceding script is successful To set up a dependency select one or more scripts that depend on the success of the previous script and click the right arrow button or press the Right Arrow key The script is indented to show the dependency Click the left arrow button or press the Left Arrow key to remove the dependency You can create many levels of dependency a domino effect by indenting multiple times un Script M Untitled script v scriptl script vi scriptl script Script dependencies Tip Although the Schedules pane does not support dependencies based on script failures you can accomplish this with a master control script For more information see Writing Master Scripts in the Using EggPlant manual Disabling and Removing Scripts from the Schedule
99. ic TIG Text Properties The following text properties can be used with text platforms whose text engine is a text image generator TIG TextFont The name of the font used in the Text Image TextSize The size of the text in points TextColor The color of the text TextBackgroundColor The background color of the Text Image Bold Whether the font is displayed as bold true or false Italic Whether the font is displayed in italics true or false Underline Whether the text is underlined true or false Anti aliasing Pango TIG only Whether or not text is anti aliased on or off UseMarkup Whether or not supported markup tags are recognized as text attributes on or treated as string literals off Example Click Text Cancel TextStyle Win2K TextBackgroundColor white For more information see The Find Text Panel and Text preferences Mouse Commands and Functions This section describes the EggPlant commands and functions that control the SUT s mouse in the Viewer window Click Command Example Click ImageOne ImageTwo ImageThree Click 2 4 Parameters One or more image references or a single coordinate location Behavior Clicks the SUT mouse in the Hot Spot of the first location found EggPlant searches for images in the order in which they are listed DoubleClick Command Example DoubleClick SomeImage Text SomeWords Italic No DoubleClick 25 358 Parameters One or more
100. if it fails OpenSuite and CloseSuite Commands Example OpenSuite Suites SuiteName CloseSuite Suites SuiteName Parameters One suite name and optional pathname If you do not specify an absolute path EggPlant searches for the suite in all of the currently open suites the folder containing the current suite and the default document directory designated in General preferences Behavior OpenSuite makes another suite available for use during the current run this availability automatically ends when the script run ends or when CloseSuite is called Note Changing the InitialSuites global property to access a suite is almost always preferable to using the OpenSuite command Suites that you open with the InitialSuites are always the first suites checked for image and script resources and they are checked in the order in which they are passed Suites that you open with the OpenSuite command are checked after the active suite and the order in which OpenSuites are checked is unpredictable OpenSuites Function Example put OpenSuites into SuitesInUse Parameters None Returns A list of all of the suites that are available to the current script www testplant com EggPlant Reference Manual 83 Behavior Returns a list of all of the suites that are available to the current script The list includes the script s own suite and suites that opened by the OpenSuite command SetOption and SetOptions Commands Example SetOpti
101. image match in the Viewer win dow The actual time may be longer than the time specified here depending on other factors related to the search Click the disclosure triangle to reveal or hide the following preferences Search Delay The value in this field is time between one image search and the next Search Count The value in this field represents the number of times EggPlant searches for a single image match When the search count value is 1 EggPlant does not perform a full screen refresh and reposition the mouse before failing This can reduce delay when searching for images that are not present in the Remote Screen but it can also cause unnecessary failures due to screen artifacts and timing errors Note The Image Search Time is equal to the Image Search Delay multiplied by one less than the Image Search Count Changing the Image Search Time affects the other two values and vice versa Thus changing the Image Search Time will affect the other two values and vice versa Precise Image Tolerance The position of this slider determines the level of precision EggPlant requires to match an image with a tolerant search The number represents the maximum difference between an original pixel s RGB value and the RGB value of a presumed match in the Viewer window Standard Image Tolerance The position of this slider determines the level of precision EggPlant requires to match an image with a standard www testplant com EggPlant Refer
102. iptTracing Examples SetOption ScriptTracing Calls Set the ScriptTracing to Off Value All or true Off or false or Calls Default Off Description The ScriptTracing determines whether or not a script is traced displayed line by line in the Run window one step ahead of actual execution as it runs The values are described below All or true Each line of the script is displayed before it is executed Off or false The script is not traced Calls Each script or handler is traced but not each line The ScriptTracing reverts to its default value upon completion of the script execution The CommandLineOutput Examples Set the CommandLineOutput to On SetOption CommandLineOutput Off Value On or true Off or false Default Off Description The CommandLineOutput controls the output of messages to the standard output stream when a script is run from the Unix or Windows command line Off or False No output is sent to standard output stdout On or True All of the script output that would appear in the EggPlant graphical interface is sent to the standard output stream Run Option Global Properties These global properties determine interactions with the SUT The default values are appropriate for most situations The RemoteWorklnterval Example SetOption RemoteWorkInterval 1 Value Time in seconds Default 0 7 Description The RemoteWorkInterval determines the minimum time EggPlant allow
103. l 41 The Suite Editor The Suite Editor is the window in which you manage scripts images and logs it is the control hub for all of your test ing operations When you are working with multiple suites you must open a separate Suite Editor for each one To open a Suite Editor choose File menu gt New Suite or Open Suite Note If a suite folder is locked in your file system a lock icon appears in the top left corner of the Suite Editor When a suite is locked you cannot add remove or edit any script resources You can still run scripts but run data is not saved The Scripts pane The Scripts pane contains a list of all of the scripts in the suite For each script the Script Name Modified Date Last Run Date and Size are displayed OOO si n Widgets suite crip Images Results Schedule Helpers Settings 4 Search All Modified Date Last Run 5 Serch Names Fri 1 7 11 3 43 08 PM Fri 1 7 11 i Tue 8 3 10 2 00 18 PM Tue 3 9 10 No History Tue 8 3 10 3 44 41 PM nnections scri Wed 9 15 10 5 47 21 PM Wed 10 6 10 copy script Wed 9 15 10 10 43 10 AM Tue 9 21 10 FailedScript script Thu 1 6 11 1 11 54 PM Thu 1 6 11 Heading3 script Tue 8 3 10 2 36 46 PM Thu 7 15 10 xa Delete 4 Run Open The Scripts pane Searching for a Script To search for a particular script in your suite type part of a script name or script text in the search field above the script list To set the type of search filte
104. ld and choose Names Descriptions or All from the pop up menu Tip To save your search term as an item in the Search pop up menu press Return after you type the term Deleting Images and Image Folders There are two ways to delete images and image folders from an EggPlant suite www testplant com EggPlant Reference Manual 44 1 Select one or more images or image folders in the image list and click the Delete button 2 Drag one or more images or image folders from the image list to the Trash Creating New Image Folders To create a new image folder click the New Folder button below the image list and enter a folder name The Image Doctor The Image Doctor is a utility that adjusts the search criteria for images that are not being found in the Viewer window To use the Image Doctor select an image in the image list and click the Image Doctor Search button Image Doctor Search Type Status Info Standard Search lt Not Found gt Dynamic Tolerance lt Not Found gt Alternate Types 383 748 Pulsing Partial Match 383 748 2 Original Location 383 748 Search Action w The Image Doctor Diagnostic The labels in this column describe each kind of adjustment the Image Doctor makes For more information on search criteria see Image property list in EggPlant Commands and Functions Standard Search This is the normal state of the image with no adjustments Dynamic Tolerance This version of the image starts
105. lectionFilter to narrow down the images EggPlant looks for within a script by name image description or both Example Set the CollectionFilter to Name German Set the CollectionFilter to Name German Description New version In the first example EggPlant would limit searches to images with the string German in the image name In the sec ond example it would limit searches to images with German in the name and New version in the image descrip tion as recorded in the Images pane of the Suite Editor Note For filtering purposes an image s subpath within an Image Collection is considered part of its name Image Property List An image property list refers to a pre existing image or Image Collection with the ability to override its default prop erties Every image property list must contain the ImageName property and may contain any additional properties from the following list ImageName file name The name of the image file Required HotSpot coordinate pair The Hot Spot coordinates within the image SearchType Precise Tolerant or Text A general measure of how closely colors on the SUT must match the colors of your images Tolerance integer Anumber that represents the acceptable color difference between pixels in an image and a match in the Viewer window You can set a single value that is used for red green and blue or three separate values separated by commas Discrepancy integer The percent
106. lors panel is especially useful for EggPlant it allows you to copy a color from any place in your display including the Viewer window To use the color picker click the magnifying glass in the Colors panel then click again wherever you see the color you would like to copy Bold Italic and Underline Check Boxes Select these checkboxes to generate bold italicized or underlined text in your text image Not all fonts can be drawn in a bold or italic form so some font and style combinations cannot produce a usable text image Note Programs can differ in the way they draw underlining so an underlined image may not produce the exact im age you need If this is the case use Capture Image to take a snapshot of your text in the Viewer window Text Image Preview To hide or show the image preview area click the disclosure triangle or the words Text Image Preview Previews of text images can be useful if your selected text platform uses a native EggPlant text image generator TIG or another fast TIG on the network If the selected text platform uses a slower TIG or the platform s TIG is currently unavailable the image preview can slow down your system Search Type Pop Up Menu Search Type describes the level of precision EggPlant requires to consider a part of the Viewer window a match for your target image For text the best search type is usually Text For more information see Search Type pop up menu in The Capture Panel above
107. lso open this menu by right clicking in the Script Editor Handler Pop Up Menu The Handler pop up menu contains a list of all of the handlers defined in the current script You can choose a handler to jump to its definition in the script Show Suite The Show Suite button opens the script s suite in a Suite Editor Show Resource The Show Resource button opens a script or image named in the currently selected text Note You can also show a resource by Option clicking a script or image name Show Results Click the Show Results button to open the last recorded results for this script in the Results pane of the Suite Editor window Customize The Customize button brings up a panel in which you can select the buttons that are available in the Script Editor toolbar To add a button to the toolbar drag the button from the Customize panel to the toolbar To remove a button from the toolbar drag it off of the toolbar While the Customize panel is open you can also drag buttons to different locations within the toolbar Add Image The Add Image menu item inserts the image into the script with no new command or function Find Text The Find Text button opens the Find Text panel which allows you to create an image based on text attributes Shift clicking the nsert pull down menu also opens the Find Text panel For more information see The Find Text Panel Colors Fonts and Print These buttons open the standard color selec
108. lue Time in seconds Default 0 01 Description The MouseDoubleClickDelay determines the wait time between the end of the first click mouseUp event and the beginning of the second click mouseDown event of double clicks sent to the SUT The MouseMoveSpeed Example SetOption MouseMoveSpeed 10 Value A number 0 or greater Default O Description The MouseMoveSpeed determines how fast the SUT s mouse is moved in the Viewer window The value represents the number of pixels EggPlant moves the SUT s mouse in each step Between steps there is a pause the length of the MouseMoveDelay value With the default value of 0 the mouse jumps from its current position to the next point in one step Note Some systems particularly certain Linux systems have trouble tracking the mouse under the default value For these systems start with a value of 10 then reduce the value as necessary until you find one that works Conversely if 10 is slow enough you can try increasing the value to see how fast the mouse can move before the SUT can no longer track it www testplant com EggPlant Reference Manual 98 The MouseDragSpeed Example Set the MouseDragSpeed to 12 Value A number 0 or greater Default 10 Description The MouseDragSpeed determines how fast the SUT s mouse is moved during a drag command The value represents the number of pixels EggPlant drags the SUT s mouse in each step Between steps there is a pause the length
109. mes Note Every instance of EggPlant requires a license To use EggPlant from the GUI and the command line at once you need at least two licenses www testplant com EggPlant Reference Manual 101 Running Scripts from the Command Line The runscript command launches EggPlant and runs scripts without showing the EggPlant GUI To control the full GUI EggPlant through the command line see GUI Options in the Command Line below 1 Type the full path of the EggPlant application followed by runscript and a space 2 Type the full path of a script or suite to run 3 For each additional script or suite insert a space then type the full path to the script or suite Example Applications Eggplant app runscript Users Alex appTests suite Applications Eggplant app runscript Users Alex appTests suite scripts testl script EggPlant saves the results of each script run in the Results folder for that script s suite Then after all scripts and suites have finished running EggPlant reports the number of successful scripts and suites as the return value A suite is successful if every script in it is successful Note To have EggPlant report script failures instead of successes set the ReportFailures option to yes Passing Parameters You can pass parameters to a single script or the last of multiple scripts to be run At the end of the runscript line type params and then the parameters separated by spaces Example Applicati
110. moteWindow Parameters None Behavior Hides and shows the Viewer window The Viewer window does not need to be visible while a script is running www testplant com EggPlant Reference Manual 84 RunningFromCommandLine Function Example If RunningFromCommandLine then Log Script was run from command line end if Parameters None Behavior Returns yes if the script run was started by a command line call returns no if the script is being run through the GUI interface TraceScreen On Off Command Example TraceScreen On TraceScreen Off Parameters On or off Behavior Turns TraceScreen mode on and off When TraceScreen mode is on a full image of the Viewer window is captured into the execution log immediately before the execution of each command that acts on the SUT These Screen captures are available in the Log Area of the Suite Editor s Results pane Tip Because each image can be quite large use the TraceScreen On Off commands within a script to capture only the images that are useful to you Reporting Commands These commands insert entries into a script s Log file Also see The ScriptLogging in Global Properties Log Command Example Log Message to be recorded in log file Parameters One or more Log messages Behavior Creates an entry in the script s Log file If you set multiple message parameters each message is inserted as a separate entry If the ScriptLogging global property value is Minim
111. n negative coordinate values are relative to the bottom right corner of the screen See also the ShouldRepositionMouse The ScriptLogging Examples Set the ScriptLogging to Silent SetOption Scriptlogging On Values On or true off or false minimal or silent Default On Description The ScriptLogging controls which events are recorded in the Log file as a script runs as follows On Log LogWarning and LogError commands and all interactions with the SUT are recorded Off Only Log LogWarning and LogError commands are recorded Minimal Only LogWarning and LogError commands are recorded Silent Nothing is recorded in the Log file Warnings and errors are still counted For more information see The Results pane in The Suite Editor The ScriptAnimation Examples SetOption ScriptAnimation All Set the ScriptAnimation to Off Value All or true Off or false or Calls Default Off Description The ScriptAnimation determines whether or not a script is animated highlighted line by line in the Run window as it runs as follows All or true Each line of the script is highlighted as it is executed Off or false The script is not animated Calls Each script or handler is highlighted but not each line The ScriptTracing reverts to its default value upon completion of the script execution For more information see Animation www testplant com EggPlant Reference Manual 95 The Scr
112. n DaSiCS ccceceeeeeeceeccec cece eee eee eet ee eee aeaaeaeeeeeeeeeeeseceacaaaaaeaeeeeeeeeeeesescccaeaeeseeeeeeeeeeeeecseesees 67 Syntax GUIdElNES civic it 67 Data types used in EggPlant Commands and Functions oooocccccnnocccccnnccannncconannnn cnc nano nar c cnn enne 67 N m Dense aan AA AAA AAA AAA AAA A 67 COOKIN ASS EM EU 68 SI 68 iieri MP 68 near 68 Mage NIME m 68 nemen 69 Image Property B oL 69 I2 70 Mouse Commands and Functions sss e enne e nennen nn enin sn nn nennen nere EEE nnne 71 eese 71 DoubleClick Commandeer tenia RR RR sss sns aa nenne nr nnn nnns senes 71 RightChick Command C M 72 MouseButtonDown MouseButtonUp COMMANOdS oocoococcnononcccnnncnnnnnnnnnncnnnnnononnnnonononononnnnnnnnnnnnonenenenenenenininins 72 ScrollWheelDown ScrollWheelUp COMMANS cccccccccceceeaeaeeeseseeeeseseeeeseeeceeeeeeeeeeceeeeeeesesesaeaeaeaeaeaaeasnsnes 72 MoveTo Command cece cee ce 72 MoveloEach Command iii nagne ined dinaeede ener eles aaa eee eee 72 Drag COMME Ad a glad 73 Drop C mmMmaNd esI 73 DragAndDrop Comm
113. n Script Tracing is turned on See the ScriptTracing in Global Properties 4 Output from commands entered in the Ad hoc Do Box See the Ad hoc Do Box below The Ad hoc do box The Ad hoc Do Box AHDB allows you to modify a script as it is running For example you can assign new values to variables execute commands or call other scripts Sa Teer ee T oT TIT Te Sra J mm LLEEI Creer Terr A a bens Sun 4 25H 0 1 44 59 PM imagelocation NoLimit pmi at 1050 365 Sun 4 25 10 1 44 58 PM drop at 1050 464 sun 4 25 10 1 44 58 PM log B EveryMin pmi sun 4 25 10 1 45 01 PM drag Availability pmat 1035 372 keyup allmodifierkeys sun 4 25 10 1 45 06 PM keyup allModifierKeys i d keyup allmodifierkeys The Ad hoc Do Box www testplant com EggPlant Reference Manual 37 The Run Window Toolbar The Run window toolbar buttons are described below Since the toolbar can be customized you might not see all of the buttons on your own toolbar For more information on adding and removing toolbar buttons see Customize below Run Script Abort Script The Run Script button reruns the last script that was run or the entire script from which a selection was run While the script is running the Run Script button becomes Abort Script While a script is running and not paused you cannot perform any manual actions in the Viewer window or open and close VNC connections Note You can run the script in debug mode
114. n the SUT Default value 5900 Password The password for the VNC server Default value None www testplant com EggPlant Reference Manual 88 sshHost The host name or IP of a computer hosting an SSH connection No default sshUser The user account on the SSH host No default sshPassword The password to the user account on the SSH server No default Visible Whether or not the Viewer window automatically opens upon connection Yes or No ColorDepth The color depth of the SUT in the Viewer window 8 16 32 Default value The native color depth of the SUT Tip If you have already connected to this SUT you can generate this property list with the ConnectionInfo function ConnectionInfo Function Example Connect ConnectionInfo SomeSUT Parameters A host name IP address or display name of a SUT a connection property list that contains at least one of the above or no parameter Returns A connection property list for the given connection If there is no parameter ConnectionInfo returns a con nection property list for the active connection Behavior Returns a connection property list for the given SUT The property list returned can include any number of the following properties Availability The last known availability status of the SUT Server ID The host name IP address or display name of the SUT PortNum The port number used by the VNC server on the SUT Pass_code The p
115. na rane AOE ate eER dena aa 89 IsemoteScreenolze t UNCION d occ roce rre adt ente tre ennt dace Apa tete he cael eve ine Tu id 89 www testplant com IX EggPlant Reference Manual Global POP GIS ion 90 Using Global Properties with SenseTalk COMMAMNAS ococoncoccccconoconcccnonnoncnc ccoo nnnnconnnn nn eene nr 90 Using Global Properties with SetOption and SetOptions oooccoccccccinocinnonconccnncnnnnnnnnnnnannn ono nnnnnnnnnnnnnnnnnannnnnnnnnnnno 90 GetOption and GetOptions FUNCIONS i2 2 tort dre tree e poc ce ttt cec lt a dri rd cree c 90 EggPlant Global Properties nitet rite c e eren XB Re RR iii 91 The CollectionFilter 25 cipi te otto tete te toc lee A NE 91 The IMAGE DOCION ex EE 91 The hitlalSulteS tai E E N 91 The FinalSultes ico i 91 The SearchRectandle savia 92 The TEXtPlatiorim icono naa dadas ARANA AAA 92 The CurfentTextPlatfOFIm cot ii ia au nd vd and 93 HD IBSEP SEINE RERUM 93 The DeTaultTexiSVYlE EI 93 The RemoteClipboatd tn etre a a aA ES SNEER TERRE RKR MES ERERSUEER S dan Ka PAM ERR 93 The lRepositonP OIM cai c 94 Elsevier EET 94 El esTe dejan RS A AER 94 The SCM PUUFACIG ERES 95 The CommarndblpneOUutpUl ert A A A 95 Run Option Global Properties cccccceccccceceeeeeeeeceeeeaeaaeeeeeeeeeeeeesaacecaaeeaeceeeeeeeeeeesedecaecaeeeeeeeeeneseeecncanaeeeeeeeees 95 The RemoteWorkInterval sita tada 95 The ImagesSearch Tim
116. ngleColumnMode is off the OCR engine may detect multiple columns and order lines of text accordingly in the return value TextLanguage anguage This property determines which character sets are valid for your ReadText return value TextLanguage can include multiple languages separated by commas such as English French German The default TextLanguage is English Trim boolean When Trim is on the OCR engine trims each edge of the ReadText rectangle until a non background pixel is encountered The background color is taken from the top left pixel of the rectangle or the TrimColor property The default value of Trim is off TrimBorder integer When Trim is on TrimBorder is the pixel width of background that is not trimmed from the ReadText rectangle The TrimBorder can be set to a negative number to trim non background edges from the rectangle The default TrimBorder is 0 TrimColor color When Trim is on TrimColor is the color that is considered the background of the ReadText rectangle If you do not set the TrimColor property the background color is taken from the top left pixel of the rectangle TrimTolerance integer When Trim is on TrimTolerance is a measure of how much a pixel can differ from the RGB value of the TrimColor and still be considered background The default TrimTolerance is 0 TrimWhitespace boolean When TrimWhitespace is on all whitespace characters are removed from the beginning and end of returned text Wh
117. o TIG The Pango TIG is not bundled with EggPlant To install the Pango TIG download the bundle from TestPlant down loads and save the download in the Library Frameworks directory or in the Library Frameworks directory of your user account Text Styles The Text Styles pop up menu contains all of the defined text styles for the current platform Each style includes a defined font size text color and background color it may also include bold italic or underlined text For information on using styles see The Find Text Panel To display and edit a text style choose it in the Text Styles pop up menu www testplant com EggPlant Reference Manual 65 Note Typically a text style corresponds to a particular type of graphical interface element such as menu item or title bar Adding a Text Style To define a new text style click the Add button The new text style is created with the same initial settings as the text style that was displayed when you clicked the Add button you can save time by choosing a text style that has some attributes in common with the new text style Removing a Text Style To remove a text style from the current platform choose the text style in the Text Style pop up menu and click the Remove button This action requires confirmation and it cannot be undone Font and Size Fields In the Font and Size fields type or choose a font and size for the current text style Note The fonts in
118. of image property lists for multiple image refer ences Depending on the data that is available the list can contain the following properties ImageName The name of the image file SearchType Precise Tolerant or Text Tolerance A number that represents the acceptable difference between the image and a match in the Viewer window You can set a single value that is used for red green and blue or three separate values separated by commas Discrepancy The percentage of pixels with a percent sign or number of pixels with no percent sign by which the image and a match in the Viewer window can differ Pulsing Whether or not the search type allows for pulsing returns a true or false value ClipRectangle With 0 0 being the top left corner of the image the cliprectangle is a pair of coordinates that define a rectangle within the captured image Only the pixels inside this rectangle are considered for image matches SearchRectangle With 0 0 being the top left corner of the screen the SearchRectangle is a pair of coordinates that define a rectangle in the Viewer window EggPlant only looks for this image within the defined rectangle www testplant com EggPlant Reference Manual 81 ImagePath The full pathname of the image file HotSpot The Hot Spot coordinates within the image ImageSize The image s size in pixels given as width height CaptureLocation Coordinates that indicate the position of the top left
119. ommandKey d KeyUp AllKeys Parameters Keyboard characters in quotation marks TypeText keywords with no quotation marks Behavior Releases keys that have been held by the KeyDown command Note You can use the keywords AllKeys AllModifierKeys and AllNonModifierKeys to release all keys of those re spective groups ReadTable Function Example Log ReadTable foundImageLocation foundImageLocation 200 600 Parameters One rectangle in which you want to read text and an optional property list that includes any number of the properties listed under the ReadText function Behavior Returns the text of a table as a list The returned list contains one sublist per row of values with each sub list containing one value per cell detected within that row The sublists for the rows may or may not contain the same number of values Note The ReadTable function performs best when the bounds of the table are included in the rectangle If no table is found within the given rectangle an error is thrown ReadText Function Examples Log ReadText addressCoordinates Log ReadText rectangle addressCoordinates multiLine true Parameters A property list that includes a rectangle and any number of the properties listed below or a stand alone rectangle value that may be followed by a property list DPI integer Dots per inch of the SUT screen The default DPI is 72 Contrast boolean When Contrast is on the OCR engine
120. ommands in Using EggPlant Log The Log command creates a custom entry in a script s execution log To insert a Log command click the Log button and type an entry into the Log panel If you provide multiple param eters each one is added to the script as a separate entry Note You can see the execution log in the Results pane of the Suite Editor For more information see The Results pane in The Suite Editor Comment The Comment button opens a panel in which you can type a comment for the active script The comment is inserted into the script in the form Comment For more information see Comment in The Script Editor Record Movie Stop Movie currently Mac OS X only The Record movie button opens a Save dialog in which you select a location to save your QuickTime movie Recording starts when you click the Save button All screen updates from the SUT are recorded in the movie whether they are caused by a script your interaction with the Viewer window or a user operating the SUT directly To end the movie click the Stop movie button Note The Record movie button does not create a script command to add movie recording to a script you must edit the script manually Capture Screen The Capture screen button takes a snapshot of the entire Viewer window of your SUT Although screen captures in your Images directory appear in the Images pane of the Suite Editor they are not added to a script when you choose Capture
121. on scriptlogging yes SetOptions searchrectangle 2 4 100 4 scriptlogging yes SetOptions JoesOptions Parameters One or more global properties and the values you are changing them to For more information see Global Properties Behavior Changes the value of run options for the current script GetOption GetOptions Functions Examples put GetOption scriptLogging put GetOptions runOptions put GetOptions Parameters One or more global properties or global property groups The global property groups are RunOptions the properties described in RunOption Global Properties TextOptions CurrentTextPlatform and TextPlatforms OtherOptions CommandLineOutput ImageDoctor ScriptAnimation and ScriptTracing Returns A global property list Behavior Returns the current value of the given global properties Tip If you do not request specific global properties GetOption returns a list of all Run Option global properties and their current values For more information see Global Properties Hide RunWindow Show RunWindow Commands Example Hide RunWindow Show RunWindow Parameters None Behavior Hides or shows the Run window Tip You can use the Hide command to close the Run window when you do not need to watch a script run and insert a Show command to reveal the Run window for the parts of the Run that you want to see Hide RemoteWindow Show RemoteWindow Commands Example Hide RemoteWindow Show Re
122. ons Eggplant app runscript Users Alex appTests suite Scripts testl script params SUT1 phonebook txt Each parameter is passed as a text string Runscript Options The options described below can be added to a runscript line To add multiple options insert a space before each one CommandLineOutput Use Controls whether script logs the data shown in the log area of the Run window are output To output script logs set the CommandLineOutput global property to yes To turn off this output set the CommandLineOutput global property to no Example Applications Eggplant app runscript Users Alex appTests suite scripts test3 script CommandLineOutput NO You can also set the CommandLineOutput global property within a script Global properties that are changed in a script always override initial settings Note Output set to standard error stderr is always displayed For finer control over the output while running from the command line you can use this syntax in your script write THIS IS SOME OUTPUT to error www testplant com EggPlant Reference Manual 102 Connection Information host port password colorDepth Use The host argument is the server ID of a specific SUT to use for your scripts When you pass in a host argu ment you can also specify a port password and color Depth Example Applications Eggplant app runscript Users Alex Docs suite scripts myTests test2 script host SUT1 port 5901 pa
123. owing properties LogFile The name and absolute path of the Log file Errors A count of errors logged for that run Warnings A count of the warnings logged for that run Exceptions A count of the EggPlant caught and uncaught exceptions raised Duration The length of time the script ran or has been running given in seconds RunDate The date and time the run was started Status The status of the run Success Failure or Running ReturnValue The returned value of any return statements SendMail Command Example sendmail to testmanager somecompany com testerl somecompany com subject Test failed body The very important test script generated an error The log file is attached attachment logfile Parameters One property list described below Behavior Sends e mail from within a script The parameters are contained in a property list described below smtp host The host name or IP Address of the mail server smtp type The authentication scheme used by the mail server None Plain Login or CRAM MD5 smtp user The user account on the mail server used if an smtp type is specified smtp password The password for login to the mail server used if an smtp type is specified smtp port The port used to connect to the mail server The default value is 25 the standard mail port To One or more addresses separated by commas Required From The user account sending the message Require
124. own toolbar For more information on adding and removing toolbar buttons see Customize below Enter Capture Mode Enter Live Mode This button toggles the Viewer window between Live Mode and Capture Mode When you click the Enter Capture Mode button it turns to Enter Live Mode button and vice versa Note You can also toggle between Live Mode and Capture Mode quickly by pressing Command You can select a different key to perform this action in Viewer window preferences Full Size Scale to Fit This button toggles between showing the Viewer window at the SUT s full display size and showing the entire SUT scaled to fit the size of the Viewer window Note Switching between the sizing options has no effect on image captures or matching Capture Image The Capture Image button takes a snapshot of the Capture Area For more information see The Capture Panel Use Image The Use Image button opens the Use Image panel in which you can select a saved image to use in a script Option clicking a command button also opens a Use Image panel At the bottom of the Use Image panel there is a pop up menu of EggPlant commands and functions that you can insert into the script with your selected image For more information see The Use Image Panel www testplant com 21 EggPlant Reference Manual 22 Find Text The Find Text button formerly the Text Image button opens the Find Text panel which allows you to search for text base
125. r click the magnifying glass in the Search field and choose Search All Search Names or Search Scripts from the pop up menu www testplant com EggPlant Reference Manual 42 Creating a new script To create a new script click the New button The script is added to the Scripts pane and a new Script Editor opens Deleting scripts To delete the selected script or scripts click the Delete button or drag the scripts into the Trash All Script Editors associated with deleted scripts close Opening scripts To open the selected script or scripts click the Open button or double click a script name Running a script To run the selected script click the Run button or choose Run menu gt Run Script Info The Info button opens and closes a panel that contains supplemental information about the selected script Script Name First Tutorial script Script Description Statistics LastRun Fri 1 5 07 11 01 51 AM First Run Wed 1 3 07 12 13 19 AM Modified Wed 1 3 07 2 18 44 PM Size 57 Runs Success Failure 10 7 3 70 0 30 0 Avg Time 0 00 02 Reset The Script info panel Script Name This text field contains the name of the script If you edit the name it is also changed in the Results pane The underlying Results folder also reflects the name change Note If you change the name of a script remember to edit calls to that script to reflect the new name Script Description This text field is a good place to record
126. r access that helper suite s scripts images and other helper suites The Settings pane The Settings pane contains general information about the suite including your notes and the location of the Results directory www testplant com EggPlant Reference Manual AD Me Windows_Tests suite Scripts Images Results Schedule Helpers i Suite Version 4 0 Upgrade Suite Description These tests validate user interface elements Results Directory Users pamela EggplantTests Eqggplant_Regression W Browse ES 55 The Settings pane Suite Version Displays your EggPlant version number To automatically update your scripts that are effected by changes to the SenseTalk scripting language click the Update button Suite Description This text field is a place for you to record your own notes about the current suite Results Directory This text field contains the file path of the current suite Click the Browse button to select a new directory in the file browser www testplant com EggPlant Reference Manual 56 Licenses and Preferences The License Registry panel The License Registry panel displays information about the EggPlant Licenses available and in use on your network When you launch EggPlant the license registry checks to make sure there is a license available Entering a New License Fill in the Key field and User Name field EggPlant finds your HostlD in your computer s System pr
127. r win dow If no image is found in the maximum wait time an exception is thrown WaitForAll Command Example WaitForAll 6 5 Somelmage SomeImageFolder WaitForAll 10 milliseconds SomeImage SomeImageFolder SomeImage2 Parameters A maximum wait time and one or more image references The default unit of maximum wait time is seconds You can also specify minutes and milliseconds Behavior Halts the next line of script execution until a of the image parameters are found in the Viewer window If all images are not found in the maximum wait time an exception is thrown Note If an enclosed list of images is passed as a WaitForAll parameter EggPlant considers that parameter found when any one of the items on the list is found For example WaitForAll crust sauce peppers olives This command has three parameters crust sauce and a list of two other items enclosed in parentheses It can be thought to mean WaitFor crust and at the same time WaitFor sauce and at the same time WaitFor peppers olives WaitFor either of these items www testplant com EggPlant Reference Manual 78 RefreshScreen Command Example RefreshScreen Parameters None Behavior Forces the Viewer window to update and redraw the SUT This is not usually necessary however if you find that a particular operation produces screen artifacts you can use this command to eliminate the artifacts Note The Fo
128. rceScreenRefresh global property causes the Viewer window to refresh after every script com mand For more information see the ForceScreenRefresh in Global Properties ImageFound Function Example Put ImageFound 10 SomeImage Put ImageFound SomeImage Parameters One or more image references can also take a maximum wait time as the first parameter Returns True or False Behavior Searches for the given images in the Viewer window returns true if an image is found and false if no im age is not found A maximum wait time parameter allows time for an image to be found before false is returned Note A maximum time of 0 causes EggPlant to perform an immediate search without refreshing the Viewer window or repositioning the mouse in a further attempt to find the image This is the fastest way to search for an image that may not be present ImageLocation Function Example Put ImageLocation ImageName Parameters One or more image references Returns Coordinates Behavior Searches for given images in the Viewer window returns the coordinates of the first image found If no image is found an exception is thrown EverylmageLocation Function Example put EveryImageLocation SomeImage SomeOtherImage Image3 Parameters One or more image references Returns The coordinates of every instance of the given image or images Behavior Searches the Viewer window for all occurrences of the given images
129. record of the run Deleting Script Names and Run Dates The Delete button deletes the selected Script name or Run Date and associated results resources This action re quires confirmation www testplant com EggPlant Reference Manual 48 Run Date deletions do not change a script s statistics The Log Area When you select a Run Date in the list the Log Area shows the detailed log for that run The log shows each step of the script that executed an EggPlant command or function you can double click any step to open the Script Editor with that step highlighted Note The EggPlant commands are an extension of the SenseTalk scripting language and they are described in this manual For more information on using the core Sensetalk language for advanced scripting see the Sense Talk Reference Manual For each numbered line of the tested script the Log Area provides the following information Time The Time column shows the local system time when each step occurred Times are recorded to the nearest thou sandth of a second You might have to widen the column to see fractional seconds Message The Message column displays the name of the function or command that was executed In SenseTalk command and function calls are referred to as messages If an error occurred in the line Exception is displayed If the exception was not caught the following line displays Failure Image The Image column displays the name of any ima
130. returns a list of the Hot Spot coordi nates for every occurrence of the images If no image is found EveryImageLocation returns an empty list Tip When you call the EverylmageLocation function you can immediately call the result to return Imagelnfo for every image represented in EverylmageLocation Example put EveryImageLocation dog cat Returns a list of coordinates for every instance of these images put the result Returns imageInfo for every coordinate pair returned by EveryImageLocation Image Information Functions The functions in this section return various properties associated with images www testplant com EggPlant Reference Manual 79 Imagelnfo Function Example Put ImageInfo into ListVariable Parameters One or more image references Returns An image property list or ist of image property lists Behavior Returns an image property list for a single image or a list of image property lists for multiple image refer ences Depending on the data that is available the list can contain the following properties ImageName The name of the image file SearchType Precise Tolerant or Text Tolerance A number that represents the acceptable difference between the image and a match in the Viewer window You can set a single value that is used for red green and blue or three separate values separated by commas Discrepancy The percentage of pixels with a percent sign or number of pixels
131. s as the platform that was displayed when you clicked the Add button Removing a Platform To remove a platform from Text preferences choose it in the Platform pop up menu and click the Remove button You cannot remove the default platform unless you name a different default first www testplant com EggPlant Reference Manual 64 Platform removal requires confirmation and it cannot by undone Set As Default The default platform is the initial value of the CurrentTextPlatform global property in your scripts To set a platform as the default choose it in the Platform pop up menu and click the Set as Default button The de fault platform name is displayed in bold text Text Engine In the Text Engine pop up menu you can choose whether you want to search for your text with OCR optical charac ter recognition or a text image generator specific to your SUT The choices are listed in the table below Text Engines Name Operating System Additional Details External TIG Windows Host The host name or IP address of the computer that is hosting your TIG To use a TIG on the current SUT type Current SUT Port The port on which the TIG host communicates The default port is 5899 Native TIG Mac OS X Currently included in EggPlant on Mac OS X only OCR Search Any operating system Pango TIG Linux See note below Scripted TIG Custom Command The name of the TIG script Note Installing the Pang
132. s for the SUT to perform a task before sending the next event from a script This is an important timing parameter for regulating the overall speed of interactions with the SUT The ImageSearchTime Example Set the ImageSearchTime to 5 www testplant com EggPlant Reference Manual 96 Value Time in seconds Default 1 8 Description The ImageSearchTime determines the length of time EggPlant searches for an image before reporting a failure The ImageSearchCount Example SetOption ImageSearchCount 3 Value A positive integer Default 7 Description The ImageSearchCount determines the number of times EggPlant scans the Viewer window search ing for an image Note Setting the ImageSearchCount to 1 causes image searches to look at only the current Viewer window bypassing any ImageSearchDelay screen refreshes and mouse repositioning This is the fastest way to perform a search but it can be prone to failure The ImageSearchDelay Example Set the ImageSearchDelay to 6 Value Time in seconds Default 0 3 Description The ImageSearchCount determines the wait time between searches for an image The KeyDownDelay Example SetOption KeyDownDelay 05 Value Time in seconds Default 0 001 Description The KeyDownDelay determines the wait time between keyDown and KeyUp events sent to the SUT The NextKeyDelay Example SetOption NextKeyDelay 08 Value Time in seconds Default 0 02 Description The NextK
133. s literal text Markups are always treated as literal text for text platforms that use the OCR text engine For more information see Using Marked Up Text in Using EggPlant The DefaultTextStyle Examples setoption DefaultTextStyle StyleOne set the defaultTextStyle TextFont to Helvetica Value A text style property list Default The default text style of the current platform Description The DefaultTextStyle is a shortcut to the default text style for the current text platform Changes you make here are reflected in the CurrentTextPlatform global property and vice versa The RemoteClipboard Examples set the RemoteClipboard to Hello setOption RemoteClipboard Hello Value Contents of the remote clipboard Default None Description The RemoteClipboard provides access to the clipboard of the SUT By modifying this global prop erty you change the contents of the SUT s clipboard Tip You can also view and modify the SUT s clipboard with the Remote Clipboard function and the SetRemoteClipboard command www testplant com EggPlant Reference Manual 94 The RepositionPoint Example SetOption RepositionPoint 1280 1024 Value One pair of screen coordinates Default A dynamic point near the lower right corner of the Viewer window Description The RepositionPoint determines where the mouse is repositioned during image searches Positive coordinate values are relative to the top left corner of the scree
134. ssful result For more information see Search Type Tolerance The number in this field represents the acceptable difference between RGB color values in the image and a match in the Viewer window If you enter a single value it is used for all three color channels You can also enter three separate values separated by commas Note When you edit the Image Tolerance value it is no longer automatically changed when you choose a differ ent search type If you delete this value the image is effected by search type again The Screen Tab in Run Option preferences Discrepancy A percentage in this field including the percent sign indicates the percentage of pixels that may differ between the actual image and a match in the Viewer window A number in this field with no percent sign indicates the absolute number of pixels that may differ between this image and a match in the Viewer window Image Description This area displays the image size in pixels and the image file size in bytes You can type comments about the image in the text field and use the text of these comments as image search terms or CollectionFilter values For more information see Searching for Images above or the CollectionFilter in Global Properties Deleting Images or Image Folders To delete the selected images and or folders drag them to the Trash or click the Delete button The Results pane The Results pane contains records of the tests you have run in th
135. ssword broncos colorDepth 16 Note A Connect command from within a running script or connection information in a schedule overrides this con nection This connection remains open but the new connection becomes the active connection GlobalResultsFolder Use Sets the name of the folder in which your script results are stored The folder path can be absolute or relative to the script s suite Example Applications Eggplant app runscript Users Alex Docs suite scripts test2 script GlobalResultsFolder MyResults repeat Use Repeats the scripts you are running x times Example Applications Eggplant app runscript Users Alex myTests suite repeat 4 ReportFailures Use Reports the number of failed scripts and suites back to the command line after script execution If you do not set ReportFailures to yes EggPlant reports the number of successful scripts and suites to the command line Example Applications Eggplant app runscript Users Alex Docs suite ReportFailures yes Launching the EggPlant GUI from the Command Line To launch the full GUI EggPlant application from the command line type the path to the EggPlant executable Example Applications Eggplant app Contents MacOS Eggplant Command Line Options AlertOnError Use Overrides the EggPlant General Preference Show alert when a connection fails Takes a yes no value Example Applications Eggplant app Contents MacOS Eggplant AlertOnError yes AutoShowRunWin
136. t The Control Menu The Control menu contains many of the features that are in the Viewer window toolbar For more information on these menu items see The Viewer Window Enter Capture Mode Enter Live Mode Enter Capture Mode disables your remote control of a SUT so you can use your local EggPlant tools to capture im ages in the Viewer window Capture Mode dims the Viewer window making the selected Capture Area stand out at normal brightness For more information on capturing images see Capture Mode in The Viewer Window Enter Live Mode restores your remote control of the SUT To toggle between Capture Mode and Live Mode quickly press Command You can change the toggle key in Viewer preferences Capture Image When the Viewer window is in Capture Mode Capture Image takes a snapshot of the Capture Area www testplant com EggPlant Reference Manual 11 Use Image Use Image brings up an Open panel in which you can select a saved image to use in your script Find Text Find Text formerly Text Image allows you to search for text based on content and formatting properties Script Command submenu The Script Command submenu contains common EggPlant script commands and functions Each menu item inserts the indicated command into the current script For more information see The Viewer window Toolbar in The Viewer Window Control Panel The Control panel allows you to enter Full Screen Mode viewing the SUT in pl
137. t have been made since the previous release When you update to a new version please check the Release Notes to read about significant changes to the soft ware Submit Question Report Bug Request Feature These three menu items open an EggPlant Support Request panel www testplant com EggPlant Reference Manual 14 The Connection List The Connection List contains the names and other information about all of the SUTs you can control through EggPlant For more information see EggPlant Getting Started The Connection List Host QA compa 5905 WindowsXP 192 168 1 5900 WindowsDe 192 168 1 5900 Wall E 192 168 1 5900 Ubuntud 192 168 9 5900 The Connection List Connection List Data Millions GA compi pamela Millions Conn Millions Conn Millions Millions ae Y The columns in the Connection List contain the following information for each SUT Status The Status column indicates the SUT s availability denoted by a color coded dot To receive a status update choose Connection menu gt Availability Connection List status colors Color Meaning Q Green Connected e Blue Available Q Gray Unavailable Q Yellow Unknown Q Partial Yellow Connecting Q Red Error Q Gold Halo Active Connection www testplant com EggPlant Reference Manual 15 Name The Name column refers to the display name a SUT sends to EggPlant Before EggPlant connec
138. t area displays a preview of the way text appears with your current colorization settings Enable syntax coloring Select this checkbox to turn on automatic script colorization Update colors continuously while typing Select this checkbox to automatically update colors in the current script line as you type If this feature is turned off script colors are updated when you insert a comment paste save or press Return Colorization Settings These settings allow you to customize the colorization of different script elements For each script element select the first checkbox to auto colorize it in the Script Editor To edit a script element s color click its color well and select a new color in the standard Colors panel Select the Bold checkbox to display the script element in bold text Run Option preferences Run Option preferences are the default values of frequently used run options To change these values for an individual script use the SetOption command or set the global property within the script For more information see Global Properties To restore all run options from all four tabs to their default value click the Restore Defaults button at the bottom of the preferences panel The Mouse pane The Mouse settings determine specific mouse behavior in the Viewer window during script execution Mouse Click Delay This value represents the time between the press and release of a mouse click on the SUT Double
139. te Run Script Connection vi Uninstall EggPlant script Mac Tests suite Ubuntu9 LaunchEggPlant script Ivi processes script vi WindowCapture script The Schedule pane www testplant com EggPlant Reference Manual 51 Adding Scripts to the Schedule There are three ways to add scripts to the schedule 1 Click the Add button on the bottom of the Schedules pane select the script from the Add panel 2 Inthe Scripts pane drag script names to the Schedules pane 3 Inthe Script Editor title bar drag the script icon to the Schedules pane in the Suite Editor Providing a Script s Connection Details When you run a script from the Schedules pane you can provide connection information to specify a SUT for the script run To specify a SUT for a selected script click the Info button to open the Info panel There you can enter a host name or IP address VNC port number and password If you need to establish a secure connection you can also provide connection and login information for an SSH host Connection Server 192 168 1 23 eO Port Num 5901 Passw Ord ssssssessss 55H User Seraei SSH Pass sess SSH Host 129 120 2 45 Y Remember 55H Password Status The Schedule info panel Changing the Run Order You can move a script to a different place in the schedule by dragging it To move a range of scripts Shift drag the script names to a new location To move multiple nonsequential scripts toget
140. te for your mail server User Name and Password In these fields enter the user name and password of the account you use for authentication If None is chosen in the Authentication pop up menu these fields are not available www testplant com 66 EggPlant Reference Manual 67 EggPlant Commands and Functions The commands and functions defined in this section are an EggPlant extension of the SenseTalk scripting language To incorporate the general Sensetalk commands and functions into your scripting see the Sense Talk Reference Manual For reference tables of EggPlant commands and functions see Appendix A and Appendix B respectively Command and Function basics Commands and functions are used very similarly The significant differences between them are Functions always have return values commands may have return values Functions are typically used as parameters to commands Commands must be written alone not part of a statement functions must be part of a statement Syntax Guidelines 1 Separate command and function parameters with commas Example Click SomeImage SomeOtherImage 2 Enclose function parameters in parentheses Example ImageLocation ThisImage ThatImage Data types used in EggPlant Commands and Functions This section defines the following data types used with EggPlant commands and functions numbers coordinates strings and property lists Numbers Single numbers passed as par
141. te is searched Suites named in the InitialSuites are searched first followed by the script s own suite and then the FinalSuites The SearchRectangle Example setoption SearchRectangle 10 12 100 4 Values Two image locations or two pairs of coordinates indicating diagonal corners of the searchrectangle Regardless of the form you pass in the return value is displayed as x y x y Default The full Viewer window Description Limits the area that EggPlant searches for images in the Viewer window Tip To reset the searchRectangle to the full Viewer window set the value to empty or fullscreen The TextPlatforms Example Put GetOption TextPlatforms Value A text platform property list Default Set in Text preferences Description The TextPlatforms global property contains the following properties for all of your text platforms Name Name of the text platform Generator The text image generator TIG used by the platform Styles The properties of each of the platform s defined text styles Text Style Properties For each text style the following properties are available TextFont The text s font such as Helvetica TextSize The text s size in points TextColor By default this is an RGB value For more information see Working with Color in the SenseTalk Reference Manual TextBackgroundColor By default an RGB value indicating the text s background Italic A yes or no value
142. the movie is saved in the suite s Results directory To end the recording insert a StopMovie command into the script Tip Movies are recorded with no compression be sure to allow ample disk space when you are recording movies StopMovie Command currently Mac OS X only Example StopMovie Parameters None Behavior Stops a movie recording that was started by the script SUT Commands and Functions These commands and functions pertain to VNC connections and the SUT s native display AllConnectionInfo Function Example put AllConnectionInfo into HostList Parameters None Returns A list of connection property lists for all of the SUTs in the Connection List Behavior Returns all connection property lists Connect Command Examples Connect 192 168 1 110 Connect serverID RedHat test portNum 5902 Visible Yes Parameters A host name IP address or display name from the Connection List Alternative Parameter One connection property list Behavior Opens a VNC connection with a SUT or makes a connected SUT the active SUT Note If the SUT is not in your Connection List or you need to override information in the Connection List you can pass in a connection property list instead of just a host name IP address or display name The connection properties are described below Server ID The host name IP address This is the only required property PortNum The port number used by the VNC server o
143. this to run scripts without saving changes Save that script Select this to auto save script changes before running scripts Save all scripts Select this to auto save all open scripts before running the current script Ask Select this to be alerted to unsaved script changes when you run a script Note When a running script calls another script the called script is read from the currently saved copy If you have unsaved changes in the called script they are not executed When a script is modified This preference determines what EggPlant does if another user saves changes to a script while you are using it Ignore Select this to keep the script as it currently appears on your desktop without loading the newly saved version Reload the script Select this to reload your script when EggPlant detects that the saved version has changed Ask to Reload Select this to have EggPlant ask you whether to keep the current version or load the saved version of your script www testplant com EggPlant Reference Manual 60 Reload breakpoints from last save Select this checkbox to automatically reset saved breakpoints when you open scripts Allow Text Drag and Drop Drag and drop text is enabled in the Script Editor by default Deselect this checkbox if you do not want to be able to move text by dragging it Default Script Font This field displays the default font of your text in the Script Editor New text and plain text lo
144. tion font and print panels found in many applications www testplant com EggPlant Reference Manual 35 The Run Window The Run window displays information about the currently running script In the Run window you can manually control Script execution view script output as it is generated and follow the progress of the script with animation or tracing 6006 Last Run CursorException script E Click foundimageLocation put foundimageLocation 0 100 Into top sun 4 25 10 7 10 33 PM START Running CursorException script gt gt gt 07 10 33 Start handler 1 cursorexception Sun 4 25 10 7 10 33 PM set IMAGESEARCHCOUNT 2 gt gt gt 07 10 34 Start handler 2 heading1 Sun 4 25 10 7 10 34 PM set SCRIPTANIMATION z Off Sun 4 25 10 7 10 34 PM set SCRIPTTRACING Off The Run window Script Display area The Script Display area is the top half of the Run window When script animation is turned on the currently executed handler is displayed here When script animation is turned off the initial handler is displayed but it is only updated when the script is paused Note A handler is a unit of execution in SenseTalk If a script does not explicitly declare a handler the entire script is treated as a handler For more information on handlers see the SenseTalk Reference Manual Dynamic breakpoints Dynamic breakpoints are markers that cause a script to pause for debugging at designated points They can be added or c
145. to different locations within the toolbar www testplant com EggPlant Reference Manual 25 The Image Panels This section describes the panels you use to create images and insert existing images into your scripts Capture Panel The Capture panel is similar to a Save dialog with some additional script and image controls Image Name Field The Image Name field defaults to a dynamically generated name that is unique to the current suite beginning with image0001 This name may be sufficient for temporary scripts and experimentation but more descriptive names are easier to follow as you start scripting in earnest Image names can contain alphanumeric characters spaces and most punctuation marks Where Pop Up Menu The Where pop up menu displays the folders in which you can save an image The default choice is the Images folder of the current suite Creating a New Folder To create a subfolder within the currently selected folder click the New Folder button Making an Image Collection To make an Image Collection based upon an existing image select the image and click the Make Collection button The Image Collection takes on the same name as the image and the image is automatically moved into the Image Collection Image Well The central portion of the Capture panel is an image well that displays the captured image The Hot Spot in the image is indicated by red cross hairs To move the Hot Spot Command click in the imag
146. ts to a SUT the Name column displays the same information as the Host column Tip To insert the name of a SUT into a script quickly drag it from the Connection List to the Script Editor To insert a connection property list into the script Option drag the SUT to the Script Editor Host The Host column displays the SUT s host name or IP address Color The Color column displays the setting you choose in the Color Depth menu Port The Port column displays the number of the port on which the SUT listens for VNC connections SSH Host The SSH Host column displays the host name or IP address of the computer that hosts an SSH tunnel for the SUT s secure connections SSH User The SSH User column displays the account name with which the SUT user logs into an SSH host Activity The Activity column displays a running description of your VNC connection Adding or Editing a SUT in the Connection List 1 Inthe Connection menu choose Connection List 2 In the Connection List Click Add or select a SUT and click Edit Fill in the text fields with the SUT s VNC server information Server Host Name or IP The remote computer s host name such as vine testplant com or IP address Port The port number of the VNC server 5900 5909 Username if required Your user account on the SUT Some VNC servers require your system level account name and password as authentication www testplant com EggPlant Reference Man
147. tyle Either the name of a text style or a list of text properties defined in a script Generated TIG text properties TextFont The name of the font used TextSize The size of the text in points TextColor The color of the text TextBackgroundColor The background color of the Text Image Bold Whether the font is displayed as bold true or false Italic Whether the font is displayed in italics true or false Underline Whether the text is underlined true or false HotSpot Coordinates of the Hot Spot within the image ImageName Name of the Text Image file File extension is not used ImagePath File path of the Text Image file SearchType Precise Tolerant or Text Pulsing Whether the search type allows for pulsing true or false CaptureLocation Coordinates of the Text Image the last time it was found ImageSize Width and height in pixels Trim Whether or not extra space is trimmed away from around the text Cache Whether a cached Text Image is used if available Anti aliasing Pango TIG only Whether text anti aliasing is on or off UseMarkup Whether supported markup tags are recognized as text attributes on or treated as string literals off Generic OCR text properties CaseSensitive Whether text searches consider case Contrast Whether the SUT display is internally seen as a two color image ContrastColor The color that is considered the primary color when contrast is on ContrastTolerance The maximum per channel difference allowed or a pi
148. u call the setOption command to set a global property value do not insert the word the before the name of the global property SetOption is an EggPlant command that takes only global properties so there is no need to distinguish a global property with the To set multiple global properties with the setOptions command pass a global property list in parentheses as you would always pass a list Examples setoption searchrectangle 1 2 2 3 setoptions searchrectangle 1 2 2 3 scriptlogging yes Tip To restore all settings to their default value call Setoptions with the parameter OriginalSettings GetOption and GetOptions Functions These functions return the value of a global property getOption or list of global properties getOptions Enclose single global properties and global property lists in parentheses as you would for any function Example put getOptions searchrectangle put getOptions searchrectangle scriptlogging www testplant com EggPlant Reference Manual 91 EggPlant Global Properties These properties pertain to the EggPlant application in general The CollectionFilter Example Set the CollectionFilter to Description 2007 Set the CollectionFilter to Name English Description release 5 0 Values A property list that contains one or both of the properties Name and Description Default No filter Description Limits image searches to those images whose names or descriptions contain th
149. ual 16 Password The password required by the SUT s VNC server Server IP Address or Host Name Port New Server 5900 Username if required Password Display Name Color Depth Default Millions HH E Skip Availability Check C Connect Securely SSH Cancel 7 _ Adding a SUT to the Connection List Changing Color Depth To increase the speed of your VNC connection you can decrease the color depth with which the Viewer window draws a SUT To increase or decrease color depth choose a value in the Color Depth pop up menu Choose Default to draw the SUT with the same color depth you see on its native display Note If you change the color depth of a SUT images you captured in the former color depth might not match the SUT in the current Viewer window Opening Secure Connections Secure Shell SSH is a network protocol that uses data encryption to transfer information securely On Mac OS X you do not need to install any additional tools to open SSH encrypted connections in EggPlant For EggPlant to connect to a SUT securely the SUT must be able to host an SSH tunnel or have a secure connec tion with another computer that can host an SSH tunnel You must have a user account on the SSH host computer Connecting to a SUT with SSH For EggPlant to connect to a SUT securely the SUT must be able to host an SSH tunnel or have a secure connec tion with another computer that can host an SSH tunnel You must ha
150. urrent script When a script has unsaved changes there is a dot in the red close button in the top left corner of the window The dot disappears when the script is saved Note By default EggPlant automatically saves scripts when you run them You can change this behavior in Script Editor preferences www testplant com EggPlant Reference Manual 33 Run Script Abort Script The Run Script button executes the script While the script is running the Run Script button is changed to Abort Script Clicking this button is the same as choosing Run menu gt Run Script or Abort Script While a script is running and not paused you cannot perform any manual actions in the Viewer window or open and close VNC connections To run a script in debug mode Option click the Run Script button This loads the script for execution and immediately pauses it allowing you to step through line by line This is the same as choosing Run menu gt Debug Script Run Selection The Run Selection button executes only the selected part of the script The selection does not have to include an entire line of code but it must be syntactically complete and executable For example if you select the beginning of an if block you must select all the way through the end if statement To run the selection in debug mode Option click the Run Selection button This loads the selection for execution and immediately pauses it allowing you to step through it line by
151. uting the next command This way you can allow an arbitrary length of time for the SUT to complete a task before proceeding with the script The Wait button opens a dialog in which you must specify the time in seconds of the Wait command Tip The WaitFor command has two advantages over the Wait command WaitFor delays the next action in your script only as long as necessary to locate the appropriate image while Wait delays the next action for a fixed period of time even if less time is needed The WaitFor command returns the time it took for its target image to appear If you use the Wait command you only know that the image appeared sometime in the Maximum Wait time frame TypeText The TypeText command sends text as keystrokes typed in the Viewer window allowing you to simulate typing on the SUT www testplant com EggPlant Reference Manual 23 The TypeText button opens a panel in which you can enter your text parameters When you create a TypeText com mand with this panel clicking the Insert button automatically encloses your text parameters in quotation marks in your script Note Text parameters enclosed in quotation marks are typed as literal text on the SUT Text parameters that are not enclosed in quotation marks are treated as variables Tip When the Viewer window is in capture mode you can start a TypeText command by typing the text you want to insert into your script For more information see Recording TypeText C
152. ve a user account on the SSH host computer www testplant com EggPlant Reference Manual 17 Setting up an SSH Login 1 In the Connection List select the SUT 2 Click Edit 3 Select the Connect Securely SSH checkbox 4 Fill in the Username and Password fields Username and Password refer to your user account on the SSH Host computer 5 In the SSH Host field enter the IP address or host name of the SSH host computer 6 Select the Remember SSH Password checkbox to save the password of the user account on the SSH host otherwise you must enter the password whenever you open a connection with the SSH host 55H Login Username pamela 55H Host myServer myCompany com wi Remember 55H Password _ Cancel SSH Login panel Setting up SSH in the SUT s VNC Server Application When you use SSH to connect to a SUT its firewall must allow connections on port 22 the standard port for SSH connections For more information see the SUT s VNC server documentation If you are using Vine Server see the Vine Server User Manual Allowing VNC Connections Opening a VNC Connection with a SUT There are several ways to open a VNC Connection with a SUT n the Connection List double click the name of the SUT Select the SUT and click Connect Select the SUT and choose Connection menu Connect www testplant com EggPlant Reference Manual 18 Note You can open a VNC connection from within a script b
153. wing text properties can be used with any text property list Text text string The text string that you want to find on the SUT Required TextPlatform text platform name The name of the text platform that generates the Text Image For more information see the TextPlatforms Global Property TextStyle text style name A group of predefined text properties For more information see The Find Text Panel Generic OCR Text Properties The following text properties can be used with the generic text platform or any text platform that uses the OCR text engine CaseSensitive boolean Whether or not EggPlant considers case in text searches TextLanguage language name The natural language of the text you are searching for Contrast boolean Whether or not the SUT display is internally converted to a high contrast two color image If contrast is on the contrast color is considered the primary color of the SUT display and all other colors are treated as the secondary color Text can be found in either color ContrastTolerance boolean When contrast is on contrastTolerance is the maximum per channel color difference that is allowed for a pixel to be seen as the contrast color The default contrast tolerance is 45 ContrastColor color name or value When contrast is on contrastColor is the color that is considered the primary color of the SUT display www testplant com EggPlant Reference Manual 71 Platform Specif
154. with no percent sign by which the image and a match in the Viewer window can differ Pulsing Whether or not the search type allows for pulsing returns a true or false value ClipRectangle With 0 0 being the top left corner of the image the cliprectangle is a pair of coordinates that define a rectangle within the captured image Only the pixels inside this rectangle are considered for image matches SearchRectangle With 0 0 being the top left corner of the screen the SearchRectangle is a pair of coordinates that define a rectangle in the Viewer window EggPlant only looks for this image within the defined rectangle ImagePath The full pathname of the image file HotSpot The Hot Spot coordinates within the image ImageSize The image s size in pixels given as width height CaptureLocation Coordinates that indicate the position of the top left corner of the image when it was captured in the Viewer window Description The image description in the Suite Editor Info panel ImageHotSpot Function Example Click ImageHotSpot SomeImage 20 32 Parameters A single image excluding Image Collections Returns Coordinates Behavior Returns the coordinates x y of the image s Hot Spot relative to the top left corner of the image ImageSize Function Example put ImageSize image into ImageSizeVariable Parameters A single image excluding Image Collections www testplant com EggPlant Reference
155. xel to be seen as the contrast color www testplant com EggPlant Reference Manual 11 5 TextStyle Properties Generated TIG textStyle properties TextSize The size of the text in points TextBackgroundColor The background color of the Text Image Italic Whether the font is displayed in italics true or false Generic OCR textStyle properties Contrast Whether the SUT display is internally seen as a two color image ContrastTolerance The maximum per channel difference allowed or a pixel to be seen as the contrast color www testplant com EggPlant Reference Manual Appendix F Pango Markup Tags Pango Markup Tags Currently Mac OS X only 1 lt sub small Bold Italics Subscript Smaller Underline www testplant com 6
156. y inserting a Connect command Tip If you are running a script that switches between SUTs you can save execution time by keeping both or all connections open rather than disconnecting and re connecting with each switch Closing a VNC Connection with a SUT There are two ways to close a VNC Connection manually In the Connection List select the SUT and click the Disconnect button While the SUT s Viewer window is the key window choose Connection menu gt Disconnect Note Closing a Viewer window does not close your VNC connection with the corresponding SUT Note You can close a VNC connection from within a script by inserting a Disconnect command www testplant com EggPlant Reference Manual 19 The Viewer Window The Viewer window shows an image of the SUT as you would see it on its own display In the Viewer window you can interact with the SUT as a user in Live Mode and capture images to use in EggPlant scripts in Capture Mode Note To toggle between Live Mode and Capture Mode quickly press Command You can select a different key to perform this action in Viewer Window preferences F e La ve Feb Tode Hep Que O fF sw rs a EQ ga edite Toca The Viewer window Live Mode In Live Mode you can use your local mouse and keyboard to interact with the SUT as a user This works just as if you were using the SUT s own keyboard and mouse directly If the Viewer window is not your active window your clicks

Eggplant Reference

Contents

Download Pdf Manuals

Related Search

Related Contents