The squishserver is responsible for handling the communications between the squishrunner and the application under test. It has has three modes of use: serving, stopping, and configuring.
The squishserver must be run on the same machine as the AUT, although squishrunner can run on a different machine.
If the squishserver is started without any command line options, it will listen to connections on port 4322 and will only accept connections from the local host (127.0.0.1). To make it accept connections from other hosts, those hosts must be specified. For this purpose, squishserver reads the file
/etc/squishserverrc (on Unix-like systems) or
C:\squishserverrc (on Windows). If the file isn't found, the squishserver will try
SQUISHDIR/etc/squishserverrc (on Unix-like systems) and
SQUISHDIR\etc\squishserverrc.txt (on Windows).
squishserverrc file can specify the IP addresses from which connections are allowed using a line of this form:
ALLOWED_HOSTS=ip-address1 ip-address2 ...
Wildcards can be used in the specified IP addresses to match more than a single IP address. For example:
The port number that squishserver listens to can be changed by adding a line of the form
PORT=port to the
Note: Squish does not create a
squishserverrc file. If you need one, create it manually using a plain text editor.
Use squishserver with no command line options, or with those documented here, to have a server for squishrunner to use.
--configfile configfile] [
--host address] [
--port port] [
--listenfile listenfile] [
--logfile logfile]] [
The items in square brackets are optional.
squishserver can be used with no options at all, or with a
--port port to specify which port to listen on. The command line option overrides any
PORT=port that is specified in the
Another useful option is
--host address to specify the IP address to listen on. The default is is to accept connections on any IP address assigned to the machine where squishserver is running.
--verbose option is used, squishserver will produce more output than usual. The extra output is designed to be helpful for investigating problems such as remote server connection problems or incorrect Qt library path settings.
On Unix-like platforms (i.e., not on Windows), the
--daemon option can be specified. If this option is used then the squishserver will be run in the background. This means that the server will detach itself from the controlling terminal and stop printing anything to standard output or to standard error. Anything that the AUT prints to these channels will be lost, unless also the
--logfile with full path to a file name is given. There is no point using the
--verbose option when the
--daemon option is used without a log file.
--disable-presence option disables SSDP service discovery. By default, the squishserver advertises that it exists on the LAN using this protocol.
--local option is used internally by the Squish IDE when starting local squishservers. It is not meant to be used by end users. This option disables SSDP discovery and listens to 127.0.0.1 by default. It chooses a port between 49152 and 65535, and prints it to standard output.
To stop a squishserver from running use the
squishserver --stop [
host address] [
If the port isn't specified the server will be contacted using Squish's default port number.
This tells the squishserver to shut down. In almost all use cases, a squishrunner cannot operate without a squishserver.
Use squishserver with the
--config option to change various settings.
squishserver --config action
Most of these configuration commands operate on the
server.ini file by default, which is in
ver1 of the Squish User Settings Directory. You can provide the location of a different configuration file by using the
squishserver [--configfile /path/to/myserver.ini]
Only a single configuration action can be specified each time. (For backward compatibility an additional optional option,
--settingsGroup settingsGroup is supported. If specified it tells the squishserver which settings group to use. The Squish IDE has no support for settings groups and this option is deprecated.)
squishserver --config addAppPath C:\squish\examples\qt\addressbook
This will add the
C:\squish\examples\qt\addressbook path to Squish's list of paths in which to look for AUTs.
It is possible to refer to environment variables on the command line using the syntax
$(NAME) (although on some shells—typically those used on Unix—the
$() parts may need to be escaped).
squishserver --config addAUT addressbook $(SQUISHPATH)/examples/qt/addressbook
Here we have added a new AUT and to do so we have used the
SQUISHPATH environment variable—which must have been set earlier.
|Adds a path to the list of paths in which squishserver looks for applications when starting an AUT.|
|Removes a path from the list of paths in which squishserver looks for applications when starting an AUT.|
|Adds an application mapped to the specified path. If different versions of the same application have the same executable name and appear in different paths that have been registered using the addAppPath option, this option specifies the one that Squish should use, thereby avoiding any ambiguity.|
|Removes an application mapped to the specified path.|
|Specifies an AUT that can be attached to.|
|Unregisters an AUT that was previously registered using the |
|The wrapper library or libraries to use with the specified AUT.|
|Enables or disables Squish expecting a built-in hook rather than the default non-intrusive hooking. Read Using the Built-in Hook before using this option.|
|How many seconds Squish should wait before timing out with a test failure if the AUT doesn't respond after being started. The default is 20.|
|How many seconds Squish should wait before timing out with a test failure when waiting for a response from the AUT. The default is 300. This is different from the timeout used by the Object waitForObject(objectOrName) function.|
|How many milliseconds Squish should wait after the first AUT process has exited. This applies to AUTs that actually start the real AUT as a new/separate (sub-)process, like Java Web Start, but also third party Java application launchers. In those cases the first AUT process may exit before the second (the real) AUT process has been hooked up by Squish. And this will cause Squish to abort its attempt to start (and hook up) the AUT with an error, unless hooking of the second AUT process succeeds within the number of milliseconds specified by this setting. The default is 1500.|
|How many milliseconds squishserver should maximally wait after sending a |
|How many milliseconds squishserver should maximally wait after squishrunner has ended before killing the application if it is still running, when started automatically or with ApplicationContext startApplication(autName). The default is 2000 milliseconds.|
|A browser and the path to its executable: |
Squish supports specific web browsers on specific desktop platforms out of the box. However, it is also possible to test other web browsers or test on non-desktop platforms (e.g., iPhones and similar) by using Squish's web proxy.
|Full path to the location of the Java executable. For example, |
|Full path to the location of the Java virtual machine. For example, |
|The Java version to use. For example, |
|For Java AUTs using the SWT GUI library, the full path to the SWT library |
|Registers a custom |
|Unregisters a custom |
The squishserver has some other configuration options, specifically,
setJavaHookMethod, which are for backward compatibility and should not be used.
© 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.