Create an integration test to combine all the parsing steps (global parameters, named parameters, positional, etc.) (#5380)

Author: ChristopherDedominici

v-next/hardhat/src/internal/cli/main.ts

@@ -33,7 +33,7 @@ import {
 } from "../helpers/config-loading.js";
 import { getHardhatRuntimeEnvironmentSingleton } from "../hre-singleton.js";
 
-export async function main(cliArguments: string[]) {
+export async function main(cliArguments: string[], print = console.log) {
   const hreInitStart = performance.now();
 
   const usedCliArguments: boolean[] = new Array(cliArguments.length).fill(
@@ -46,7 +46,7 @@ export async function main(cliArguments: string[]) {
   );
 
   if (hardhatSpecialArgs.version) {
-    console.log("3.0.0");
+    print("3.0.0");
     return;
   }
 
@@ -83,7 +83,7 @@ export async function main(cliArguments: string[]) {
     );
 
     const hreInitEnd = performance.now();
-    console.log("Time to initialize the HRE (ms):", hreInitEnd - hreInitStart);
+    print("Time to initialize the HRE (ms):", hreInitEnd - hreInitStart);
 
     const taskParsingStart = performance.now();
 
@@ -92,7 +92,7 @@ export async function main(cliArguments: string[]) {
     if (Array.isArray(result)) {
       if (result.length === 0) {
         // TODO: Print the global help
-        console.log("Global help");
+        print("Global help");
         return;
       }
 
@@ -104,32 +104,26 @@ export async function main(cliArguments: string[]) {
     if (hardhatSpecialArgs.help) {
       if (task.isEmpty) {
         // TODO: Print information about its subtasks
-        console.log("Info about subtasks");
+        print("Info about subtasks");
         return;
       }
 
       // TODO: Print the help message for this task
-      console.log("Help message of the task");
+      print("Help message of the task");
       return;
     }
 
     const taskParsingEnd = performance.now();
 
-    console.log(
-      "Time to parse the task (ms):",
-      taskParsingEnd - taskParsingStart,
-    );
+    print("Time to parse the task (ms):", taskParsingEnd - taskParsingStart);
 
     const taskRunningStart = performance.now();
 
     await task.run(taskArguments);
 
     const taskRunningEnd = performance.now();
 
-    console.log(
-      "Time to run the task (ms):",
-      taskRunningEnd - taskRunningStart,
-    );
+    print("Time to run the task (ms):", taskRunningEnd - taskRunningStart);
   } catch (error) {
     process.exitCode = 1;
 
@@ -140,10 +134,10 @@ export async function main(cliArguments: string[]) {
 
     // TODO: Print the errors nicely, especially `HardhatError`s.
 
-    console.log("Error running the task:", error.message);
+    print("Error running the task:", error.message);
 
     if (hardhatSpecialArgs.showStackTraces) {
-      console.log("");
+      print("");
       console.error(error);
     }
   }

v-next/hardhat/test/fixture-projects/cli/parsing/base-project/hardhat.config.ts

@@ -0,0 +1,17 @@
+import type { HardhatUserConfig } from "@nomicfoundation/hardhat-core/config";
+
+import { task } from "@nomicfoundation/hardhat-core/config";
+
+export const tasksResults = {
+  wasParam1Used: false,
+};
+
+const customTask = task("task")
+  .setAction(() => {
+    tasksResults.wasParam1Used = true;
+  })
+  .build();
+
+export default {
+  tasks: [customTask],
+} satisfies HardhatUserConfig;

v-next/hardhat/test/fixture-projects/cli/parsing/subtask-help/hardhat.config.ts

@@ -0,0 +1,9 @@
+import type { HardhatUserConfig } from "@nomicfoundation/hardhat-core/config";
+
+import { emptyTask } from "@nomicfoundation/hardhat-core/config";
+
+const customTask = emptyTask("empty-task", "empty task description").build();
+
+export default {
+  tasks: [customTask],
+} satisfies HardhatUserConfig;

v-next/hardhat/test/fixture-projects/cli/parsing/tasks-and-subtasks/hardhat.config.ts

@@ -0,0 +1,73 @@
+import type { HardhatUserConfig } from "@nomicfoundation/hardhat-core/config";
+
+import { task } from "@nomicfoundation/hardhat-core/config";
+
+export const tasksResults = {
+  wasParam1Used: false,
+  wasParam2Used: false,
+  wasParam3Used: false,
+};
+
+function resetResults() {
+  tasksResults.wasParam1Used = false;
+  tasksResults.wasParam2Used = false;
+  tasksResults.wasParam3Used = false;
+}
+
+const customTask = task("task")
+  .addNamedParameter({ name: "param1" })
+  .addPositionalParameter({ name: "param2" })
+  .addVariadicParameter({ name: "param3" })
+  .setAction((taskArguments) => {
+    resetResults();
+
+    const { param1, param2, param3 } = taskArguments;
+
+    tasksResults.wasParam1Used = param1 === "<value1>";
+    tasksResults.wasParam2Used = param2 === "<value2>";
+    if (Array.isArray(param3)) {
+      tasksResults.wasParam3Used = param3[0] === "<value3>"; // Variadic parameters are always in an array
+    }
+  })
+  .build();
+
+const customTask2 = task("task-default")
+  .addNamedParameter({ name: "param1", defaultValue: "<default-value1>" })
+  .setAction((taskArguments) => {
+    resetResults();
+
+    const { param1 } = taskArguments;
+    tasksResults.wasParam1Used = param1 === "<default-value1>";
+  })
+  .build();
+
+const customSubtask = task(["task", "subtask"])
+  .addNamedParameter({ name: "param1" })
+  .addPositionalParameter({ name: "param2" })
+  .addVariadicParameter({ name: "param3" })
+  .setAction((taskArguments) => {
+    resetResults();
+
+    const { param1, param2, param3 } = taskArguments;
+
+    tasksResults.wasParam1Used = param1 === "<value1>";
+    tasksResults.wasParam2Used = param2 === "<value2>";
+    if (Array.isArray(param3)) {
+      tasksResults.wasParam3Used = param3[0] === "<value3>"; // Variadic parameters are always in an array
+    }
+  })
+  .build();
+
+const customSubtask2 = task(["task-default", "subtask-default"])
+  .addNamedParameter({ name: "param1", defaultValue: "<default-value1>" })
+  .setAction((taskArguments) => {
+    resetResults();
+
+    const { param1 } = taskArguments;
+    tasksResults.wasParam1Used = param1 === "<default-value1>";
+  })
+  .build();
+
+export default {
+  tasks: [customTask, customTask2, customSubtask, customSubtask2],
+} satisfies HardhatUserConfig;

v-next/hardhat/test/fixture-projects/cli/parsing/user-config/hardhat.config.ts

@@ -0,0 +1,5 @@
+import type { HardhatUserConfig } from "@nomicfoundation/hardhat-core/config";
+
+export default {
+  tasks: [],
+} satisfies HardhatUserConfig;

v-next/hardhat/test/fixture-projects/cli/parsing/user-config/user-hardhat.config.ts

@@ -0,0 +1,17 @@
+import type { HardhatUserConfig } from "@nomicfoundation/hardhat-core/config";
+
+import { task } from "@nomicfoundation/hardhat-core/config";
+
+export const tasksResults = {
+  wasParam1Used: false,
+};
+
+const customTask = task("user-task")
+  .setAction(() => {
+    tasksResults.wasParam1Used = true;
+  })
+  .build();
+
+export default {
+  tasks: [customTask],
+} satisfies HardhatUserConfig;