Eclipse IDE Integration

The Squish IDE is a stand-alone IDE based on Eclipse. To integrate Squish into an previously installed Eclipse, install the Squish Eclipse Integration plugin. The Eclipse integration works with Eclipse 3.7 or later and requires that at least one scripting language editor is installed.

Downloading Squish Eclipse Integration

The Squish Eclipse integration plugin can be found in the Downloads section of Qt Customer Portal after choosing Squish as a product. The downloadable file (with the title Squish IDE (Eclipse Integration)) is Squish-Eclipse-Integration-$(version).zip where $(version) must be 5.1.0 or higher. Download the file to your local disk. You do not need to unpack it.

Installing the Squish Eclipse Integration Plugin

To install the Squish Eclipse Integration Plugin in Eclipse:

1. Select Help > Install New Software to open the Install dialog.
2. Select Add to open the Add Repository dialog.
3. In the Name field, enter a name, such as Squish Eclipse Integration.
4. Select the Archive button to open a file chooser dialog, and locate the Squish Eclipse Integration .zip file you downloaded.
5. Select the OK button (or the Open button, and so on, depending on the platform) in the file chooser.
6. In the Add Repository dialog, select Add.

Enabling Squish Features

In the Install dialog, expand the entry for Squish Eclipse Integration to show all the available features. The most fundamental feature is called Squish UI. It provides basic Squish support and must be checked to enable using Squish within Eclipse. Also included is support for script editors. Select at least one of the editor support items.

Once you have selected the features you want, click the Next button and follow the dialog's instructions. For example, accept license agreements or acknowledge security warnings. Keep going until you can finally click the Finish button. During the process you may be prompted with a dialog informing you that the Squish integration is not signed. If you received the .zip file from Qt Company, it is safe to install the features.

Once the features have been added Eclipse will prompt you to restart. Doing the restart is not necessary as you need to quit Eclipse completely now anyway.

Enabling Video Playback in Eclipse

After installing Squish features and exiting Eclipse, you need to modify the eclipse.ini file. You can find it next to the Eclipse executable (on macOS in Eclipse.app/Contents/Eclipse). It is a plain text file that you can edit with a text editor. Add the following line to eclipse.ini:

-Dosgi.framework.extensions=org.eclipse.fx.osgi

The line can be placed anywhere after the -vmargs line, but it has to be kept on a line of its own. Usually it is best and easiest to just append the line to the end of the file.

The modified eclipse.ini ensures that the Squish Video Player is working properly. It is used for replaying videos captured during the test execution. You can now restart Eclipse and finish setup.

Setting the Location of Squish Command Line Tools

The last step is to choose the Squish tools package that you want to use. This is the package that contains Squish's supporting command line tools, such as squishrunner and squishserver. These tools must be downloaded separately from Qt Customer Portal. Once you have downloaded and unzipped them, you can tell Eclipse where they are by clicking the Preferences > Squish menu option and choosing the directory where the Squish tools are located. For more information about installing the Squish tools, see Installation.

Once Eclipse knows where the Squish tools are, you are ready to use Eclipse as your test editing and running environment. The best way to start is to switch to the Test Management Perspective. This is done in the standard Eclipse way, by clicking Window > Show Perspective > Squish Test Management, for example. This makes Eclipse look and behave like the standalone Squish IDE and provides access to all the Squish-specific perspectives and views that are used for recording, editing, and running Squish tests. You can adapt Squish perspectives within Eclipse to suit your own preferences by adding or removing views, or you can add Squish views to your other perspectives.

The Squish perspectives and views inside Eclipse look and behave like those in Squish IDE.