AHK Test Suite

From ReactOS Wiki
Jump to: navigation, search

What is AHK Test Suite

AHK Test Suite is a testing framework written in the AutoHotKey scripting language.
Its purpose is to automatically test applications running under the ReactOS operating system.

AHK Test Suite runs in the VBox virtual machine (VM).
Configure VBox as follows:

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

How to download AHK Test Suite

If you have TortoiseSVN,
1) Create a folder you want AHK Test Suite to be downloaded to (e.g. C:\AHK_Test_Suite).
2) Navigate your file manager to the created folder.
3) 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.

Then, download Applications and Media from here.

Warning: these files are unmaintained. See ONLINE-716.

If something is missing 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.
Scroll down the newly opened page until you see tests that start with 'zz_' prefix.

Compiling and running test manually

In order to run a test, you need to compile it.
1) First, download the test (how to do so check titles above).
2) 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 planning 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.
If compilation went successfully, a 'zz_*_test.exe' (e.g. 'zz_firefox_2.0.0.20_test.exe') file will be created. All .ahk files that are #included will be bundled into the output 'zz_*_test.exe' as well.
There are dependencies. You are going to need the exact same test application version as described in test (e.g. 'Firefox'). Download Applications and Media from here.
You need to create two folders in target machine 'Apps' and 'Media'. You put test program *.exe (e.g. 'Firefox 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.
Note: All compiled scripts go into the same folder and all use the same 'Apps' and the same 'Media' folder.
Picture below demonstrates folder hierarchy.
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').
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.

How to write new tests

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

Create two folders: 1 - Application name, 2 - Application version. E.g.: Firefox\
This is so we can have the same application tested, but different version e.g. Firefox\, Firefox\3.0.11, Firefox\12.0, etc.
There are different ways of making an application do things. You can use mouse to click controls and you can use keyboard. Sending keystrokes is not the most reliable thing to do, but sometimes applications do not have 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 application. Use uninstaller with silent switches. If not possible, just delete hard-coded default path and settings if any. The path and registry modifications can be detected on installation using tools such as ProcMon
Let's 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 windows 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
        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 ").")
    TestsOK("'Window Caption (Window Tex)' window closed (iTimeOut=" iTimeOut ").")

We want tests to consume as little 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.")
    szExpectedString = Some text
    IfNotInString, clipboard, %szExpectedString% ; You want clipboard to go first
        TestsFailed("Copied text onto clipboard and got unexpected results. Is '" clipboard "', should be '" szExpectedstring "'.")
        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 exists first. If you close an application, make sure that 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:
SetTimer, WatchCursor, 100
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%

There is how all stuff works: seku_diagrama.jpg