Pruebas con Chai y Mocha

(Soportado desde Remix IDE v0.22.0)

Remix admite la comprobación de sus archivos en JavaScript mediante la biblioteca de aserción Chai y el marco de pruebas Mocha

Chai es una librería de aserción BDD / TDD para node y el navegador que puede ser deliciosamente emparejada con cualquier framework de pruebas javascript.

Mocha es un marco de pruebas JavaScript rico en funciones que se ejecuta en Node.js y en el navegador, haciendo que las pruebas asíncronas sean sencillas y divertidas.

Escribir pruebas

Create a js file in your project workspace. Better to create it inside scripts folder. Let’s name it sample.test.js.

Escriba sus pruebas en el archivo. Aquí tiene un ejemplo:

const { expect } = require("chai");

describe("Sample", function () {
  it("Sample tests with mocha and chai", async function () {
    var foo = 'bar'
    var beverages = { tea: [ 'chai', 'matcha', 'oolong' ] };
    expect(foo).to.be.a('string');
    expect(foo).to.equal('bar');
    expect(foo).to.have.lengthOf(3);
    expect(beverages).to.have.property('tea').with.lengthOf(3);
  });
});

Ejecutar pruebas

Una vez que haya terminado de escribir las pruebas, haga clic con el botón derecho del ratón sobre el nombre del archivo en el plugin Explorador de archivos. Mostrará algunas opciones junto con la opción de Ejecutar. Esta opción Run se utiliza para ejecutar los scripts JS

Haga clic en Ejecutar, las pruebas se ejecutarán y el resultado se mostrará en el Terminal.

Probar un contrato

De forma similar se pueden escribir pruebas unitarias para probar la funcionalidad de un contrato inteligente. Un ejemplo para probar el contrato por defecto 1_Storage.sol puede ser como:

const { expect } = require("chai");

describe("Storage", function () {
  it("test initial value", async function () {
    // Make sure contract is compiled and artifacts are generated
    const metadata = JSON.parse(await remix.call('fileManager', 'getFile', 'contracts/artifacts/Storage.json'))
    const signer = (new ethers.providers.Web3Provider(web3Provider)).getSigner()
    let Storage = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer);
    let storage = await Storage.deploy();
    console.log('storage contract Address: ' + storage.address);
    await storage.deployed()
    expect((await storage.retrieve()).toNumber()).to.equal(0);
  });

  it("test updating and retrieving updated value", async function () {
    const metadata = JSON.parse(await remix.call('fileManager', 'getFile', 'contracts/artifacts/Storage.json'))
    const signer = (new ethers.providers.Web3Provider(web3Provider)).getSigner()
    let Storage = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer);
    let storage = await Storage.deploy();
    await storage.deployed()
    const setValue = await storage.store(56);
    await setValue.wait();
    expect((await storage.retrieve()).toNumber()).to.equal(56);
  });

  it("fail test updating and retrieving updated value", async function () {
    const metadata = JSON.parse(await remix.call('fileManager', 'getFile', 'contracts/artifacts/Storage.json'))
    const signer = (new ethers.providers.Web3Provider(web3Provider)).getSigner()
    let Storage = new ethers.ContractFactory(metadata.abi, metadata.data.bytecode.object, signer);
    let storage = await Storage.deploy();
    await storage.deployed()
    const setValue = await storage.store(56);
    await setValue.wait();
    expect((await storage.retrieve()).toNumber()).to.equal(55);
  });
});

El resultado será el siguiente:

Depuración de una transacción de prueba

Para depurar una transacción en una de las pruebas, imprima el hash de la transacción e introdúzcalo en el Remix Debugger plugin.

Soporte para cascos

Remix también soporta métodos del plugin hardhat-ethers del framework Hardhat. Los métodos disponibles bajo este plugin son:

interface Libraries {
  [libraryName: string]: string;
}

interface FactoryOptions {
  signer?: ethers.Signer;
  libraries?: Libraries;
}

function getContractFactory(name: string, signer?: ethers.Signer): Promise<ethers.ContractFactory>;

function getContractFactory(name: string, factoryOptions: FactoryOptions): Promise<ethers.ContractFactory>;

function getContractFactory(abi: any[], bytecode: ethers.utils.BytesLike, signer?: ethers.Signer): Promise<ethers.ContractFactory>;

function getContractAt(name: string, address: string, signer?: ethers.Signer): Promise<ethers.Contract>;

function getContractAt(abi: any[], address: string, signer?: ethers.Signer): Promise<ethers.Contract>;

function getSigners() => Promise<ethers.Signer[]>;

function getSigner(address: string) => Promise<ethers.Signer>;

function getContractFactoryFromArtifact(artifact: Artifact, signer?: ethers.Signer): Promise<ethers.ContractFactory>;

function getContractFactoryFromArtifact(artifact: Artifact, factoryOptions: FactoryOptions): Promise<ethers.ContractFactory>;

function getContractAtFromArtifact(artifact: Artifact, address: string, signer?: ethers.Signer): Promise<ethers.Contract>;

Con esto, uno puede ejecutar las pruebas para un proyecto hardhat fácilmente usando Remix.

Ejemplo para probar el contrato Storage con este plugin los métodos pueden ser como:

const { expect } = require("chai");
const { ethers } = require("hardhat");

describe("Storage", function () {
  it("test initial value", async function () {
    const Storage = await ethers.getContractFactory("Storage");
    const storage = await Storage.deploy();
    await storage.deployed();
    console.log('storage deployed at:'+ storage.address)
    expect((await storage.retrieve()).toNumber()).to.equal(0);
  });
   it("test updating and retrieving updated value", async function () {
    const Storage = await ethers.getContractFactory("Storage");
    const storage = await Storage.deploy();
    await storage.deployed();
    const storage2 = await ethers.getContractAt("Storage", storage.address);
    const setValue = await storage2.store(56);
    await setValue.wait();
    expect((await storage2.retrieve()).toNumber()).to.equal(56);
  });
});

El resultado será el siguiente: