NODE_ENV set to "test" for all test runners

Author: michalbrabec

.changeset/calm-toes-throw.md

@@ -0,0 +1,7 @@
+---
+"@nomicfoundation/hardhat-node-test-runner": patch
+"@nomicfoundation/hardhat-mocha": patch
+"hardhat": patch
+---
+
+All test runners now set NODE_ENV to "test" in case it is not set before the tests start

v-next/hardhat-mocha/src/task-action.ts

@@ -54,6 +54,10 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   // Set an environment variable that plugins can use to detect when a process is running tests
   process.env.HH_TEST = "true";
 
+  // Sets the NODE_ENV environment variable to "test" so the code can detect that tests are running
+  // This is done by other JS/TS test frameworks like vitest
+  process.env.NODE_ENV ??= "test";
+
   setGlobalOptionsAsEnvVariables(hre.globalOptions);
 
   if (!noCompile) {

v-next/hardhat-mocha/test/env.ts

@@ -0,0 +1,30 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import { useFixtureProject } from "@nomicfoundation/hardhat-test-utils";
+
+describe("Hardhat Mocha env variables", () => {
+  useFixtureProject("test-project");
+
+  it("should set the NODE_ENV variable if undefined and HH_TEST always", async () => {
+    const { createHardhatRuntimeEnvironment } = await import("hardhat/hre");
+    const hardhatConfig = await import(
+      "./fixture-projects/test-project/hardhat.config.js"
+    );
+    const hre = await createHardhatRuntimeEnvironment(hardhatConfig.default);
+
+    const exitCode = process.exitCode;
+    const nodeEnv = process.env.NODE_ENV;
+    const hhTest = process.env.HH_TEST;
+    try {
+      process.env.NODE_ENV = undefined;
+      await hre.tasks.getTask(["test", "mocha"]).run({ noCompile: true });
+      assert.equal(process.env.NODE_ENV, "test");
+      assert.equal(process.env.HH_TEST, "true");
+    } finally {
+      process.env.HH_TEST = hhTest;
+      process.env.NODE_ENV = nodeEnv;
+      process.exitCode = exitCode;
+    }
+  });
+});

v-next/hardhat-node-test-runner/src/task-action.ts

@@ -60,6 +60,10 @@ const testWithHardhat: NewTaskActionFunction<TestActionArguments> = async (
   // Set an environment variable that plugins can use to detect when a process is running tests
   process.env.HH_TEST = "true";
 
+  // Sets the NODE_ENV environment variable to "test" so the code can detect that tests are running
+  // This is done by other JS/TS test frameworks like vitest
+  process.env.NODE_ENV ??= "test";
+
   setGlobalOptionsAsEnvVariables(hre.globalOptions);
 
   if (!noCompile) {

v-next/hardhat-node-test-runner/test/index.ts

@@ -0,0 +1,51 @@
+import assert from "node:assert/strict";
+import { describe, it } from "node:test";
+
+import { useFixtureProject } from "@nomicfoundation/hardhat-test-utils";
+import { createHardhatRuntimeEnvironment } from "hardhat/hre";
+
+describe("Hardhat Node plugin", () => {
+  useFixtureProject("test-project");
+
+  it("should set the NODE_ENV variable if undefined and HH_TEST always", async () => {
+    const baseHhConfig = (
+      await import("./fixture-projects/test-project/hardhat.config.js")
+    ).default;
+    const hre = await createHardhatRuntimeEnvironment(baseHhConfig);
+
+    const exitCode = process.exitCode;
+    const nodeEnv = process.env.NODE_ENV;
+    const hhTest = process.env.HH_TEST;
+    try {
+      process.env.NODE_ENV = undefined;
+      await hre.tasks.getTask(["test", "nodejs"]).run({ noCompile: true });
+      assert.equal(process.env.NODE_ENV, "test");
+      assert.equal(process.env.HH_TEST, "true");
+    } finally {
+      process.env.HH_TEST = hhTest;
+      process.env.NODE_ENV = nodeEnv;
+      process.exitCode = exitCode;
+    }
+  });
+
+  it("should not set the NODE_ENV variable if defined before", async () => {
+    const baseHhConfig = (
+      await import("./fixture-projects/test-project/hardhat.config.js")
+    ).default;
+    const hre = await createHardhatRuntimeEnvironment(baseHhConfig);
+
+    const exitCode = process.exitCode;
+    const nodeEnv = process.env.NODE_ENV;
+    const hhTest = process.env.HH_TEST;
+    try {
+      process.env.NODE_ENV = "HELLO";
+      await hre.tasks.getTask(["test", "nodejs"]).run({ noCompile: true });
+      assert.equal(process.env.NODE_ENV, "HELLO");
+      assert.equal(process.env.HH_TEST, "true");
+    } finally {
+      process.env.HH_TEST = hhTest;
+      process.env.NODE_ENV = nodeEnv;
+      process.exitCode = exitCode;
+    }
+  });
+});

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

@@ -47,6 +47,13 @@ const runSolidityTests: NewTaskActionFunction<TestActionArguments> = async (
   { testFiles, chainType, grep, noCompile, verbosity },
   hre,
 ) => {
+  // Set an environment variable that plugins can use to detect when a process is running tests
+  process.env.HH_TEST = "true";
+
+  // Sets the NODE_ENV environment variable to "test" so the code can detect that tests are running
+  // This is done by other JS/TS test frameworks like vitest
+  process.env.NODE_ENV ??= "test";
+
   if (!isSupportedChainType(chainType)) {
     throw new HardhatError(
       HardhatError.ERRORS.CORE.ARGUMENTS.INVALID_VALUE_FOR_TYPE,

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

@@ -123,6 +123,42 @@ describe("solidity-test/task-action", function () {
   });
 
   describe("running the tests", () => {
+    it("should set the NODE_ENV variable if undefined and HH_TEST always", async () => {
+      hre = await createHardhatRuntimeEnvironment(hardhatConfigAllTests);
+
+      const exitCode = process.exitCode;
+      const nodeEnv = process.env.NODE_ENV;
+      const hhTest = process.env.HH_TEST;
+      try {
+        process.env.NODE_ENV = undefined;
+        await hre.tasks.getTask(["test", "solidity"]).run({ noCompile: true });
+        assert.equal(process.env.NODE_ENV, "test");
+        assert.equal(process.env.HH_TEST, "true");
+      } finally {
+        process.env.HH_TEST = hhTest;
+        process.env.NODE_ENV = nodeEnv;
+        process.exitCode = exitCode;
+      }
+    });
+
+    it("should not set the NODE_ENV variable if defined before", async () => {
+      hre = await createHardhatRuntimeEnvironment(hardhatConfigAllTests);
+
+      const exitCode = process.exitCode;
+      const nodeEnv = process.env.NODE_ENV;
+      const hhTest = process.env.HH_TEST;
+      try {
+        process.env.NODE_ENV = "HELLO";
+        await hre.tasks.getTask(["test", "solidity"]).run({ noCompile: true });
+        assert.equal(process.env.NODE_ENV, "HELLO");
+        assert.equal(process.env.HH_TEST, "true");
+      } finally {
+        process.env.HH_TEST = hhTest;
+        process.env.NODE_ENV = nodeEnv;
+        process.exitCode = exitCode;
+      }
+    });
+
     it("should run all the tests and throw if any of them fail", async () => {
       hre = await createHardhatRuntimeEnvironment(hardhatConfigFailingTests);