add a check that smoke tested deploy script doesn't auto deploy on node startup (#557)

Author: sparrowDom

contracts/hardhat.config.js

@@ -12,7 +12,7 @@ const { debug } = require("./tasks/debug");
 const { env } = require("./tasks/env");
 const { execute, executeOnFork, proposal } = require("./tasks/governance");
 const { balance } = require("./tasks/ousd");
-const { smokeTest } = require("./tasks/smokeTest");
+const { smokeTest, smokeTestCheck } = require("./tasks/smokeTest");
 const {
   storeStorageLayoutForAllContracts,
   assertStorageLayoutChangeSafe,
@@ -145,6 +145,15 @@ task(
     "Optional deployment id to run smoke tests against"
   )
   .setAction(smokeTest);
+task(
+  "smokeTestCheck",
+  "Execute necessary smoke test environment / deploy script checks before the node is initialized"
+)
+  .addOptionalParam(
+    "deployid",
+    "Optional deployment id to run smoke tests against"
+  )
+  .setAction(smokeTestCheck);
 
 // Storage slots
 task(

contracts/scripts/test/smokeTest.sh

@@ -23,7 +23,7 @@
 # any child processes created by this process are killed once the main process is terminated
 trap "exit" INT TERM ERR
 trap "kill 0" EXIT
-nodeWaitTimeout=180
+nodeWaitTimeout=60
 
 main()  
 {
@@ -32,9 +32,14 @@ main()
         echo "It is recommended that BLOCK_NUMBER is set to a recent block to improve performance of the fork";
     fi
 
+    SMOKE_TEST=true FORK=true npx hardhat smokeTestCheck --network localhost "$@"
+    if [ $? -ne 0 ]
+    then
+      exit 1
+    fi
+
     nodeOutput=$(mktemp "${TMPDIR:-/tmp/}$(basename 0).XXX")
     SMOKE_TEST=true yarn run node:fork &> $nodeOutput &
-    NODE_PID=$!
 
     echo "Node output: $nodeOutput"
     echo "Waiting for node to initialize:"
@@ -53,7 +58,7 @@ main()
     printf "\n"
     echo "🟢 Node initialized running smoke tests"
 
-    FORK=true npx hardhat smokeTest --network localhost "$@"
+    SMOKE_TEST=true FORK=true npx hardhat smokeTest --network localhost "$@"
 }
 
 main "$@"

contracts/tasks/smokeTest.js

@@ -45,6 +45,23 @@ function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+async function smokeTestCheck(taskArguments, hre) {
+  const deployId = taskArguments.deployid
+
+  if (!deployId) {
+    // interactive mode nothing to do here
+    return
+  }
+
+  const scripts = await getDeployScripts()
+  const deployScript = scripts[parseInt(deployId)]
+  const main = require(deployScript.fullPath)
+
+  if (!main.skip()) {
+    throw new Error("Deploy script that smoke tests are ran against should return skip === true in smoke test environment. See that the 'main.skip' function in deploy script ends with '|| isSmokeTest;'")
+  }
+}
+
 async function smokeTest(taskArguments, hre) {
   const deployId = taskArguments.deployid
   let interactiveMode = false
@@ -104,5 +121,6 @@ async function smokeTest(taskArguments, hre) {
 }
 
 module.exports = {
-  smokeTest
+  smokeTest,
+  smokeTestCheck
 }