4.2. Squish for Java (AWT/Swing) Tutorials

Table of Contents

4.2.1. Tutorial: Starting to Test Java™ AWT/Swing Applications

Learn how to test applications which are based AWT/Swing.

4.2.1. Tutorial: Starting to Test Java™ AWT/Swing Applications

This tutorial will show you how to create, run, and modify tests for an example Java AWT/Swing application. In the process you will learn about Squish's most frequently used features so that by the end of the tutorial you will be able to start writing your own tests for your own applications. (If you want to test Java SWT applications, you might prefer to read, Tutorial: Starting to Test Java™ SWT Applications (Section 4.3.1).)

This chapter presents most of the major concepts behind Squish and provides the information you need to get started using Squish for testing your own applications. This tutorial does not discuss all of Squish's features, and those that it does cover are not covered in full detail. After reading this tutorial we recommend reading the User Guide (Chapter 5), and at least skimming the API Reference Manual (Chapter 6) and the Tools Reference Manual (Chapter 7), so that you are familiar with all the features that Squish has to offer, even if you don't need to use them all straight away.

This tutorial is divided into several sections. If you are new to Squish it is best to read all of them. If you are already using Squish you might want to just skim the tutorial, stopping only to read those sections that cover any new features that you haven't used before—or you could just skip straight to the User Guide (Chapter 5).

Whenever we show how to achieve something using the IDE we will often follow with an explanation of how to do the same thing using the command line tools. Using an IDE is the easiest and best way to start, but once you build up lots of tests you will want to automate them, (e.g., doing nightly runs of your regression test suite), so it is worth knowing how to use the command line tools since they can be run from batch files or shell scripts.

The application we will test is a very simple Address Book application. Users can add new addresses via a dialog, edit addresses in-place, and remove addresses. They can also open and save address book data files. Although the application is very simple it has all the standard features that you are likely to want to use in your own tests, including menus, a table, and a pop-up dialog with line edits and buttons. Once you know how to test any of these user interface elements you will be able to apply the same principles to testing elements present in your own applications that are not used in the tutorial, such as tree views and number and date spinners. (The User Guide (Chapter 5) has more comprehensive examples that show how to test lists, tables, and trees, and also the most common widgets, including spinners.)

The screenshot shows the application in action with a user adding a new name and address.

The Java AWT/Swing addressbook example.

The application (i.e., the AUT—Application Under Test) can be found with Squish's examples in SQUISHDIR/examples/java/addressbook/. There, you will find the AUT packaged in AddressBookSwing.jar. If you compile yourself, you can use AddressBook.class as the AUT since it also contains the main() function. You can also use a batch file, or shell script. Some executable launchers even work as an AUT. The tests that we will discuss in the following sections are in sub-folders, for example, the versions of the tests using the Python language are in SQUISHDIR/examples/java/addressbook/suite_py, with the tests written in other languages in similarly named sub-folders.

In principle, testing Java AWT/Swing and Java SWT applications works the same, so all the practices described in this tutorial can be applied to either. The only significant differences are that both of these toolkits use their own distinct set of widgets with different APIs (Application Programming Interfaces), and so our tests must of course access the toolkit-specific widgets and use the toolkit-specific APIs when we want to interact with them—for example, when checking that a particular widget's property holds a particular value.

[Note]Using the Examples

The first time you try running a test for one of the example AUTs you might get a fatal error that begins “Squish couldn't find the AUT to start...”. If this occurs, click the Test Suite Settings toolbar button, and in the Application Under Test (AUT) section choose the AUT from the combobox if it is available, or click the Browse... button and navigate to the AUT via the file open dialog that pops up. This only needs to be done once per AUT.

In the following sections we will create a test suite and then create some tests, but first we will very briefly review some key Squish concepts.

4.2.1.1. Squish Concepts

To perform testing, two things are required:

  1. an application to test—known as the Application Under Test (AUT), and

  2. a test script that exercises the AUT.

One fundamental aspect of Squish's approach is that the AUT and the test script that exercises it are always executed in two separate processes. This ensures that even if the AUT crashes, it should not crash Squish. (In such cases the test script will fail gracefully and log an error message.) In addition to insulating Squish and test scripts from AUT crashes, running the AUT and the test script in separate processes brings other benefits. For example, it makes it easier to store the test scripts in a central location, and it also makes it possible to perform remote testing on different machines and platforms. The ability to do remote testing is particularly useful for testing AUTs that run on multiple platforms, and also when testing AUTs that run on embedded devices.

Squish runs a small server (squishserver) that handles the communication between the AUT and the test script. The test script is executed by the squishrunner tool, which in turn connects to the squishserver. The squishserver starts the AUT and injects the Squish hook into it. The hook is a small library that makes the AUT's live running objects accessible and that can communicate with the squishserver. With the hook in place, the squishserver can query AUT objects regarding their state and can execute commands—all on behalf of the squishrunner. And the squishrunner itself requests that the AUT performs whatever actions the test script specifies. All the communication takes place using network sockets which means that everything can be done on a single machine, or the test script can be executed on one machine and the AUT can be tested over the network on another machine.

The following diagram illustrates how the individual Squish tools work together.

From the test engineer's perspective this separation is not noticeable, since all the communication is handled transparently behind the scenes.

Tests can be written and executed using the Squish IDE, in which case the squishserver is started and stopped automatically, and the test results are displayed in the Squish IDE's Test Results view (Section 8.2.17). The following diagram illustrates what happens behind the scenes when the Squish IDE is used.

The Squish tools can also be used from the command line without the Squish IDE—this is useful for those testers who prefer to use their own tools (for example, their favorite editor), and also for performing automatic batch testing (for example, when running regression tests overnight). In these cases, the squishserver must be started manually, and stopped when all the testing is complete (or, if preferred, started and stopped for each test).

[Note]Terminology

The Squish documentation mostly uses the term widget when referring to GUI objects (i.e., buttons, menus, menu items, labels, table controls, etc). Java™ AWT users would refer to them as Component or Container, but here we use the term 'widget' for both. Similarly, macOS users may be used to the term view; again, we use the term widget for this concept.

4.2.1.1.1. Making an Application Testable

In most cases, nothing special needs to be done to make an application testable, since the toolkit's API (e.g., AWT, SWT) provides enough functionality to implement and record test scripts. The connection to the squishserver is also established automatically, when the Squish IDE starts the AUT.

[Note]The Squish Directory

Throughout the manual, we often refer to the SQUISHDIR directory. This means the directory where Squish is installed, which might be C:/Users/UserName/squish-for-java-6.x.y, /Applications/squish-for-java-6.x.y, ~/squish-for-java-6.x.y, or somewhere else, depending on where you installed it. The exact location doesn't matter, so long as you mentally translate the SQUISHDIR directory to whatever the directory really is when you see paths and filenames in this manual.

4.2.1.2. Creating a Test Suite

A test suite is a collection of one or more test cases (tests). Using a test suite is convenient since it makes it easy to share tests scripts and test data between a group of related tests.

Here, and throughout the tutorial, we will start by describing how to do things using the IDE, with the information for command line users following.

To begin with start up the Squish IDE, either by clicking or double-clicking the squishide icon, or by launching squishide from the taskbar menu or by executing squishide on the command line—whichever you prefer and that is suitable for the platform you are using. Once Squish starts up you might be greeted with a Welcome Page in case you're starting the squishide for the first time. Click the Workbench button to dismiss it. Then, the squishide will look similar to the screenshot—but probably slightly different depending on the windowing system, colors, fonts, and theme that you use, and so on.

The Squish IDE with no Test Suites

Once Squish has started click File|New Test Suite... to pop-up the New Test Suite wizard shown below.

The New Test Suite wizard's Name & Directory page

Enter a name for your test suite and choose the folder where you want the test suite to be stored. In the screenshot we have called the test suite suite_py and will put it inside the addressbook folder. (For your own tests you might use a more meaningful name such as "suite_addressbook"; we chose "suite_py" because for the sake of the tutorial we will create several suites, one for each scripting language that Squish supports.) Naturally, you can choose whatever name and folder you prefer. Once the details are complete, click Next to go on to the Toolkit (or Scripting Language) page.

The New Test Suite wizard's Toolkit page

If you get this wizard page, click the toolkit your AUT uses. For this example, we must click Java since we are testing a Java application—it doesn't matter whether the AUT is AWT/Swing, JavaFX, or SWT, the Java option covers them all. Then click Next to go to the Scripting Language page.

The New Test Suite wizard's Scripting Language page

Choose whichever scripting language you want—the only constraint is that you can only use one scripting language per test suite. (So if you want to use multiple scripting languages, just create multiple test suites, one for each scripting language you want to use.) The functionality offered by Squish is the same for all languages. Having chosen a scripting language, click Next once more to get to the wizard's last page.

The New Test Suite wizard's AUT page

If you are creating a new test suite for an AUT that Squish already knows about, simply click the combobox to pop-down the list of AUTs and choose the one you want. If the combobox is empty or your AUT isn't listed, click the Browse button to the right of the combobox—this will pop-up a file open dialog from which you can choose your AUT. In the case of Java programs, the AUT is often a .jar file containing all the application's classes suitable for starting by double clicking it—in this case the AddressBook.jar. Once you have chosen the AUT, click Finish and Squish will create a sub-folder with the same name as the test suite, and will create a file inside that folder called suite.conf that contains the test suite's configuration details. Squish will also register the AUT with the squishserver. The wizard will then close and Squish's IDE will look similar to the screenshot below.

The Squish IDE with the suite_py test suite

We are now ready to start creating tests. Read on to learn how to create test suites without using the IDE, or skip ahead to Recording Tests and Verification Points (Section 4.2.1.3) if you prefer.

[Note]For command-line users

To create a new test suite from the command line, three steps are necessary: first, create a directory for the test suite; second, create a test suite configuration file; and third, register the AUT with squishserver.

  1. Create a new directory to hold the test suite—the directory's name should begin with suite. In this example we have created the SQUISHDIR/examples/java/addressbook/suite_py directory for Python tests. (We also have similar subdirectories for other languages but this is purely for the sake of example, since normally we only use one language for all our tests.)

  2. Create a plain text file (ASCII or UTF-8 encoding) called suite.conf in the suite subdirectory. This is the test suite's configuration file, and at the minimum it must identify the AUT, the scripting language used for the tests, and the wrappers (i.e., the GUI toolkit or library) that the AUT uses. The format of the file is key = value, with one key–value pair per line. For example:

    AUT            = AddressBookSwing.jar
    LANGUAGE       = Python
    WRAPPERS       = Java
    OBJECTMAPSTYLE = script
    

    The AUT for Java programs is the .jar file that contains the AUT classes and can be run by double clicking it. The LANGUAGE can be set to whichever one you prefer—currently Squish is capable of supporting JavaScript, Python, Perl, Ruby, and Tcl. For both Java AWT/Swing and Java SWT programs, setting WRAPPERS to Java is sufficient.

  3. Register the AUT with the squishserver. [3] This is done by executing the squishserver on the command line with the --config option and the addAUT command. For example, assuming we are in the squish directory on Linux:

    squishserver --config addAUT AddressBookSwing.jar \
    SQUISHDIR/examples/java/addressbook
    

    Windows users can use \ or / as their directory separator.

    We must give the addAUT command the name of the AUT's executable and—separately—the AUT's path. In this case the path is to the .jar file that was added as the AUT in the test suite configuration file. (For more information about application paths, see AUTs and Settings (Section 7.3) in the User Guide (Chapter 5).)

We are now ready to record our first test.

4.2.1.3. Recording Tests and Verification Points

Squish records tests using the scripting language that was specified for the test suite. Once a test has been recorded we can run the test and Squish will faithfully repeat all the actions that we performed when recording the test, but without the pauses that humans are prone to but which computers don't need. It is also possible—and very common—to edit recorded tests, or to copy parts of recorded tests into manually created tests, as we will see later on in the tutorial.

Recordings are made into existing test cases. We begin by creating a New Script Test Case. There are two ways we can do this. One way is to click File|New Test Case.... This will pop up the New Squish Test Case wizard (Section 8.3.10)—simply enter the name for the test case and then click Finish. Another way is to click the New Test Case () toolbar button (to the right of the Test Cases label in the Test Suites view); this will create a new test case with a default name (which you can easily change). Use one of these methods and give the new test case the name “tst_general”. Squish automatically creates a sub-folder inside the test suite's folder with this name and also a test file, for example test.py. (If we had chosen JavaScript as our scripting language the file would be called test.js, and correspondingly for Perl, Ruby, or Tcl.)

The Squish IDE with the tst_general test case
[Note]Note

If you get a sample .feature file instead of an empty script file, then click on the arrow left to the Run Test Suite button and select New Script Test Case.

To make the test script file (e.g., test.py) appear in an Editor view (Section 8.2.6), click—or double-click the test case. (Incidentally, the checkboxes are used to control which test cases are run when the Run Test Suite toolbar button is clicked; we can always run a single test case by clicking its Run Test button.) Initially, the script is empty. If we were to create a test manually (as we will do later on in the tutorial), we must write a main function. The name "main" is special to Squish—tests may contain as many functions and other code as we like (providing it is legal for the scripting language), but when the test is executed (i.e., run), Squish always executes the main function. This is actually very convenient since it means we are free to create other functions, import libraries, and so on, without problems. It is also possible to share commonly used code between test scripts—this is covered in the User Guide (Chapter 5). (In fact, two other function names are special to Squish, cleanup and init; see Tester-Created Special Functions (Section 6.1) for details.)

Once the new empty test case has been created, we are free to write test code manually, or to record a test. If we choose to record we can either replace all the test's code with the recorded code, or insert recorded code into the middle of some existing test code. We will only concern ourselves with recording and replacing in the tutorial.

[Note]For command-line users

Creating a new test case from the command line is an easy two-step process: first, create a test case directory; and second, create an empty test case script.

  1. Create a new subdirectory inside the test suite directory. For example, inside the SQUISHDIR/examples/java/addressbook/suite_py directory, create the tst_general directory.

  2. Inside the test case's directory create an empty file called test.py (or test.js if you are using the JavaScript scripting language, and similarly for the other languages).

Before we dive into recording let's briefly review our very simple test scenario:

  1. Open the MyAddresses.adr address file.

  2. Navigate to the second address and then add a new name and address.

  3. Navigate to the fourth address (that was the third address) and change the surname field.

  4. Navigate to the first address and remove it.

  5. Verify that the first address is now the new one that was added.

We are now ready to record our first test. Click the Record () to the right of the tst_general test case shown in the Test Suites view (Section 8.2.18)'s Test Cases list. This will cause Squish to run the AUT so that we can interact with it. Once the AUT is running, perform the following actions—and don't worry about how long it takes since Squish doesn't record idle time:

  1. Click File|Open, and once the file dialog appears, type MyAddresses.adr into the line edit, then click the Open button.

  2. Click the second row, then click Edit|Add..., then click the first line edit in the Add dialog and type in "Jane". Now click (or tab to) the second line edit and type in "Doe". Continue similarly, to set an email address of "jane.doe@nowhere.com" and a phone number of "555 123 4567". Don't worry about typing mistakes—just backspace delete as normal and fix them. Finally, click the OK button. There should now be a new second address with the details you typed in.

  3. Click the fourth row's second (surname) column, delete its text and replace it with "Doe". Then press Enter to confirm your edit.

  4. Now click the first row, then click Edit|Remove..., and then click the Yes button in the message box. The first row should be gone, so your "Jane Doe" entry should now be the first one.

  5. Click the Verify toolbar button in the Squish Figure 4.1, “ Squish Control Bar ” and select Properties.

    Figure 4.1.  Squish Control Bar

    Squish Control Bar



    This will make the Squish IDE appear. In the Application Objects view, use the Object Picker () or expand the AddressBook object, then the JRootPane object, then the JLayeredPane object, then the JPanel object, then the JScrollPane object, then the JViewport object, and then the JTable object. Now expand the row_0 object. Click the column_0 object to make its properties appear in the Properties view (Section 8.2.12), and then check the text property's checkbox.

    At this point, double-check that the Type: is set to Scriptified Properties, in case it was set to something else previously.

    Next, click the column_1 object and check its text property.

    Finally, click the Save and Insert Verifications button (at the bottom of the Verification Point Creator, shown in Verification Point Creator). This will cause the forename and surname verifications for the first row to be inserted into the recorded test script (See Recorded Scriptified Verifications). Once the verification points are inserted, the Squish IDE's window will be hidden again, and the Control Bar window and the AUT will be back in view.

  6. We've now completed the test, so in the AUT click File|Quit, then click No in the message box, since we don't want to save any changes.

The Verification Point Creator showing two verification points about to be inserted

Once we quit the AUT, the recorded test will appear in Squish's IDE as the screenshot illustrates. (Note that the exact code that is recorded will vary depending on how you interact. For example, you might invoke menu options by clicking them or by using key sequences—it doesn't matter which you use, but since they are different, Squish will record them differently.)

The Squish IDE showing recorded scriptified verifications

If the recorded test doesn't appear, click (or double-click depending on your platform and settings) the tst_general test case; this will make Squish show the test's test.py file in an editor window as shown in the screenshot.

Now that we've recorded the test, we should be able to play it back, i.e., run it. This in itself is useful in that if the play back failed it might mean that the application has been broken. Furthermore, the two verifications we put in will be checked on play back as the screenshot shows.

Inserting verification points during test recording is very convenient. Here we inserted two in one go, but we can insert as many as we like as often as we like during the test recording process. However, sometimes we might forget to insert a verification, or later on we might want to insert a new verification. We can easily insert additional verifications into a recorded test script as we will see in the next section, Inserting Additional Verification Points (Section 4.2.1.4).

Before going further we will look at how to record a test from the command line. Then we will see how to run a test, and we will also look at some of the code that Squish generated to record the test and discuss some of its features.

[Note]For command-line users

First and foremost, the squishserver must always be running when recording or running a test. This is handled automatically by the Squish IDE, but for command line users the squishserver must be started manually. (See squishserver (Section 7.4.4) for further details.)

To record a test from the command line we execute the squishrunner program and specify the test suite we want to record inside and the name we want to give to the test case. For example (assuming we are in the directory that contains the test suite's directory):

squishrunner --testsuite suite_py --record tst_general --useWaitFor

It is always best to record using the --useWaitFor option since this records calls to the waitForObject function which is more reliable than using the snooze function which for historical reasons is the default. (Note that the Squish IDE automatically uses the waitForObject function.)

To run a test case in the IDE just click the Run Test Case toolbar button (the green right-pointing triangle that appears when the test case is selected in theTest Suites view (Section 8.2.18) ). This will cause Squish to run the AUT and replay every action (omitting human idle time, but allowing just enough time for the GUI toolkit to keep up). It is worth trying out since it has quite an impressive effect, especially if you haven't seen it in action before.

When we have two or more test cases we can run them individually by clicking the test case we want to run to select it and then clicking the Run Test button, or we can run them all (one after the other) by clicking the Run Test Suite toolbar button (which is above and slightly to the left of the Run Test button. (Actually, only those test cases that are checked are run by clicking the Run Test Suite toolbar button, so we can easily run a particular group of tests.)

[Note]For command-line users

As noted earlier, the squishserver must always be running when recording or running a test. (See squishserver (Section 7.4.4) for further details.)

To play back a recorded test from the command line we execute the squishrunner program and specify the test suite our recorded script is in and the test case we want to play. For example (assuming we are in the directory that contains the test suite's directory):

squishrunner --testsuite suite_py --testcase tst_general

If you look at the code in the screenshot (or the code snippet shown below) you will see that it consists of lots of waitForObject calls as parameters to various other calls such as activateItem, clickButton, mouseClick, and type. The waitForObject function waits until a GUI object is ready to be interacted with (i.e., becomes visible and enabled), and is then followed by some function that interacts with the object. The typical interactions are activate (pop-up) a menu, click a menu option or a button, or type in some text. (For a complete overview of Squish's script commands see the User Guide (Chapter 5), the API Reference Manual (Chapter 6), and the Tools Reference Manual (Chapter 7). Objects are identified by names that Squish generates. (See How to Identify and Access Objects (Section 5.1) for full details.)

The generated code is about 35 lines of code. Here's an extract that just shows how Squish records clicking the Edit menu's Add option, typing in Jane Doe's details into the Add dialog, and clicking OK at the end to close the dialog and update the table.

[Note]Scripting Language Support

Although the screenshots only show the Python test suite in action, for the code snippets quoted here and throughout the tutorial, we show the code for all the scripting languages that Squish supports. In practice you would normally only use one of them of course, so feel free to just look at the snippets in the language you are interested in and skip the others. (In the HTML version of this manual you can use the combobox at the top of the page to select the language you use—this will hide the code snippets in other languages.)

Python

    activateItem(waitForObjectItem(names.address_Book_MyAddresses_adr_JMenuBar, "Edit"))
    activateItem(waitForObjectItem(names.edit_JMenu, "Add..."))
    type(waitForObject(names.address_Book_Add_Forename_JTextField), "jane")
    type(waitForObject(names.address_Book_Add_Surname_JTextField), "doe")
    type(waitForObject(names.address_Book_Add_Email_JTextField), "jane.doe@nowhere.com")
    type(waitForObject(names.address_Book_Add_Phone_JTextField), "123 555 1212")
    clickButton(waitForObject(names.address_Book_Add_OK_JButton))
JavaScript

    activateItem(waitForObjectItem(names.addressBookMyAddressesAdrJMenuBar, "Edit"));
    activateItem(waitForObjectItem(names.editJMenu, "Add..."));
    type(waitForObject(names.addressBookAddForenameJTextField), "Jane");
    type(waitForObject(names.addressBookAddSurnameJTextField), "Doe");
    type(waitForObject(names.addressBookAddEmailJTextField), "jane.doe@nowhere.com");
    type(waitForObject(names.addressBookAddPhoneJTextField), "123 555 1212");
    clickButton(waitForObject(names.addressBookAddOKJButton));
Perl

    activateItem(waitForObjectItem($Names::address_book_myaddresses_adr_jmenubar, "Edit"));
    activateItem(waitForObjectItem($Names::edit_jmenu, "Add..."));
    type(waitForObject($Names::address_book_add_forename_jtextfield), "Jane");
    type(waitForObject($Names::address_book_add_surname_jtextfield), "Doe");
    type(waitForObject($Names::address_book_add_email_jtextfield), "jane.doe\@nowhere.com");
    type(waitForObject($Names::address_book_add_phone_jtextfield), "123 555 1212");
    clickButton(waitForObject($Names::address_book_add_ok_jbutton));
Ruby

    activateItem(waitForObjectItem(Names::Address_Book_MyAddresses_adr_JMenuBar, "Edit"))
    activateItem(waitForObjectItem(Names::Edit_JMenu, "Add..."))
    type(waitForObject(Names::Address_Book_Add_Forename_JTextField), "Jane")
    type(waitForObject(Names::Address_Book_Add_Surname_JTextField), "Doe")
    type(waitForObject(Names::Address_Book_Add_Email_JTextField), "jane.doe@nowhere.com")
    type(waitForObject(Names::Address_Book_Add_Phone_JTextField), "123 555 1212")
    clickButton(waitForObject(Names::Address_Book_Add_OK_JButton))
Tcl

    invoke activateItem [waitForObjectItem $names::Address_Book_MyAddresses_adr_JMenuBar "Edit"]
    invoke activateItem [waitForObjectItem $names::Edit_JMenu "Add..."]
    invoke type [waitForObject $names::Address_Book_Add_Forename_JTextField] "Jane"
    invoke type [waitForObject $names::Address_Book_Add_Surname_JTextField] "Doe"
    invoke type [waitForObject $names::Address_Book_Add_Email_JTextField] "jane.doe@nowhere.com"
    invoke type [waitForObject $names::Address_Book_Add_Phone_JTextField] "123 555 1212"
    invoke clickButton [waitForObject $names::Address_Book_Add_OK_JButton]

This script has been edited for brevity. Originally, the tester used the keyboard to tab from one text field to another, but we removed those interactions since they were not necessary for playback. If the tester had moved the focus by clicking the mouse and clicked the OK button by tabbing to it and pressing Spacebar, or any other combination of interactions, the outcome would be the same, but of course Squish will have recorded the actual actions that were taken.

Notice in the code snippet that there are no explicit delays. (It is possible to force a delay using Squish's snooze function.) This is because the waitForObject function delays until the object it is given is ready—thus allowing Squish to run as fast as the GUI toolkit can cope with, but no faster.

[Note] Object Names

Squish recordings refer to objects using variables that begin with a names. prefix. This identifies them as Symbolic Names. Each variable contains, as a value, the corresponding Real Name, which can be string-based, or implemented as a key-value mapping of properties to values. Squish supports several naming schemes, all of which can be used—and mixed—in scripts. The advantage of using symbolic names is that if the application changes in a way that results in different names being needed, we can simply update Squish's Object Map (which relates symbolic names to real names), and thereby avoid the need to change our test scripts. (See the Object Map (Section 7.11) and the Object Map view (Section 8.2.10) for more about the Object Map.)

[Tip] Editor Context Menu

When a Symbolic Name is under the cursor, the editor's context menu allows you to Open Symbolic Name, showing its entry in the Object Map, or Convert to Real Name, which places an inline mapping in your desired script language at the cursor, allowing you to hand-edit the properties in the script itself.

Now that we have seen how to record and play back a test and have seen the code that Squish generates, let's go a step further and make sure that at particular points in the test's execution certain conditions hold.

4.2.1.4. Inserting Additional Verification Points

In the previous section we saw how easy it is to insert verification points during the recording of test scripts. Verification points can also be inserted into existing test scripts, either by setting a breakpoint and using the Squish IDE, or simply by editing a test script and putting in calls to Squish's test functions such as test.compare and test.verify.

Squish supports four kinds of verification points: those that verify that object properties have particular values—known as "Object Property Verifications"; those that verify that an entire table has the contents we expect—known as "Table Verifications"; those that verify that two images match—known as "Screenshot Verifications"; and a hybrid verification type that includes properties and screenshots from multiple objects, known as "Visual Verifications". The most commonly used kind is object property verifications, and it is these that we will cover in the tutorial. For further reading, see How to Create and Use Verification Points (Section 5.22)).

Regular (non-scriptified) property verification points are stored as XML files in the test case or test suite resources, and contain the value(s) that need to be passed to test.compare(). These verification points can be reused across test cases, and can verify many values in a single line of script code.

Scriptified property verification points are direct calls to the test.compare function, with two arguments—the value of a particular property for a particular object, and an expected value. We can manually insert calls to the test.compare function in a recorded or hand written script, or we can get Squish to insert them for us using scriptified verification points. In the previous section we showed how to use the Squish IDE to insert verifications during recording. Here we will first show how to use the Squish IDE to insert verifications into an existing test script, and then we will show how to insert a verification by hand.

Before asking Squish to insert verification points, it is best to make sure that we have a list of what we want to verify and when. There are many potential verifications we could add to the tst_general test case, but since our concern here is simply to show how to do it, we will only do two—we will verify that the "Jane Doe" entry's email address and phone number match the ones entered, and put the verifications immediately after the ones we inserted during recording.

To insert a verification point using the IDE we start by putting a break point in the script (whether recorded or manually written—it does not matter to Squish), at the point where we want to verify.

The Squish IDE showing the tst_general test case with a breakpoint

As the above screenshot shows, we have set a breakpoint at line 36. This is done simply by double-clicking, or right-clicking in the gutter (next to the line number in the editor) and selecting the Add Breakpoint context menu item. We chose this line because it follows the script lines where the first address is removed, so at this point (just before invoking the File menu to close the application), the first address should be that of "Jane Doe". The screenshot shows the verifications that were entered using the Squish IDE during recording. Our additional verifications will follow them. (Note that your line number may be different if you recorded the test in a different way, for example, using keyboard shortcuts rather than clicking menu items.)

Having set the breakpoint, we now run the test as usual by clicking the Run Test button, or by clicking the Run|Run Test Case menu option. Unlike a normal test run the test will stop when the breakpoint is reached (i.e., at line 34, or at whatever line you set), and Squish's main window will reappear (which will probably obscure the AUT). At this point the Squish IDE will automatically switch to the Squish Test Debugging Perspective (Section 8.1.2.3).

[Note]Perspectives and Views

The Squish IDE works just like the Eclipse IDE. If you aren't used to Eclipse it is crucial to understand one key concept: Views and Perspectives. In Eclipse (and therefore in the Squish IDE), a View is essentially a child window (perhaps a dock window, or a tab in an existing window). And a Perspective is a collection of Views arranged together. Both are accessible through the Window menu.

The Squish IDE is supplied with three Perspectives—the Squish Test Management Perspective (Section 8.1.2.2) (which is the Perspective that the Squish IDE starts with, and the one we have seen in all previous screenshots), Squish Test Debugging Perspective (Section 8.1.2.3), and Squish Spy Perspective (Section 8.1.2.1). You can change these Perspectives to include additional Views (or to get rid of any Views that you don't want), and you can create your own Perspectives with exactly the Views you want. So if your windows change dramatically it just means that the Perspective changed; you can always use the Window menu to change back to the Perspective you want. In practice, Squish will automatically change perspective to reflect the current situation, so it isn't really necessary to change perspective manually.

As the screenshot below shows, when Squish stops at a breakpoint the Squish IDE automatically changes to the Squish Test Debugging Perspective (Section 8.1.2.3). The perspective shows the Variables view (Section 8.2.20), the Editor view (Section 8.2.6), the Debug view (Section 8.2.5), the Application Objects view (Section 8.2.1), and the Properties view (Section 8.2.12), Methods view (Section 8.2.9), and Test Results view (Section 8.2.17).

To insert a verification point we can expand items in the Application Objects view until we find the object we want to verify, or we can use the Object Picker (). In this example we want to verify the JTable's first row's texts, so we expand the AddressBook item, and its child items until we find the JTable, and within that the row and column we are interested in. Once we click the column object its properties are shown in the Properties view (Section 8.2.12) as the screenshot shows.

Picking an object to verify in the Application Objects view

The normal Squish Test Management Perspective (Section 8.1.2.2) can be returned to at any time by choosing it from the Window menu (or by clicking its toolbar button), although the Squish IDE will automatically return to it if you stop the script or run it to completion.

Here, we can see that the text property of the item in row 0 and column 0 has the value “Jane”; we already have a verification for this that we inserted during recording. Scroll down so that you can see the item in row 0 column 2: this is the email address. To make sure that this is verified every time the test is run, click the column_2 item in the Application Objects view (Section 8.2.1) to make its properties appear, and then click the text property to check its check box. When we check it the Verification Point Creator view (Section 8.2.21) appears as shown in the screenshot.

Choosing a property value to verify

At this point the verification point has not been added to the test script. We could easily add it by clicking the Save and Insert Verifications button. But before doing that we'll add one more thing to be verified.

Scroll down and click the column_3 item in the Application Objects view (Section 8.2.1); then click its text property. Now both verifications will appear in the Verification Point Creator view (Section 8.2.21) as the screenshot shows.

Choosing several property values to verify

We have now said that we expect these properties to have the values shown, that is, an email address of “jane.doe@nowhere.com” and phone number of “555 123 4567”. We must click the Insert button to actually insert the verification point, so do that now.

We don't need to continue running the test now, so we can either stop running the test at this point (by clicking the Stop toolbar button), or we can continue (by clicking the Resume button).

Once we have finished inserting verifications and stopped or finished running the test we should now disable the break point. Just right click the break point and click the Disable Breakpoint menu option in the context menu. We are now ready to run the test without any breakpoints but with the verification points in place. Click the Run Test button. This time we will get some additional test results—as the screenshot shows—one of which we have expanded to show its details. (We have also selected the lines of code that Squish inserted to perform the verifications—notice that the code is structurally identical to the code inserted during recording.)

The newly inserted verification points in action

These particular verification points generate four tests comparing the forename, surname, email, and phone number of the newly inserted entry.

Another way to insert verification points is to insert them in code form. In theory we can just add our own calls to Squish's test functions such as test.compare and test.verify anywhere we like in an existing script. In practice it is best to make sure that Squish knows about the objects we want to verify first so that it can find them when the test is run. This involves a very similar procedure to inserting them using the Squish IDE. First we set a breakpoint where we intend adding our verifications. Then we run the test script until it stops. Next we navigate in the Application Objects view (Section 8.2.1) until we find the object we want to verify. At this point it is wise to right-click the object we are interested in and click the Add to Object Map context menu option. This will ensure that Squish can access the object. Then right click again and click the Copy to clipboard (Symbolic Name) context menu option—this gives us the name of the object that Squish will use to identify it. Now we can edit the test script to add in our own verification and finish or stop the execution. (Don't forget to disable the break point once it isn't needed any more.)

Although we can write our test script code to be exactly the same style as the automatically generated code, it is usually clearer and easier to do things in a slightly different style, as we will explain in a moment.

For our manual verifications we want to check the number of addresses present in the JTable after reading in the MyAddresses.adr file, then after the new address is added, and finally after the first address is removed. The screenshot shows two of the lines of code we entered to get one of these three verifications, plus the results of running the test script.

Manually entered verification points in action

When writing scripts by hand, we use Squish's test module's functions to compare or verify conditions at certain points during our test script's execution. As the screenshot (and the code snippets below) show, we begin by retrieving a reference to the object we are interested in. Using the waitForObject function is standard practice for manually written test scripts. This function waits for the object to be available (i.e., visible and enabled), and then returns a reference to it. (Otherwise it times out and raises a catchable exception.) We then use this reference to access the item's properties—in this case the JTable's row count—and verify that the value is what we expect it to be using the test.verify function. (Incidentally, we got the name for the object from the previous line so we didn't need to set a breakpoint and manually add the table's name to the Object Map to ensure that Squish would remember it in this particular case because Squish had already added it during the test recording.)

Here is the code we entered manually for the first verification for all the scripting languages that Squish supports. Naturally, you only need to look at the code for the language that you will be using for your own tests.

Python

    table = waitForObject(names.address_Book_MyAddresses_adr_JTable)
    test.compare(table.getRowCount(), 125)
JavaScript

    var table = waitForObject(names.addressBookMyAddressesAdrJTable);
    test.compare(table.getRowCount(), 125);
Perl

    my $table = waitForObject($Names::address_book_myaddresses_adr_jtable);
    test::compare($table->getRowCount(), 125);
Ruby

    table = waitForObject(Names::Address_Book_MyAddresses_adr_JTable)
    Test.compare(table.rowcount, 125)
Tcl

    set table [waitForObject $names::Address_Book_MyAddresses_adr_JTable]
    test compare [invoke $table getRowCount] 125

The coding pattern is very simple: we retrieve a reference to the object we are interested in and then verify its properties using one of Squish's verification functions. And we can, of course, call methods on the object to interact with it if we wish.

We will see more examples of manually written code shortly, in the Creating Tests by Hand (Section 4.2.1.5) section, and further examples are in the User Guide (Chapter 5).

For complete coverage of verification points, see How to Create and Use Verification Points (Section 5.22) in the User Guide (Chapter 5).

4.2.1.4.1. Test Results

After each test run finishes, the test results—including those for the verification points—are shown in the Test Results view at the bottom of the Squish IDE.

This is a detailed report of the test run and would also contain details of any failures or errors, etc. If you click on a Test Results item, the Squish IDE highlights the script line which generated the test result. And if you expand a Test Results item, you can see additional details of the test.

4.2.1.5. Creating Tests by Hand

Now that we have seen how to record a test and modify it by inserting verification points, we are ready to see how to create tests manually. The easiest way to do this is to modify and refactor recorded tests, although it is also perfectly possible to create manual tests from scratch.

Potentially the most challenging part of writing manual tests is to use the right object names, but in practice, this is rarely a problem. We can either copy the symbolic names that Squish has already added to the Object Map when recording previous tests, or we can copy object names directly from recorded tests. And if we haven't recorded any tests and are starting from scratch we can use the Spy. We do this by clicking the Launch AUT toolbar button. This starts the AUT and switches to the Squish Spy Perspective (Section 8.1.2.1). We can then interact with the AUT until the object we are interested in is visible. Then, inside the Squish IDE we can navigate to, or pick the object so it is selected in the Application Objects view and use the context menu to both Add to Object Map and Copy (Symbolic | Real) Name to Clipboard (so that we can paste it into our test script). And at the end we can click the Quit AUT toolbar button to terminate the AUT and return Squish to the Squish Test Management Perspective (Section 8.1.2.2). (See How to Use the Spy (Section 5.21.3) in the User Guide (Chapter 5) for more details on using the Spy.)

We can view the Object Map by clicking the Object Map toolbar button (in the Test Suites window), or from the Script Editor context menu, Open Symbolic Name when right-clicking on an object name in script (see also, the Object Map view (Section 8.2.10)). Every application object that Squish interacts with is listed here, either as a top-level object, or as a child object (the view is a tree view). We can retrieve the symbolic name used by Squish in recorded scripts by right-clicking the object we are interested in and then clicking the context menu's Copy Object Name (to get the symbolic name variable) or Copy Real Name (to get the actual key-value pairs stored in the variable). This is useful for when we want to modify existing test scripts or when we want to create test scripts from scratch, as we will see later on in the tutorial.

Squish's Object Map

4.2.1.5.1. Modifying and Refactoring Recorded Tests

Suppose we want to test the AUT's Add functionality by adding three new names and addresses. We could of course record such a test but it is just as easy to do everything in code. The steps we need the test script to do are: first click File|New to create a new address book, then for each new name and address, click Edit|Add, then fill in the details, and click OK. And finally, click File|Quit without saving. We also want to verify at the start that there are no rows of data and at the end that there are three rows. We will also refactor as we go, to make our code as neat and modular as possible.

First we must create a new empty test case. Click File|New Test Case... and set the test case's name to be tst_adding. Squish will automatically create an empty test.py (or test.js, and so on) file.

Command line users can simply create a tst_adding directory inside the test suite's directory and create and edit the test.py file (or test.js and so on) within that directory.

The first thing we need is a way to start the AUT and then invoke a menu option. Here are the first few lines from the recorded tst_general script:

Python

import names

def main():
    startApplication("AddressBookSwing.jar")
    activateItem(waitForObjectItem(names.address_Book_JMenuBar, "File"))
    activateItem(waitForObjectItem(names.file_JMenu, "Open..."))
JavaScript

import * as names from 'names.js';

function main() {
    startApplication("AddressBookSwing.jar");
    activateItem(waitForObjectItem(names.addressBookJMenuBar, "File"));
    activateItem(waitForObjectItem(names.fileJMenu, "Open..."));
Perl

require 'names.pl';

sub main
{
    startApplication("AddressBookSwing.jar");    
    activateItem(waitForObjectItem($Names::address_book_jmenubar, "File"));
    activateItem(waitForObjectItem($Names::file_jmenu, "Open..."));
Ruby

require 'squish'
require 'names'

include Squish

def main
    startApplication("AddressBookSwing.jar")
    activateItem(waitForObjectItem(Names::Address_Book_JMenuBar, "File"))
    activateItem(waitForObjectItem(Names::File_JMenu, "Open..."))
Tcl

source [findFile "scripts" "names.tcl"]

proc main {} {
    startApplication "AddressBookSwing.jar"
    invoke activateItem [waitForObjectItem $names::Address_Book_JMenuBar "File"]
    invoke activateItem [waitForObjectItem $names::File_JMenu "Open..."]

Notice that the pattern in the code is simple: start the AUT, then wait for the menu bar, then activate the menu bar; wait for the menu item, then activate the menu item. In both cases we have used the waitForObjectItem function. This function is used for a multi-valued objects (such as lists, tables, trees—or in this case, a menubar and a menu), and allows us to access the object's items (which are themselves objects of course), by passing the name of the object containing the item and the item's text as arguments.

[Note]Note

It may seem a waste to put our functions in tst_adding because we could also use them in tst_general and in other test cases. However, to keep the tutorial simple we will put the code in the tst_adding test case. It is of course very easy to create shared scripts, but we defer coverage of that to the user guide. (See How to Create and Use Shared Data and Shared Scripts (Section 5.23) for how to share scripts.)

If you look at the recorded test (tst_general) or in the Object Map you will see that Squish sometimes uses different names for the same things. For example, the menubar is identified in two different ways, initially as ":Address Book_JMenuBar", and then later on as ":Address Book - MyAddresses.adr_JMenuBar". The reason for this is that Squish needs to uniquely identify every object in a given context, and it uses whatever information it has to hand. So in the case of identifying menubars (and many other objects), Squish uses the window title text to give it some context. (For example, an application's File or Edit menus may have different options depending on whether a file is loaded and what state the application is in.)

Naturally, when we write test scripts we don't want to have to know or care which particular variation of a name to use, and Squish supports this need by providing alternative naming schemes, as we will see shortly.

Once we start writing tests, sometimes the AUT will appear to freeze when we run one of our tests. When this happens, just wait for Squish to time out the AUT (about 20 seconds), and then an Object Not Found dialog should appear.

Object Not Found Dialog

don't worry! It just means that Squish doesn't have an object with the given name in the Object Map. From here, we can Pick New Object, Debug Throw Error, or after picking a new object, Retry. Picking a new object will update the object map entry for the symbolic name. In addition to the Object Picker (), we can also use the Spy's Application Objects view (Section 8.2.1) to locate the objects we are interested in and use the context menu to Add To Object Map. However, recording a dummy test is often quicker for adding lots of objects to the Object Map, providing we interact with all the AUT objects we are interested in.

We've spent a bit of time on the issue of naming since it is probably the part of writing scripts that leads to the most error messages (usually of the "object ... not found" kind shown above.) Once we have identified the objects we are going to access in our tests, writing test scripts using Squish is very straightforward. And of course you can almost certainly use the scripting language you are most familiar with since Squish supports the most popular ones available.

We are now almost ready to write our own test script. It is probably easiest to begin by recording a dummy test. So click File|New Test Case... and set the test case's name to be tst_dummy. Then click the dummy test case's Record (). Once the AUT starts, click File|New, then click the (empty) table, then click Edit|Add and add an item, then press Return or click OK. Finally, click File|Quit to finish, and say No to saving changes. Then replay this test just to confirm that everything works okay. The sole purpose of this is to make sure that Squish adds the necessary names to the Object Map since it is probably quicker to do it this way than to use the Spy for every object of interest. After replaying the dummy test you can delete it if you want to.

With all the object names we need in the Object Map, we can now write our own test script completely from scratch. We will start with the main function, and then we will look at the supporting functions that the main function uses.

Python

import names

def main():
    startApplication("AddressBookSwing.jar")
    invokeMenuItem("File", "New...")
    data = [("Andy", "Beach", "andy.beach@nowhere.com", "555 123 6786"),
            ("Candy", "Deane", "candy.deane@nowhere.com", "555 234 8765"),
            ("Ed", "Fernleaf", "ed.fernleaf@nowhere.com", "555 876 4654")]
    for fields in data:
        addNameAndAddress(fields)
    jtable = waitForObject({"type": "javax.swing.JTable"})
    test.compare(jtable.getRowCount(), len(data))
    closeWithoutSaving()
JavaScript

import * as names from 'names.js';

function main()
{
    startApplication("AddressBookSwing.jar");
    invokeMenuItem("File", "New...");
    var jtable = waitForObject({"type": "javax.swing.JTable"});
    test.verify(jtable.getRowCount() == 0);
    var data = [
        ["Andy", "Beach", "andy.beach@nowhere.com", "555 123 6786"],
        ["Candy", "Deane", "candy.deane@nowhere.com", "555 234 8765"],
        ["Ed", "Fernleaf", "ed.fernleaf@nowhere.com", "555 876 4654"]];
    for (var row = 0; row < data.length; ++row) {
        addNameAndAddress(data[row]);
    }
    test.compare(jtable.getRowCount(), data.length);
    closeWithoutSaving();
}
Perl

require 'names.pl';

sub main
{
    startApplication("AddressBookSwing.jar");
    invokeMenuItem("File", "New...");
    my $jtable = waitForObject({"type" => "javax.swing.JTable"});
    test::verify($jtable->getRowCount() == 0);
    my @data = (["Andy", "Beach", "andy.beach\@nowhere.com", "555 123 6786"],
                ["Candy", "Deane", "candy.deane\@nowhere.com", "555 234 8765"],
                ["Ed", "Fernleaf", "ed.fernleaf\@nowhere.com", "555 876 4654"]);
    foreach my $details (@data) {
        addNameAndAddress(@{$details});
    }
    test::compare($jtable->getRowCount(), scalar(@data));
    closeWithoutSaving();
}
Ruby

require 'squish'
require 'names'

include Squish

def main
    startApplication("AddressBookSwing.jar")
    invokeMenuItem("File", "New...")
    jtable = waitForObject({:type => "javax.swing.JTable"})
    Test.verify(jtable.rowcount == 0)
    data = [["Andy", "Beach", "andy.beach@nowhere.com", "555 123 6786"],
            ["Candy", "Deane", "candy.deane@nowhere.com", "555 234 8765"],
            ["Ed", "Fernleaf", "ed.fernleaf@nowhere.com", "555 876 4654"]]
    data.each do |oneNameAndAddress|
        addNameAndAddress(oneNameAndAddress)
    end
    Test.compare(jtable.rowcount, data.length)
    closeWithoutSaving
end
Tcl

source [findFile "scripts" "names.tcl"]

proc main {} {
    startApplication "AddressBookSwing.jar"
    invokeMenuItem "File" "New..."
    set jtable [waitForObject $names::Address_Book_Unnamed_JTable]
    test compare [invoke $jtable getRowCount] 0
    set data [list \
        [list "Andy" "Beach" "andy.beach@nowhere.com" "555 123 6786"] \
        [list "Candy" "Deane" "candy.deane@nowhere.com" "555 234 8765"] \
        [list "Ed" "Fernleaf" "ed.fernleaf@nowhere.com" "555 876 4654"] ]
    for {set i 0} {$i < [llength $data]} {incr i} {
        addNameAndAddress [lindex $data $i]
    }
    test compare [invoke $jtable getRowCount] [llength $data]
    closeWithoutSaving
}

We begin by starting the application with a call to the startApplication function. The name we pass as a string is the name registered with Squish (normally the name of the .jar file containing the application code or the .class file that has the class which contains the main method). Then we obtain a reference to the JTable. The object name we want is not yet in the Object Map, and the existing object name for the JTable from tst_general is too specific, and will not work at this point in a test. Therefore, we can take an existing symbolic name which is for the same type, right click on it from the editor and Convert to Real Name, removing the properties that are not relevant or too specific for the function.

The waitForObject function waits until an object is ready (visible and enabled) and returns a reference to it—or it times out and raises a catchable exception.

The invokeMenuItem function is one we have created specially for this test. It takes a menu name and a menu option name and invokes the menu option. After using the invokeMenuItem function to do File|New, we verify that the table's row count is 0. The test.verify function is useful when we simply want to verify that a condition is true rather than compare two different values. (For Tcl we usually use the test.compare function rather than the test.verify function simply because it is slightly simpler to use in Tcl.)

Next, we create some sample data and call a custom addNameAndAddress function to populate the table with the data using the AUT's Add dialog. Then we again compare the table's row count, this time to the number of rows in our sample data. And finally we call a custom closeWithoutSaving function to terminate the application.

We will now review each of the three supporting functions, so as to cover all the code in the tst_adding test case, starting with the invokeMenuItem function.

Python

def invokeMenuItem(menu, item):
    mouseClick(waitForObjectItem({"type": "javax.swing.JMenuBar"}, menu))
    mouseClick(waitForObjectItem({"caption": menu, "type": "javax.swing.JMenu"}, item))
JavaScript

function invokeMenuItem(menu, item)
{
    activateItem(waitForObjectItem({"type": "javax.swing.JMenuBar"}, menu));
    activateItem(waitForObjectItem({"caption": menu, "type": "javax.swing.JMenu"}, item));
}
Perl

sub invokeMenuItem
{
    my($menu, $item) = @_;
    activateItem(waitForObjectItem({"type" => "javax.swing.JMenuBar"}, $menu));
    activateItem(waitForObjectItem({"caption" => $menu, "type" => "javax.swing.JMenu"}, $item));
}
Ruby

def invokeMenuItem(menu, item)
    activateItem(waitForObjectItem({:type => "javax.swing.JMenuBar"}, menu))
    activateItem(waitForObjectItem({:caption => menu, :type => "javax.swing.JMenu"}, item))
end
Tcl

proc invokeMenuItem {menu item} {
    invoke activateItem [waitForObjectItem [::Squish::ObjectName type javax.swing.JMenuBar visible true] $menu]
    invoke activateItem [waitForObjectItem [::Squish::ObjectName type javax.swing.JMenu visible true caption $menu] $item]
}

As we mentioned earlier, the object names Squish uses for menus and menu items (and other objects) can vary depending on the context, and often with the name derived from the window's title. For applications that put the current filename in the title—such as the Address Book example—names will include the filename, and we must account for this.

In the case of the Address Book example, the main window's title is “Address Book” (at startup), or “Address Book - Unnamed” (after File|New, but before File|Save or File|Save As), or “Address Book - filename” where the filename can of course vary. Our code accounts for all these cases by making use of real (multi-property) names.

Real names are represented by a key-value map in your script language. Every real name must specify the type property and at least one other property. Here we've used the type to uniquely identify the MenuBar, and the type and caption properties to uniquely identify the Menu.

Once we have identified the object we want to interact with we use the waitForObjectItem function to retrieve a reference to it and in this case we then apply the activateItem function to it. The waitForObjectItem function pauses Squish until the specified object and its item are visible and enabled. So, here, we waited for the menu bar and one of its menu bar items, and then we waited for a menu bar item and one of its menu items. And as soon as the waiting is over each time we activate the object and its item using the activateItem function.

Python

def addNameAndAddress(fields):
    invokeMenuItem("Edit", "Add...")
    type(waitForObject(names.address_Book_Add_Forename_JTextField), fields[0])
    type(waitForObject(names.address_Book_Add_Surname_JTextField), fields[1])
    type(waitForObject(names.address_Book_Add_Email_JTextField), fields[2])
    type(waitForObject(names.address_Book_Add_Phone_JTextField), fields[3])
    clickButton(waitForObject(names.address_Book_Add_OK_JButton))
JavaScript

function addNameAndAddress(fields)
{
    invokeMenuItem("Edit", "Add...");
    type(waitForObject(names.addressBookAddForenameJTextField), fields[0]);
    type(waitForObject(names.addressBookAddSurnameJTextField), fields[1]);
    type(waitForObject(names.addressBookAddEmailJTextField), fields[2]);
    type(waitForObject(names.addressBookAddPhoneJTextField), fields[3]);
    clickButton(waitForObject(names.addressBookAddOKJButton));
}
Perl

sub addNameAndAddress
{
    invokeMenuItem("Edit", "Add...");
    type(waitForObject($Names::address_book_add_forename_jtextfield), $_[0]);
    type(waitForObject($Names::address_book_add_surname_jtextfield), $_[1]);
    type(waitForObject($Names::address_book_add_email_jtextfield), $_[2]);
    type(waitForObject($Names::address_book_add_phone_jtextfield), $_[3]);
    clickButton(waitForObject($Names::address_book_add_ok_jbutton));
}
Ruby

def addNameAndAddress(oneNameAndAddress)
    invokeMenuItem("Edit", "Add...")
    type(waitForObject(Names::Address_Book_Add_Forename_JTextField), oneNameAndAddress[0])
    type(waitForObject(Names::Address_Book_Add_Surname_JTextField), oneNameAndAddress[1])
    type(waitForObject(Names::Address_Book_Add_Email_JTextField), oneNameAndAddress[2])
    type(waitForObject(Names::Address_Book_Add_Phone_JTextField), oneNameAndAddress[3])
    clickButton(waitForObject(Names::Address_Book_Add_OK_JButton))
end
Tcl

proc addNameAndAddress {fields} {
    invokeMenuItem "Edit" "Add..."

    invoke type [waitForObject $names::Address_Book_Add_Forename_JTextField] [lindex $fields 0]
    invoke type [waitForObject $names::Address_Book_Add_Surname_JTextField] [lindex $fields 1]
    invoke type [waitForObject $names::Address_Book_Add_Email_JTextField] [lindex $fields 2]
    invoke type [waitForObject $names::Address_Book_Add_Phone_JTextField] [lindex $fields 3]
    invoke clickButton [waitForObject $names::Address_Book_Add_OK_JButton]
}

For each set of name and address data we invoke the Edit|Add menu option to pop up the Add dialog. Then for each value received we populate the appropriate field by waiting for the relevant JTextField to be ready and then typing in the text using the type function. And at the end we click the dialog's OK button. We got the line at the heart of the function by copying it from the recorded tst_general test and simply parametrizing it by the text. Similarly, we copied the code for clicking the OK button from the tst_general test case's code.

Python

def closeWithoutSaving():
    invokeMenuItem("File", "Quit")
    clickButton(waitForObject(names.address_Book_No_JButton))
JavaScript

function closeWithoutSaving()
{
    invokeMenuItem("File", "Quit");
    clickButton(waitForObject(names.addressBookNoJButton));
}
Perl

sub closeWithoutSaving
{
    invokeMenuItem("File", "Quit");
    clickButton(waitForObject($Names::address_book_no_jbutton));
}
Ruby

def closeWithoutSaving
    invokeMenuItem("File", "Quit")
    clickButton(waitForObject(Names::Address_Book_No_JButton))
end
Tcl

proc closeWithoutSaving {} {
    invokeMenuItem "File" "Quit"
    invoke clickButton [waitForObject $names::Address_Book_No_JButton]
}

Here we use the invokeMenuItem function to do File|Quit, and then click the "save unsaved changes" dialog's No button. The last line was copied from the recorded test, but with the filename changed from "MyAddresses.adr" to "Unnamed" since in the course of the test we invoked File|New but never saved the file. (An alternative would have been to use a real (multi-property) name to identify the unsaved changes dialog's No button.)

The entire test is under 30 lines of code—and would be even less if we put some of the common functions (such as invokeMenuItem and closeWithoutSaving) in a shared script. And much of the code was copied directly from the recorded test, and in some cases parametrized.

This should be sufficient to give a flavor of writing test scripts for an AUT. Keep in mind that Squish provides far more functionality than we used here, (all of which is covered in the API Reference Manual (Chapter 6) and the Tools Reference Manual (Chapter 7)). And Squish also provides access to the entire public APIs of the AUT's objects.

However, one aspect of the test case is not very satisfactory. Although embedding test data as we did here is sensible for small amounts, it is rather limiting, especially when we want to use a lot of test data. Also, we didn't test any of the data that was added to see if it correctly ended up in the JTable. In the next section we will create a new version of this test, only this time we will pull in the data from an external data source, and check that the data in the JTable is correct.

4.2.1.5.2. Creating Data Driven Tests

In the previous section we put three hard-coded names and addresses in our test. But what if we want to test lots of data? One approach is to import a dataset into Squish and use the dataset as the source of the values we insert into our tests. Squish can import data in .tsv (tab-separated values format), .csv (comma-separated values format), .xls, or .xlsx (Microsoft® Excel™ spreadsheet formats). [4]

Test data can either be imported using the Squish IDE, or manually using a file manager or console commands. We will describe both approaches, starting with using the Squish IDE.

For the addressbook application we want to import the MyAddresses.tsv data file. To do this we must start by clicking File|Import Test Resource to pop-up the Import Squish Resource dialog (Section 8.3.6). Inside the dialog click the Browse button to choose the file to import—in this case MyAddresses.tsv. Make sure that the Import As combobox is set to “TestData”. By default the Squish IDE will import the test data just for the current test case, but we want the test data to be available to all the test suite's test cases: to do this check the Copy to Test Suite for Sharing radio button. Now click the Finish button. You can now see the file listed in the Test Suite Resources view (in the Test Data tab), and if you click the file's name it will be shown in an Editor view (Section 8.2.6). The screenshot shows Squish after the test data has been added.

[Note]For command-line users

It is also possible to import test data outside the Squish IDE using a file manager (such as File Explorer) or console commands. To do this, create a directory inside the test suite's directory called shared. Now make a directory inside the shared directory called testdata. Now copy the data file (in this example, MyAddresses.tsv) into the shared\testdata directory. Now quit the Squish IDE if it is running and start it up again. If you click the Test Suite Resources view's Test Data tab you should see the data file. Click the file's name to see it in an Editor view (Section 8.2.6).

Squish with some imported test data

Although in real life we would modify our tst_adding test case to use the test data, for the purpose of the tutorial we will make a new test case called tst_adding_data that is a copy of tst_adding and which we will modify to make use of the test data.

The only function we have to change is main, where instead of iterating over hard-coded items of data, we iterate over all the records in the dataset. We also need to update the expected row count at the end since we are adding a lot more records now, and we will also add a function to verify each record that's added.

Python

import names

def main():
    startApplication("AddressBookSwing.jar")
    jtable = waitForObject({"type": "javax.swing.JTable"})
    invokeMenuItem("File", "New...")
    test.verify(jtable.getRowCount() == 0)
    limit = 10 # To avoid testing 100s of rows since that would be boring
    for row, record in enumerate(testData.dataset("MyAddresses.tsv")):
        forename = testData.field(record, "Forename")
        surname = testData.field(record, "Surname")
        email = testData.field(record, "Email")
        phone = testData.field(record, "Phone")
        addNameAndAddress((forename, surname, email, phone)) # pass as a single tuple
        checkNameAndAddress(jtable, record)
        if row > limit:
            break
    test.compare(jtable.getRowCount(), row + 1)
    closeWithoutSaving()
JavaScript

import * as names from 'names.js';

function main()
{
    startApplication("AddressBookSwing.jar");
    invokeMenuItem("File", "New...");
    var jtable = waitForObject({"type": "javax.swing.JTable"});
    test.compare(jtable.getRowCount(), 0);
    var limit = 10; // To avoid testing 100s of rows since that would be boring
    var records = testData.dataset("MyAddresses.tsv");
    var row = 0;
    for (; row < records.length; ++row) {
        var record = records[row];
        var forename = testData.field(record, "Forename");
        var surname = testData.field(record, "Surname");
        var email = testData.field(record, "Email");
        var phone = testData.field(record, "Phone");
        addNameAndAddress([forename, surname, email, phone]);
        checkNameAndAddress(jtable, record);
        if (row > limit)
            break;
    }
    test.compare(jtable.getRowCount(), row + 1);
    closeWithoutSaving();
}
Perl

require 'names.pl';

sub main
{
    startApplication("AddressBookSwing.jar");
    invokeMenuItem("File", "New...");
    my $jtable = waitForObject({"type" => "javax.swing.JTable"});
    test::verify($jtable->getRowCount() == 0);
    my $limit = 10; # To avoid testing 100s of rows since that would be boring
    my @records = testData::dataset("MyAddresses.tsv");
    my $row = 0;
    for (; $row < scalar(@records); $row++) {
        my $record = $records[$row];
        my $forename = testData::field($record, "Forename");
        my $surname = testData::field($record, "Surname");
        my $email = testData::field($record, "Email");
        my $phone = testData::field($record, "Phone");
        addNameAndAddress($forename, $surname, $email, $phone);
        checkNameAndAddress($jtable, $record);
        if ($row > $limit) {
            last;
        }
    }
    test::compare($jtable->getRowCount(), $row + 1);
    closeWithoutSaving();
}
Ruby

require 'squish'
require 'names'

include Squish

def main
    startApplication("AddressBookSwing.jar")
    jtable = waitForObject({:type => "javax.swing.JTable"})
    invokeMenuItem("File", "New...")
    Test.verify(jtable.rowcount == 0)
    limit = 10 # To avoid testing 100s of rows since that would be boring
    rows = 0
    TestData.dataset("MyAddresses.tsv").each_with_index do
        |record, row|
        forename = TestData.field(record, "Forename")
        surname = TestData.field(record, "Surname")
        email = TestData.field(record, "Email")
        phone = TestData.field(record, "Phone")
        addNameAndAddress([forename, surname, email, phone]) # pass as a single Array
        checkNameAndAddress(jtable, record)
        break if row > limit
        rows += 1
    end
    Test.compare(jtable.rowcount, rows + 1)
    closeWithoutSaving
end
Tcl

source [findFile "scripts" "names.tcl"]

proc main {} {
    startApplication "AddressBookSwing.jar"
    invokeMenuItem "File" "New..."
    set jtable [waitForObject [::Squish::ObjectName type javax.swing.JTable ]]
    test compare [invoke $jtable getRowCount] 0
    # To avoid testing 100s of rows since that would be boring
    set limit 10
    set data [testData dataset "MyAddresses.tsv"]
    set columns [llength [testData fieldNames [lindex $data 0]]]
    set row 0
    for {} {$row < [llength $data]} {incr row} {
        set record [lindex $data $row]
        set forename [testData field $record "Forename"]
        set surname [testData field $record "Surname"]
        set email [testData field $record "Email"]
        set phone [testData field $record "Phone"]
        set fields [list $forename $surname $email $phone]
        addNameAndAddress $fields
        checkNameAndAddress $jtable $record
        if {$row > $limit} {
            break
        }
    }
    test compare [invoke $jtable getRowCount] [expr $row + 1]
    closeWithoutSaving
}

Squish provides access to test data through its testData module's functions—here we used the testData.dataset function to access the data file and make its records available, and the testData.field function to retrieve each record's individual fields.

Having used the test data to populate the JTable we want to be confident that the data in the table is the same as what we have added, so that's why we added the checkNameAndAddress function. We also added a limit to how many records we would compare, just to make the test run faster.

Python

def checkNameAndAddress(jtable, record):
    tableModel = jtable.getModel()
    for column in range(len(testData.fieldNames(record))):
        value = tableModel.getValueAt(0, column)
        test.compare(value, testData.field(record, column))
JavaScript

function checkNameAndAddress(jtable, record)
{
    var tableModel = jtable.getModel();
    for (var column = 0; column < testData.fieldNames(record).length; ++column) {
        var value = tableModel.getValueAt(0, column).toString();
        test.compare(value, testData.field(record, column));
    }
}
Perl

sub checkNameAndAddress
{
    my($jtable, $record) = @_;
    my $tableModel = $jtable->getModel();
    my @columnNames = testData::fieldNames($record);
    for (my $column = 0; $column < scalar(@columnNames); $column++) {
        my $value = $tableModel->getValueAt(0, $column);
        test::compare($value, testData::field($record, $column));
    }
}
Ruby

def checkNameAndAddress(table, record)
    model = table.getModel()
    for column in 0...TestData.fieldNames(record).length
        value = model.getValueAt(0, column)
        Test.compare(value,  TestData.field(record, column))
    end
end
Tcl

proc checkNameAndAddress {jtable record} {
    set tableModel [invoke $jtable getModel]
    set columns [llength [testData fieldNames $record]]
    for {set column 0} {$column < $columns} {incr column} {
        set value [invoke $tableModel getValueAt 0 $column]
        test compare $value [testData field $record $column]
    }
}

This function accesses the JTable's underlying TableModel and extracts each cell's value. We then use Squish's test.compare function to check that the value in the cell is the same as the value in the test data we used. Note that this particular AUT always adds a new row before the current row (or as the first row if there are no rows yet), and always makes the added row the current row. The effect of this is that every new name and address is always added as the first row, and this is why we hard-coded the row to be 0.

The screenshot show Squish's Test Summary log after the data-driven tests have been run.

Squish after a successful data-driven test run

Squish can also do keyword-driven testing. This is a bit more sophisticated than data-driven testing. See How to Do Keyword-Driven Testing (Section 5.16).

4.2.1.6. Learning More

We have now completed the tutorial! Squish can of course do much more than we have shown here, but the aim has been to get you started with basic testing as quickly and easily as possible. The User Guide (Chapter 5) provides many more examples, including those that show how tests can interact with particular widgets such as spinners, comboboxes, and line editors, and of course with view widgets and their underlying models.

The API Reference Manual (Chapter 6) and Tools Reference Manual (Chapter 7) give full details of Squish's testing API and the numerous functions it offers to make testing as easy and efficient as possible. It is well worth reading the User Guide (Chapter 5) and at least skimming the API Reference Manual (Chapter 6) and Tools Reference Manual (Chapter 7)—especially since the time invested will be repaid because you'll know what functionality Squish provides out of the box and can avoid reinventing things that are already available.

The key Java AWT/Swing examples with links to the places they are used are given below.

In addition to the documented examples listed above, further Java AWT/Swing example applications and their corresponding tests are provided in SQUISHDIR/examples/java.




[3] Each AUT must be registered with the squishserver so that test scripts do not need to include the AUT's path, thus making the tests platform-independent. Another benefit of registering is that AUTs can be tested without the Squish IDE—for example, when doing regression testing.

[4] Both .csv and .tsv files are assumed to use the Unicode UTF-8 encoding—the same encoding used for all test scripts.