Merge pull request #6235 from NomicFoundation/solidity-test-stack-traces

feat: integrate stack traces into solidity test
NomicFoundation · Feb 7, 2025 · 14ebbdb · 14ebbdb
2 parents 1ec485f + 285d3a6
commit 14ebbdb
Show file tree

Hide file tree

Showing 10 changed files with 207 additions and 77 deletions.
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/v-next/example-project/contracts/Counter.t.sol b/v-next/example-project/contracts/Counter.t.sol
@@ -2,6 +2,7 @@
 pragma solidity ^0.8.0;
 
 import "./Counter.sol";
+import "hardhat/console.sol";
 
 contract CounterTest {
   Counter counter;
@@ -41,14 +42,18 @@ contract FailingCounterTest {
   Counter counter;
 
   function setUp() public {
+    console.log("Setting up");
     counter = new Counter();
+    console.log("Counter set up");
   }
 
   function testInitialValue() public view {
+    console.log("Testing initial value");
     require(counter.x() == 1, "Initial value should be 1");
   }
 
   function testFuzzInc(uint8 x) public {
+    console.log("Fuzz testing inc");
     for (uint8 i = 0; i < x; i++) {
       counter.inc();
     }
@@ -59,6 +64,7 @@ contract FailingCounterTest {
   }
 
   function testFailFuzzInc(uint8 x) public {
+    console.log("Fuzz testing inc fail");
     for (uint8 i = 0; i < x; i++) {
       counter.inc();
     }

diff --git a/v-next/hardhat/package.json b/v-next/hardhat/package.json
@@ -84,7 +84,7 @@
     "typescript-eslint": "7.7.1"
   },
   "dependencies": {
-    "@ignored/edr": "0.6.4-alpha.2",
+    "@ignored/edr": "0.8.0-alpha.1",
     "@ignored/edr-optimism": "0.6.5-alpha.2",
     "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.15",
     "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.15",

diff --git a/.../internal/builtin-plugins/network-manager/edr/stack-traces/stack-trace-solidity-errors.ts b/.../internal/builtin-plugins/network-manager/edr/stack-traces/stack-trace-solidity-errors.ts
@@ -68,7 +68,7 @@ export function createSolidityErrorWithStackTrace(
   }
 }
 
-function encodeStackTraceEntry(
+export function encodeStackTraceEntry(
   stackTraceEntry: SolidityStackTraceEntry,
 ): SolidityCallSite {
   switch (stackTraceEntry.type) {

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/config.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/config.ts
@@ -20,7 +20,6 @@ const solidityTestUserConfigType = z.object({
       write: z.array(z.string()).optional(),
     })
     .optional(),
-  trace: z.boolean().optional(),
   testFail: z.boolean().optional(),
   labels: z
     .array(

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/reporter.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/reporter.ts
@@ -8,6 +8,8 @@ import type { TestResult } from "@ignored/edr";
 import { bytesToHexString } from "@ignored/hardhat-vnext-utils/hex";
 import chalk from "chalk";
 
+import { encodeStackTraceEntry } from "../network-manager/edr/stack-traces/stack-trace-solidity-errors.js";
+
 import { formatArtifactId } from "./formatters.js";
 
 /**
@@ -117,27 +119,55 @@ export async function* testReporter(
     for (const [index, failure] of failures.entries()) {
       yield `\n${chalk.bold(chalk.red(`Failure (${index + 1})`))}: ${failure.name}\n`;
 
-      if (failure.decodedLogs !== undefined && failure.decodedLogs.length > 0) {
-        yield `Decoded Logs${chalk.grey(`: ${failure.decodedLogs.join("\n")}\n`)}`;
+      if (
+        failure.reason !== undefined &&
+        failure.reason !== null &&
+        failure.reason !== ""
+      ) {
+        yield `Reason: ${chalk.grey(failure.reason)}\n`;
+      }
+
+      const stackTrace = failure.stackTrace();
+      if (
+        stackTrace !== undefined &&
+        stackTrace !== null &&
+        stackTrace.length > 0
+      ) {
+        const stackTraceStack: string[] = [];
+        for (const entry of stackTrace.reverse()) {
+          const callsite = encodeStackTraceEntry(entry);
+          if (callsite !== undefined) {
+            stackTraceStack.push(`  at ${callsite.toString()}`);
+          }
+        }
+
+        if (stackTraceStack.length > 0) {
+          yield `${chalk.grey(stackTraceStack.join("\n"))}\n`;
+        }
       }
 
-      if (failure.reason !== undefined && failure.reason !== "") {
-        yield `Reason${chalk.grey(`: ${failure.reason}\n`)}`;
+      if (
+        failure.decodedLogs !== undefined &&
+        failure.decodedLogs !== null &&
+        failure.decodedLogs.length > 0
+      ) {
+        yield `Decoded Logs:\n${chalk.grey(failure.decodedLogs.map((log) => `  ${log}`).join("\n"))}\n`;
       }
 
-      if (failure.counterexample !== undefined) {
+      if (
+        failure.counterexample !== undefined &&
+        failure.counterexample !== null
+      ) {
         const counterexamples = Array.isArray(failure.counterexample)
           ? failure.counterexample
           : [failure.counterexample];
 
         for (const counterexample of counterexamples) {
-          const details = `{\n${Object.entries(counterexample)
-            .map(
-              ([key, value]) =>
-                `  ${key}: ${Buffer.isBuffer(value) ? bytesToHexString(value) : value}`,
-            )
-            .join(",\n")}\n}`;
-          yield `Counterexample${chalk.grey(`: ${details}\n`)}`;
+          const details = Object.entries(counterexample).map(
+            ([key, value]) =>
+              `  ${key}: ${Buffer.isBuffer(value) ? bytesToHexString(value) : value}`,
+          );
+          yield `Counterexample:\n${chalk.grey(details.join("\n"))}\n`;
         }
       }
     }

diff --git a/v-next/hardhat/src/internal/builtin-plugins/solidity-test/runner.ts b/v-next/hardhat/src/internal/builtin-plugins/solidity-test/runner.ts
@@ -3,6 +3,7 @@ import type {
   ArtifactId,
   Artifact,
   SolidityTestRunnerConfigArgs,
+  TracingConfigWithBuffers,
 } from "@ignored/edr";
 
 import { Readable } from "node:stream";
@@ -49,6 +50,7 @@ export function run(
   artifacts: Artifact[],
   testSuiteIds: ArtifactId[],
   configArgs: SolidityTestRunnerConfigArgs,
+  tracingConfig: TracingConfigWithBuffers,
   options?: RunOptions,
 ): TestsStream {
   const stream = new ReadableStream<TestEvent>({
@@ -83,6 +85,7 @@ export function run(
         artifacts,
         testSuiteIds,
         configArgs,
+        tracingConfig,
         (suiteResult) => {
           controller.enqueue({
             type: "suite:result",

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
@@ -2,7 +2,10 @@ import type { RunOptions } from "./runner.js";
 import type { TestEvent } from "./types.js";
 import type { BuildOptions } from "../../../types/solidity/build-system.js";
 import type { NewTaskActionFunction } from "../../../types/tasks.js";
-import type { SolidityTestRunnerConfigArgs } from "@ignored/edr";
+import type {
+  SolidityTestRunnerConfigArgs,
+  TracingConfigWithBuffers,
+} from "@ignored/edr";
 
 import { finished } from "node:stream/promises";
 
@@ -13,6 +16,7 @@ import { createNonClosingWriter } from "@ignored/hardhat-vnext-utils/stream";
 import { shouldMergeCompilationJobs } from "../solidity/build-profiles.js";
 import {
   getArtifacts,
+  getBuildInfos,
   throwIfSolidityBuildFailed,
 } from "../solidity/build-results.js";
 
@@ -65,7 +69,8 @@ const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
 
   throwIfSolidityBuildFailed(results);
 
-  const artifacts = await getArtifacts(results, hre.config.paths.artifacts);
+  const buildInfos = await getBuildInfos(results, hre.artifacts);
+  const artifacts = await getArtifacts(results, buildInfos);
   const testSuiteIds = artifacts.map((artifact) => artifact.id);
 
   console.log("Running Solidity tests");
@@ -81,10 +86,20 @@ const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
       hre.config.paths.root,
       solidityTestConfig,
     );
+  const tracingConfig: TracingConfigWithBuffers = {
+    buildInfos,
+    ignoreContracts: false,
+  };
   const options: RunOptions =
     solidityTestConfigToRunOptions(solidityTestConfig);
 
-  const runStream = run(artifacts, testSuiteIds, config, options);
+  const runStream = run(
+    artifacts,
+    testSuiteIds,
+    config,
+    tracingConfig,
+    options,
+  );
 
   const testReporterStream = runStream
     .on("data", (event: TestEvent) => {

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
@@ -16,7 +16,6 @@ declare module "../../../types/config.js" {
       read?: string[];
       write?: string[];
     };
-    trace?: boolean;
     testFail?: boolean;
     labels?: Array<{
       address: string; // 0x-prefixed hex string