Skip to content
TheChatArchiveThe Chat Archive
gpt-3.5-turbo-0613· openaiHugging Face Suzhen/CodeChat

dans un test unitaire d'un smart contrat, comment tester un revert ?

  1. User

    dans un test unitaire d'un smart contrat, comment tester un revert ?

  2. Assistant

    Pour tester un revert dans un smart contract, vous pouvez suivre les étapes suivantes :

    1. Importez les bibliothèques nécessaires pour exécuter les tests unitaires, comme Truffle Assert.
    const assert = require('truffle-assertions');
    
    1. Écrivez votre test unitaire en utilisant la structure it de votre framework de test. Par exemple, avec Mocha :
    it("devrait rever­tir si une condition est invalide", async() => {
      // Déployez le contrat ou récupérez une instance existante du contrat
      const myContract = await MyContract.deployed();
    
      // Appel à une fonction qui devrait générer un revert
      await assert.reverts(
        myContract.myFunction(invalidCondition),
        "Erreur attendue"
      );
    });
    
    1. Dans cet exemple, myFunction est la fonction à tester et invalidCondition est une condition qui doit être évaluée comme invalide pour que le revert se produise.

    2. assert.reverts est une fonction fournie par Truffle Assert qui vérifie si le contrat génère une exception (revert) lors de l'appel à myFunction. Le deuxième argument de cette fonction est une chaîne de caractères correspondant à un message d'erreur ou une partie du message d'erreur attendu.

    3. Exécutez vos tests unitaires avec votre framework de test préféré (par exemple, truffle test). Les tests échoueront si le revert n'est pas généré ou si le message d'erreur généré ne correspond pas à celui attendu.

    Ces étapes vous permettent de tester si une fonction génère bien un revert lorsque les conditions prévues ne sont pas remplies.

  3. User

    comment obtenir la bibliothèque "Truffle Assert."

  4. Assistant

    Truffle Assert est une bibliothèque de test fournie avec le framework Truffle. Pour l'utiliser, vous devez installer Truffle et inclure la bibliothèque dans vos tests.

    Voici comment obtenir la bibliothèque Truffle Assert :

    1. Assurez-vous que Truffle est installé sur votre machine. Si ce n'est pas le cas, vous pouvez l'installer en tapant la commande suivante dans votre terminal :
    npm install -g truffle
    
    1. Une fois que Truffle est installé, créez un nouveau projet Truffle ou accédez au projet existant en utilisant la commande suivante :
    truffle init
    
    1. Dans votre projet Truffle, vous devriez trouver un répertoire appelé "test". Accédez à ce répertoire en utilisant la commande suivante :
    cd test
    
    1. À l'intérieur du répertoire "test", vous pouvez installer Truffle Assert à l'aide de la commande npm suivante :
    npm install truffle-assertions
    
    1. Une fois l'installation terminée, vous pouvez importer la bibliothèque Truffle Assert dans vos tests unitaires en incluant la ligne suivante :
    const assert = require('truffle-assertions');
    

    Après avoir effectué ces étapes, vous devriez pouvoir utiliser Truffle Assert dans vos tests unitaires pour vérifier les reverts, les événements, les équivalences et autres fonctionnalités lors de l'exécution de vos contrats intelligents.

  5. User

    pourquoi ne pas utiliser expectRevert ?

  6. Assistant

    Mon erreur, veuillez m'excuser pour la confusion. Vous pouvez également utiliser la fonction expectRevert fournie par Truffle Assert pour tester un revert dans un contrat intelligent lors de vos tests unitaires.

    La fonction expectRevert fournit une syntaxe plus conviviale et concise pour vérifier un revert avec des messages d'erreur personnalisés :

    1. Importez la bibliothèque expectRevert de Truffle Assert dans vos tests unitaires :
    const { expectRevert } = require('@openzeppelin/test-helpers');
    
    1. Dans votre test unitaire, appelez la fonction expectRevert et passez-lui l'appel à la fonction qui devrait générer un revert. Vous pouvez également spécifier un message d'erreur personnalisé en tant que deuxième argument de la fonction :
    it("devrait rever­tir si une condition est invalide", async() => {
      // Déployez le contrat ou récupérez une instance existante du contrat
      const myContract = await MyContract.deployed();
    
      // Appel à une fonction qui devrait générer un revert
      await expectRevert(myContract.myFunction(invalidCondition), "Erreur attendue");
    });
    
    1. La fonction expectRevert vérifiera automatiquement si l'appel à myFunction génère un revert et générera une erreur si ce n'est pas le cas ou si le message d'erreur généré ne correspond pas à celui attendu.

    En utilisant expectRevert, vous obtiendrez des messages d'erreur plus explicites sur la raison du revert et cela facilitera la compréhension et le débogage de vos tests unitaires.

  7. User

    si le revert est "if (currentPlayer != msg.sender) } else { revert("already registered"); } - "await expectRevert( penduelInstance.joinGame(currentPlayer != msg.sender), “already registered”); est ce correct ?

  8. Assistant

    Non, votre expression currentPlayer != msg.sender directement passée comme argument à la fonction joinGame n'est pas correcte. La fonction expectRevert attend une fonction spécifique à appeler, pas une condition booléenne.

    Pour tester correctement un revert avec la condition "if (currentPlayer != msg.sender)", vous devez effectuer les étapes suivantes :

    1. Importez la bibliothèque expectRevert de Truffle Assert dans vos tests unitaires :
    const { expectRevert } = require('@openzeppelin/test-helpers');
    
    1. Dans votre test unitaire, appelez la fonction expectRevert en invoquant correctement la fonction joinGame et en passant le message d'erreur attendu :
    it("devrait rever­tir si le joueur est déjà enregistré", async () => {
      // Déployez le contrat ou récupérez une instance existante du contrat
      const penduelInstance = await Penduel.deployed();
    
      // Définissez currentPlayer et msg.sender
      const currentPlayer = ... // Définissez currentPlayer avec une adresse valide
      const sender = ... // Définissez sender avec la même adresse que currentPlayer
    
      // Appel à la fonction joinGame qui devrait générer un revert
      await expectRevert(penduelInstance.joinGame({ from: sender }), "already registered");
    });
    

    Dans cet exemple, assurez-vous de remplacer ... par la valeur appropriée pour currentPlayer et sender. Vous devez également vous assurer que joinGame est appelée correctement avec { from: sender } pour indiquer que l'appel provient de sender.

    Cela permettra de tester avec succès le revert lorsque la condition currentPlayer != msg.sender est vraie, avec le message d'erreur "already registered".

  9. User

    devrait échouer si le jeu n'est dans l'état : createdGame:

      Wrong kind of exception received
      + expected - actual
    
      -VM Exception while processing transaction: revert invalid ID -- Reason given: invalid ID.
      +game not created
    
  10. Assistant

    L'erreur que vous obtenez indique que l'exception générée lors du test ne correspond pas à celle attendue. Il semble y avoir une erreur dans la façon dont vous appelez la fonction expectRevert dans votre test unitaire.

    Pour corriger cela, vous devriez ajuster votre test unitaire en conséquence. Voici comment vous devriez le modifier :

    1. Importez la bibliothèque expectRevert de Truffle Assert dans vos tests unitaires :
    const { expectRevert } = require('@openzeppelin/test-helpers');
    
    1. Dans votre test unitaire, appelez la fonction expectRevert en invoquant correctement la fonction joinGame et en passant le message d'erreur attendu :
    it("devrait rever­tir si le jeu n'est pas dans l'état createdGame", async () => {
      // Déployez le contrat ou récupérez une instance existante du contrat
      const penduelInstance = await Penduel.deployed();
    
      // Assumez qu'un jeu a déjà été créé avec un ID spécifique
      const gameId = 1;
    
      // Tentative de rejoindre le jeu existant avec l'ID spécifique
      await expectRevert(penduelInstance.joinGame(gameId), "game not created");
    });
    

    Assurez-vous que vous avez correctement identifié le message d'erreur attendu de votre revert, qui semble être "game not created" dans votre cas.

    Avec cette modification, le test unitaire devrait échouer si le jeu n'est pas dans l'état "createdGame" et génère le revert attendu avec le message d'erreur approprié.

Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.