Installing from Binary Packages
In most cases, you can install Squish from a binary package that you first unpack and then configure to make Squish ready for use. Binary packages are available for Linux, macOS, and Microsoft Windows. Different versions of each Squish edition are provided to ensure the tightest possible integration between Squish, the operating system, and the applications or web sites you want to test.
Binary packages contain the Squish IDE and the Squish Tools (squishrunner, squishserver, and others). They have varying minimum system requirements.
The Squish IDE can be installed on the following platforms:
- Microsoft Windows:
- 64-bit Windows 7 SP1 or newer 64-bit versions
- 64-bit CentOS 7.5 or newer 64-bit versions
- 64-bit Red Hat Enterprise 7.5 or newer 64-bit versions
- 64-bit SUSE Linux Enterprise Server 15 or newer 64-bit versions
- other 64-bit distributions which provide GTK 3.20 or newer
- Apple macOS:
- macOS 10.14 Mojave or newer
Note: Squish binary packages can be still installed on older platforms, but the Squish IDE will not be available. For those requirements, see the section below.
The Squish command-line Tools (squishrunner, squishserver, and others) can be installed on the following platforms:
- Microsoft Windows:
- Windows 7 SP1 or newer
- CentOS 6 or newer
- Debian 7 or newer
- Ubuntu 14.04 or newer
- other distributions which provide glibc 2.12 and libstdc++ 4.4 or newer
Squish binary packages for Qt 5.8 and higher (like Qt 5.9, Qt 6.0, Qt 6.1, etc) have the same requirements as their matching Qt libraries. For example, Squish for Qt 5.9 binary packages have the same requirements as Qt 5.9 binary packages.
- Apple macOS
- macOS 10.14 Mojave or newer
Note: Squish Tools (squishrunner, squishserver, and others) can also run on other platforms (like embedded Linux, or older versions of the platforms above), but they have to be built from sources, and remote testing has to be used.
The binary Squish packages are available in the Downloads section of Qt Customer Portal after choosing Squish as a product. To find out which package to download, you need to know which toolkit is used to build the applications you are going to test. The toolkit could be: Qt, Java, native Windows (e.g. MFC, WinForms or WPF), macOS (Cocoa or SwiftUI), Web, and so on. You also need to know which operating system you are going to use to test the applications: Linux, macOS, or Microsoft Windows. For easier search for a suitable binary package, Qt Customer Portal has a set of helpful filters that can be used to display only packages that match the given host operating system or the given Squish edition (toolkit).
If you will be testing Qt applications, you need to collect some additional technical information in order to choose the correct package:
- Which version of Qt is used by the application you want to test?
- Which compiler (and which version of the compiler) was used to compile the Qt library and the application you want to test?
If you don't have this information, you'll need to ask one of the application's developers. Once you know the operating system, Squish edition, toolkit version, and the compiler name and version, you can identify the correct Squish package as follows: Every Squish package name is of the form
squish-<squishVersion>-toolkit<toolkitVersion>-<platform>-<compiler> and ending with
.exe (on Windows),
.run (on Linux) or
.dmg (on macOS). Some package names don't specify the
<toolkitVersion>, in which case the package can be used with any version of the toolkit; others have an x in the toolkit version, in which case they can be used with a version of the toolkit that has any digit in that position—so
qt62x means any Qt 6.2 version, Qt 6.2.0, Qt 6.2.1, and so on. Some packages don't specify the
<compiler>, in which case they can be used with any compiler that runs on the platform. Some examples are shown in the table below.
Squish packages for macOS machines—and that are processor-dependent—embed a processor identifier in their name, e.g.,
x86_64 for 64-bit Intel processors. Similarly, some Java packages specify whether they are for 32-bit or 64-bit Intel Windows machines (e.g., using
java-win64 in their names). Yet in some cases the architecture of the machine doesn't matter. For example, Squish for Windows (i.e., for applications using the native MFC or .NET toolkit) is designed to work with all Windows compilers and with both Intel 32-bit and 64-bit versions of Windows—so in this case the package names just have the Squish version, e.g.,
|Example Package Name||Description|
|Squish 6.6.1 for 64-bit AUTs running on Linux and built with Qt 4.7.x and using any compiler.|
|Squish 6.6.1 for 32-bit AUTs running on Windows and built with Qt 5.9.x using the MSVC 14 (VS 2015) compiler.|
|Squish 6.6.1 for 64-bit AUTs running on Windows and built with Qt 5.14.x using the MSVC 14.1 (VS 2017) compiler.|
|Squish 6.6.1 for AUTs running on 64-bit Intel macOS machines and built with Qt 5.6.x using the standard compiler.|
|Squish 6.6.1 for Web using any browser on Windows.|
|Squish 6.6.1 for Web using a 64-bit browser on Linux.|
|Squish 6.6.1 for Web using any browser on macOS.|
|Squish 6.6.1 for Java—all 32-bit versions from 1.4 using AWT/Swing or SWT—running on Windows.|
|Squish 6.6.1 for Java—all 64-bit versions from 1.4 using AWT/Swing or SWT—running on Windows.|
If you cannot find a Squish binary package in Qt Customer Portal that matches your platform, it is best that you build Squish from source. This will ensure that Squish integrates correctly with your local software configuration. Building Squish from source is described in Installing Squish for Qt from Desktop Source Packages.
After you have decided which Squish binary package you need, download it from Qt Customer Portal onto your computer, and execute it.
On Linux, you need to make the
.run file which you downloaded executable first. Popular desktop environments allow this by right-clicking the file and enabling the
Execute permission. You can however also make the installer executable on the command line by executing:
$ chmod a+x packagename
The installation program will guide you through the configuration process by presenting multiple pages.
The installation program is shown running in the screenshot above (and in several screenshots that follow). However, the list of configuration steps varies depending on which edition of Squish you are installing, so don't be concerned if one or more of the configuration pages mentioned below is not presented to you, or if additional pages are shown.
To change a setting you made during the configuration, use the Back button to go back to the relevant page, change the configuration setting, and then move forward again using the Next button.
After acknowledging the welcome page by pressing the Next button at the bottom of the setup program's window, the next page will request you to enter the Squish license key, activation code, or address of a Floating License Server. If you have a 19-character license key to enter, this section is for you. If you want to enter a hostname:port of a Floating License Server, see Entering a Floating License Server Address.
If you already have a previous Squish installation on your computer—perhaps an evaluation version—or if you have already copied the license file to your
HOME directory, and renamed it to start with a period, the license key will be shown in the input field. If there is no license shown, or if you want to use a different one, enter your license here exactly as it appears in the
License Details section of your Qt Customer Portal, including any dashes.
To use a license key file stored somewhere else, set the
SQUISH_LICENSEKEY_DIR environment variable to the desired location. See Environment Variables.
Click the Next button to advance to the next step in the configuration process. If there are any problems with the license (for example, if it has expired or you mistyped it) then a message box will be shown, explaining the problem. You can then have another try.
Select the corresponding section to use a floating license with Squish. The installer will try to discover license servers on the network and populate the drop down menu with them. If the license server you plan to use is not listed, you may enter a server address manually in the form of (hostname_or_IP_address:port). When a valid server address is selected the Next button will be enabled.
Click Next to advance to the next step in the configuration process. If there are any problems with the license server or its license (for example, the server is not reachable or its license doesn't include the required Squish editions) then a message box will be shown, explaining the problem; you can then have another try.
After entering your license key or server address, you will be presented with the license under which you are permitted to use your copy of Squish. Read the entire license text carefully before proceeding. Click one of the two radio buttons (I accept the license. or I do not accept the license.), that appear below the license text, to indicate whether you agree or disagree with the terms. If you disagree, then you cannot install or use Squish so you should click the Cancel button (or close the window) to terminate the installation.
Note: The license text varies depending on the license key. For example, the terms are different for evaluation versions and commercial versions.
If you accept the license, the Next button will become enabled, so you can proceed to the next step of the configuration process.
In this step, the installation of Squish can be customized by selecting optional components.
The basic Squish Tools (such as squishrunner or squishserver) are mandatory and thus are always selected. However, other components are optional:
- Squish IDE: You can choose to not install the Squish IDE in order to save disk space. This can be useful in case the Squish installation is only meant to be used for automatic (e.g. nightly or CI-driven) test execution but not for test development.
- Squish Test Center: The Squish Test Center is a separate component for aggregating and displaying Squish test reports. This component is typically only installed on a single system and then shared across the network with other workstations.
In this step, the script languages to use for test scripts can be configured. Furthermore, in case the Squish package contains multiple versions of any given language, this page permits selecting the version to use for executing tests. Note that these settings can also be reconfigured later on by running the squishconfig program.
This page is not displayed if a Squish package contains only a single version of each script language.
This step decides into which location on your system the Squish package will be uncompressed.
This step is only necessary if you are configuring a Squish package set up for testing Qt applications on macOS, and if your license key entitles you to test Qt applications. If either of these conditions doesn't apply, this configuration page will not appear, in which case you can safely skip to the next section and continue from there.
Most Qt applications on the macOS contain Qt libraries in the application bundle. If this is the case for your AUT, then use the Finder to navigate to the AUT, right click on it and say Show Package Contents, then drill down to
Contents/Frameworks to find
QtCore.framework. To copy that path to the clipboard, View > Show Path Bar, right click on the Frameworks button in the bottom path bar, Copy "Frameworks" as Pathname, then paste it into the line edit in the installer dialog.
After specifying the path to the requested Qt library, use the Next button to advance to the next step of the setup.
To change the location of the Qt library without reinstalling Squish, issue the command:
$ SQUISHDIR/bin/squishconfig --qt=/path/to/QtCore.framework
This step is only necessary if you are configuring a Squish package set up for testing Java applications or if you are configuring a Squish package for testing Web applications and if your license key entitles you to test Java or Web applications. If either of these conditions doesn't apply, this configuration page will not appear, in which case you can safely skip to the next section and continue from there.
To test Java applications, you need to tell Squish where your Java runtime libraries are installed. If you are using the Java SDK (Software Development Kit), you must specify the runtime library directory—called
jre, which is located inside the SDK's directory. If you only have the JRE (Java Runtime Environment) installed, specify the JRE's directory, not a directory inside the JRE.
After specifying the path to the Java runtime library, use the Next button to advance to the next step of the setup.
At this point all the configuration options have been set and the installation is ready to launch. A page is shown which displays the disk space required by the selected Squish configuration.
When you press the Next button on this page, the configuration shown is saved to disk and Squish will use these settings from now on.
The installation program now commences installing Squish on your system. You can click the Show Details button to get a detailed list of actions performed as part of the installation.
You can close the installer at any time, e.g. by closing the window or by pressing the Cancel button (only visible on platforms other than macOS). All changes done so far will be rolled back.
Congratulations! You have finished configuring Squish, and all the settings have been saved successfully. This page concludes the setup of your Squish binary package.
Click the Finish button to close the installation program. An option is presented which can be used to define whether the Squish IDE should be launched after the installation finished.
Note: A restart is required when installing Squish on Windows if reconfiguration is required which only takes effect when starting the operating system. Restart your computer before using Squish to ensure that it operates properly.
Note: On macOS, Squish requires enabling Accessibility access for the Squish IDE or the Terminal to be able to replay interactions in menus and use the nativeType(keys) or the nativeMouseClick(x, y, button) function. Upon starting the Squish IDE or launching squishserver from the Terminal, a dialog opens that leads you through the process. For more information, see macOS Universal Access.
It is possible to perform the installation of Squish completely unattended, passing any required values up front. Unattended installation requires no user interactions whatsoever and is equivalent to manually interacting with the installer interface. To perform an unattended installation, invoke the Squish installation program from the command line passing at least the argument
$ ./squish-6.6.1-windows unattended=1 more options...
That argument will launch the installation without any graphical user interface. Instead, progress information and potential error messages are written to the console.
In addition to the
unattended=1 argument, you may want to specify further arguments to specify the target directory, the license key and further settings. See the installer reference documentation for a full list of recognised arguments.
In case any required values are missing, the installation will print a message and stop, e.g.:
$ ./squish-6.6.1-windows unattended=1 IFW Version: 2.0.81, built with Qt 5.5.0. Build date: Nov 30 2015 Installer Framework SHA1: cf9e21b  Language: en  Arguments: ./squish-6.6.1-windows, unattended=1, targetdir=/tmp/foo  Operations sanity check succeeded. ..  Cannot perform unattended installation; target directory not specified.  Please pass 'targetdir=<PATH>' on the command line.
Omitting optional arguments will make the installer pick a sensible default value. A message will be printed indicating this condition, and how to override it. For instance, here's the output generated while installing a Squish for Web package on macOS:
..  No Firefox executable specified, using auto-detected path '/Applications/Firefox.app'  Specify 'firefox=<PATH>' on the command line to override this.  No Chrome executable specified, using auto-detected path '/Applications/Google Chrome.app'  Specify 'chrome=<PATH>' on the command line to override this. ..
© 2023 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.
The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.
Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.