Merge pull request #7686 from NomicFoundation/fix-solidity-tests-task-compilation

Fix `test solidity` and `build` issues

Author: alcuadrado

.changeset/rude-badgers-grow.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Remove the compilation spinner when the compilation fails

.changeset/serious-knives-smoke.md

@@ -0,0 +1,5 @@
+---
+"hardhat": patch
+---
+
+Fix the `test solidity` task's compilation process

.changeset/twenty-dolls-stand.md

@@ -0,0 +1,6 @@
+---
+"@nomicfoundation/hardhat-errors": patch
+"hardhat": patch
+---
+
+Fail when a file isn't built neither as contract nor test

pnpm-lock.yaml

@@ -1167,6 +1167,18 @@ Please check Hardhat's output for more details.`,
         websiteTitle: "Could not parse a compiler version",
         websiteDescription: `Hardhat failed to parse the full compiler version from the output of the compiler's 'version' command.`,
       },
+      UNRECOGNIZED_FILES_NOT_COMPILED: {
+        number: 915,
+        messageTemplate: `The build process failed because these files you provided haven't been recognized neither as contracts nor tests:
+        
+{files}
+
+Solidity test files must be placed in your test directory, or in your contracts directory and end in .t.sol.`,
+        websiteTitle: "Build failed due to unrecognized files",
+        websiteDescription: `Hardhat failed to build your contracts and/or tests because you passed a file as parameter, but it wasn't recognized neither as a valid contract nor test.
+        
+Solidity test files must be placed in your test directory, or in your contracts directory and end in .t.sol.`,
+      },
     },
     ARTIFACTS: {
       NOT_FOUND: {

v-next/hardhat-errors/src/descriptors.ts

@@ -48,6 +48,7 @@
     "c8": "^9.1.0",
     "eslint": "9.25.1",
     "expect-type": "^1.2.1",
+    "hardhat": "workspace:^3.0.0",
     "prettier": "3.2.5",
     "rimraf": "^5.0.5",
     "tsx": "^4.19.3",

v-next/hardhat-keystore/package.json

@@ -16,11 +16,12 @@ import {
   l1HardforkLatest,
   IncludeTraces,
   FsAccessPermission,
+  CollectStackTraces,
 } from "@nomicfoundation/edr";
 import { hexStringToBytes } from "@nomicfoundation/hardhat-utils/hex";
 import chalk from "chalk";
 
-import { OPTIMISM_CHAIN_TYPE } from "../../constants.js";
+import { DEFAULT_VERBOSITY, OPTIMISM_CHAIN_TYPE } from "../../constants.js";
 
 import { type Colorizer, formatArtifactId } from "./formatters.js";
 
@@ -126,6 +127,8 @@ export async function solidityTestConfigToSolidityTestRunnerConfigArgs({
     }
   }
 
+  const shouldAlwaysCollectStackTraces = verbosity > DEFAULT_VERBOSITY;
+
   return {
     projectRoot,
     ...config,
@@ -144,6 +147,9 @@ export async function solidityTestConfigToSolidityTestRunnerConfigArgs({
     forkBlockNumber,
     rpcEndpoints,
     generateGasReport,
+    collectStackTraces: shouldAlwaysCollectStackTraces
+      ? CollectStackTraces.Always
+      : CollectStackTraces.OnFailure,
   };
 }
 

v-next/hardhat/src/internal/builtin-plugins/solidity-test/helpers.ts

@@ -2,6 +2,7 @@ import type { HardhatPlugin } from "../../../types/plugins.js";
 
 import { ArgumentType } from "hardhat/types/arguments";
 
+import { DEFAULT_VERBOSITY } from "../../constants.js";
 import { task } from "../../core/config.js";
 
 import "./type-extensions.js";
@@ -38,7 +39,7 @@ const hardhatPlugin: HardhatPlugin = {
         name: "verbosity",
         shortName: "v",
         description: "Verbosity level of the test output",
-        defaultValue: 2,
+        defaultValue: DEFAULT_VERBOSITY,
       })
       .setAction(async () => import("./task-action.js"))
       .build(),

v-next/hardhat/src/internal/builtin-plugins/solidity-test/index.ts

@@ -302,9 +302,11 @@ export async function* testReporter(
           case "UnsafeToReplay":
             if (stackTrace.globalForkLatest === true) {
               yield indenter.t`Stack Trace Warning: ${colorizer.grey("The test is not safe to replay because a fork url without a fork block number was provided.")}\n`;
+              yield indenter.t`Try rerunning your tests with -vvv or above.\n`;
             }
             if (stackTrace.impureCheatcodes.length > 0) {
               yield indenter.t`Stack Trace Warning: ${colorizer.grey(`The test is not safe to replay because it uses impure cheatcodes: ${stackTrace.impureCheatcodes.join(", ")}`)}\n`;
+              yield indenter.t`Try rerunning your tests with -vvv or above.\n`;
             }
             break;
           case "HeuristicFailed":

v-next/hardhat/src/internal/builtin-plugins/solidity-test/reporter.ts

@@ -79,12 +79,19 @@ const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
     );
   }
 
+  // Run the build task for contract files if needed
+  if (noCompile !== true) {
+    await hre.tasks.getTask("build").run({
+      noTests: true,
+    });
+  }
+
   // Run the build task for test files
   const { testRootPaths }: { testRootPaths: string[] } = await hre.tasks
     .getTask("build")
     .run({
       files: testFiles,
-      noContracts: noCompile,
+      noContracts: true,
     });
   console.log();