Comment mieux gérer l’authentification dans l’automatisation des tests d’API

Antoine Craske3 min de lecture

Il nous faut une meilleure façon de gérer correctement l’authentification des API dans nos tests automatisés.

Sur cette page4
Comment mieux gérer l’authentification dans l’automatisation des tests d’API

Les API sont la pierre angulaire des systèmes distribués. Elles permettent de composer des services pour offrir des expériences à plus forte valeur. Aussi puissantes soient-elles, les API doivent garantir un accès sécurisé.

Tester des API peut s’avérer frustrant : on passe parfois plus de temps à essayer de se connecter à l’API qu’à la tester. Or les retards dans la mise en place des tests automatisés coûtent cher, car ils allongent le délai de mise en production des changements (lead time).

Dans cet article, nous présentons une méthode concrète pour concevoir vos tests de sorte qu’ils gèrent l’authentification des API en limitant le code et la duplication. À la fin de l’article, vous disposerez d’une structure réutilisable pour vos tests automatisés :

  • Comprendre le flux et les données d’authentification
  • Mettre en place une couche d’authentification fiable
  • Créer un bloc d’authentification réutilisable avec une propriété
  • Étendre facilement l’automatisation de vos tests d’API

Commençons par comprendre les étapes de l’authentification.

Comprendre le flux et les données d’authentification#

Les API s’appuient généralement sur des standards d’authentification : un simple token, OAuth ou OpenID, entre autres. L’essentiel est de comprendre l’enchaînement des appels et les données en jeu.

Dans notre cas, l’API utilise un token Bearer. Un premier appel, généralement avec des identifiants, permet de récupérer le token. Ensuite, chaque appel doit porter ce token dans son en-tête pour être accepté.

Dans le cas d’une API REST, les étapes sont les suivantes :

  1. L’application crée une assertion JWT avec le secret partagé et l’oauthClientId, puis l’envoie en POST au serveur d’autorisation.
  2. Le serveur d’autorisation renvoie un token d’accès OAuth 2.0.
  3. L’application utilise ce token d’accès pour effectuer des actions en tant qu’utilisateur.

Voyons comment mettre en œuvre ces étapes.

Mettre en place une couche d’authentification fiable#

Tester des API est plus technique que tester une application web ou mobile. Pour clarifier la mise en œuvre de l’authentification, consultez la documentation de l’API ou, si besoin, échangez avec le développeur.

La première difficulté, en automatisation des tests, consiste à effectuer l’appel initial puis à conserver le token pour les appels suivants. Dans Cerberus Testing, la bonne méthode consiste à effectuer l’appel initial et à stocker le token dans une propriété (Property).

L’API étant en REST/JSON, nous pouvons utiliser le localisateur simple « $.access_token », présent dans la réponse, pour récupérer le token. Ainsi, à chaque exécution du test, une instance du token est stockée.

L’étape suivante consiste à créer un bloc réutilisable par tous nos tests.

Créer un bloc d’authentification réutilisable avec une propriété#

L’appel d’API exige le token Bearer dans l’en-tête. Il faut donc configurer le token dans la bibliothèque de services de Cerberus. Pour d’autres protocoles, il faudrait configurer des paramètres au niveau des actions de test.

Cerberus Testing permet de définir et de récupérer des propriétés de manière dynamique. Il suffit donc d’utiliser le délimiteur % pour désigner une propriété au sein d’autres éléments. Dans notre cas, la propriété à placer dans l’en-tête est « %access_token% ».

Le standard Bearer exige le mot « Bearer », d’où sa présence devant la propriété. Cette configuration peut servir dans n’importe quel test. Dans cet exemple, nous effectuons un POST vers un endpoint donné pour initier une transaction à l’aide du token.

Grâce à la bibliothèque, cette structure est reproductible dans tous nos tests.

Étendre facilement l’automatisation de vos tests d’API#

Dans Cerberus Testing, les étapes (steps) contiennent les actions et les contrôles du test automatisé. Chaque étape peut faire partie d’une bibliothèque : elle devient alors disponible dans d’autres tests, tout en étant protégée contre la modification.

Dans notre cas, nous avons ajouté l’étape « Get Authentication » à notre bibliothèque. Nous pouvons ainsi créer autant de tests que nous le souhaitons avec la même structure.

Nous pouvons alors mettre en œuvre nos tests fonctionnels. Les tests n’ont besoin que d’une structure type, et il n’y a qu’un seul endroit à modifier si l’authentification change.

Vous pouvez appliquer la même technique à d’autres protocoles d’authentification, et même aux API SOAP ou GraphQL. Il n’y a pas de temps à perdre : d’où l’intérêt d’un framework.

Arrêtez de coder et commencez à tester : essayez Cerberus Testing gratuitement.

Partager

Tutoriels

Comment créer un pipeline de tests continus avec GitHub Actions

« Pouvez-vous déployer des tests dans la CI/CD en une heure ? » Suivre le rythme des équipes de développement tout en livrant une automatisation des tests réellement utile est un défi quotidien.

Antoine Craske3 min de lecture3 min
Tutoriels

Automatisation des tests mobiles avec Appium, sans coder

Tester une application mobile est pénible. Il faut d’abord trouver un moyen d’exécuter l’application mobile, sur un appareil local ou distant, le plus souvent émulé.

Antoine Craske7 min de lecture7 min