AHK Test Suite

From ReactOS Wiki
Revision as of 12:39, 10 April 2013 by EDIJS (talk | contribs) (How to write new tests)
Jump to: navigation, search

What is AHK Test Suite

AHK Test Suite is testing framework written in AutoHotKey scripting language of goal to test applications automatically in ReactOS operating system. Test suite is ran in VBox. There are some details:

  • 512MB RAM addigned to VM;
  • VM haves 800x600 screen resolution
  • Hardware:
OCZ Sata3 SSD
  • Virtual HDD: SATA AHCI 8GB
  • 10-20MB/s Internet connection
  • 60sec from last debug output until "[SYSREG] timeout".
  • VM OS username: Administrator

How to download AHK Test Suite

If you have TortoiseSVN create a folder you want AHK Test Suite to be downloaded to (e.g. C:\AHK_Test_Suite). Navigate your file manager to the created folder, right click and choose 'SVN Checkout'. 'Checkout' window will appear. Type 'svn://svn.reactos.org/project-tools/trunk/ahk_tests' in 'URL of repository' field and hit OK button and wait until things are downloaded.
SVN_Checkout_tortoise.jpg
Sadly, we do NOT host needed installers nor media files, but you can ask Edijus or Caemyr in IRC channel (irc.freenode.com, #reactos).

How to see test results

Online tests

If you want to see results of online tests you need:
1) Enter http://reactos.org/testman/ in your browser address;
2) Specify ReactOS revision number you want to check results of;
3) Enter 'CMake_x86_GCCWin' in 'Source' field;
4) Select up to five revisions using checkboxes provided;
5) Hit 'Compare selected Results' button.
Picture below demonstrates all the steps.
testman.jpg
Scroll down the newly opened page until you see tests that start with 'zz_' prefix.
Test_results.jpg

Compiling and running test manually

In order to run test you need to compile it. First, download the test (how to do so check titles above). When download is done, you need to compile using Ahk2Exe.exe (AutoHotKey v1.0.48.05 is used when compiling ReactOS tests). If you are planing to compile using GUI tool, there is the steps:
1) Run Ahk2Exe.exe;
2) When Ahk2Exe window appears, hit "Browse" button in in "Source (script file)" and open file that matches 'zz_*_test.ahk' file pattern (e.g. 'zz_firefox_2.0.0.20_test.ahk');
3) Hit "> Convert <" button and dialog box saying 'Conversion complete' will appear.
Picture below demonstrates all the steps.
Ahk2Exe.jpg
If compilation went successfully a 'zz_*_test.exe' (e.g. 'zz_firefox_2.0.0.20_test.exe') file will be created. There are dependencies. You gonna need exact the same test application version as described in test (e.g. 'Firefox 2.0.0.20'). Sadly, we do not provide any host links to test media we have for AHK tests. In case you managed to get everything you need (asked Caemyr, Edijus?) you need to create two folders in target machine 'Apps' and 'Media'. You put test program *.exe (e.g. 'Firefox 2.0.0.20 Setup.exe') in 'Apps' and rest of stuff (e.g. 'FF_2_Search_Arrow.jpg') in 'Media' folder. The compiled script executable goes into root folder.
Picture below demonstrates folder hierarchy.
Folders.jpg
Now, all you need is to start test executable by passing test name via command line (e.g. 'D:\AHK_Tests\zz_firefox_2.0.0.20_test.exe 1.install').
Start_Test_CMD.jpg
Results will be displayed in debug output. Debug output can be monitored with DebugView application.
Picture below demonstrates how results are displayed in DebugView application.
DebugView.jpg

How to write new tests

If you want to write test for completely new application, use those as templates:

Create two folders: 1 - Application name, 2 - Application version. E.g.: Firefox\2.0.0.20
This is so we could have same application tested, but different version e.g. Firefox\2.0.0.20, Firefox\3.0.11, Firefox\12.0, etc.
There are different ways of making application to do things. You can use mouse to click controls and you can use keyboard. Sending keystrokes is not most reliable thing to do, but sometimes applications haves no control names. In such case (e.g. Firefox 12.0 case) send keystrokes (e.g. Alt+N to click 'Next' button, etc.).
Tests for installers: first of all you have to remove all previous versions of applications. Use uninstaller with silent switches. If not possible, just delete hard-coded default path and settings if any.
Lets say some window takes long to close (some installers takes some time to extract files). Do not use something like WinWaitClose, Window Caption, Window Text, 60, because window may never close because of bugs in ReactOS code and some window just pop-out. Instead, write a loop. Something like this:

TestsInfo("'Window Caption (Window Tex)' window appeared, waiting for it to close.")
iTimeOut := 60
while iTimeOut > 0
{
    IfWinActive, Window Caption, Window Text    {
        WinWaitClose, Window Caption, Window Tex, 1
        iTimeOut--
    }
    else
    {
        WinGetActiveTitle, ActiveWndTitle
        TestsInfo("'" ActiveWndTitle "' window poped-up.")
        break ; exit the loop if something poped-up
    }
}

WinWaitClose, Window Caption, Window Tex, 1
if ErrorLevel
    TestsFailed("'Window Caption (Window Tex)' window failed to close (iTimeOut=" iTimeOut ").")
else
    TestsOK("'Window Caption (Window Tex)' window closed (iTimeOut=" iTimeOut ").")

We want tests to consume as less time as possible. sysreg will time out ([SYSREG] timeout) if there is no debug output in 60 seconds.
Do not create too many indentations - 5-8 is the number we would like to see.
If you do 'SendInput, Some text', do 'ControlGetText' or

clipboard = ; clean the clipboard
SendInput, ^a ; Ctrl+A
SendInput, ^c ; Ctrl+C
ClipWait, 2
if ErrorLevel
    TestsFailed("Unable to copy text onto clipboard.")
else
{
    szExpectedString = Some text
    IfNotInString, clipboard, %szExpectedString%
        TestsFailed("Copied text onto clipboard and got unexpected results. Is '" clipboard "', should be '" szExpectedstring "'.")
    else
        TestsOK("Filled 'Some field name' with '" szExpectedString "' in 'Some window (window text)'.")
}

to make sure you sent text to correct window and not some error box. File name and specific test name must match. For example test name '2.address_bar' and file name 'address_bar.ahk'. Test and file names are case sensitive. If you are trying to access some file, make sure it exist first. If you close application, make sure sure not only window has closed, but application process too.

How to get control names

You can use Spy++ application or this AHK script:

DetectHiddenText, Off ; Hidden text is not detected
Sleep, 3500


WinGetTitle, ActiveWndTitle, A
WinGetText, ActiveWndText, %ActiveWndTitle%
ControlGetFocus, FocusedName, %ActiveWndTitle%
ControlGetText, FocusedText, %FocusedName%, %ActiveWndTitle%
MsgBox, ActiveWnd: %ActiveWndTitle% `nFocused: %FocusedText% `nText: %ActiveWndText%


; This example allows you to move the mouse around to see
; the title of the window currently under the cursor:
#Persistent
SetTimer, WatchCursor, 100
return

WatchCursor:
MouseGetPos, OutputVarX, OutputVarY, id, control
WinGetTitle, title, ahk_id %id%
WinGetClass, class, ahk_id %id%
ControlGetText, FocusedText, %control%, A
ControlGet, ControlHwnd, Hwnd,, %control%, A
PixelGetColor, color, %OutputVarX%, %OutputVarY%
SetTitleMatchMode, 2
IfWinNotActive, Notepad
    ToolTip, ahk_id %id%`nahk_class %class%`n%title%`nControl: %control%`nControlText: %FocusedText%`nMousePos: %OutputVarX%x%OutputVarY%`nColor: %color%
return