truffle/test/scenarios/contract_names/test_imports.js

Truffle - Simple development framework for Ethereum

const MemoryLogger = require("../MemoryLogger");
const CommandRunner = require("../commandRunner");
const contract = require("@truffle/contract");
const fs = require("fs-extra");
const path = require("path");
const assert = require("assert");
const Server = require("../server");
const sandbox = require("../sandbox");

describe("Contract names", function () {
  let config, cleanupSandboxDir;
  const logger = new MemoryLogger();
  const project = path.join(__dirname, "../../sources/contract_names");

  before(async function () {
    this.timeout(10000);
    ({ config, cleanupSandboxDir } = await sandbox.create(project));
    config.network = "development";
    config.logger = logger;
    await Server.start();
  });
  after(async function () {
    await Server.stop();
    cleanupSandboxDir();
  });

  it("compiles if file names do not match contract names", async function () {
    this.timeout(40000);

    await CommandRunner.run("compile", config);

    // The contract's name is Contract, but the file name is contract.
    // Not only should we not receive an error, but we should receive contract
    // artifacts relative to the contract name and not the file name.
    assert(
      fs.existsSync(
        path.join(config.contracts_build_directory, "Contract.json")
      )
    );
  });

  it("migrates when artifacts.require() doesn't have an extension and names do not match", async function () {
    this.timeout(50000);

    await CommandRunner.run("migrate", config);

    const contractPath = path.join(
      config.contracts_build_directory,
      "Contract.json"
    );
    const Contract = contract(require(contractPath));
    Contract.setProvider(config.provider);

    const instance = await Contract.deployed();
    assert.notEqual(
      instance.address,
      null,
      instance.contract_name + " didn't have an address!"
    );

    // Now let's interact with our deployed contract JUST to ensure it actually did do
    // the right thing.
    const value = await instance.specialValue.call();
    assert.equal(
      parseInt(value),
      1337,
      "Somehow the wrong contract was deployed, because we don't have the correct value"
    );
  });

  it("compiles and migrate with relative imports (using filename)", async function () {
    this.timeout(50000);

    const contractPath = path.join(
      config.contracts_build_directory,
      "RelativeImport.json"
    );

    await CommandRunner.run("compile", config);

    assert(fs.existsSync(contractPath));

    await CommandRunner.run("migrate", config);

    const RelativeImport = contract(require(contractPath));
    RelativeImport.setProvider(config.provider);

    const instance = await RelativeImport.deployed();
    assert.notEqual(
      instance.address,
      null,
      instance.contract_name + " didn't have an address!"
    );

    // Now let's interact with our deployed contract JUST to ensure it actually did do
    // the right thing.
    const value = await instance.specialValue.call();
    assert.equal(
      parseInt(value),
      1337,
      "Somehow the wrong contract was deployed, because we don't have the correct value"
    );
  });
});