test: implement config tests for the isolated option

Author: galargh

v-next/hardhat/src/internal/builtin-plugins/solidity/config.ts

@@ -26,6 +26,10 @@ const sourcePathsType = conditionalUnionType(
   "Expected a string or an array of strings",
 );
 
+const commonSolcUserConfigType = z.object({
+  isolated: z.boolean().optional(),
+});
+
 const solcUserConfigType = z.object({
   version: z.string(),
   settings: z.any().optional(),
@@ -34,10 +38,10 @@ const solcUserConfigType = z.object({
   profiles: incompatibleFieldType("This field is incompatible with `version`"),
 });
 
-// NOTE: This is only to match the setup present in ./type-extensions.ts
-const singleVersionSolcUserConfigType = solcUserConfigType;
+const singleVersionSolcUserConfigType =
+  commonSolcUserConfigType.merge(solcUserConfigType);
 
-const multiVersionSolcUserConfigType = z.object({
+const multiVersionSolcUserConfigType = commonSolcUserConfigType.extend({
   compilers: z.array(solcUserConfigType).nonempty(),
   overrides: z.record(z.string(), solcUserConfigType).optional(),
   version: incompatibleFieldType("This field is incompatible with `compilers`"),

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

@@ -88,6 +88,7 @@ describe(
             },
           ],
           overrides: {},
+          isolated: false,
         },
       },
       npmFilesToBuild: [],

v-next/hardhat/test/internal/builtin-plugins/solidity/build-system/solc-config-selection.ts

@@ -53,6 +53,7 @@ describe("SolcConfigSelector", () => {
     buildProfile = {
       compilers: [],
       overrides: {},
+      isolated: false,
     };
     root = createProjectResolvedFile("root.sol", ["^0.8.0"]);
     dependencyGraph = new DependencyGraphImplementation();
@@ -357,7 +358,11 @@ describe("SolcConfigSelector", () => {
 
       const selector = new SolcConfigSelector(
         buildProfileName,
-        { compilers: [{ version: "0.8.0", settings: {} }], overrides: {} },
+        {
+          compilers: [{ version: "0.8.0", settings: {} }],
+          overrides: {},
+          isolated: false,
+        },
         dependencyGraph,
       );
 

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

@@ -232,11 +232,108 @@ describe("solidity plugin config validation", () => {
       );
     });
 
-    it.todo("Should reject invalid SingleVersionSolidityUserConfig values");
+    it("Should reject invalid SingleVersionSolidityUserConfig values", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: 123,
+            npmFilesToBuild: {},
+            isolated: "false",
+          },
+        }),
+        [
+          {
+            message: "Expected boolean, received string",
+            path: ["solidity", "isolated"],
+          },
+          {
+            message: "Expected string, received number",
+            path: ["solidity", "version"],
+          },
+          {
+            message: "Expected array, received object",
+            path: ["solidity", "npmFilesToBuild"],
+          },
+        ],
+      );
+    });
 
-    it.todo("Should reject invalid MultiVersionSolidityUserConfig values");
+    it("Should reject invalid MultiVersionSolidityUserConfig values", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            compilers: [
+              {
+                version: 123,
+              },
+            ],
+            overrides: [],
+            isolated: "false",
+          },
+        }),
+        [
+          {
+            message: "Expected boolean, received string",
+            path: ["solidity", "isolated"],
+          },
+          {
+            message: "Expected string, received number",
+            path: ["solidity", "compilers", 0, "version"],
+          },
+          {
+            message: "Expected object, received array",
+            path: ["solidity", "overrides"],
+          },
+        ],
+      );
+    });
 
-    it.todo("Should reject invalid BuildProfilesSolidityUserConfig values");
+    it("Should reject invalid BuildProfilesSolidityUserConfig values", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            profiles: {
+              default: {
+                version: 123,
+                isolated: "false",
+              },
+              production: {
+                version: "0.8.0",
+                compilers: [
+                  {
+                    version: 123,
+                  },
+                ],
+                overrides: [],
+                isolated: "true",
+              },
+            },
+          },
+        }),
+        [
+          {
+            message: "Expected boolean, received string",
+            path: ["solidity", "profiles", "default", "isolated"],
+          },
+          {
+            message: "Expected string, received number",
+            path: ["solidity", "profiles", "default", "version"],
+          },
+          {
+            message: "Expected boolean, received string",
+            path: ["solidity", "profiles", "production", "isolated"],
+          },
+          {
+            message: "This field is incompatible with `version`",
+            path: ["solidity", "profiles", "production", "compilers"],
+          },
+          {
+            message: "This field is incompatible with `version`",
+            path: ["solidity", "profiles", "production", "overrides"],
+          },
+        ],
+      );
+    });
 
     it("Should accept solidity version strings", () => {
       assert.deepEqual(validateSolidityUserConfig({ solidity: "0.8.0" }), []);
@@ -249,11 +346,104 @@ describe("solidity plugin config validation", () => {
       );
     });
 
-    it.todo("Should accept a SingleVersionSolidityUserConfig value");
+    it("Should accept a SingleVersionSolidityUserConfig value", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            version: "0.8.0",
+            settings: {
+              optimizer: {
+                enabled: true,
+                runs: 200,
+              },
+            },
+            npmFilesToBuild: ["./build.js"],
+            isolated: false,
+          },
+        }),
+        [],
+      );
+    });
 
-    it.todo("Should accept a MultiVersionSolidityUserConfig value");
+    it("Should accept a MultiVersionSolidityUserConfig value", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            compilers: [
+              {
+                version: "0.8.0",
+                settings: {
+                  optimizer: {
+                    enabled: true,
+                    runs: 200,
+                  },
+                },
+              },
+            ],
+            overrides: {
+              "contracts/Contract.sol": {
+                version: "0.8.1",
+                settings: {
+                  optimizer: {
+                    enabled: false,
+                    runs: 100,
+                  },
+                },
+              },
+            },
+            isolated: false,
+          },
+        }),
+        [],
+      );
+    });
 
-    it.todo("Should accept a BuildProfilesSolidityUserConfig value");
+    it("Should accept a BuildProfilesSolidityUserConfig value", () => {
+      assert.deepEqual(
+        validateSolidityUserConfig({
+          solidity: {
+            profiles: {
+              default: {
+                version: "0.8.0",
+                settings: {
+                  optimizer: {
+                    enabled: true,
+                    runs: 200,
+                  },
+                },
+                isolated: false,
+              },
+              production: {
+                compilers: [
+                  {
+                    version: "0.8.0",
+                    settings: {
+                      optimizer: {
+                        enabled: true,
+                        runs: 200,
+                      },
+                    },
+                  },
+                ],
+                overrides: {
+                  "contracts/Contract.sol": {
+                    version: "0.8.1",
+                    settings: {
+                      optimizer: {
+                        enabled: true,
+                        runs: 300,
+                      },
+                    },
+                  },
+                },
+                isolated: true,
+              },
+            },
+          },
+        }),
+        [],
+      );
+    });
   });
 });