Cas d’utilisation d’Automated Test Framework : récupérez un incident à l’aide de REST-Inbound

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • Le test de test Obtenir la ressource nouvellement créée via l’API REST est fourni avec le Framework de tests automatisés, et utilise les étapes REST - Inbound et assert.

    Avant de commencer

    Vérifiez les API REST et les informations de l’étape de configuration Envoyer une demande REST - Entrante - Explorateur d’API REST avant de créer ce test.

    Rôle requis : atf_ws_designer

    Pourquoi et quand exécuter cette tâche

    Ce test crée un enregistrement d’incident, utilise une étape REST - entrante pour récupérer l’enregistrement, puis utilise des étapes de déclaration pour déterminer si la demande a abouti.

    Vous pouvez utiliser l’étape Envoyer une demande REST - Explorateur d’API REST entrante pour générer et tester la demande, ou créer manuellement la demande à l’aide de l’étape Envoyer une demande REST - Entrante. Dans les deux cas, vous devez spécifier les informations d’authentification de base dans le formulaire Envoyer une demande REST - étape entrante.

    Lors de la création de votre test, commencez par votre API REST et déterminez le comportement que vous souhaitez valider. Vous pouvez ensuite déterminer les données de test à créer. Vous pouvez utiliser d’autres catégories de configuration d’étape de test pour créer, mettre à jour ou supprimer des enregistrements, puis utiliser une étape Envoyer REST entrant pour récupérer, mettre à jour ou supprimer les données de test. Inversement, vous pouvez utiliser l’étape Envoyer REST entrant pour créer des enregistrements, puis utiliser d’autres catégories de configuration d’étape de test pour valider que les enregistrements ont été créés correctement.

    Cette tâche vous guide dans la création du test de test Obtenir une ressource récemment créée via l’API REST .

    Procédure

    1. Créez un test.
      1. Accédez à la Framework de tests automatisés > Tests, cliquez sur Nouveau.
        Le formulaire Tester le nouvel enregistrement s’affiche.
      2. Saisissez un nom et une description pour le test, puis cliquez sur Soumettre.
      3. Cliquez sur le test créé à l’étape précédente.
        Le formulaire de test s’affiche.
    2. Créez des données de test.
      1. Cliquez sur le bouton Ajouter une étape de test .
        Le formulaire Ajouter une étape de test s’affiche.
      2. Cliquez sur une catégorie de configuration de test, puis cliquez sur une configuration de test.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , cliquez sur Serveur > Insertion d'enregistrement, puis sur Suivant.
        Le formulaire de configuration de test que vous avez sélectionné s’affiche.
      3. Renseignez les informations nécessaires pour la configuration de test que vous avez sélectionnée.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , dans le formulaire Insertion d’enregistrement , spécifiez la table d’incidents, ajoutez une valeur pour le champ Brève description , puis cliquez sur Soumettre.
    3. Créez la demande REST.
      1. Cliquez sur le bouton Ajouter une étape de test .
        Le formulaire Ajouter une étape de test s’affiche.
      2. Cliquez sur une catégorie de configuration de test, puis cliquez sur une configuration de test.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , cliquez sur REST > Envoyer une demande REST - Entrante Explorateur d’API REST, puis sur Suivant.
        L’explorateur d’API REST s’affiche.
      3. Renseignez les informations requises pour la demande REST, puis cliquez sur Envoyer.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , renseignez les champs.
        Nom Valeur
        Espace de noms Maintenant
        Nom d'API API de table
        Version de l'API dernier
        tableName incident

        Lorsque vous ne spécifiez pas l’authentification de base, l’explorateur d’API REST utilise vos informations d’identification.

        L’étape Créer un test automatisé s’affiche une fois que vous avez cliqué sur Envoyer.

      4. Lorsque vous êtes prêt, cliquez sur Créer une étape de test automatisée.
        L’étape de test Envoyer une demande REST - Entrante est créée.
      5. Cliquez sur l’étape Envoyer une demande REST - entrante et, dans le champ Authentification de base, spécifiez une configuration d’authentification de base.
        Si aucune configuration n’est disponible, vous pouvez créer une configuration d’authentification de base en cliquant sur Nouveau dans le formulaire Configurations d’authentification de base .
      6. Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , dans le champ Chemin d’accès , cliquez sur le bouton Recherche contextuelle, puis cliquez sur Insertion d'enregistrement > Enregistrement.
      7. Cliquez sur Mettre à jour.
    4. Créez des étapes d’assertion pour vérifier la réponse REST.
      1. Cliquez sur le bouton Ajouter une étape de test .
        Le formulaire Ajouter une étape de test s’affiche.
      2. Cliquez sur une catégorie de configuration de test, puis cliquez sur une configuration de test.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , cliquez sur REST > Code d'état de la déclaration, puis sur Suivant.
        Le formulaire Code d’état d’assertion s’affiche.
      3. Saisissez les informations requises pour le formulaire, puis cliquez sur Soumettre.
        Pour répliquer le test Obtenir une ressource nouvellement créée via l’API REST , dans le champ Opération , sélectionnez est et dans le champ Code d’état , saisissez 200.

        Pour répliquer le test Obtenir une ressource récemment créée via l’API REST , répétez cette étape pour créer des étapes de test Déclarer que la charge utile JSON de la réponse est valide et Déclarer l’élément de charge utile de la réponse JSON .