🐲 🔖 ↔️ Test des API à l'aide de Postman et Excel 🤟🏽 ✋🏻 🍅

Bonjour à tous, je suis le chef du département des tests, et récemment une tâche pour tester l'API est apparue. Pour le résoudre, j'ai maîtrisé le nouvel outil Postman et JavaScript pour moi.

Au départ, pour chaque API, j'ai écrit mes collections et préparé des données de test au format JSON. C'est assez pratique, mais avec un grand nombre de tests et de collections, il devient peu rentable de le maintenir. Et il n'est pas pratique de valider des données en JSON.

Pour résoudre ces problèmes, j'ai écrit une macro pour Excel et une collection dans Postman. Maintenant, dans Postman, j'ai une collection pour toutes les API et un ensemble standard de fonctions pour traiter les données entrantes et valider les résultats renvoyés. J'ai réussi à transférer la gestion des données de test et la séquence d'exécution des requêtes vers Excel.

Quel était

1. JSON avec données

Auparavant, le kit de test était stocké sous cette forme

2. 2. La séquence d'exécution des requêtes avec les gestionnaires JS a été stockée dans les collections Postman.

Qu'est devenu

1. Suite de tests déplacée vers Excel

Toutes les données sont saisies dans Excel (caractères clés de contrôle: R, H, I, etc. je vais écrire ci-dessous) puis, à l'aide d'une macro, elles sont transférées au format json:

2. Dans Postman

L'expérience a été menée sur un ensemble standard d'opérations CRUD, qui peuvent être développées davantage.

Étant donné que dans Postman, toutes les opérations sont effectuées uniquement dans le cadre de la demande, j'ai dû saisir une demande get vide à la fin de laquelle la prochaine demande de la séquence est déterminée. Exécutez le code JS avant la demande et déterminez la première demande sans échec vide.

Dans toutes les demandes, le script de pré-demande et les sections de test sont vides, tout le code est unifié pour les demandes et est stocké dans les sections générales du script de pré-demande et du test du dossier Collection d'API.

Dans toutes les requêtes, il est important de faire attention à l'url et à la section Body dans les requêtes POST et PUT, leurs valeurs sont déterminées par des variables, dont les valeurs sont entrées depuis le JSON avec les données.

Maintenant sur les tests eux-mêmes

Comment lire Excel . La première ligne non vide est le numéro du cas de test, c'est-à-dire que le cas de test est stocké verticalement et sur cette page il y a 9 cas de test. Dans l'ensemble actuel, dans chaque cas de test, une demande POST sera exécutée en premier, puis Supprimer.

Comment démarrer la génération Json à partir d'Excel . Dans Excel, appuyez sur F11 et allez dans "EtaBook", lancez-y la macro.

Mots clefs

R - demande, signifie le début d'une nouvelle demande, dans la deuxième cellule de la ligne le type de demande est stocké, dans la troisième est l'adresse à laquelle vous devez contacter. Veuillez noter qu'en url vous pouvez spécifier des variables Postman

La valeur de la variable sera extraite

H - Données à vérifier dans l'en-tête, jusqu'à présent, seul le code de réponse a été entré, Postman ne les vérifie que dans le facteur. Il est important que dans Excel le nom soit le même "code de réponse", ou corrigé dans Postman

I, I2 ... - La section des données d'entrée prend en charge le stockage des modèles de données de toute imbrication, la figure à droite de I est responsable du niveau d'imbrication. L'ensemble de données suivant est enveloppé dans JSON comme ceci. Si la variable qui stocke les données est vide, elle ne sera pas ajoutée. Autrement dit, s'il n'y a pas de valeur dans la variable inn, elle ne sera pas ajoutée et la variable principale sera ajoutée, car elle stocke le modèle. De plus, si le modèle entier est vide, il ne sera pas ajouté non plus.

Les données de cette section seront soumises dans le corps de la demande

O, O2 ... - Section des paramètres de sortie, ils seront comparés à ceux retournés par réponse. Comme la section Input, il prend en charge le stockage de modèles.

Lors de la comparaison, les données sont converties en chaîne, j'ai également limité le niveau de récursivité, cela peut être supprimé

PO - Postman Output, les valeurs de cette section seront extraites du corps de réponse de la demande par le nom de la variable et écrites dans la variable Postman.

Dans Excel, il suffit de mettre n'importe quel caractère, la valeur de la réponse, pas Excel, est écrite dans la variable

Cette section est nécessaire pour stocker des données entre des scripts, par exemple, pour supprimer un objet avec l'ID qui a été créé dans la demande précédente

PC - Commande Postman, introduite une seule commande «terminate», elle est utilisée pour forcer la terminaison après l'exécution de la requête en cours. Utile pour un test négatif, afin de ne pas provoquer de suppression de l'objet créé.

La saisie de cette commande a permis de stocker les tests positifs et négatifs sur une seule feuille

PI - Entrée Postman, les valeurs de cette section seront écrites dans les variables Postman avant la définition de l'URL

Cela peut être utile si vous devez remplacer les variables spécifiées dans l'URL de la demande.

Soit dit en passant, vous pouvez utiliser les données des variables Postman dans les données fournies, pour cela, vous devez utiliser une conception spéciale

Dans le cas 1, nous avons entré la valeur obtenue dans une variable, dans le cas 2, nous l'avons utilisée. Il peut être utilisé non seulement dans le cas suivant, mais aussi dans le cas actuel à la prochaine demande. Par exemple, cela peut être nécessaire si la définition de l'objet de la modification ne suit pas l'URL, mais en fonction de la valeur de la variable dans la demande.

Préparation à la course

Et maintenant, exécutez, exécutez le coureur Postman, sélectionnez-y la collection souhaitée et téléchargez le fichier avec les données de test:

Nous servirons l'ensemble suivant:

15 tests sont décrits ici, les étapes 1-11, 13, 15 étant positives avec un résultat de 200 pour une demande POST et les étapes 12, 14 sont négatives avec un résultat de 400. Les informations ne seront pas entrées dans la base de données et par conséquent la section Sortie est vide et la commande est indiquée mettre fin. Cette commande interrompra l'exécution de la séquence et la demande de suppression de «Supprimer» ne sera pas envoyée.

Après les cas 1-11, 13, 15, nous nous souvenons de l'ID qui a été attribué au nouvel objet, puis nous le supprimons.

Nous lançons

Les 15 tests ont réussi, l'image montre le test 14, dans lequel la suppression n'est pas appelée après le POST

Dans les tests 1-11,13,15 après POST, la suppression de l'objet créé est appelée:

Résumé

La séquence de demandes de test de l'API est effectuée dans Excel et traitée dans Postman.
Toutes les données de test sont également rendues dans Excel, il est pratique de les gérer et de les valider. Au moins plus pratique qu'au format JSON.
La collection Postman est standardisée et n'a pas besoin d'être améliorée lors du test d'API similaires.

Les références

Mise à jour du 15/10/2019

1. Amélioration de la possibilité de générer des fichiers json sans exécuter Excel, placez-le dans le git GenerateAll.cmd, qui exécute le script vb GenerateJsonFiles.vbs. Le script appelé passera par le dossier courant et tous les sous-dossiers et générera des fichiers json
2. RunAll.cmd s'exécute pour exécuter tous les fichiers de données json générés, ainsi que le dossier actuel et tous les sous-dossiers. À côté de chacun d'eux sera mis output-report.log avec les résultats de l'exécution.

Maintenant, le vissage sur CI ne devrait pas être un problème. Vous pouvez également accélérer la génération json pour git deploy et comparer les données dans excel pour les changements dans les fichiers json.

Test des API à l'aide de Postman et Excel