Run a single hardhat test file

Question

I have a few test files:

./test/ContractA.test.js

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

describe("ContractA tests", function () {
  it("does function one", async function () {
    expect(await contractA.someFunc()).to.equal(something);
  });
  it("does function two", async function () {
    expect(await contractA.someOtherFunction()).to.equal(somethingOtherThing);
  });
});

./test/ContractB.test.js

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

describe("ContractB tests", function () {
  it("does function one", async function () {
    expect(await contractB.someFunc()).to.equal(something);
  });
  it("does function two", async function () {
    expect(await contractB.someOtherFunction()).to.equal(somethingOtherThing);
  });
});

When I run hardhat test all the files run.

How Can I run all the tests in ContractA.test.js?

---

Things I've Already Tried

hardhat test ./test/ContratA.test.js - this does not run any tests at all...

hardhat test --grep "ContractA" - also does not run any tests...

Answer 1

$ yarn hardhat test ./test/ContratA.test.js

Should work as the command line helper message explains:

$ yarn hardhat test --help

    Usage: hardhat [GLOBAL OPTIONS] test [--bail] [--deploy-fixture] [--grep <STRING>] [--no-compile] [--no-impersonation] [--parallel] [...testFiles]
    POSITIONAL ARGUMENTS:
    
      testFiles     An optional list of files to test (default: [])

Answer 2

yes you can do that. You just need to put ".only" after that describe, that you want to run. In your case:

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

describe.only("ContractA tests", function () {   it("does function one", async function () {
    expect(await contractA.someFunc()).to.equal(something);   });   it("does function two", async function () {
    expect(await contractA.someOtherFunction()).to.equal(somethingOtherThing);   }); });

Answer 3

I encountered the same problem, try this

npx hardhat test ../test/ContratA.test.js

The difference between your command is the path is ../test/ContratA.test.js not ./test/ContratA.test.js

Answer 4

hardhat test ./test/ContractA.test.js is correct. You misspelt ContractA in your original post (you were missing the c and ended up with ContratA)

Answer 5

you can also use hardhat.config.js to configure your sources and tests directories and write a custom task to prescribe which test file to execute at run time. Sample of one such custom task -

task("testFile", "Test a specific contract")
  .addParam("test", "Path to the corresponding test file")
  .setAction(async (args, { run }) => {
    if (args.test) {
      await run("compile");
      await run("test", { files: args.test });
    } else {
      console.error("Please provide the test file path.");
    }
  })

The compiler will know where to pick the contract and test files from the sources and tests descriptions and will pick up which specific file to run based on the subtask. Sample request: npx hardhat testFile --test <test-file-name>.test.js