Skip to content

Further Information on Version Upgrades

Upgrade from Version 5.0 to Version 5.1.X

To upgrade Squash TM from version 5.0 to version 5.1.X, it is not necessary to upgrade the database. You must only upgrade the app.

Upgrade from version 4.1 to version 5.0

Warning

With Squash TM 5.0, the drivers for connection databases are updated.
As a result, for MariaDB users:

  • Squash TM 5.0 is not compatible with MariaDB 10.5 and earlier versions. The recommanded version is MariaDB 10.6.
  • The following properties must be updated with "mariadb" in the startup file:
    • DB_URL="jdbc:mariadb://localhost:3306/squashtm"
    • DB_TYPE=mariadb

To upgrade Squash TM from version 4.1 to version 5.0, you must run an upgrade script on the database: <database>-upgrade-to-5.0.0.sql.
It is necessary to follow the usual upgrade procedure.

Plugins Compatibility

Because of the upgrade of internal components, when upgrading to Squash TM 5.0, it is necessary to also upgrade all the plugins. All the plugins compatible with Squash TM 5.0 are in version 5.0.0.

Compatibility with Squash AUTOM/DEVOPS

To get all the new features, specifically the interpreted environment variables, it is necessary to upgrade Squash Orchestrator and its services to the versions of Squash AUTOM/DEVOPS 2023-02 delivery.

Moreover, with Squash TM 5.0, it is now possible to configure the URL to pass subscription and publication information to Squash Orchestrator for a Squash AUTOM test automation server. For existing configuration, it is necessary to configure this URL. For more information, visit the documentation.

Upgrade from version 4.0 to version 4.1

To upgrade Squash TM from version 4.0 to version 4.1, you must run an upgrade script on the database: <database>-upgrade-to-4.1.0.sql.
It is necessary to follow the usual upgrade procedure.

Plugins compatibility

With the upgrade to Squash TM 4.1, it is necessary to also upgrade some plugins to get all the new features. All the plugins compatible with Squash TM 4.1 are in version 4.1.0.
For the plugins that don't have a 4.1 version, the version 4.0.X is compatible with Squash TM 4.1.

Compatibility with Squash AUTOM/DEVOPS

To get all the new features, specifically to view environment tags and variables on an execution consultation page, it is necessary to upgrade Squash Orchestrator and its services to the versions of Squash AUTOM/DEVOPS 2022-10 delivery.

Upgrade from version 3.0 to version 4.0

Warning

With Squash TM 4.0, version of Java and the drivers for connection to PostgreSQL and MariaDB databases are updated.
As a result of choices imposed by these tools, Squash TM 4.0.0 is not compatible with: - MySQL, no matter its version
- MariaDB 10.1
- PostgreSQL 9 (as a reminder, PostgreSQL 10 is also not supported)
- Java versions before Java 11, including Java 8 (Java installed on the server hosting Squash TM)

If you are using Squash with one of these versions, we recommend you to upgrade your tools - or to migrate in the case of MySQL - before considering an upgrade to Squash TM version 4.0. More information on this post

To upgrade Squash TM from version 3.0 to version 4.0, you must run an upgrade script on the database: <database>-upgrade-to-4.0.0.sql.
It is necessary to follow the usual upgrade procedure.

Plugins Compatibility

Because of the upgrade of internal components, when upgrading to Squash TM 4.0, it is necessary to also upgrade all the plugins. All the plugins compatible with Squash TM 4.0 are in version 4.0.0.

Transition from Mantis SOAP Bugtracker to Mantis REST Bugtracker

With Squash TM 4.0, Mantis REST Bugtracker replaces Mantis SOAP Bugtracker that is not available anymore. Unlike Mantis SOAP Bugtracker which was included in Squash TM core, it is necessary to install Mantis REST Bugtracker connector to access its functionalities. By default, it is included in Squash TM distribution (in the 'plugins' directory).

Transition from Mantis SOAP Bugtracker to Mantis REST Bugtracker does not cause data loss. Known issues linked to executions are still visible in Squash TM. It is also not necessary to create a new bugtracker in Squash TM.
Only the authentication protocol changes, it is now a token authentication. To use this new connector and visualize known issues reported with the former connector, users must authenticate again to Mantis from Squash TM with their token generated in Mantis beforehand.

Compatibility with Squash AUTOM/DEVOPS

Squash TM 4.0 is compatible with Squash AUTOM/DEVOPS 2022-05 and later deliveries. Thus, for Squash AUTOM/DEVOPS users, Squash Orchestrator and the associated services must be updated.

Moreover, with Squash TM 4.0, it is now possible to configure the URL to retrieve information from Squash Orchestrator for a Squash AUTOM test automation server. For existing configuration, it is necessary to configure this URL. For more information, visit the documentation.

Upgrade from Version 2.1+ to Version 3.0

To upgrade Squash TM from version 2.1 to version 3.0, you must run an upgrade script on the database: <database>-upgrade-to-3.0.0.sql.
It is necessary to follow the usual upgrade procedure.

Plugins Compatibility

With the upgrade to Squash TM 3.0, it is necessary to also upgrade some plugins. All the plugins compatible with Squash TM 3.0 are in version 3.0.0.
For the plugins that don't have a 3.0 version, the version 2.X is compatible with Squash TM 3.0.

Upgrade from Version 2.1 to Version 2.2

To upgrade Squash TM from version 2.1 to version 2.2, it is not necessary to upgrade the database. You must only upgrade the app.

Plugins Compatibility

Plugins compatible with Squash TM 2.1 are also compatible with Squash TM 2.2 except the following plugins that have a 2.2 version:

  • Result Publisher Plugin
  • Squash AUTOM Plugin

Warning, plugins in version 2.2 are not compatible with Squash TM 2.1. To have the latest features, it is necessary to upgrade Squash TM and the plugins in version 2.2.

Upgrade from Version 2.0 to Version 2.1

To upgrade Squash TM from version 2.0 to version 2.1, you must run an upgrade script on the database: <database>-upgrade-to-2.1.0.sql.
It is necessary to follow the usual upgrade procedure.

Plugins Compatibility

Squash TM 2.1 is compatible with plugins in version 2.1. For the plugins that don't have a 2.1 version, the version 2.0 is compatible with Squash TM 2.1.
Warning, plugins in version 2.1 are not compatible with Squash TM 2.0. To have the latest features, it is necessary to upgrade Squash TM and the plugins in version 2.1.

Upgrade from Version 1.22.5+ to Version 2.0

To upgrade from Squash TM 1.22.5 to Squash TM 2.0, you must follow the usual procedure:

  • Download the configuration files and the database
  • Download version 2.0
  • Run the upgrade script <database>-upgrade-to-2.0.0.sql in the database
  • Update the app

Warning

From version 2.0 onwards, packages Debian and Red Hat are no longer supported.
Please visit the page for more details on the procedure to follow.

Focus

Squash TM 2.0 offers a brand new interface based on the Angular technology. This change of technology entails that you must be watchful about a few things, which are listed down below.

Plugins Compatibility

Squash TM plugins that are compatible with versions 1.X are no longer compatible with version 2.0. Therefore, you must download the new version of these plugins to enjoy their features in Squash TM 2.0.

To avoid inconsistencies, all the plugins compatible with Squash TM 2.0 are in version 2.0.0.RELEASE.

Learn More

To see the list of plugins compatible with Squash TM 2.0, please visit the page Squash TM Plugins

Some plugins compatible with versions 1.X of Squash TM were already in version 2.X. To ensure a version number consistency between Squash TM and its plugins, these plugins were renamed.

Here is the table of correspondences for these plugins:

Plugin Name in Squash TM 1.X Name in Squash TM 2.0
Test Cases Report Books PDF report.books.testcases-1.x report.books.testcases.pdf
Editable Test Cases Report Books
(included in Squash TM)		 report.books.testcases-2.x report.books.testcases.editable
Requirements Report Books PDF report.books.requirements-1.x report.books.requirements.pdf
Editable Requirements Report Books
(included in Squash TM)		 report.books.requirements-2.x report.books.requirements.editable
Campaign & Iteration Report report.campaignassessment report.campaign.execution

Changes in Language Files

In Squash TM 2.0, the outsourcing of language files is evolving. The new interface being based on Angular, the messages visible in the HCI are now stored in new files in .json format. Custom (empty) files for every supported language (French, English, Spanish, German) are available in the Squash TM server directory conf/lang.

If the language files were modified in version 1.X to custom messages visible in the HCI, you must copy these changes in the .json files compatible with Squash TM 2.0.

However, you must keep the language files that were modified in version 1.X because they are still being used in version 2.X, especially for some backend and report messages.

Learn more

To learn more about these files, please read this part Outsource language files

Custom Plugins

This change of technology also has consequences on plugins. Thus, if custom plugins were created for Squash TM, and if they add graphic elements (buttons, fields) or new screens to Squash TM, they will no longer work with Squash TM 2.0. You must make the necessary changes to these custom plugins before you can use them in the new version.

Upgrade from Version 1.21.X to Version 1.22.4

To upgrade to version 1.22, you must follow the usual procedure: replace the binary code and run the required SQL scripts.

Warning

To upgrade to version 1.22.2+, you must run all the upgrade scripts between the database's original version to the targeted version of Squash TM. To upgrade to version 1.22.4 from version 1.21.X, you must run the following scripts in order:

  • <databse>-upgrade-to-1.22.0.sql
  • <databse>-upgrade-to-1.22.2.sql
  • <databse>-upgrade-to-1.22.3.sql

When you are running the script to upgrade to version 1.22, warnings and triggers can appear. These warnings are only for information purposes and have no impact whatsoever on the app.

Following the upgrade to Squash TM 1.22, login information to the automated execution servers will be lost because they are stored differently in the database. You will have to re-enter them on the automated execution server's consultation page in the block "Authentication policy":

Authentification à Jenkins

A new option added to the Squash TM administration allows you to automatically connect to bugtrackers when you are using an AD or LDAP.

Three new API come with version 1.22: Admin API, Xsquash4Jira API, and Actions Library API.

Learn more

To learn more about Squash TM APIs, please visit this page Squash TM APIs

Focus

In Squash TM 1.22, the install process of the systemd service in Debian has also evolved. Read more.

Upgrading from Version 1.20.X to Version 1.21.X

Upgrading from Squash TM 1.20.X to Squash TM 1.21.X must be done by following the usual version upgrade procedure.

It must be noted that running the script to upgrade to version 1.21 can take longer than usual when there is a high number of executions in Squash TM's database.