The Testing tool is one of the most powerful tools in the Unqork Designer Platform. Use it to create and monitor tests in Unqork.
Specifically, the tool lets you perform a variety of tests on API modules, like:
Testing the execution sequence of your API modules.
Comparing an expected API response to the actual API response received.
Confirming data fields in your API response meet specific criteria.
Running tests on your module ensures your modules run as expected. The Testing tool tracks your module's behavior. It reports the test status, notifies you of status changes, and identifies the modules affected.
The email notification includes links to the following:
Module whose test failed.
Module Revisions Dashboard tool.
You can review the test in the Testing tool and use the Module Revisions Dashboard tool to view what caused the issue.
To learn more about creating API tests with the Testing tool, view our Creating API Tests article.
This article explains how to enable the tool in your environment and provides an overview of its key features. Explore the REST of this article series to learn about each Testing tool feature.
To learn more about API modules and how to configure them, view our How to: Create and Edit a Module article. Likewise, to learn more about the Module Revisions Dashboard tool, view our Module Revisions Dashboard Tool article.
Enabling the Testing Tool Workflow
For convenience, you have access to the Testing tool workflow. This workflow automatically executes your tests each time you save your module.
When you first access the Testing tool, you see a notification at the top of the page. In this notification, you find a link to enable the Testing tool workflow in your environment. This notification displays in new environments and at each promotion level—like Staging and UAT. If it is not enabled, the tool still functions, but you must execute your tests manually.
When you click the link, the Testing tool's workflow for your environment opens. You must unlock the workflow so you can enable its Signal Start node.
To unlock the workflow:
Click Viewing at the top of the Workflow Builder.
Click Editing.
Click Save…
Save the workflow
While performing testing, you might experience a warning asking to enable the workflow. The following steps explain how to enable the workflow.
To enable the workflow:
Open the workflow in the workflow builder.
Locate the Signal Start Node, and click Start.
Click Save...
Save the workflow.
Navigating the Testing Tool's Dashboards
The Testing tool consists of a variety of sequential dashboards. As you move from one dashboard to the next, you see more details about your modules and their tests. The Testing tool's dashboards include the following:
Testing Workspace Dashboard
Testing App Dashboard
Testing Module Dashboard
Testing App Dashboard
Along with the dashboard's typical metrics, you also find the following:
Along with the dashboard's typical metrics, you'll also find the following:
The Number of tests passed.
The number of tests failed.
And the total number of tests in your Application.
This dashboard also populates with all the modules in your application. The dashboard includes a variety of filters to locate the information.
Some of these filters include the following:
Helping to determine which modules are API or non-API modules.
Sorting application tests by success rate.
Sorting by application test coverage.
After you find an application, you can view its modules and tests in greater detail.
Clicking View Module Tests takes you to that module's Testing Module Dashboard. Return to the tabs above to view the details of this dashboard.
Testing Workspace Dashboard
The Testing Workspace Dashboard is the entry point to Unqork's Testing tool. After selecting your workspace, you see all tests set up in that workspace. You see everything from:
The test metrics of your workspace.
The number of workspace applications with tests.
The success and failure rates of those tests.
A Failed test on the dashboards is the result of 0% component coverage. All component tests must be successful to receive a Pass.
This dashboard also populates all the applications in your workspace. The dashboard includes a variety of filters to locate your information.
Some of these filters include:
Finding workspace applications with no tests.
Sorting application tests by success rate.
Sorting applications by test coverage.
After you find your application, you can view its modules and tests in greater detail.
Breadcrumbs at the top left of the page show which Testing tool dashboard you are viewing.
Clicking View App Tests navigates you to the application's Testing App Dashboard. Return to the tabs above to view the details of this dashboard.
Testing Module Dashboard
The Testing Module Dashboard is like the Testing App Dashboard. The difference is that it displays the test metrics of a specific module in your application.
The metrics include the following:
Test metrics for your module.
The module's test coverage.
The total number of passed and failed tests.
This dashboard also populates with all the tests in your module. To help you find and sort this information, the dashboard includes a variety of filters.
Some of these filters include:
Finding specific tests in your module.
Filtering by test and component type.
Sorting by date and time of the test's creation.
Once you locate a test, you can view it in greater detail.
Test results vary based on the type of test run. For example, component test details display the component type and the result. You also see grids listing the key and value for each Input and Output. API request test details display the test name, test type, module ID, the API request, the result, and service logs. You also have the option to execute, edit, and delete the test from this details page.
To learn more about creating API tests with the Testing tool, view our Creating API Tests article.