dans un test unitaire d'un smart contrat, comment tester un revert ?
- User
dans un test unitaire d'un smart contrat, comment tester un revert ?
- Assistant
Pour tester un revert dans un smart contract, vous pouvez suivre les étapes suivantes :
- Importez les bibliothèques nécessaires pour exécuter les tests unitaires, comme Truffle Assert.
const assert = require('truffle-assertions');- Écrivez votre test unitaire en utilisant la structure
itde votre framework de test. Par exemple, avec Mocha :
it("devrait revertir 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" ); });-
Dans cet exemple,
myFunctionest la fonction à tester etinvalidConditionest une condition qui doit être évaluée comme invalide pour que le revert se produise. -
assert.revertsest 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. -
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.
- User
comment obtenir la bibliothèque "Truffle Assert."
- 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 :
- 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- 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- Dans votre projet Truffle, vous devriez trouver un répertoire appelé "test". Accédez à ce répertoire en utilisant la commande suivante :
cd test- À l'intérieur du répertoire "test", vous pouvez installer Truffle Assert à l'aide de la commande npm suivante :
npm install truffle-assertions- 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.
- User
pourquoi ne pas utiliser expectRevert ?
- Assistant
Mon erreur, veuillez m'excuser pour la confusion. Vous pouvez également utiliser la fonction
expectRevertfournie par Truffle Assert pour tester unrevertdans un contrat intelligent lors de vos tests unitaires.La fonction
expectRevertfournit une syntaxe plus conviviale et concise pour vérifier unrevertavec des messages d'erreur personnalisés :- Importez la bibliothèque
expectRevertde Truffle Assert dans vos tests unitaires :
const { expectRevert } = require('@openzeppelin/test-helpers');- Dans votre test unitaire, appelez la fonction
expectRevertet passez-lui l'appel à la fonction qui devrait générer unrevert. Vous pouvez également spécifier un message d'erreur personnalisé en tant que deuxième argument de la fonction :
it("devrait revertir 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"); });- La fonction
expectRevertvérifiera automatiquement si l'appel àmyFunctiongénère unrevertet 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 durevertet cela facilitera la compréhension et le débogage de vos tests unitaires. - Importez la bibliothèque
- 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 ?
- Assistant
Non, votre expression
currentPlayer != msg.senderdirectement passée comme argument à la fonctionjoinGamen'est pas correcte. La fonctionexpectRevertattend une fonction spécifique à appeler, pas une condition booléenne.Pour tester correctement un
revertavec la condition"if (currentPlayer != msg.sender)", vous devez effectuer les étapes suivantes :- Importez la bibliothèque
expectRevertde Truffle Assert dans vos tests unitaires :
const { expectRevert } = require('@openzeppelin/test-helpers');- Dans votre test unitaire, appelez la fonction
expectReverten invoquant correctement la fonctionjoinGameet en passant le message d'erreur attendu :
it("devrait revertir 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 pourcurrentPlayeretsender. Vous devez également vous assurer quejoinGameest appelée correctement avec{ from: sender }pour indiquer que l'appel provient desender.Cela permettra de tester avec succès le
revertlorsque la conditioncurrentPlayer != msg.senderest vraie, avec le message d'erreur"already registered". - Importez la bibliothèque
- 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 - 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
expectRevertdans votre test unitaire.Pour corriger cela, vous devriez ajuster votre test unitaire en conséquence. Voici comment vous devriez le modifier :
- Importez la bibliothèque
expectRevertde Truffle Assert dans vos tests unitaires :
const { expectRevert } = require('@openzeppelin/test-helpers');- Dans votre test unitaire, appelez la fonction
expectReverten invoquant correctement la fonctionjoinGameet en passant le message d'erreur attendu :
it("devrait revertir 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
revertattendu avec le message d'erreur approprié. - Importez la bibliothèque
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.