Merge pull request #5584 from NomicFoundation/node-test-runner

Node test runner plugin supporting js tests
NomicFoundation · Aug 26, 2024 · 1bdf98d · 1bdf98d
2 parents 17ba161 + c2d5655
commit 1bdf98d
Show file tree

Hide file tree

Showing 20 changed files with 360 additions and 46 deletions.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/v-next/core/src/internal/hre.ts b/v-next/core/src/internal/hre.ts
@@ -179,6 +179,7 @@ async function resolveUserConfig(
       root: projectRoot,
       cache: config.paths?.cache ?? "", // TODO: resolve cache path
       artifacts: config.paths?.artifacts ?? "", // TODO: resolve artifacts path
+      tests: config.paths?.tests ?? "test", // TODO: resolve tests path
     },
   };
 

diff --git a/v-next/core/src/types/config.ts b/v-next/core/src/types/config.ts
@@ -56,6 +56,7 @@ export interface ProjectPathsUserConfig {
   root?: string;
   cache?: string;
   artifacts?: string;
+  tests?: string;
 }
 
 /**
@@ -69,4 +70,5 @@ export interface ProjectPathsConfig {
   root: string;
   cache: string;
   artifacts: string;
+  tests: string;
 }
diff --git a/v-next/core/test/internal/configuration-variables/configuration-variables.ts b/v-next/core/test/internal/configuration-variables/configuration-variables.ts
@@ -28,6 +28,7 @@ describe("ResolvedConfigurationVariable", () => {
           root: projectRoot,
           cache: "",
           artifacts: "",
+          tests: "",
         },
       },
       hooks: hookManager,

diff --git a/v-next/core/test/internal/hook-manager.ts b/v-next/core/test/internal/hook-manager.ts
@@ -105,6 +105,7 @@ describe("HookManager", () => {
               root: projectRoot,
               cache: "",
               artifacts: "",
+              tests: "",
             },
           },
           hooks: hookManager,
@@ -175,6 +176,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -230,6 +232,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -335,6 +338,7 @@ describe("HookManager", () => {
               root: projectRoot,
               cache: "",
               artifacts: "",
+              tests: "",
             },
           },
           hooks: hookManager,
@@ -355,6 +359,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -441,6 +446,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -564,6 +570,7 @@ describe("HookManager", () => {
               root: projectRoot,
               cache: "",
               artifacts: "",
+              tests: "",
             },
           },
           hooks: hookManager,
@@ -658,6 +665,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -702,6 +710,7 @@ describe("HookManager", () => {
               root: projectRoot,
               cache: "",
               artifacts: "",
+              tests: "",
             },
           },
           hooks: hookManager,
@@ -720,6 +729,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -740,6 +750,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -825,6 +836,7 @@ describe("HookManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         };
 
@@ -869,6 +881,7 @@ describe("HookManager", () => {
               root: projectRoot,
               cache: "",
               artifacts: "",
+              tests: "",
             },
           },
           hooks: hookManager,
@@ -1030,6 +1043,7 @@ function buildMockHardhatRuntimeEnvironment(
         root: projectRoot,
         cache: "",
         artifacts: "",
+        tests: "",
       },
     },
     tasks: mockTaskManager,

diff --git a/v-next/core/test/internal/user-interruptions/user-interruptions-manager.ts b/v-next/core/test/internal/user-interruptions/user-interruptions-manager.ts
@@ -32,6 +32,7 @@ describe("UserInterruptionManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         },
         globalOptions: {},
@@ -78,6 +79,7 @@ describe("UserInterruptionManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         },
         globalOptions: {},
@@ -126,6 +128,7 @@ describe("UserInterruptionManager", () => {
             root: projectRoot,
             cache: "",
             artifacts: "",
+            tests: "",
           },
         },
         globalOptions: {},

diff --git a/v-next/example-project/hardhat.config.ts b/v-next/example-project/hardhat.config.ts
@@ -2,12 +2,12 @@ import { HardhatPluginError } from "@ignored/hardhat-vnext/plugins";
 
 import {
   task,
-  HardhatUserConfig,
   emptyTask,
-  overrideTask,
   configVariable,
   globalOption,
+  HardhatUserConfig,
 } from "@ignored/hardhat-vnext/config";
+import HardhatNodeTestRunner from "@ignored/hardhat-vnext-node-test-runner";
 
 const exampleEmptyTask = emptyTask("empty", "An example empty task").build();
 
@@ -47,40 +47,6 @@ const exampleTaskOverride = task("example2")
   })
   .build();
 
-const testTask = task("test", "Runs mocha tests")
-  .addVariadicArgument({
-    name: "testFiles",
-    description: "An optional list of files to test",
-    // defaultValue: [],
-  })
-  .addFlag({
-    name: "noCompile",
-    description: "Don't compile before running this task",
-  })
-  .addFlag({
-    name: "parallel",
-    description: "Run tests in parallel",
-  })
-  .addFlag({
-    name: "bail",
-    description: "Stop running tests after the first test failure",
-  })
-  .addOption({
-    name: "grep",
-    description: "Only run tests matching the given string or regexp",
-    defaultValue: "",
-  })
-  .setAction(import.meta.resolve("./tasks/non-existing.ts"))
-  .build();
-
-const testTaskOverride = overrideTask("test")
-  .addFlag({
-    name: "newFlag",
-    description: "A new flag",
-  })
-  .setAction((_taskArguments, _hre, _runSuper) => {})
-  .build();
-
 const testSolidityTask = task(["test", "solidity"], "Runs Solidity tests")
   .setAction(async () => {
     console.log("Running Solidity tests");
@@ -131,14 +97,12 @@ const pluginExample = {
 const config: HardhatUserConfig = {
   tasks: [
     exampleTaskOverride,
-    testTask,
-    testTaskOverride,
     testSolidityTask,
     exampleEmptyTask,
     exampleEmptySubtask,
     greeting,
   ],
-  plugins: [pluginExample],
+  plugins: [pluginExample, HardhatNodeTestRunner],
   privateKey: configVariable("privateKey"),
 };