truffle/test/scenarios/compile/vyper-compile.js

Truffle - Simple development framework for Ethereum

const MemoryLogger = require("../MemoryLogger");
const CommandRunner = require("../commandRunner");
const fs = require("fs");
const path = require("path");
const assert = require("assert");
const Server = require("../server");
const sandbox = require("../sandbox");
const log = console.log;

//NOTE: this file is copypasted with modifications from compile.js
describe("Repeated compilation of Vyper contracts with imports [ @standalone ]", function () {
  let config,
    cleanupSandboxDir,
    artifactPaths,
    initialTimes,
    finalTimes,
    output;
  const mapping = {};

  const project = path.join(__dirname, "../../sources/vyper-imports");
  const names = ["Root.vy", "Branch.vy", "LeafA.vy", "LeafB.vy", "LeafC.vy"];
  const logger = new MemoryLogger();

  // ----------------------- Utils -----------------------------
  function processErr(err, output) {
    if (err) {
      log(output);
      throw new Error(err);
    }
  }

  function waitSecond() {
    return new Promise((resolve, _reject) => setTimeout(() => resolve(), 1250));
  }

  function getSource(key) {
    return fs.readFileSync(mapping[key].sourcePath);
  }

  function getArtifactStats() {
    const stats = {};
    names.forEach(key => {
      const mDate = fs.statSync(mapping[key].artifactPath).mtime.getTime();
      stats[key] = mDate;
    });
    return stats;
  }

  function touchSource(key) {
    const source = getSource(key);
    fs.writeFileSync(mapping[key].sourcePath, source);
  }

  function hasBeenUpdated(fileName) {
    return initialTimes[fileName] < finalTimes[fileName];
  }

  // ----------------------- Setup -----------------------------

  before(async function () {
    await Server.start();
  });
  after(async function () {
    await Server.stop();
  });

  beforeEach("set up sandbox and do initial compile", async function () {
    this.timeout(30000);

    ({ config, cleanupSandboxDir } = await sandbox.create(project));
    config.network = "development";
    config.logger = logger;

    // create artifact path array
    artifactPaths = names.map(name => {
      const basename = path.basename(path.basename(name, ".vy"));
      return path.join(config.contracts_build_directory, `${basename}.json`);
    });

    // create mapping from name to source path
    names.forEach((name, i) => {
      mapping[name] = {};
      mapping[name].artifactPath = artifactPaths[i];
      mapping[name].sourcePath = path.join(config.contracts_directory, name);
    });

    try {
      await CommandRunner.run("compile", config);
    } catch (error) {
      output = logger.contents();
      processErr(error, output);
    }

    initialTimes = getArtifactStats();

    // mTime resolution on 6.9.1 is 1 sec.
    await waitSecond();
  });

  afterEach(function () {
    cleanupSandboxDir();
  });

  // -------------Inheritance Graph -------
  //                                      |
  //      ERC20        LeafA              |
  //     /           /       \            |
  // Root* - Branch -           - LeafC   |
  //     \           \       /            |
  //      Abi          LeafB              |
  //                                      |
  // --------------------------------------

  it("updates only Root when Root is touched", async function () {
    this.timeout(30000);

    touchSource("Root.vy");

    await CommandRunner.run("compile", config);
    output = logger.contents();

    finalTimes = getArtifactStats();

    try {
      assert(hasBeenUpdated("Root.vy"), "Should update root");

      for (const file of Object.keys(mapping)) {
        if (file !== "Root.vy") {
          assert(!hasBeenUpdated(file), `Should not update ${file}`);
        }
      }
    } catch (err) {
      err.message += "\n\n" + output;
      throw new Error(err);
    }
  });

  // -------------Inheritance Graph -------
  //                                      |
  //      ERC20        LeafA              |
  //     /           /       \            |
  // Root* - Branch* -           - LeafC  |
  //     \           \       /            |
  //      Abi          LeafB              |
  //                                      |
  // --------------------------------------

  it("updates Branch and Root when Branch is touched", async function () {
    this.timeout(30000);

    touchSource("Branch.vy");

    await CommandRunner.run("compile", config);
    output = logger.contents();

    finalTimes = getArtifactStats();

    try {
      assert(hasBeenUpdated("Root.vy"), "Should update root");
      assert(hasBeenUpdated("Branch.vy"), "Should update Branch");

      for (const file of Object.keys(mapping)) {
        if (file !== "Root.vy" && file !== "Branch.vy") {
          assert(!hasBeenUpdated(file), `Should not update ${file}`);
        }
      }
    } catch (err) {
      err.message += "\n\n" + output;
      throw new Error(err);
    }
  });

  // -------------Inheritance Graph --------
  //                                       |
  //      ERC20        LeafA*              |
  //     /           /       \             |
  // Root* - Branch* -           - LeafC   |
  //     \            \       /            |
  //      Abi           LeafB              |
  //                                       |
  // ---------------------------------------

  it("updates LeafA, Branch and Root when LeafA is touched", async function () {
    this.timeout(30000);

    touchSource("LeafA.vy");

    await CommandRunner.run("compile", config);
    output = logger.contents();

    finalTimes = getArtifactStats();

    try {
      assert(hasBeenUpdated("LeafA.vy"), "Should update LeafA");
      assert(hasBeenUpdated("Branch.vy"), "Should update Branch");
      assert(hasBeenUpdated("Root.vy"), "Should update root");

      for (const file of Object.keys(mapping)) {
        if (file !== "Root.vy" && file !== "Branch.vy" && file !== "LeafA.vy") {
          assert(!hasBeenUpdated(file), `Should not update ${file}`);
        }
      }
    } catch (err) {
      err.message += "\n\n" + output;
      throw new Error(err);
    }
  });

  // -------------Inheritance Graph --------
  //                                       |
  //      ERC20        LeafA*              |
  //     /           /       \             |
  // Root* - Branch* -           - LeafC*  |
  //     \           \        /            |
  //      Abi          LeafB*              |
  //                                       |
  // ---------------------------------------

  it("updates everything when LeafC is touched", async function () {
    this.timeout(30000);

    touchSource("LeafC.vy");

    await CommandRunner.run("compile", config);
    output = logger.contents();

    finalTimes = getArtifactStats();

    try {
      for (const file of Object.keys(mapping)) {
        assert(hasBeenUpdated(file), `Should not update ${file}`);
      }
    } catch (err) {
      err.message += "\n\n" + output;
      throw new Error(err);
    }
  });
});