Test Manager API integration

Vue d'ensemble (Overview)

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.

Scénarios d'intégration

Vous pouvez comprendre le fonctionnement de l'intégration en vous basant sur les scénarios type suivants :

Synchronisation des exigences externes
Création de défauts dans des outils externes
Affectation de l'automatisation aux cas de test externes
Récupération des résultats dans des outils externes

Synchronisation des exigences externes

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.
Les exigences dans Test Manager sont mises à jour à l'aide de l'outil externe.
Deleting all artefacts and any related records in Test Manager through a cascading delete is possible but not considered good practice.
La description des exigences peut utiliser la syntaxe Markdown à des fins de formatage.

Création de défauts dans des outils externes

Test Manager provides a webhook that is invoked when you create a defect from a test case log (see Execution). 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 Execution > Test Case Key > Defect.

Affectation de l'automatisation aux cas de test externes

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

Lorsque vous attribuez une automatisation à des cas de test externes, tenez compte des points suivants :

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.
L'affichage des informations d'automatisation dans les outils externes révèle que l'automatisation a été attribuée. Ceci est considéré comme une bonne pratique.

Récupération des résultats dans des outils externes

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.

Vous devez interroger les résultats à intervalles réguliers. Envisagez de récupérer de nouveaux résultats toutes les 20 secondes ou plus.

Configuration des intégrations d'API

Vous devez configurer votre intégration en tant que service individuel. Il n'y a aucune restriction quant à la technologie utilisée par votre outil externe, tant qu'il peut utiliser des services Web RESTful.

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