Squash Orchestrator 5.1.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.1.0 compared to 5.0.0.

Squash Orchestrator 5.1.0 was released on March 05, 2025.

New features

• Issue orchestrator #653 Adapt datasources for the retry plugin
  Issue python-plugins #25 🔑 Create retry plugin
  Issue micronaut-java-plugins #109 🔑 [Publisher] Manage test executions retries
  The orchestrator now includes a retry mechanism to improve the reliability and resilience of test executions. It utilizes a new event tm.squashtest.org/retry@v1 with parameters such as max-retry, scope, and failure-status. Currently, it is only available at the channel hook level. More information can be found here.

• Issue orchestrator #650 Implement reusable workflows
  Users can now define reusable workflows by executing an additional workflow within a main workflow, treating it as a set of jobs integrated into the primary execution flow. More information can be found here.

• Issue orchestrator #631 Define and implement an initial set of telemetry metrics for the eventbus service
  Issue orchestrator #630 Define and implement an initial set of telemetry metrics for the arranger service
  Issue orchestrator #632 Add a metrics collector service
  Issue orchestrator #640 Define and implement an initial set of telemetry metrics for the agentchannel and the sshchannel services
  Issue python-toolkit #188 Add OpenTelemetry collector to startup
  Telemetry metrics have been introduced to improve system observability and performance tracking. An initial set of metrics has been implemented for key services, including EventBus, Arranger, AgentChannel, and SSHChannel. Additionally, a dedicated metrics collector service has been added to centralize and streamline monitoring. By default, it is disabled, it can be enabled using the OPENTF_TELEMETRY=true environment variable. For more details on how to use these new metrics, refer to the documentation here.

• Issue otf-all-in-one-images #204 Upgrade allure library from 2.13.8 to minor version 2.14.0
  The Allure reporting library has been upgraded from version 2.13.8 to 2.14.0, bringing minor improvements and fixes.

• Issue python-plugins #27 🔑 Improve logpublisher logs
  The LogPublisher plugin has been enhanced to include the HTTP return code in the log.

Bug fixes

• Issue python-toolkit #191 Hooks based on after teardown are not executed after the cleanup
  The execution order of the hooks has been fixed. The "after teardown" hooks are now correctly executed after the cleanup, as expected.

• Issue orchestrator #658 Improve channel allocator queue handling
  Pending job channel requests for completed workflows are now properly cleared, preventing unnecessary requests and improving the performance of other workflows.

• Issue orchestrator #654 timeout-minutes parameter is not transfered through a job generator
  The issue where the timeout-minutes parameter was not transferred correctly through a job generator has been fixed. This ensures that the timeout for generated jobs now matches the expected value set in the workflow configuration.

• Issue orchestrator #652 Generator jobs are initialized with last initialized job name in contexts
  An issue has been fixed where generator jobs were initialized with the name of the last initialized job in their contexts (contexts.opentf.job and contexts.squashtf.job). Now, each generated job will have the expected job name in the contexts.

• Issue micronaut-java-plugins #126 [Interpreter]Nonexistent node in the failureXpath is not handled correctly
  The issue where nonexistent nodes in the failureXpath were not handled correctly has been resolved. The system now properly manages such cases, improving error handling and diagnostics.