Testing Tool: Workspace Dashboard
Overview
The Testing Workspace Dashboard is the entry point to Unqork's Testing tool. Here you see every test set up in a workspace. At this high level, you see everything from:
-
Test metrics for a workspace.
-
The number of workspace applications with tests.
-
The success and failure rates of those tests.
This dashboard also populates with all the applications in your workspace. The dashboard includes a variety of filters to help you find and sort this information. Some of these filters include:
-
Finding workspace applications with no tests set up.
-
Sorting application tests by success rate.
-
Sorting by application test coverage.
Once you find an application, you can view its modules and tests in greater detail.
To learn more about creating API tests with the Testing tool, view our Creating API Tests article.
What You'll Learn
In this article, you’ll learn how to:
Selecting a Workspace
Now that you are logged in to the tool, select a workspace to view its tests. Use the Workspace drop-down to select a workspace in your environment. Once you select a workspace, the dashboard populates with:
-
API (application programming interface) module test coverage and success rates.
-
Component test coverage and success rates.
-
Filters and sorting functions to view specific data.
You can see an example of the Testing Workspace Dashboard in the following image:
You'll also notice a link to the right of the drop-down. Clicking this link takes you directly to that workspace in the Unqork Designer Platform.
Viewing the Workspace Test Metrics
After selecting a workspace, all its test metrics and applications display on the dashboard. As you add, edit, or remove tests in this workspace, the results in this section change in real-time. Below is a description of the different metrics in this section:
| Test Metric | Description |
|---|---|
|
API Coverage |
The percentage of all API modules that have tests in this workspace. |
|
API Success Rate |
The percentage of successful API tests in this workspace. |
|
Component Coverage |
The percentage of all module components that have tests in this workspace. |
|
Component Success Rate |
The percentage of successful component tests in this workspace. |
Using the Testing Workspace Dashboard's Filters
Above the Applications table, you'll find the dashboard's filters. These filters help you find specific applications in your workspace. You see the following filters:
| Filter | Description |
|---|---|
|
Application |
Use this drop-down to select a specific application in your workspace. You can select as many applications as you want. |
|
Result |
This group of filters lets you find all applications with passed, failed, or no tests. |
|
Pass |
Select this checkbox to show all applications with a 100% API Success Rate. |
|
Fail |
Select this checkbox to show all applications that have an API Success Rate less than 100%. |
|
N/A |
Select this checkbox to show all applications that don't have tests. |
|
Sort By |
This filter doesn't display specific types of applications. Instead, use this drop-down to sort the Applications table. You can sort by App Name, Result, Success Rate, and Test Coverage. Below are explanations of each sort option. |
|
App Name |
Organizes the Applications table alphabetically. By default, the results are in ascending (A-Z) order. |
|
API Coverage |
Organizes the Applications table by API Test Coverage. Applications with the highest percentage of API modules tested are at the top of the table. |
|
API Success Rate |
This option organizes the Applications table by API Success Rate. From top to bottom, the table has the following organization:
|
|
Component Coverage |
Organizes the Applications table by Component Coverage. Applications with the highest percentage of components tested are at the top of the table. |
|
Component Success Rate |
Organizes the Applications table by Component Success Rate. From top to bottom, the table has the following organization:
|
|
Result |
Organizes the Applications table by App Status. From top to bottom, the table has the following organization:
By default, the results are in ascending (A-Z) order. |
|
Apply Button |
Click this button to apply the filters. |
|
Reset Filters Button |
Click this button to reset the filters and return the Applications table to its default view. |
Navigating the Applications Table
Below the test metrics, you'll see a table of all your workspace applications. The table is organized into the following attributes:
| Attribute | Description |
|---|---|
|
App Name |
The application name. |
|
API Coverage |
The percentage of all application API modules that have tests. The calculation is the number of tested modules compared to the total number of modules. |
|
API Success Rate |
The percentage of successful API tests. The calculation is the number of successful tests compared to the total number of tests. |
|
Component Coverage |
The percentage of all module components that have tests. The calculation is the number of tested components compared to the total number of testable components in the module. |
|
Component Success Rate |
The percentage of successful component tests. The calculation is the number of successful tests compared to the total number of tests. |
|
Result |
You see a green icon if your API Success Rate is 100%. Anything below 100% shows as a red icon. |
|
View App Tests Button |
Clicking this button opens that application in the Testing App Dashboard. |
Hover over any of the percentages to see how they were calculated.
From top to bottom, the table has the following organization:
-
Applications with successful tests. Remember, successful tests are only those with a 100% Success Rate.
-
Applications with failed tests. A failed test has a Success Rate less than 100%.
-
Applications with no tests.
By default, the table shows 10 entries. You can click the pagination buttons below the table to see more entries.
Viewing Your Workspace Applications
After you use the filters to find an application, you can view its test details. Clicking the View App Tests button opens the Testing App Dashboard for that specific application. The Testing App Dashboard shows you:
-
The number of passed and failed tests.
-
The application's test coverage.
-
The application module's test success rates.
To learn more about the Testing App Dashboard, search Testing Tool: App Dashboard in our In-Product Help.
