Testing Tool Overview

The Testing tool creates and monitors automated tests for Unqork API modules. The tool supports three test types:

• Execution Sequence: Tests whether all components trigger in the correct order.
• Match Response: Compares the expected API response against the actual response received.
• Validate Fields: Confirms that data fields in the API response meet specific criteria.

When a test fails, the Testing tool sends an email notification with links to the failed module and the Module Revisions Dashboard. Use the Module Revisions Dashboard to identify what change caused the failure.

Enabling the Testing Tool Workflow

The Testing tool workflow is available in every environment. This workflow automatically executes tests each time a module is saved.

When the Testing tool is first accessed, a notification displays at the top of the page with a link to enable the Testing tool workflow in the environment. The notification displays in new environments and at each promotion level, like Staging and UAT. If the workflow is not enabled, the tool still functions, but tests must be executed manually.

Clicking the link opens the Testing tool workflow. Unlock the workflow to enable its Signal Start node.

To unlock the workflow:

1. Click Viewing at the top of the Workflow Builder.

2. Click Editing.

3. Click Save…

4. Save the workflow.

A warning might appear asking to enable the workflow:

To enable the workflow:

1. Open the workflow in the Workflow Builder.

2. Locate the Signal Start Node and click Start.

   

3. Click Save...

4. Save the workflow.

Navigating the Testing Tool's Dashboards

The Testing tool consists of three sequential dashboards, each drilling deeper into test detail.

Testing Workspace Dashboard

The Testing Workspace Dashboard is the entry point for the Testing Tool. After selecting a workspace, the dashboard shows test coverage and success rate metrics for all applications in the workspace. Use the filters to find applications with no tests, sort by success rate, or sort by test coverage.

A failed test on the dashboards is the result of 0% component coverage. All component tests must pass to receive a Pass result.

Breadcrumbs at the top left of the page show the current Testing Tool dashboard.

Click View App Tests to open the App Dashboard for a specific application.

Testing App Dashboard

The Testing App Dashboard shows test metrics and all modules for a specific application. Use the filters to identify API and non-API modules, sort by success rate, or sort by test coverage.

Click View Module Tests to open the Module Dashboard for a specific module.

Testing Module Dashboard

The Testing Module Dashboard shows test metrics and all tests for a specific module. Use the filters to find tests by type, filter by component type, or sort by creation date. Tests can be executed, edited, and deleted from the test details page.

Test details vary by type. Component test details show the component type, result, and input/output values. API test details show the test name, type, module ID, API request, result, and service logs.

To learn more about creating API tests, see Creating API Tests.