Squash Orchestrator 5.0.0 Release Note
Introduction
Squash Orchestrator is a set of micro-services to perform automated test execution workflows described in a specific format.
This release note describes the changes of Squash Orchestrator version 5.0.0 compared to 4.15.1.
Squash Orchestrator 5.0.0 was released on January 31, 2025.
New features
-
Issue squash-orchestrator #298 🔑 Set default scope for quality gates
Issue squash-orchestrator #271 🔑 Set default scope for insights
Issue orchestrator #616 Handle managedTestResults notifications
Issue squash-orchestrator #269 🔑 Add insights and qualitygate default configurations to image-conf
HTML reports will now display the name of the test cases as it is in Squash TM, instead of its name in the automation test project. In some cases, the HTML reports and the quality gate could also show a different number of test cases based on what was set in the test reference (e.g. a JUnit class containing multiple tests). This is not the case anymore. This is done through a new parameter nameddefault_scope
, available in both the quality gate and the insight collector (set by default totest.managed==true
). Beware that for custom quality gates and insight definitions, this condition needs to be added manually if the scope is explicitely set. -
Issue squashtest-tm-staging #3111 🔑 Allow configurable xpath for failure extraction
Starting from Squash TM 9.0, failed assertion messages will be shown in the execution detail screen and the execution page. This is done through a new parameter namedfailureXPath
available in the Surefire Parser configuration file, to specify the path to the failed assertion message in the XML report. A value is already set for default providers, only custom ones should have it set manually. -
Issue orchestrator #622 Study configurable default configuration for insights
Issue orchestrator #626 Make HTML reports use external CSS style sheets
Insight definition files can now be mounted in the orchestrator without the environment variable, in the path defined by theconfigurations_path
parameter of the insight collector (by default in/app/insights
). Additionally, external CSS files can also be used to customize all the HTML reports generated. These should also be mounted in theconfigurations_path
, in its owncss
folder. More information can be found here for the new parameter and here for the CSS. -
Issue orchestrator #638 Configurable default configuration for qualitygate
Quality gate definitions can now be mounted in the orchestrator without the environment variable. The path is defined by thedefinitions_path
parameter in the quality gate configuration file. More information can be found here. -
Issue orchestrator #636 Add spec.scope property to the SurefireXmlReport insights configuration
Issue orchestrator #648 Add scope parameter for a quality gate
Thescope
property is now also available for SurefireXmlReport and for quality gates. It can be used to add some restrictions to either the report or the qualitygate. -
Issue orchestrator #635 Add an option to disable timestamps in execution logs
Issue python-toolkit #186 Adjust insight collector definition schema
The prefix in the execution logs can now be customized, for example to remove the timestamps. This is done through theoutput-prefix
label. More information can be found here. -
Issue orchestrator #422 Support of Git SHA-256
In previous versions, the actions/checkout action could only accept a commit hash of 40 characters. This has now been extended for SHA256 repositories, with commit hash having 64 characters. -
Issue python-toolkit #182 Allow for '#' in selector values
opentf-ctl
commands (and the related endpoints) accepting selectors (e.g., with the options--field-selector
,--having
,--selector
) now accept hash (#
) in the values of these ones.
Bug fixes
-
Issue orchestrator #620 scp.py does not always close the channel properly
When a step chained multiple commands to retrieve some attachments, if one of them was incorrect the following commands were stopped. This is not the case anymore, every command will be executed regardless of the previous results. -
Issue orchestrator #617 Improve handling of missing OPENTF_VARIABLES file
In previous versions, an inaccessible OPENTF_VARIABLES file could cause some issues with some variables not available. This has now been fixed. -
Issue orchestrator #365 [Action-checkout]Add mask to action checkout
The orchestrator will now mask the credentials used in a checkout action if they were to be printed in the console output.