Merge pull request #5780 from NomicFoundation/feat/skeleton-solidity-test-integration

add skeleton EDR Solidity Testing integration

Author: kanej

pnpm-lock.yaml

@@ -6,3 +6,9 @@
 
 # pnpm deploy output
 /bundle
+
+# Hardhat Build Artifacts
+/artifacts
+
+# Hardhat compilation (v2) support directory
+/cache

v-next/example-project/.gitignore

@@ -0,0 +1,10 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+contract Counter {
+  uint public x;
+
+  function inc() public {
+    x++;
+  }
+}

v-next/example-project/contracts/Counter.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "./Counter.sol";
+
+contract CounterTest {
+  Counter counter;
+
+  function setUp() public {
+    counter = new Counter();
+  }
+
+  function testInitialValue() public view {
+    require(counter.x() == 0, "Initial value should be 0");
+  }
+
+  function testInc() public {
+    counter.inc();
+    require(counter.x() == 1, "Value after inc should be 1");
+  }
+}

v-next/example-project/contracts/Counter.t.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+contract Rocket {
+    string public name;
+    string public status;
+
+    constructor(string memory _name) {
+        name = _name;
+        status = "ignition";
+    }
+
+    function launch() public {
+        status = "lift-off";
+    }
+}

v-next/example-project/contracts/Rocket.sol

@@ -1,7 +1,7 @@
 {
   "name": "@ignored/hardhat-vnext-build-system",
   "private": true,
-  "version": "2.0.1-next.0",
+  "version": "3.0.0-next.2",
   "description": "Build and Solidity compilation system for Hardhat",
   "homepage": "https://github.com/nomicfoundation/hardhat/tree/main/v-next/hardhat-build-system",
   "repository": {
@@ -13,6 +13,9 @@
   "license": "MIT",
   "type": "module",
   "types": "dist/src/index.d.ts",
+  "exports": {
+    ".": "./dist/src/index.js"
+  },
   "keywords": [
     "ethereum",
     "smart-contracts",
@@ -38,8 +41,8 @@
     "README.md"
   ],
   "dependencies": {
-    "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.0",
-    "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.0",
+    "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.2",
+    "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.2",
     "@nomicfoundation/ethereumjs-util": "9.0.4",
     "@nomicfoundation/solidity-analyzer": "^0.1.0",
     "adm-zip": "^0.4.16",
@@ -60,8 +63,7 @@
   },
   "devDependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
-    "@ignored/hardhat-vnext-node-test-reporter": "workspace:^3.0.0-next.0",
-    "@nomicfoundation/hardhat-test-utils": "workspace:^",
+    "@ignored/hardhat-vnext-node-test-reporter": "workspace:^3.0.0-next.2",
     "@types/ci-info": "^2.0.0",
     "@types/debug": "^4.1.4",
     "@types/find-up": "^2.1.1",

v-next/hardhat-build-system/package.json

@@ -1,5 +1,18 @@
 import type { CompilationJob, CompilerInput } from "../../types/index.js";
 
+const defaultSolcOutputSelection = {
+  "*": {
+    "*": [
+      "abi",
+      "evm.bytecode",
+      "evm.deployedBytecode",
+      "evm.methodIdentifiers",
+      "metadata",
+    ],
+    "": ["ast"],
+  },
+} as const;
+
 export function getInputFromCompilationJob(
   compilationJob: CompilationJob,
 ): CompilerInput {
@@ -18,9 +31,50 @@ export function getInputFromCompilationJob(
 
   const { settings } = compilationJob.getSolcConfig();
 
-  return {
+  const result = {
     language: "Solidity",
     sources,
-    settings,
+    settings: settings ?? {},
+  };
+
+  // This code is pulled in from `resolveCompiler` in
+  // `packages/hardhat-core/src/internal/core/config/config-resolution.ts`
+  //
+  // In v2 the config loading sets the default values that will be passed
+  // to the compiler. I am pulling it to here for the moment to keep
+  // the build system encapsulated.
+  result.settings.optimizer = {
+    enabled: false,
+    runs: 200,
+    ...result.settings.optimizer,
   };
+
+  if (result.settings.outputSelection === undefined) {
+    result.settings.outputSelection = {};
+  }
+
+  for (const [file, contractSelection] of Object.entries(
+    defaultSolcOutputSelection,
+  )) {
+    if (result.settings.outputSelection[file] === undefined) {
+      result.settings.outputSelection[file] = {};
+    }
+
+    for (const [contract, outputs] of Object.entries(contractSelection)) {
+      if (result.settings.outputSelection[file][contract] === undefined) {
+        result.settings.outputSelection[file][contract] = [];
+      }
+
+      for (const output of outputs) {
+        const includesOutput: boolean =
+          result.settings.outputSelection[file][contract].includes(output);
+
+        if (!includesOutput) {
+          result.settings.outputSelection[file][contract].push(output);
+        }
+      }
+    }
+  }
+
+  return result;
 }

v-next/hardhat-build-system/src/internal/solidity/compiler/compiler-input.ts

@@ -73,6 +73,11 @@ export const ERROR_CATEGORIES: {
     max: 999,
     websiteTitle: "Network-helpers errors",
   },
+  SOLIDITY_TESTS: {
+    min: 1000,
+    max: 1099,
+    websiteTitle: "Solidity tests errors",
+  },
 };
 
 export const ERRORS = {
@@ -685,4 +690,12 @@ This might be caused by using hardhat_reset and loadFixture calls in a testcase.
       websiteDescription: "Error while reverting snapshot",
     },
   },
+  SOLIDITY_TESTS: {
+    BUILD_INFO_NOT_FOUND_FOR_CONTRACT: {
+      number: 1000,
+      messageTemplate: `Build info not found for contract {fqn}`,
+      websiteTitle: `Build info not found for contract`,
+      websiteDescription: `Build info not found for contract while compiling Solidity test contracts.`,
+    },
+  },
 } as const;

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

@@ -77,6 +77,8 @@
     "typescript-eslint": "7.7.1"
   },
   "dependencies": {
+    "@ignored/edr": "0.6.2-alpha.0",
+    "@ignored/hardhat-vnext-build-system": "workspace:^3.0.0-next.2",
     "@ignored/hardhat-vnext-errors": "workspace:^3.0.0-next.2",
     "@ignored/hardhat-vnext-utils": "workspace:^3.0.0-next.2",
     "@ignored/hardhat-vnext-zod-utils": "workspace:^3.0.0-next.2",