API 1.13

Software version: API 1.13

Scheduled release date: 21 Oct 2022 

This file provides information about the VERA API Server:

  • Version Information

  • Resolved Issues

  • New Features

  • Docker Image Information

  • Known Issues and Limitations

 

Version Information

High-level VERA Version

2022.3

API Version

API 1.13

Software Build

(Can be verified on the "Versions" screen in the web portal.)

3249

(2022/10/18)

Resolved Issues

Key

Summary

Notes

Key

Summary

Notes

VS-2043

Enhanced Logging

Logging has been updated to be module specific and provide better flexibility in log naming and formatting. See https://tx3.atlassian.net/wiki/spaces/V20222/pages/69042991 for more information.

VS-2256

Signature verification issue

Fixed an issue that was causing some signature verifications to fail unexpectedly.

VS-2286

Policies Module omitted sub-constraints

Fixed an issue where the Policies Module would not load sub-constraints properly.

VS-2300

Users removed from a qTest project caused routing to fail

Fixed an issue where when routing a qTest record for approval, the route would fail if any of the authors were removed from the qTest project.

VS-2317

Policies module does not honor other existing constraints

The Policies module was extended to utilize more constraints, e.g. Field Is Equal.

VS-2342

qTest Module is requesting an auth token with each request to qTest

The qTest Module was enhanced to only request an authorization token when needed.

VS-2525

Security Enhancements

Several modules were upgraded for security enhancements.

New Features

Key

Summary

Key

Summary

VS-1836 / VS-1837 / VS-1838 / VS-1839

Completely reworked how Approval Roles work with domains. Now a user can be assigned to an Approval Role within a single domain or across domains.

VS-1835

Separated out System Roles (eg. System Administrator) from Approval Roles.

VS-1846

Enhanced the CSV import utility to be able to assign both System Roles, Domain access, and new Domain-based Approval Roles.

VS-1964 / VS-1965 / VS-1967

Enhanced the system automatically convert the previous role system to the new Domain-based Approval Roles. Enhanced the system to create a Default Domain and assign any un-assigned projects to the Defect Domain.

VS-2564

Enhanced the Route for Approval Notification to include the Domain and Project in the subject line.

Docker Image Information

Known Issues and Limitations

Key

Summary

Known Issue Details

Key

Summary

Known Issue Details

VS-139

"Pending Tasks" field refreshes too slowly after route withdrawal.

The Pending Tasks field in qTest and Jira is not immediately updated when the record is approved or rejected in VERA.  The cached values are updated when the user invokes a browser refresh,

VS-163

Rejection Reason can be submitted with only a space (no text) entered

Rejection Reason can be submitted with only a space (no text) entered. 

VS-447

User Administrator role can see Signature Verification Failure Report and Re-verify

A User Administrator can access the Signature Verification reporting section of the Administration Portal.  This feature should be limited to System Administrators.

VS-668

Sorting shows all values beginning with a capital letter before lowercase values

When sorting data (users, records, etc.) alphabetically, the system erroneously alphabetizes capital letters independently from lower-case letters.  For example:  Apple, Cat, ball -- instead of: Apple, ball, Cat

VS-692

JSON Attachment download returns 500 error

A Jira issue had the approval policy.json file attached; an error was displayed when downloading the attachment.

VS-698

VERA cannot create a qTest record if two fields in the record have the same name

The VERA-qTest integration does not support importing records from qTest where the record has two fields with the same name.  If such a record is routed for approval from qTest, then an error will occur.

VS-700

User sees duplicate approval tasks for the same record in approval queue

If an approval route contains two pending tasks for the same role (e.g. two Technical approvals) then an eligible approver will see both tasks in their queue.

VS-962

Approval Queue user filter uses RegEx can match different users

Due to regular expression matching, a record that has been signed by one user may cause another user's approval queue to exclude the record when it should be available.

VS-988

VERA DevOps does not apply a default approval route

If a record is routed for approval that does not satisfy any configured route templates, the user will see "VERA is trying to start the approval route" rather than a descriptive error containing the reason why the route was not started.

VS-1060

If user has a null value for a role in their claims list the user module fails to add or remove them from a role

If a user has a claim that has a type of role and a value of null (not just a blank string), the user module will throw an exception when trying to add or remove the user from a role.

VS-1065

A misleading error message is displayed when VERA cannot apply a final approval

VERA will display a misleading error message when it fails to transition a Jira issue in the workflow.  The error message displayed to the user will indicate that there is a connectivity problem, even if it's actually a configuration problem. 

VS-1243

Invalid Approval Group error log should indicate with group or line number the error is on

Currently error log does not display approval group details when invalid approval group is logged. 

VS-1277

VERA returns an HTTP 500 status code to Jira webhooks when it cannot access the Sync ID field

With Jira Cloud, the HTTP 500 status code will prompt Jira to retry the same webhook a few minutes later.  This is undesirable, because a) there is no reasonable expectation that it will succeed, and b) the user will have very likely tried rerouting the record again anyway.

Therefore, the Jira module should return a different status code that will not trigger a retry from Jira Cloud.

VS-1278

VERA does not handle concurrent start route requests for the same record

The VERA API does not have proper handling for concurrent start approval route requests for the same record.  If it is a new record, then the end result could be the record receiving two different Sync IDs each with its own approval route.

VS-1293

Final approval fails when Jira projects are configured with a Signatures field

VERA will attempt to write the entire approval route to the Jira Signatures field if the field is present in the Jira project. If the approval route contains over 255 characters the Approval will fail since VERA is attempting to write over 255 characters to the field.

VS-1303

Jira and qTest Modules use the Server property from the Sync Policy as the Base URL

The Jira and qTest modules both use the Server property for a location for the baseurl when connecting to Jira or qTest. This is normally fine, but can cause an issue where a client has a gateway or proxy in between VERA and their Jira/qTest servers. Modules should use the API Server url defined in the policy file.

VS-1391

Revision is blank in qTest Run Record Details for History entries

The Revision field is blank for qTest Test Run records in the Record Details for a History entry.

VS-1419

Routing records for approval - errors in logs

In the users module, when GET /users/{userId} endpoint is being called with a userId different from the request owner's userId, then users module responses with 403 Forbidden status code.

VS-1591

Password content can break qTest integration

Using a colon character (":") in the qTest Service Account password causes the qTest integration to fail. The colon character (":") is not supported and should not be used in service account passwords.