Squish

Squish Licensing Information & Contact Details

We have one floating tester subscription and one floating execution subscription licence. The execution subscription is used by a build server to run tests, the tester subscription is used by us to develop tests. We can have at most one developer writing tests at a time, but we can all install the software on our machines. I don’t yet know how the license system works e.g. if one developer forgets to close squish on their system, does it block everybody until they do? Or is there some timeout? We will have to experiment. See license server below for more details.

Set Up for local server

  1. Install SQUISH/JAVA WINDOWS from <isis experiment controls share>\squish

  2. Read and accept the terms and conditions if still correct

  3. Install download:

    1. Run download installer

    2. Floating license: Enter control-svcs.isis.cclrc.ac.uk:49345

    3. Licence Agreement: Read and accept the licence

    4. Uncheck Test Center from items to install, unless you really need it

    5. Select python version for script language (3.*)

    6. Installation folder: Use c:\tools (or c:\squish on a build server)

    7. JRE or JDK: Select the JDK we are currently developing with

    8. Shortcuts: use defaults

    9. Start Menu: use defaults

    10. Accept default except for location which should be changed to c:\tools (or c:\squish on a build server)

    11. Install

  4. Clone the current tests to your machine, into c:\Instrument\dev\:

git clone https://github.com/ISISComputingGroup/System_Tests_UI_E4.git

  1. Open the test suites in the IDE

    1. Menu File -> Open Test Suite ..

    2. Open the root of the git clone you just made this will open all tests suites in the window

  2. Set the Application under test (AUT)

    1. Ensure that the ibex_gui client has been built with build.bat

    2. Edit -> Server Settings -> Manage AUTs …

    3. Select Mapped AUTs and click Add…

    4. Locate the executable from the built (built using the build.bat maven script) eclipse project (e.g. ibex-client in ibex_gui\built_client\)

  3. To get access to global scripts right click in squish -> global scripts pane -> add -> global scripts directory (Found within System_Tests_UI_E4) and select the global scripts directory in the repository root.

  4. If not running in Python 3 follow these instructions, and point to the default python3 directory in the squish installation root.

You may also need to install psutil and mysql-connector-python==8.0.11 through the GUI (Edit -> Preferences -> PyDev -> Interpreters -> Python Interpreter then “Manage with pip”) if running the experiment details tests.

Once you have set up Squish via the steps above, you should be able to run a test suite to confirm everything is working.

Note

You will need the IBEX server running in the background, but not the client (which will be started by Squish when you run a test).

RDP to Server

It is possible to remote desktop to the squish server but when you disconnect you must use the “Disconnect from RDP” shortcut on the desktop. To do this you must be an Admin on the desktop.

Setup For Build Server

  1. Install all the things needed for an instrument (Git, MySQL, Java)

  2. Install Jenkins build system but run it from a command line.

  3. Add the script for running the command to the startup.

  4. Install squish as above.

  5. Add to C:\Users\<user>\AppData\Roaming\froglogic\Squish\ver1 the key GlobalScriptDirs = "C:\\Jenkins\\workspace\\squish_ui_system_tests\\global_scripts"

  6. Add applications under test to the server setup as above using the IDE

  7. Change the Application Behaviour to have a startup time of 120s.

  8. Check that the global script directory has been set.

  9. Switch off screen saver and power saving

  10. Next remote desktop from another machine as the user stated in the password doc

    • We have tried making this autologon, but it gets stuck at the policy screen

    • We don’t need VNC this seems to do the job without a problem

  11. Then disconnect the session using the shortcut on the desktop

  12. Leave the machine with an attached screen. I think this is needed to set the resolution when leaving remote desktop.

Creating a new Test Suite

  1. Click File -> New test Suite …

  2. New Test Suite:

    1. Create a sensible name, suite_<what>_tests

    2. Make the test suite path the same as the system testing folder

  3. Language: Make sure it is python

  4. Select the application as eclipse (the ibex client in E4 was called eclipse)

  5. Finish

  6. Edit the test suite settings (select test suite in test suites tab. Then click on icon with blue spanner)

    1. Edit Object Map to be ..\objects.map. You may not be able to do this from the Squish client depending on your version, in which case you can directly edit suite.conf in /<System tests folder>/suite_<something>_tests/ (it should say OBJECTMAP=..\objects.map)

System Testing The IBEX Script Generator with Squish BDD Tools

The way we use Squish for testing the script generator is a bit different to the way we test the IBEX client. The method for testing is documented on the Squish BDD Tools page. Many of the hints and tips from this page still apply, for example using utilities such as set_text_field.

Creating a new Test

A test contains one test case.

  1. Find the suite the test should be in

  2. Click “Create new test case” (icon document with a plus in Test Suites tab)

  3. Change name to tst_<what the test does>

  4. A test suite should start:

# -*- coding: utf-8 -*-
import sys
import os
path = os.path.abspath(os.path.dirname(findFile("scripts", "test_running.py")))
sys.path.append(path)

from test_running import start_test
<other imports> 

def main():

    # Given application
    start_test()

    <rest of test>

Writing tests

Hints, tips and gotchas for writing tests:

  • Use set_text_field to set a text field because it deletes its contents before adding the new value.

  • Use menu module to access menus because if a menu is interrupted then you want it to try again at the top level menu.

  • Use generate_config_name to generate a config name so that it will be ignored by git and cleaned up by the system test

  • If you open a dialogue capture it using a context manager. You could consider adding an option for OK and Cancel.

  • If you need to select a perspective button the object picker will set it using the index (occurrence) however these buttons might change their positions it is better to select them based on their text. To do this:

    1. Open the object map.

    2. Click on the button object definition (you can use the search at the top to find it).

    3. In the properties tab change occurrence to text and the value to the text on the button.

    4. Save it and check it works by clicking highlight object; button should flash red.

  • Often test.compare and test.verify in Squish provides logs that aren’t very useful, please do add a test.log line to describe the error.

Other

Change Java that squish is using

To change java that squish is using:

cd <squish installation directory>
"bin/squishconfig" --java="C:\Program Files\Java\jdk<jdk version>\jre\bin"

This fixes the issue:

Internal Error: don't know where to log: Squish for Java has not been configured for the current user yet.
Please configure the (Java Runtime Environment) used for executing the AUT (Application Under Test) in the Squish IDE via Edit > Preferences > Squish > .... (Or use `SQUISH_DIR/bin/squishconfig --java=path_to_jre`.
Replace "path_to_jre" as required.) (Starting application)

and also the error message:

java.lang.NoClassDefFoundError: com/froglogic/squish/swt/CompositeResolver
	at com.froglogic.squish.swt.SWT.<clinit>(SWT.java:922)
	at org.eclipse.swt.widgets.Display.<init>(Display.java:419)
	at org.eclipse.swt.widgets.Display.<init>(Display.java:481)
	at org.eclipse.ui.internal.Workbench.createDisplay(Workbench.java:795)
	at org.eclipse.ui.PlatformUI.createDisplay(PlatformUI.java:160)
	at uk.ac.stfc.isis.ibex.e4.product.Application.start(Application.java:38)

when starting the GUI.

Restart after a Power Cut

After a power cut you will need to log into the machine via RDP and then disconnect using the shortcut on the desktop.

Diagnosing Error Screenshots

Taking screenshots on error should be turned on in start_test in test_running.py. The screenshots are placed on the squish server in ... Jenkins\workspace\System_Tests_Squish\suite_configuration_tests\<test name>\errorImages. Only the screenshots from the most recent build will be available.

License server

This was set up as per https://doc.qt.io/squish/setting-up-the-squish-floating-license-server.html on control-svcs.isis.cclrc.ac.uk in the directory /usr/local/squish-licenceserver. The service is automatically started at boot time via systemd, the file squish-licenseserver.service has the service details and is symbolically linked from the systemd /etc/systemd/system area. The log file is /var/log/squish-licenseserver.log and the service is running on the default port of 49345.

To restart the licence server process, use sudo systemctl restart squish-licenseserver.service on the licence server machine.

Troubleshooting

Squish fails to run tests with an error in the C runtime library

Error is:

Runtime Error! 

Program: C:\Squish\lib\_squishrunner.exe 

R6034 An application has made an attempt to load the C runtime library incorrectly. Please contact the application's support team for more information.

This issue is due to us loading the uuid library in Python. This library loads a conflicted C runtime library and means tests aren’t able to run completely correctly.

Solution is to rename C:\Squish\python\msvcr90.dll to msvcr90_off.dll, which removes the conflicting dependency version. See ticket #4773 for more details.

Squish fails to begin run

Attempt to change your tcb file to a regular neutron tcb file and begin a run. You should see it beginning and then return to set up with the log message: invalid tcb start - must be 0 not 5.00000 ns. See the DAE troubleshooting “invalid tcb start” section.

Squish Fails to Start the Application

Look at the Runner/Server Log tab see if you can diagnose the problem.

If the error is:

Unrecognized option: --add-reads=javafx.base=ALL-UNNAMED

This probably means squish is attempting to run on an old Java version, for example Java 8. The client install script copies a fixed version of java into a jre folder next to the client executable, which should force the client to pick up the correct version of Java - check that this is present and the correct version that the client should presently be using.

KeyError: MYSQLPW is missing

To remedy this error set MYSQLPW to the root password in your environment variables when running the tests.

Note

In order to pick up the new environment variable, the Squish IDE will need to be restarted after setting the environment variable.

No licence available

If onsite/vpn you can access https://control-svcs.nd.rl.ac.uk/squish/squish_stats.txt - look for something like

"clientAddress": "::ffff:a.b.c.d"
"licenseType": "tester"

Then from a command windows do nslookup a.b.c.d to see machine name using licence. Currently, licences should auto-expire after 12 hours anyway, so you may just need to wait. licenceType can be tester or execution, we have one of each type and execution is used by the jenkins squish test server (this licence type only allow running, not editing, of tests).

Install new licence

On control-svcs, edit /etc/squish-licence-server/licences/squish-licence.cfg and paste in new licence details. Then run:

service squish-license-server stop
service squish-license-server start

To restart the Squish license server with the new license.