Autoit Launcher (autoit.jar)

The Autoit launcher allows interfacing with Autoit (.au3) scripts.
It has been tested with Autoit v3.


Configuration

The autoit.xml file allows pre-configuring the launcher with some default values:


Parameter Description
General
Test root path This must indicate where are located all the .au3 scripts.
This is a root path. Each test in XStudio has a canonical path that will be appended to this path.
This path MUST not include an ending slash.

Default value is: C:/my_autoit_scripts
Asynchronous timeout (in seconds) This must indicates the maximum time the system will wait for the test to complete.
Default value is: 600
AutoIt
AutoIt install path This must indicate where is installed AutoIt on the host.

Default value is: C:/tools/autoit-3


These values can be changed while creating the campaign session from XStudio.


Requirements

  • Each test in XStudio must have his dedicated .au3 script. The name of the script MUST be equal to the name of the test.

  • The .au3 script must be able to parse the argument testcaseIndex passed during interpretation.
    This allows the script to execute different routines depending on the testcase index.
    The interpreter is executed by the launcher using this syntax:

    "<autoitInstallPath>/AutoIt3.exe" "<testRootPath>/<testPath>/<testName>.au3" /debug
    /testcaseIndex=<testcaseIndex>

  • When the .au3 has executed all its action, it MUST create an empty test_completed.txt file.
    Indeed, the executions of the autoit scripts are asynchronous. This mechanism allows the launcher to know when the test is completed.
    A timeout of 10 minutes is predefined.
    If the .au3 script did not create the test_completed.txt within the first 10 minutes, then the launcher considers the test has crashed and skips it.

  • the .au3 script must generate a log.txt during its execution.
    This file MUST describe all the actions performed by the test as well as the result of each action.
    This file will be parsed by the launcher and all the information will be passed/stored automatically in the XStudio database.
    The log.txt MUST respect a specific format: Each line MUST include the strings [Success], [Failure] or [Log] or the line will not be treated. Based on this information, the testcase will be flagged as passed or failed.

Tutorial: Creating and executing Autoit tests

In this tutorial, we will learn to run some AutoIt test scripts.

Prerequisites

Install AutoIt in the folder C:\Program files\AutoIt3


We will modify one of the example script provided with AutoIt.
Copy the file C:\Program Files\AutoIt3\Examples\calculator.au3 and rename it as calculator_test.au3.


Insert in the beginning of the file calculator_test.au3 the following lines of code: 

    #include <File.au3>
    $RESULT_FILENAME = "Log.txt"
    FileDelete($RESULT_FILENAME)
    $FLAG_FILENAME = "test_completed.txt"
    FileDelete($FLAG_FILENAME)


And insert at the end of the file: 

    ; log a success
    logFileAndConsoleWrite($RESULT_FILENAME, "[Log] first message")
    logFileAndConsoleWrite($RESULT_FILENAME, "[Log] second message")
    logFileAndConsoleWrite($RESULT_FILENAME, "[Success] testcase succeeded")
    ;logFileAndConsoleWrite($RESULT_FILENAME, "[failure] testcase failed")
    
    ; create the test_completed.txt file
    FileOpen($FLAG_FILENAME, 1)
    
    Func logFileAndConsoleWrite($logFile, $input)
       ConsoleWrite($input & @CRLF)
       _FileWriteLog($logFile, $input)
    EndFunc



Create a dedicated category for AutoIt tests and create a test

  • create a category AutoIt in the test tree associated to the launcher autoit.jar
  • under this category, create (somewhere in the tree) a test with name calculator_test and with a canonical path set to /Examples.



Creating a test campaign

  • create a campaign including only the test calculator_test
  • create a campaign session specifying in the configuration:
    • Test root path: C:/Program Files/AutoIt3
    • AutoIt install path: C:/Program Files/AutoIt3



Run a campaign session

Run the campaign session