Test Manager API integration

概述

Test Manager Software Development Kit (SDK) provides Test Manager integration with your development tools. Through this type of integration, you can synchronize artefacts (requirements, stories, defects) and bring UiPath® automation capabilities.

The following architecture diagram describes the integration capabilities with UiPath® components and 3rd party tools. For more information, see Application Lifecycle Management Integration Patterns.

集成场景

您可以通过以下典型场景了解集成的工作方式:

• 同步外部需求
• 在外部工具中创建缺陷
• 将自动化分配给外部测试用例
• 将结果提取到外部工具中

同步外部需求

The main purpose of synchronizing artefacts such as requirements is to assign test cases to them. This shows the requirements that have been covered through the test cases. To achieve this, you need to synchronize all the requirements from your external tool to Test Manager. To take this action in Test Manager, see Requirements.

When you synchronize external requirements to Test Manager, consider the following:

• The external tool is primarily used in the testing process. Externally synchronized requirements show up as read-only in Test Manager.
• 使用外部工具更新 Test Manager 中的需求。
• Deleting all artefacts and any related records in Test Manager through a cascading delete is possible but not considered good practice.
• 要求说明可能会使用 Markdown 进行格式化。

在外部工具中创建缺陷

Test Manager provides a webhook that is invoked when you create a defect from a test case log (see Test Results). You can configure an integration for your Test Manager project to receive test case log information required for defect creation (e.g. Jira Server). You can quickly access the tool where the defects are created by navigating to Test Results > Test Case Key > Defect.

将自动化分配给外部测试用例

To enable automation capabilities through Studio, you need to synchronize your test cases to Test Manager.

将自动化分配给外部测试用例时，请考虑以下事项：

• The external tool stores the mapping information between external test cases and corresponding artefacts in Test Manager.
• You can assign automation after the test case has been synchronized with Test Manager.
• 在外部工具中显示自动化信息表明该自动化已被分配。这被认为是一种很好的做法。

将结果提取到外部工具中

To retrieve results, you need to query TestExecution objects through Test Manager REST API. The TestExecution object is composed of results generated during test set execution. TestExecution holds a reference to TestCaseLogs objects that represent the test case results.

您需要定期轮询结果。考虑每 20 秒或更长时间检索一次新结果。

设置集成

您需要将集成设置为单个服务。只要外部工具可以使用 RESTful 网页服务，则外部工具使用的技术没有限制。

In the following diagram, you can see an example of how the artefact synchronization works from your external tools to Test Manager.

注意：根据您的外部工具功能，可能不需要中间集成服务。