Test Suite Settings

The Test Suite Settings view is not shown in any perspective by default. It can be shown by clicking the Test Suites view's Test Suite Settings toolbar button. It is used to view and edit test suite-specific information. (See also The suite.conf File.)

Test Suite Information

{}

The General tab (Test Suite Settings)

The Test Suite Information gets most of its values when the New Squish Test Suite wizard is used to create a new test suite: it cannot be changed.

The Description section can be used to give the test suite both a short summary and a longer description.

The Object Map specifies the name and path of the objects.map file. (If no path is given then Squish will look for it in the test suite's folder.) If you want to specify an objects.map file that isn't in the test suite's folder, you can either enter the filename and path directly or click the Browse button to pop up a file dialog to choose an objects.map file. If you enter a path by hand you can use an environment variable if you wish—for example:

$(TEST_ENVIRONMENT)\myapp\objects.map

If the environment in which the Squish tools execute has an entry of TEST_ENVIRONMENT = C:\TestFolder then Squish will read the Object Map from the C:\TestFolder\myapp\objects.map file.

The Object Map can be edited using the Object Map view. For information about handling the Object Map programmatically in test scripts see Object Map Functions. For more about Object Maps in use see the Object Map.

AUT Information

The AUT is normally set to the name of the AUT's executable, although for Java AWT/Swing applications it is normally set to the main class (the class that contains the main method). For some AUTs it contains the name of a shell script or Windows .bat file. For Java applications it is possible to specify a CLASSPATH (although this is often done in a shell script or Windows .bat file for Java SWT applications). And for all application it is possible to specify the command line arguments that the AUT should be started with. If the Hook into sub-processes launched by the application checkbox is checked, Squish will also be able to test application's launched by the AUT—providing they use a GUI toolkit that Squish recognizes and is licensed for. (Java SWT applications must check this checkbox of course since the actual SWT application is launched from a shell script or Windows .bat file.) The Automatically start the AUT checkbox is unchecked by default and the AUT is started in the test script with a call to the ApplicationContext startApplication(autName) function. This makes it possible to execute statements in the test script before the AUT is launched.

{}

The AUT tab (Test Suite Settings)

The Working Directory is the folder where the AUT is run from. The default is the folder where the AUT's executable resides, but it is also possible to use the squishserver's working directory, or simply to choose any folder you like. If you choose the Custom location you can either enter a path or click the Browse button to pop up a file dialog to choose a path. If you enter a path by hand you can use an environment variable if you wish—for example:

$(TEST_ENVIRONMENT)\myapp

If the environment in which the Squish tools execute has an entry of TEST_ENVIRONMENT = C:\TestFolder then Squish will execute the AUT with the AUT's working directory set to the C:\TestFolder\myapp directory.

The Environment can be used to specify the environment variables (names and values) that should be present when the AUT runs. If you need an AUT-specific environment, simply click (or double-click depending on your platform and Squish IDE settings) an empty Key cell and enter an environment variable name. Then do the same to the corresponding Value cell. You can do this as many times as necessary. To delete a variable, simply delete its Key and press Enter. Note that Squish has two different environments: the environment that the Squish tools (such as squishserver and squishrunner) and the test cases execute in, and the AUT's environment. (See also, Setting Environment Variables, Setting Environment Variables for the AUT, and Environment Variables.)

Connection Information

The Connection tab is only present for VNC test suites. It allows configuration of the connection parameters for the remote VNC server. For Protocol there are 2 choices, Native, which requires a squishserver to be running on the remote system, or VNC, where the actual VNC protocol is used to connect.

If Native is chosen, the actual host and port to use are specified in the Remote Testing Options.

If VNC is chosen, some additional fields are visible. Of those, all but Hostname are optional, and depend on the configuration of the VNC server.

{}

The Connection tab (Test Suite Settings)

The password for the VNC server (if required) can be specified on the Password Information page. Once configured, it will become available as one of the options in the Password combo box.

Test Settings

The Test Settings tab contains a number of options that influence execution of all scripts in the test suite. The initial settings in this section get default values from the properties of testSettings object.

{}

The Test Settings tab (Test Suite Settings)

The options available in the editor correspond to the following properties:

The Image Search tab contains options that influence squish image search functionality. The initial settings in this section get default values from the properties of testSettings object.

{}

The Image Search tab (Test Suite Settings)

The options available in the editor correspond to the following properties:

Password Information

The Passwords tab lets you associate a list of passwords with the current test suite. These passwords can be retrieved in the test script using the String testSettings.getPassword(key) function.

{}

The Passwords tab (Test Suite Settings)

Note: The passwords stored in a Squish test suite have to be retrievable in plaintext form. Therefore, they are not stored in a secure way. They are just stored separately, so that it is not necessary to hard-code passwords in test scripts.

Descriptions

{}

The Descriptions tab (Test Suite Settings)

The Descriptions tab allows editing of a sort summary and a longer description for each of the test cases in the current test suite. It also allows specification of a comma-separated list of Tags for each of the script-based test cases. The Tags field for the BDD test cases is disabled, because the Gherkin file format allows assigning tags to a scenario in the file itself. Tagged test cases can be executed selectively as described in the Playback option --tags section.