3.2.4 Quality Gates, Scripts

Abbreviations, used in manual:

QG - Quality Gates

EF - Execution Flow

Scripts are commands that can be implemented within the QG module.

• The Script can contain several steps (of the same type).
• Steps order can be changed.
• Dependency type of a following step to a previous step failure can be configured.

The default return status of a Script is Success (1). If a Script returns a value, it is possible to specify an expected Success/Failure value and to use the Script as a trigger.

 

In QG module "Scripts" are available in the left side menu, under each specific  "Project -> Library -> Scripts" section:

By clicking on "Scripts", a grid displaying all scripts associated with the selected project will be shown:



 

Available operations in the Scripts grid:

Bulk Operations - allow to mark a few Scripts at a time and to Delete, Update or Copy them together.

Deploy/Deploy All - allows to Deploy selected Scripts/all the Scripts in the page from one environment to another.

A Data Script(s) can also be Edited/Copied/Deleted by clicking relevant icons in each row.

In order to add a new script, click on "Add Script":

Name - choose suitable name for Variable.

Description - short and informative Variable description.

Severity - The impact level of a script failure

Tags - Variable can be related to appropriate Tag(s).

Supported Script types:

• Command line - allows to run most of CMD commands. Also can be used as a trigger to run an entity (EF, Test, ...) in the QG module. Please see related detailed manual: Command Line.
• run_qp command - allows to implement run_qp commands using relevant syntax to remotely trigger QG module entities (EFs, Tests, ...). Please see related detailed manual: run_qp command
• SQL Execute - in SQL (Structured Query Language), an "execute" statement is used to run a previously prepared SQL statement or stored procedure. Please see related detailed manual: SQL Execute
• SQL query - allows to run a custom SQL query. Please see related detailed manual: SQL query
  
  

Return Type (*Optional) - chose "Success" or "Failure":

Success return type - if the return value is equal to the results from the query, a successful message will appear and will enable the Scriptable Button in FW.
If the return value is not equal to the results from the query, a failure message will appear and will disable the Scriptable Button in FW. 

Failure return type - if the return value is equal to the results from the query, a failure message will appear and will disable the Scriptable Button in FW.
If the return value is not equal to the results from the query, a successful message will appear and will enable the Scriptable Button in FW.

Return value - When selecting "Return Type", an option to specify the Return value will appear:

• Success Message & Error Message will be added to the returned value in case of using "Return Type" & "Return Value". For Example:
  
  
   

Success Message – Write the message to be displayed when the script runs successfully.
Error Message – Write the message to be displayed in case of a failure.

To add an additional step to the Script, click the "Add Script" button located in the bottom left corner of the page:

It will add a new Script code window under the existing one:

You can adjust the execution order of commands by using the arrow icons to arrange each Script in the desired sequence.