9.10. Eclipse IDE Integration

Table of Contents

9.10.1. Download and Install the Squish Integration

The Squish IDE is a stand-alone IDE based on Eclipse. If you prefer to use your existing Eclipse it is possible to integrate Squish's Eclipse integration so that you can seamlessly use Squish from inside your normal Eclipse. The Eclipse integration works with Eclipse 3.7 or later and requires that at least one scripting language editor is installed.

9.10.1. Download and Install the Squish Integration

The Squish Eclipse integration is available in a file in your froglogic download area. The file's name is Squish Eclipse Integration-version.zip where version will be 5.1.0 or higher. Simply download the file to your local disk—there is no need to unpack it.

Installing the Plugin

Start up Eclipse and click the Help|Install New Software menu option. This will pop up the Install dialog. Now click the Install dialog's top-right Add... button; this will pop up the Add Repository dialog. In the Add Repository dialog enter a name in the Name line edit (e.g., “Squish Eclipse Integration”), and then click the Archive... button. This will pop up a file chooser dialog that you can use to locate the Squish Eclipse integration .zip file you downloaded. Once you have found it click the OK button (or the Open button, etc., depending on platform) in the file chooser, then click the Add Repository dialog's OK button.

Enabling Features of Squish

In the Install dialog, expand the entry for the Squish Eclipse Integration to show all the features that are available. The most fundamental feature is the "Squish UI" feature. This contains basic Squish support and must be checked to use Squish within Eclipse. Also included is support for script editors. Check 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, you may have to 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 which says that the Squish integration is not signed. So long as you got the .zip file from froglogic it is safe to install the features. (froglogic is currently working on getting the Squish Eclipse integration signed.)

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 the video playback feature in Eclipse

After installation of the features and terminating Eclipse you need to modify the eclipse.ini file. It can be found next to the Eclipse executable (on macOS it is located inside Eclipse.app/Contents/Eclipse) and is a plain text file that can be edited with a text editor. The eclipse.ini file needs to be extended with the following line:

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

The line can be placed anywhere after the -vmargs line, but 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 Video Player of Squish is working properly. This is for replaying videos that may be captured during the test execution. You can now start Eclipse again and finish setup.

Setting the location of the 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 your customer area on the froglogic web site. 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 how to install the Squish tools see How to Install Squish (Chapter 3).)

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 Squish Test Management Perspective (Section 8.1.2.2)—this is done in the standard Eclipse way, e.g., by clicking Window|Show Perspective|Squish Test Management. This will make Eclipse look and work in a very similar way to 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. Naturally, you can adapt the Squish perspectives within Eclipse to suit your own preferences by adding or removing views—or you can add Squish views to your other perspectives if you prefer.

The Squish perspectives and views inside Eclipse look and behave the same as those in the Squish IDE. The Squish IDE is described more fully in the IDE Reference Manual (Chapter 8).