Envoyer des Résultats de Tests via l'API Wolfpack

Il est possible d'envoyer des résultats de tests directement via l'API Wolfpack. Pour cela, vous aurez besoin d'une clé d'API (voir ici comment procéder pour en récupérer une).

Wolfpack propose deux points d'accès pour envoyer des résultats de tests : l'un pour envoyer un test à la fois et l'autre pour envoyer plusieurs résultats en bulk.

1. Envoyer un Résultat de Test Individuel

URL

POST https://api.wolfpackqa.com/test-runs

Description

Ce point d'accès permet d'envoyer un résultat de test unique à la plateforme Wolfpack. Vous pouvez utiliser ce point d'accès pour ajouter des informations comme le statut du test, l'environnement et la release associée.

Authentification

L'en-tête de la requête doit inclure un token d'API valide :

    
    x-api-token: VOTRE_API_TOKEN
    

Corps de la Requête

Le corps de la requête doit contenir les informations suivantes :

  • name : Le nom du test.
  • status : Le statut du test (passed ou failed).
  • environmentKey :  La clé de l'environnement où le test a été exécuté.
  • releaseId : (Optionnel) L'identifiant de la release associée.
  • suite : (Optionnel) La suite à laquelle le test appartient.
  • testDefinitionId : (Optionnel) L'id du test, si celui-ci existe déjà et que vous souhaitez spécifiquement l'associer. 

Les clé API étant liées à un projet spécifique, il ne sera pas nécessaire de spécifier le projet.

En principe, l'association des executions de test aux test est automatique. Voir les règles en partie 3.

Exemple de Corps de la Requête


{
  "name": "Test du login",
  "status": "passed",
  "environmentKey": "staging",
  "suite": "auth-tests"
}

Réponses

  • 200 OK : Le test a été enregistré avec succès.
  • 400 Bad Request : Le statut du test est invalide ou des informations obligatoires manquent.

2. Envoyer des Résultats de Tests en Bulk

URL

POST /test-runs/bulk

Description

Ce point d'accès permet d'envoyer plusieurs résultats de tests en une seule requête. Il est conçu pour traiter des lots de tests afin d'optimiser les envois en masse.

Authentification

L'en-tête de la requête doit inclure un token d'API valide :

    
    x-api-token: VOTRE_API_TOKEN
    

Corps de la Requête

Le corps de la requête doit contenir un tableau d'objets, où chaque objet représente un test individuel avec les mêmes champs que pour une requête individuelle.

Exemple de Corps de la Requête

    
[
  {
    "name": "Test du login",
    "status": "passed",
    "environmentKey": "staging",
    "releaseId": "789def123ghi456",
    "suite": "auth-tests"
  },
  {
    "name": "Test de l'inscription",
    "status": "failed",
    "environmentKey": "staging",
    "releaseId": "789def123ghi456",
    "suite": "auth-tests"
  }
]
    

Réponses

  • 200 OK : Tous les tests ont été enregistrés avec succès.
  • 400 Bad Request : Certaines erreurs sont détectées dans les résultats envoyés.

3. Création et Gestion des Définitions de Tests

Lors de l'envoi d'un résultat de test, Wolfpack détermine si un test existant (liée à l'identifiant testDefinitionId) existe déjà ou s'il faut en créer une nouvelle.

Récupération de la Définition de Test

  • Si un testDefinitionId est fourni :
    Wolfpack utilise la définition de test associée à cet identifiant.
  • Si aucun testDefinitionId n'est fourni :
    Wolfpack tente de retrouver un test basé sur les informations fournies, comme le name, la suite, et le project. Si aucun test n'est trouvée, Wolfpack en crée automatiquement un nouveau.

Conditions d'Erreur

  • Statut invalide : Si le champ status contient une valeur autre que passed ou failed, une erreur de type 400 Bad Request est renvoyée.
  • Projet manquant : Si le champ project est manquant et que le token d'API ne contient pas d'informations de projet, une erreur de type 400 Bad Request est renvoyée.

Cette API est conçue pour simplifier le suivi centralisé des tests dans votre projet et garantir la traçabilité de vos résultats de tests sur la plateforme Wolfpack.

send-test-results-via-the-wolfpack-api