fix: adapt gas-analytics and solidity-test to Result pattern after rebase onto main

Author: schaable

v-next/hardhat/src/internal/builtin-plugins/gas-analytics/index.ts

@@ -21,7 +21,7 @@ const hardhatPlugin: HardhatPlugin = {
         default: async (args, _hre, runSuper) => {
           // We don't need to do anything here, as the test task will forward
           // the arguments to its subtasks.
-          await runSuper(args);
+          return runSuper(args);
         },
       }))
       .build(),

v-next/hardhat/src/internal/builtin-plugins/gas-analytics/tasks/solidity-test/task-action.ts

@@ -1,11 +1,14 @@
 import type { TaskOverrideActionFunction } from "../../../../../types/tasks.js";
+import type { Result } from "../../../../../types/utils.js";
+import type { SolidityTestRunResult } from "../../../solidity-test/task-action.js";
 import type { FunctionGasSnapshotCheckResult } from "../../function-gas-snapshots.js";
 import type { SnapshotCheatcodesCheckResult } from "../../snapshot-cheatcodes.js";
 import type { SuiteResult } from "@nomicfoundation/edr";
 
 import { HardhatError } from "@nomicfoundation/hardhat-errors";
 import chalk from "chalk";
 
+import { errorResult } from "../../../../../utils/result.js";
 import {
   checkFunctionGasSnapshots,
   extractFunctionGasSnapshots,
@@ -36,9 +39,13 @@ export interface SnapshotCheckResult {
 const runSolidityTests: TaskOverrideActionFunction<
   GasAnalyticsTestActionArguments
 > = async (args, hre, runSuper) => {
-  const taskResult = await runSuper(args);
-  const suiteResults: SuiteResult[] = taskResult.suiteResults;
-  const testsPassed = process.exitCode !== 1;
+  const superResult: Result<SolidityTestRunResult, SolidityTestRunResult> =
+    await runSuper(args);
+  const testsPassed = superResult.success;
+  const solidityTestRunResult = testsPassed
+    ? superResult.value
+    : superResult.error;
+  const suiteResults = solidityTestRunResult.suiteResults;
   const rootPath = hre.config.paths.root;
 
   if (args.snapshot && args.snapshotCheck) {
@@ -66,12 +73,11 @@ const runSolidityTests: TaskOverrideActionFunction<
       snapshotCheckResult.snapshotCheatcodesCheck.passed;
   }
 
-  process.exitCode = testsPassed && snapshotCheckPassed ? 0 : 1;
+  if (!snapshotCheckPassed) {
+    return errorResult(solidityTestRunResult);
+  }
 
-  return {
-    ...taskResult,
-    suiteResults,
-  };
+  return superResult;
 };
 
 export async function handleSnapshot(

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

@@ -47,10 +47,14 @@ interface TestActionArguments {
   testSummaryIndex: number;
 }
 
+export interface SolidityTestRunResult extends TestRunResult {
+  suiteResults: SuiteResult[];
+}
+
 const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
   { testFiles, chainType, grep, noCompile, verbosity, testSummaryIndex },
   hre,
-): Promise<Result<TestRunResult, TestRunResult>> => {
+): Promise<Result<SolidityTestRunResult, SolidityTestRunResult>> => {
   assertHardhatInvariant(
     hre instanceof HardhatRuntimeEnvironmentImplementation,
     "Expected HRE to be an instance of HardhatRuntimeEnvironmentImplementation",

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

@@ -140,7 +140,7 @@ describe("solidityTestConfigToSolidityTestRunnerConfigArgs", () => {
     const args = await solidityTestConfigToSolidityTestRunnerConfigArgs({
       chainType: GENERIC_CHAIN_TYPE,
       projectRoot: process.cwd(),
-      config: { gasLimit: undefined },
+      config: { fuzz: { seed: "0x1234" }, gasLimit: undefined },
       verbosity: 1,
       generateGasReport: false,
     });
@@ -152,7 +152,7 @@ describe("solidityTestConfigToSolidityTestRunnerConfigArgs", () => {
     const args = await solidityTestConfigToSolidityTestRunnerConfigArgs({
       chainType: GENERIC_CHAIN_TYPE,
       projectRoot: process.cwd(),
-      config: { gasLimit: 12_000_000n },
+      config: { fuzz: { seed: "0x1234" }, gasLimit: 12_000_000n },
       verbosity: 1,
       generateGasReport: false,
     });

v-next/hardhat/test/internal/builtin-plugins/solidity-test/task-action.ts

@@ -185,18 +185,18 @@ describe("solidity-test/task-action", function () {
       const result = await hre.tasks
         .getTask(["test", "solidity"])
         .run({ noCompile: true });
-      assert.deepEqual(result, {
-        success: false,
-        error: {
-          summary: {
-            failed: 0,
-            passed: 0,
-            skipped: 0,
-            todo: 0,
-            failureOutput: "",
-          },
-        },
+      assert.equal(result.success, false);
+      assert.deepEqual(result.error.summary, {
+        failed: 0,
+        passed: 0,
+        skipped: 0,
+        todo: 0,
+        failureOutput: "",
       });
+      assert.ok(
+        Array.isArray(result.error.suiteResults),
+        "suiteResults should be an array",
+      );
     });
 
     it("should return a success result when all tests pass", async () => {
@@ -205,18 +205,18 @@ describe("solidity-test/task-action", function () {
       const result = await hre.tasks
         .getTask(["test", "solidity"])
         .run({ noCompile: true });
-      assert.deepEqual(result, {
-        success: true,
-        value: {
-          summary: {
-            failed: 0,
-            passed: 0,
-            skipped: 0,
-            todo: 0,
-            failureOutput: "",
-          },
-        },
+      assert.equal(result.success, true);
+      assert.deepEqual(result.value.summary, {
+        failed: 0,
+        passed: 0,
+        skipped: 0,
+        todo: 0,
+        failureOutput: "",
       });
+      assert.ok(
+        Array.isArray(result.value.suiteResults),
+        "suiteResults should be an array",
+      );
     });
 
     describe("when the contracts are in the optimism chain type", () => {