Add splitTestsCompilation solidity setting: main PR

.changeset/great-parents-play.md

@@ -0,0 +1,8 @@
+---
+"@nomicfoundation/hardhat-node-test-runner": patch
+"@nomicfoundation/hardhat-typechain": patch
+"@nomicfoundation/hardhat-ignition": patch
+"@nomicfoundation/hardhat-mocha": patch
+---
+
+Update to the new splitTestsCompilation setting

.changeset/tender-taxis-lead.md

@@ -0,0 +1,6 @@
+---
+"@nomicfoundation/hardhat-errors": patch
+"hardhat": minor
+---
+
+Make the split of contracts and solidity tests compilation optional, and controlled with a new `splitTestsCompilation` config field.

.peer-bumps.json

@@ -86,6 +86,26 @@
       "package": "@nomicfoundation/hardhat-solx",
       "peer": "hardhat",
       "reason": "It depends on the new CommonSingleVersionSolidityUserConfig type"
+    },
+    {
+      "package": "@nomicfoundation/hardhat-node-test-runner",
+      "peer": "hardhat",
+      "reason": "splitTestsCompilation update"
+    },
+    {
+      "package": "@nomicfoundation/hardhat-typechain",
+      "peer": "hardhat",
+      "reason": "splitTestsCompilation update"
+    },
+    {
+      "package": "@nomicfoundation/hardhat-ignition",
+      "peer": "hardhat",
+      "reason": "splitTestsCompilation update"
+    },
+    {
+      "package": "@nomicfoundation/hardhat-mocha",
+      "peer": "hardhat",
+      "reason": "splitTestsCompilation update"
     }
   ]
 }

cspell.config.mts

@@ -31,5 +31,9 @@ export default defineConfig({
     "**/artifacts/**/*.json",
     "**/artifacts/**/*.d.ts",
     "**/build-info/**/*",
+    "packages/*/artifacts",
+    "packages/*/cache",
+    "packages/*/test/fixture-projects/**/artifacts",
+    "packages/*/test/fixture-projects/**/cache",
   ],
 });

packages/hardhat-errors/src/descriptors.ts

@@ -1192,6 +1192,36 @@ Remaining test suites: {suites}`,
         websiteDescription:
           "An inline config key was used that does not apply to the type of test function it was attached to. Fuzz test functions (test*) only accept fuzz.* keys and top-level keys, while invariant test functions (invariant*) only accept invariant.* keys and top-level keys.",
       },
+      SELECTED_TEST_FILES_NOT_COMPILED: {
+        number: 814,
+        messageTemplate: `The following Solidity test files have not been compiled:
+
+{files}
+
+Run \`hardhat build\` to compile your project before running tests with \`--no-compile\`.`,
+        websiteTitle: "Selected Solidity test files not compiled",
+        websiteDescription: `You ran Solidity tests with \`--no-compile\`, but some of the selected test files have not been compiled yet. Run \`hardhat build\` first, or remove the \`--no-compile\` flag.`,
+      },
+      SELECTED_FILES_ARE_NOT_SOLIDITY_TESTS: {
+        number: 815,
+        messageTemplate: `Trying to run these files as Solidity tests, but they aren't:
+
+{files}
+
+Double-check the files that you are providing to the \`test solidity\` task.`,
+        websiteTitle: "Invalid Solidity test files",
+        websiteDescription: `You ran the \`test solidity\` task with files that aren't classified as Solidity tests.`,
+      },
+      SELECTED_TEST_FILES_DO_NOT_EXIST: {
+        number: 816,
+        messageTemplate: `The following Solidity test files do not exist:
+
+{files}
+
+Double-check the paths you are providing to the \`test solidity\` task.`,
+        websiteTitle: "Selected Solidity test files do not exist",
+        websiteDescription: `You ran the \`test solidity\` task with files that do not exist on disk.`,
+      },
     },
     SOLIDITY: {
       PROJECT_ROOT_RESOLUTION_ERROR: {
@@ -1346,6 +1376,32 @@ Solidity test files must be placed in your test directory, or in your contracts
 
 Solidity test files must be placed in your test directory, or in your contracts directory and end in .t.sol.`,
       },
+      SPLIT_TESTS_COMPILATION_DISABLED: {
+        number: 916,
+        messageTemplate: `A method of the SolidityBuildSystem was called with \`scope: "tests"\`, but \`splitTestsCompilation\` is disabled in your config.
+
+When \`splitTestsCompilation\` is \`false\`, contracts and tests are compiled together under \`scope: "contracts"\`, so \`scope: "tests"\` is not a valid option.
+
+Set \`solidity.splitTestsCompilation\` to \`true\` in your Hardhat config to enable this build scope.`,
+        websiteTitle: "Split tests compilation is disabled",
+        websiteDescription: `The Solidity build system was called with \`scope: "tests"\`, but \`splitTestsCompilation\` is disabled in your config.
+
+When \`splitTestsCompilation\` is \`false\`, contracts and tests are compiled together under \`scope: "contracts"\`, so \`scope: "tests"\` is not a valid option.
+
+Set \`solidity.splitTestsCompilation\` to \`true\` in your Hardhat config to enable this build scope.`,
+      },
+      INCOMPATIBLE_FILES_WITH_BUILD_FLAGS: {
+        number: 917,
+        messageTemplate: `Some of the files you are trying to build are incompatible with the \`--no-contracts\` or \`--no-tests\` flag you provided:
+
+{files}
+
+Try re-running without these files, or without the flag.`,
+        websiteTitle: "Incompatible files with build flags",
+        websiteDescription: `You are trying to build a list of files while using \`--no-contracts\` or \`--no-tests\`, but some of those files are incompatible with the flag you provided.
+
+For example, you may be trying to build a test file with \`--no-tests\`, which isn't a valid operation.`,
+      },
     },
     ARTIFACTS: {
       NOT_FOUND: {

packages/hardhat-ignition/src/internal/tasks/deploy.ts

@@ -154,9 +154,10 @@ const taskDeploy: NewTaskActionFunction<TaskDeployArguments> = async (
     );
   }
 
+  const noTests = hre.config.solidity.splitTestsCompilation;
   await hre.tasks.getTask("build").run({
     quiet: true,
-    noTests: true,
+    noTests,
     defaultBuildProfile: "production",
   });
 

packages/hardhat-ignition/src/internal/tasks/visualize.ts

@@ -22,7 +22,8 @@ const visualizeTask: NewTaskActionFunction<TaskVisualizeArguments> = async (
   { noOpen, modulePath }: { noOpen: boolean; modulePath: string },
   hre: HardhatRuntimeEnvironment,
 ) => {
-  await hre.tasks.getTask("build").run({ noTests: true, quiet: true });
+  const noTests = hre.config.solidity.splitTestsCompilation;
+  await hre.tasks.getTask("build").run({ noTests, quiet: true });
 
   const userModule = await loadModule(hre.config.paths.ignition, modulePath);
 

packages/hardhat-ignition/test/deploy/build-invocation.ts

@@ -0,0 +1,95 @@
+import path from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+import { assert } from "chai";
+import { overrideTask } from "hardhat/config";
+import { createHardhatRuntimeEnvironment } from "hardhat/hre";
+
+import hardhatIgnitionPlugin from "../../src/index.js";
+
+describe("deploy - build invocation", function () {
+  function buildArgCaptor() {
+    const buildArgs: any[] = [];
+    const buildOverride = overrideTask("build")
+      .setAction(async () => ({
+        default: async (args: any, _hre, runSuper) => {
+          buildArgs.push(args);
+          return runSuper(args);
+        },
+      }))
+      .build();
+    return { buildArgs, buildOverride };
+  }
+
+  function getProjectConfig() {
+    const projectPath = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      "../fixture-projects",
+      "minimal",
+    );
+
+    const configPath = path.join(projectPath, "hardhat.config.js");
+
+    return { projectPath, configPath };
+  }
+
+  it("should call build without noTests when splitTestsCompilation is false", async function () {
+    const { buildArgs, buildOverride } = buildArgCaptor();
+    const { projectPath, configPath } = getProjectConfig();
+
+    const { default: userConfig } = await import(
+      pathToFileURL(configPath).href
+    );
+
+    const hre = await createHardhatRuntimeEnvironment(
+      {
+        ...userConfig,
+        plugins: [hardhatIgnitionPlugin],
+        tasks: [buildOverride],
+      },
+      { config: configPath },
+      projectPath,
+    );
+
+    await hre.tasks.getTask(["ignition", "deploy"]).run({
+      modulePath: path.join(projectPath, "ignition", "modules", "MyModule.js"),
+    });
+
+    assert.equal(buildArgs.length, 1);
+    assert.equal(buildArgs[0].noTests, false);
+    assert.equal(buildArgs[0].defaultBuildProfile, "production");
+    assert.equal(buildArgs[0].quiet, true);
+  });
+
+  it("should call build with noTests when splitTestsCompilation is true", async function () {
+    const { buildArgs, buildOverride } = buildArgCaptor();
+    const { projectPath, configPath } = getProjectConfig();
+
+    const { default: userConfig } = await import(
+      pathToFileURL(configPath).href
+    );
+
+    const hre = await createHardhatRuntimeEnvironment(
+      {
+        ...userConfig,
+        solidity: {
+          ...userConfig.solidity,
+          splitTestsCompilation: true,
+        },
+        plugins: [hardhatIgnitionPlugin],
+        tasks: [buildOverride],
+      },
+      { config: configPath },
+      projectPath,
+    );
+
+    await hre.tasks.getTask(["ignition", "deploy"]).run({
+      modulePath: path.join(projectPath, "ignition", "modules", "MyModule.js"),
+    });
+
+    assert.equal(buildArgs.length, 1);
+    assert.equal(buildArgs[0].noTests, true);
+    assert.equal(buildArgs[0].defaultBuildProfile, "production");
+    assert.equal(buildArgs[0].quiet, true);
+  });
+});

packages/hardhat-ignition/test/plan/build-invocation.ts

@@ -0,0 +1,95 @@
+import path from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+
+import { assert } from "chai";
+import { overrideTask } from "hardhat/config";
+import { createHardhatRuntimeEnvironment } from "hardhat/hre";
+
+import hardhatIgnitionPlugin from "../../src/index.js";
+
+describe("visualize - build invocation", function () {
+  function buildArgCaptor() {
+    const buildArgs: any[] = [];
+    const buildOverride = overrideTask("build")
+      .setAction(async () => ({
+        default: async (args: any) => {
+          buildArgs.push(args);
+          return { contractRootPaths: [], testRootPaths: [] };
+        },
+      }))
+      .build();
+    return { buildArgs, buildOverride };
+  }
+
+  function getProjectConfig() {
+    const projectPath = path.join(
+      path.dirname(fileURLToPath(import.meta.url)),
+      "../fixture-projects",
+      "minimal",
+    );
+
+    const configPath = path.join(projectPath, "hardhat.config.js");
+
+    return { projectPath, configPath };
+  }
+
+  it("should call build without noTests when splitTestsCompilation is false", async function () {
+    const { buildArgs, buildOverride } = buildArgCaptor();
+    const { projectPath, configPath } = getProjectConfig();
+
+    const { default: userConfig } = await import(
+      pathToFileURL(configPath).href
+    );
+
+    const hre = await createHardhatRuntimeEnvironment(
+      {
+        ...userConfig,
+        plugins: [hardhatIgnitionPlugin],
+        tasks: [buildOverride],
+      },
+      { config: configPath },
+      projectPath,
+    );
+
+    await hre.tasks.getTask(["ignition", "visualize"]).run({
+      noOpen: true,
+      modulePath: path.join(projectPath, "ignition", "modules", "MyModule.js"),
+    });
+
+    assert.equal(buildArgs.length, 1);
+    assert.equal(buildArgs[0].noTests, false);
+    assert.equal(buildArgs[0].quiet, true);
+  });
+
+  it("should call build with noTests when splitTestsCompilation is true", async function () {
+    const { buildArgs, buildOverride } = buildArgCaptor();
+    const { projectPath, configPath } = getProjectConfig();
+
+    const { default: userConfig } = await import(
+      pathToFileURL(configPath).href
+    );
+
+    const hre = await createHardhatRuntimeEnvironment(
+      {
+        ...userConfig,
+        solidity: {
+          ...userConfig.solidity,
+          splitTestsCompilation: true,
+        },
+        plugins: [hardhatIgnitionPlugin],
+        tasks: [buildOverride],
+      },
+      { config: configPath },
+      projectPath,
+    );
+
+    await hre.tasks.getTask(["ignition", "visualize"]).run({
+      noOpen: true,
+      modulePath: path.join(projectPath, "ignition", "modules", "MyModule.js"),
+    });
+
+    assert.equal(buildArgs.length, 1);
+    assert.equal(buildArgs[0].noTests, true);
+    assert.equal(buildArgs[0].quiet, true);
+  });
+});

packages/hardhat-mocha/src/task-action.ts

@@ -82,9 +82,8 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   perf.startPhase("Build");
 
   if (!noCompile) {
-    await hre.tasks.getTask("build").run({
-      noTests: true,
-    });
+    const noTests = hre.config.solidity.splitTestsCompilation;
+    await hre.tasks.getTask("build").run({ noTests });
     console.log();
   }