Testing Tool: Module Dashboard

Prev Next

The Testing tool’s Module Dashboard lets you view test details for a specific module in your application.

On the dashboard, you can explore your module’s:

  • Test coverage.

  • Test success rate.

  • Overall test status.

You can also view which tests are active and inactive. Active tests run on module save. Inactive tests don't run on module save. The dashboard includes filters to help you locate and organize your information.

Some of these filters include:

  • Finding active or inactive tests.

  • Sorting tests by creation date.

  • Sorting tests by test type.

Once you locate a test, view it in detail.

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

Viewing a Module

The tool's dashboards are sequential. When you open the tool, you begin at the highest level of your Unqork creations: Workspaces. After selecting a workspace, view its applications:

  1. From the Workspace drop-down, select a workspace.

  2. Use the dashboard's filters to locate a specific Application.

  3. To the right of an application tile, click View App Tests to view its test details.

The Testing App Dashboard opens for that specific application.

To view the application in the Unqork Designer Platform, click View App in Workspace in the top-right corner.

The following video demonstrates how to view your application's tests from the Testing Workspace Dashboard:

After selecting your workspace and application, locate a specific module's tests:

  1. Use the Testing App Dashboard filter to locate a module.

  2. To the right of a module tile, click View Module Tests to view its test details.

The Testing Module Dashboard opens for that specific module.

To view the module in the Module Builder, click View Module in Designer at the top-right of the dashboard.

The following video demonstrates how to view your module's tests from the Testing App Dashboard:

The following clip shows you how to view your module's tests from the Testing App Dashboard

In the Testing Module Dashboard, you can perform various actions:

  • View that module in the Module Builder.

  • Manually execute all API tests in that module.

    As long as the Testing workflow in your environment is running, tests execute automatically on module save. To learn more about enabling the Testing workflow, see Testing Tool.

  • Create an API test.

    To learn more about creating API tests, search Creating API Tests article.

The following sections are also available:

  • The dashboard's test metrics.

  • The dashboard's filters.

  • The Tests table, which displays all your API and component tests.

What displays in the Tests table depends on the type of test. Tests in this table are either API tests or component tests. If your module contains both test types, use the API Tests and Components tabs to filter.

This is how the tabs look:

The following clip shows you how to navigate the Testing Module Dashboard

For API tests, the following table attributes display:

Attribute

Description

Created

The date and time the test was created.

Test Name

The test's name at creation.

Test Type

The test type. Options in this column include:

  • Execution Sequence: Checks whether all your components trigger in the correct order.

  • Match Response: Compares the JSON of the expected API response against the actual API response.

  • Validate Fields: Validates a data field against specific criteria. For example, it confirms an expected value for a specific data field.

Result

A green icon displays when your Test Success Rate is 100%. A red icon displays for rates below 100%.

View API Test

Click this button to view the test's details.

For component tests, the following attributes display:

Attribute

Description

Component key

The Property ID of the component with the test.

Type

The type of logic component. For example, a Calculator, Decisions, or Data Workflow component.

Total Tests

The total Number of tests for that component.

Success Rate

Various options display here: Successful tests: A successful test has a 100% success rate. Failed tests: A failed test has a Success Rate less than 100%. No Success Rate: Occurs when the component has no tests.

  • Successful tests: A successful test has a 100% success rate.

  • Failed tests: A failed test has a Success Rate less than 100%.

  • No Success Rate: Occurs when the component has no tests.

View Component Tests

Click this button to view the test's details.

Table information is also organized alphabetically. By default, the table displays ten entries. Click the pagination buttons below to view more.

Viewing the Module Test Metrics

Here are your module's test metrics. As you add, edit, or remove tests, the results 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 module.

API Success Rate

The percentage of successful API tests in this module.

Component Coverage

The percentage of all module components that have tests in this module.

Component Success Rate

The percentage of successful component tests in this module.

Using the Testing Module Dashboard Filters

Below the metrics are the dashboard filters. Use these filters to locate specific tests in your module.

Depending on the type of test, different filter options are available. If your API module only has an API test, only the filters specific to API tests display. If you have a module with API and component tests, tabs display on the dashboard for each set of filters.

Filtering API Module Tests

If the module you're viewing has API tests, click the API Tests tab above the filters. The Tests table then displays only API tests in that module.

If your module only has one type of test, you do not see these tabs.

You also see the following filters:

Filter

Description

Test Type

The test type. Options in this column include:

  • Execution Sequence: Checks whether all your components trigger in the correct order.

  • Match Response: Compares the JSON of the expected API response against the actual API response.

  • Validate Fields: Validates a data field against specific criteria. For example, it confirms an expected value for a specific data field.

Result

This group of filters lets you locate all tests that passed, failed, or are inactive.

Below are explanations of each Result type.

Pass

Select this checkbox to display all tests with a 100% Test Success Rate.

Fail

Select this checkbox to display all tests with a Test Success Rate less than 100%.

N/A

Select this checkbox to display all inactive tests.

Status

This pair of filters lets you see only active or inactive tests.

Active

Select this checkbox to display only active tests. Active tests are available to run.

Inactive

Select this checkbox to display only inactive tests. Inactive tests are disabled and can't run.

Sort By

Use this drop-down to sort the Tests table. Sorting options include Created, Result, Test Name, and Test Type. Below are explanations of each option.

Created

Organizes the table by the test's creation date and time. The most recent test displays at the top of the table.

Result

Organizes the Tests table by Result. From top to bottom, the table has the following organization:

  • Tests with a green Result icon. This icon indicates these tests passed.

  • Tests with a red Result icon. This icon indicates these tests failed.

By default, the results are in ascending (A-Z) order by Test Name.

Test Name

Organizes the table in ascending (A-Z) order by Test Name.

Test Type

Organizes the table in ascending (A-Z) order by Test Type.

Apply Filter

Click this button to apply the filters.

Reset Filter

Click this button to reset the filters and return the Tests table to its defaults.

Filtering Component Tests

In the module where you're viewing component tests, click the Components tab above the filters. The Tests table then displays only component tests in that module.

If your module only has one type of test, you do not see these tabs.

A logic component filter and sorting options are also available:

You also see a logic component filter and various sorting options:

Filter

Description

Component Type

This drop-down lets you select a logic component to filter. The options include a Calculator, Decisions, or Data Workflow component.

Sort By

Use this drop-down to sort the Tests table. Sorting options include Component Key, Type, Total Tests, and Success Rate. Below are explanations of each option.

Component Key

Organizes the table in ascending (A-Z) order by component Property ID.

Type

Organizes the Tests table in ascending (A-Z) order by the component type.

Total Tests

Organizes the Tests table by total number of tests. Components with the most tests display at the top of the table.

Success Rate

Organizes the Tests table by Success Rate. From top to bottom, the table has the following organization:

  • Successful tests. A successful test has a 100% Success Rate.

  • Failed tests. A failed test has a Success Rate less than 100%.

  • No Success Rate. Occurs when the component has no tests.

Apply Filter

Click this button to apply the filters.

Reset Filter

Click this button to reset the filters and return the Tests table to its defaults.

Viewing Component Test Details

After using the dashboard's filters to locate a test, click View Component Tests. This opens the Component Test Details page, which displays information specific to your component tests. The page also includes a link to open your module in the Module Builder.

The page includes the following:

Attribute

Description

Row

When you create a test in a component, you’ll enter its information into that component's Testing Harness. Doing so references the row the test exists in the component's harness table. The first row of the table is 0.

Inputs

The component's test inputs.

Outputs

The component's test outputs.

Result

The status of the test. Options include:

  • Pass: The executed test performed its function correctly.

  • Fail: The executed test performed its function incorrectly.

View Details

This button is helpful when your test fails. Click it to open a pop-up modal that displays the expected and actual outputs.

Here's an example of the information that displays when you click View Details for a failed test.

Click Go to Module Builder to open that module. Or click X (Close) at the top-right to close the Modal and return to the Component Tests page.

Viewing Test Details

After using the filters to locate a module, view its details. The details depend on the type of test you're viewing. Here are the test details for each test type.

Viewing API Test Details

After using the dashboard's filters to find a test, click View API Test. This opens the API Test Details page, which displays information specific to your API module tests. The information differs slightly depending on the test, but the page always includes the following:

Attribute

Description

Execute Test

Click this button to execute the test manually. A modal displays confirming whether the test passed or failed.

View Module in Designer

Click this link to open the tested API module.

Edit Test

Click this button to edit the test. You can do the following:

  • Change the Test Name.

  • Change the API request.

  • Add, edit, or delete assertion tests. These tests verify whether an API response matches the expected response.

  • Set the test to inactive. Clear the Active checkbox to make tests inactive. Inactive tests are grayed out in the Tests table.

Delete Test

Click this button to delete the test.

Below these buttons and links are three tabs:

  • Details

  • Result

  • Service Logs

Here's the information each tab provides:

Viewing the Details Tab

Regardless of the API request Test Type, the Details tab includes common information. The following information displays for your API request test:

Attribute

Description

Test Name

The name of the test.

Test Type

The API test type. Options in this column include:

  • Execution Sequence: Checks whether all your components trigger in the correct order.

  • Match Response: Compares the JSON of the expected API response against the actual API response.

  • Validate Fields: Validates a data field against specific criteria. For example, it confirms an expected value for a specific data field.

Created

The date and time the test was created.

Creator

The user who created the test.

Active

Whether the test is active or inactive. It displays as either:

  • Active: Yes

  • Active: No

Module ID

The module ID of the module where this test exists.

submission ID

The submission ID of the submission tested.

The information that displays depends on the test. The following table describes the information for each test:

Test

Test Details

Execution Sequence

For this test, the following information displays:

  • Request: The tested API request in the Request field.

  • Event Log: This log displays the full sequence of your API call, including the components, their events, and the steps at which the events occur.

Match Response

For this test, the following information displays:

  • Request: The tested API request in the Request field.

  • Expected Response: This field displays the expected API response for your API module.

Validate Fields

For this test, the following information displays:

  • Request: The tested API request in the Request field.

  • Assertion Test: This table displays the tested data field and its criteria.

Here's an example of the Details tab for an Execution Sequence test:

Viewing the Result Tab

The Result tab shows whether your test passed or failed. It also displays the executed API response and the execution sequence of your API call. An Event Log displays the components and their events at each step. Use the navigation bar to view all steps and their events. For Validate Fields tests, a table of assertion tests and their pass/fail results also displays.

Below is an example of the Result tab for a failed Validate Fields test.

Viewing the Service Logs Tab

Every time an API call executes, the system creates a service log. The Service Logs tab displays the logs for the most recent test execution. This tab displays the following information:

Attribute

Description

URL

The URL for the tested API call.

Service Log ID

The generated identifier when the API request executes.

Response Code - Text

The response code for the API call. For example, a successful call returns 200 - OK. Other response codes include 400 and 500 error codes.

Duration (ms)

The time the API call took to finish, measured in milliseconds (ms).

Request Time

The timestamp detailing when the API call started.

Response Time

The timestamp detailing when the API call finished.

View Service Logs Dashboard Link

Click this link to view this API module's service logs.

To learn more about the Service Logs Dashboard tool, see Service Logs Dashboard Tool.

Here's an example of the Service Logs tab for an Execution Sequence test: