Merge pull request #4671 from trufflesuite/connect-or-start

Internal improvement: refactor connectOrStart

packages/environment/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["../../.eslintrc.package.json"]
+}

packages/environment/chain.js

@@ -227,14 +227,13 @@ class GanacheMixin {
 
   // cleanup Ganache process on exit
   exit(_supervisor) {
-    this.ganache.close(err => {
-      if (err) {
+    this.ganache
+      .close()
+      .then(() => (process.exitCode = 0))
+      .catch(err => {
         console.error(err.stack || err);
-        process.exit(1);
-      } else {
-        process.exit();
-      }
-    });
+        process.exitCode = 1;
+      });
   }
 }
 

packages/environment/develop.js

@@ -4,7 +4,7 @@ const { spawn } = require("child_process");
 const debug = require("debug");
 
 const Develop = {
-  start: async function(ipcNetwork, options = {}) {
+  start: async function (ipcNetwork, options = {}) {
     let chainPath;
 
     // The path to the dev env process depends on whether or not
@@ -39,7 +39,7 @@ const Develop = {
     });
   },
 
-  connect: function(options) {
+  connect: function (options) {
     const debugServer = debug("develop:ipc:server");
     const debugClient = debug("develop:ipc:client");
     const debugRPC = debug("develop:ganache");
@@ -69,7 +69,7 @@ const Develop = {
     if (options.log) {
       debugRPC.enabled = true;
 
-      loggers.ganache = function() {
+      loggers.ganache = function () {
         // HACK-y: replace `{}` that is getting logged instead of ""
         var args = Array.prototype.slice.call(arguments);
         if (
@@ -88,21 +88,21 @@ const Develop = {
       ipc.config.maxRetries = 0;
     }
 
-    var disconnect = function() {
+    var disconnect = function () {
       ipc.disconnect(ipcNetwork);
     };
 
     return new Promise((resolve, reject) => {
-      ipc.connectTo(ipcNetwork, connectPath, function() {
-        ipc.of[ipcNetwork].on("destroy", function() {
+      ipc.connectTo(ipcNetwork, connectPath, function () {
+        ipc.of[ipcNetwork].on("destroy", function () {
           reject(new Error("IPC connection destroyed"));
         });
 
-        ipc.of[ipcNetwork].on("truffle.ready", function() {
+        ipc.of[ipcNetwork].on("truffle.ready", function () {
           resolve(disconnect);
         });
 
-        Object.keys(loggers).forEach(function(key) {
+        Object.keys(loggers).forEach(function (key) {
           var log = loggers[key];
           if (log) {
             var message = `truffle.${key}.log`;
@@ -113,29 +113,25 @@ const Develop = {
     });
   },
 
-  connectOrStart: async function(options, ganacheOptions) {
+  connectOrStart: async function (options, ganacheOptions) {
     options.retry = false;
 
     const ipcNetwork = options.network || "develop";
 
-    let connectedAlready = false;
+    let started = false;
+    let disconnect;
 
     try {
-      const disconnect = await this.connect(options);
-      connectedAlready = true;
-      return {
-        started: false,
-        disconnect
-      };
+      disconnect = await this.connect(options);
     } catch (_error) {
       await this.start(ipcNetwork, ganacheOptions);
       options.retry = true;
-      const disconnect = await this.connect(options);
-      if (connectedAlready) return;
-      connectedAlready = true;
+      disconnect = await this.connect(options);
+      started = true;
+    } finally {
       return {
-        started: true,
-        disconnect
+        disconnect,
+        started
       };
     }
   }

packages/environment/test/connectOrStartTest.js

@@ -0,0 +1,57 @@
+const assert = require("chai").assert;
+const Develop = require("../develop");
+
+describe("connectOrStart test network", async function () {
+  const ipcOptions = { network: "test" };
+  const ganacheOptions = {
+    host: "127.0.0.1",
+    network_id: 666,
+    port: 6969
+  };
+
+  it("starts Ganache when no Ganache instance is running", async function () {
+    let connection;
+    try {
+      connection = await Develop.connectOrStart(ipcOptions, ganacheOptions);
+      assert.isTrue(connection.started, "A new Ganache server did not spin up");
+      assert.isFunction(connection.disconnect, "disconnect is not a function");
+    } finally {
+      if (connection) {
+        connection.disconnect();
+      }
+    }
+  });
+
+  it("connects to an established Ganache instance", async function () {
+    let connectionOneDisconnect, connectionTwo;
+    let spawnedGanache;
+
+    try {
+      //Establish IPC Ganache service
+      spawnedGanache = await Develop.start(ipcOptions.network, ganacheOptions);
+      connectionOneDisconnect = await Develop.connect({
+        ...ipcOptions,
+        retry: true
+      });
+
+      //Test
+      connectionTwo = await Develop.connectOrStart(ipcOptions, ganacheOptions);
+
+      //Validate
+      assert.isFalse(connectionTwo.started);
+    } finally {
+      //Cleanup IPC2
+      if (connectionTwo.disconnect) {
+        connectionTwo.disconnect();
+      }
+      //Cleanup IPC1
+      if (connectionOneDisconnect) {
+        connectionOneDisconnect();
+      }
+      //Signal Ganache Process to exit
+      process.kill(spawnedGanache.pid, "SIGHUP");
+      //Resolve on confirmation of process exit
+      await new Promise(resolve => spawnedGanache.on("exit", () => resolve()));
+    }
+  });
+});

packages/environment/test/develop.js

@@ -29,17 +29,15 @@ describe("Environment develop", function () {
         gas: expectedNetwork.gas
       }
     };
-    sinon.stub(Environment, "detect");
   });
 
-  afterEach("Restore Environment detect", async function () {
-    Environment.detect.restore();
-  });
-
-  it("Environment.develop overwrites the network_id of the network", async function() {
+  it("Environment.develop overwrites the network_id of the network", async function () {
+    //Stub detect in order to prevent its executing during this test
+    //which is invoked during `Environment.develop(..)`
+    sinon.stub(Environment, "detect");
     await Environment.develop(config, testOptions);
-    const mutatedNetwork = config.networks[config.network];
 
+    const mutatedNetwork = config.networks[config.network];
     assert.equal(
       mutatedNetwork.port,
       expectedNetwork.port,
@@ -55,6 +53,8 @@ describe("Environment develop", function () {
       expectedNetwork.gas,
       "The gas of the network should be unchanged."
     );
-  });
 
+    //Restore `detect` functionality
+    Environment.detect.restore();
+  });
 }).timeout(10000);