chore: restore the semantics of paths.tests.solidity

NomicFoundation · Jan 3, 2025 · 18dca31 · 18dca31
1 parent 67daa57
commit 18dca31
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 64 deletions.
diff --git a/v-next/example-project/hardhat.config.ts b/v-next/example-project/hardhat.config.ts
@@ -163,11 +163,7 @@ const config: HardhatUserConfig = {
     tests: {
       mocha: "test/mocha",
       nodeTest: "test/node",
-      solidity: [
-        "contracts/Counter.sol",
-        "contracts/Counter.t.sol",
-        "contracts/WithForge.t.sol",
-      ],
+      solidity: "test/contracts",
     },
   },
   solidity: {

diff --git a/...example-project/contracts/WithForge.t.sol → ...mple-project/test/contracts/WithForge.sol b/...example-project/contracts/WithForge.t.sol → ...mple-project/test/contracts/WithForge.sol
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/helpers.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/helpers.ts
@@ -104,14 +104,12 @@ export async function getArtifacts(
  */
 export async function getTestSuiteIds(
   artifacts: EdrArtifact[],
-  rootFilePaths: string[],
+  rootTestFilePaths: string[],
   projectRoot: string,
 ): Promise<EdrArtifactId[]> {
-  const testSources = rootFilePaths
-    .filter((p) => {
-      return p.endsWith(".t.sol");
-    })
-    .map((p) => path.relative(projectRoot, p));
+  const testSources = rootTestFilePaths.map((p) =>
+    path.relative(projectRoot, p),
+  );
 
   return artifacts
     .map(({ id }) => id)

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/hook-handlers/config.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/hook-handlers/config.ts
@@ -37,33 +37,20 @@ export default async (): Promise<Partial<ConfigHooks>> => {
         resolveConfigurationVariable,
       );
 
-      let testsPaths: string[];
+      let testsPath = userConfig.paths?.tests;
 
       // TODO: use isObject when the type narrowing issue is fixed
-      if (
-        typeof userConfig.paths?.tests === "object" &&
-        userConfig.paths.tests.solidity !== undefined
-      ) {
-        if (Array.isArray(userConfig.paths.tests.solidity)) {
-          testsPaths = userConfig.paths.tests.solidity;
-        } else {
-          testsPaths = [userConfig.paths.tests.solidity];
-        }
-      } else {
-        testsPaths = resolvedConfig.paths.sources.solidity;
-      }
-
-      const resolvedPaths = testsPaths.map((p) =>
-        resolveFromRoot(resolvedConfig.paths.root, p),
-      );
+      testsPath =
+        typeof testsPath === "object" ? testsPath.solidity : testsPath;
+      testsPath ??= "test";
 
       return {
         ...resolvedConfig,
         paths: {
           ...resolvedConfig.paths,
           tests: {
             ...resolvedConfig.paths.tests,
-            solidity: resolvedPaths,
+            solidity: resolveFromRoot(resolvedConfig.paths.root, testsPath),
           },
         },
       };

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/task-action.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/task-action.ts
@@ -5,11 +5,7 @@ import type { NewTaskActionFunction } from "../../../types/tasks.js";
 
 import { finished } from "node:stream/promises";
 
-import {
-  getAllFilesMatching,
-  isDirectory,
-} from "@ignored/hardhat-vnext-utils/fs";
-import { resolveFromRoot } from "@ignored/hardhat-vnext-utils/path";
+import { getAllFilesMatching } from "@ignored/hardhat-vnext-utils/fs";
 import { createNonClosingWriter } from "@ignored/hardhat-vnext-utils/stream";
 
 import { shouldMergeCompilationJobs } from "../solidity/build-profiles.js";
@@ -28,47 +24,42 @@ interface TestActionArguments {
 }
 
 const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
-  { timeout, noCompile },
+  { timeout },
   hre,
 ) => {
-  const rootFilePaths = (
-    await Promise.all(
-      hre.config.paths.tests.solidity
-        .map((p) => resolveFromRoot(hre.config.paths.root, p))
-        .map(async (p) => {
-          // NOTE: The paths specified in the `paths.tests.solidity` array
-          // can be either directories or files.
-          if (await isDirectory(p)) {
-            return getAllFilesMatching(p, (f) => f.endsWith(".sol"));
-          } else if (p.endsWith(".sol") === true) {
-            return [p];
-          } else {
-            return [];
-          }
-        }),
-    )
+  const rootSourceFilePaths = await hre.solidity.getRootFilePaths();
+  // NOTE: A test file is either a file with a `.sol` extension in the `tests.solidity`
+  // directory or a file with a `.t.sol` extension in the `sources.solidity` directory
+  const rootTestFilePaths = (
+    await Promise.all([
+      getAllFilesMatching(hre.config.paths.tests.solidity, (f) =>
+        f.endsWith(".sol"),
+      ),
+      ...hre.config.paths.sources.solidity.map(async (dir) => {
+        return getAllFilesMatching(dir, (f) => f.endsWith(".t.sol"));
+      }),
+    ])
   ).flat(1);
 
   const buildOptions: BuildOptions = {
-    // NOTE: The uncached sources will still be compiled event if `noCompile`
-    // is true. We could consider adding a `cacheOnly` option to support true
-    // `noCompile` behavior.
-    force: !noCompile,
+    force: false,
     buildProfile: hre.globalOptions.buildProfile,
     mergeCompilationJobs: shouldMergeCompilationJobs(
       hre.globalOptions.buildProfile,
     ),
     quiet: false,
   };
 
+  // NOTE: We compile all the sources together with the tests
+  const rootFilePaths = [...rootSourceFilePaths, ...rootTestFilePaths];
   const results = await hre.solidity.build(rootFilePaths, buildOptions);
 
   throwIfSolidityBuildFailed(results);
 
   const artifacts = await getArtifacts(results, hre.config.paths.artifacts);
   const testSuiteIds = await getTestSuiteIds(
     artifacts,
-    rootFilePaths,
+    rootTestFilePaths,
     hre.config.paths.root,
   );
 

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/type-extensions.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/type-extensions.ts
@@ -2,10 +2,10 @@ import "@ignored/hardhat-vnext/types/config";
 
 declare module "@ignored/hardhat-vnext/types/config" {
   export interface TestPathsUserConfig {
-    solidity?: string | string[];
+    solidity?: string;
   }
 
   export interface TestPathsConfig {
-    solidity: string[];
+    solidity: string;
   }
 }
diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity/build-system/build-system.ts
@@ -78,7 +78,10 @@ export class SolidityBuildSystemImplementation implements SolidityBuildSystem {
     const localFilesToCompile = (
       await Promise.all(
         this.#options.soliditySourcesPaths.map((dir) =>
-          getAllFilesMatching(dir, (f) => f.endsWith(".sol")),
+          getAllFilesMatching(
+            dir,
+            (f) => f.endsWith(".sol") && !f.endsWith(".t.sol"),
+          ),
         ),
       )
     ).flat(1);

diff --git a/v-next/hardhat/test/internal/core/config-validation.ts b/v-next/hardhat/test/internal/core/config-validation.ts
@@ -1,5 +1,8 @@
 import type { HardhatUserConfig } from "../../../src/config.js";
-import type { ProjectPathsUserConfig } from "../../../src/types/config.js";
+import type {
+  ProjectPathsUserConfig,
+  TestPathsUserConfig,
+} from "../../../src/types/config.js";
 import type { HardhatPlugin } from "../../../src/types/plugins.js";
 import type {
   EmptyTaskDefinition,
@@ -1247,7 +1250,8 @@ describe("config validation", function () {
       it("should work when the tests and sources properties are both objects", async function () {
         // Objects are not validated because they are customizable by the user
         const paths: ProjectPathsUserConfig = {
-          tests: { randomProperty: "randomValue" },
+          /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- testing validations for js users who can bypass type checks */
+          tests: { randomProperty: "randomValue" } as TestPathsUserConfig,
           sources: {},
         };
 

diff --git a/v-next/hardhat/test/internal/core/hook-manager.ts b/v-next/hardhat/test/internal/core/hook-manager.ts
@@ -258,7 +258,7 @@ describe("HookManager", () => {
                       givenHre: HardhatRuntimeEnvironment,
                     ): Promise<void> => {
                       givenHre.config.paths.tests = {
-                        solidity: ["./test-folder-from-plugin1"],
+                        solidity: "./test-folder-from-plugin1",
                       };
                     },
                   } as Partial<HardhatRuntimeEnvironmentHooks>;
@@ -279,7 +279,7 @@ describe("HookManager", () => {
                       givenHre: HardhatRuntimeEnvironment,
                     ): Promise<void> => {
                       givenHre.config.paths.tests = {
-                        solidity: ["./test-folder-from-overriding-plugin2"],
+                        solidity: "./test-folder-from-overriding-plugin2",
                       };
                     },
                   } as Partial<HardhatRuntimeEnvironmentHooks>;
@@ -304,7 +304,7 @@ describe("HookManager", () => {
 
             assert.equal(result.length, 2);
             assert.equal(
-              hre.config.paths.tests.solidity[0],
+              hre.config.paths.tests.solidity,
               "./test-folder-from-overriding-plugin2",
             );
           });