Fix integration tests.

Author: colonelpopcorn

lib/virtualbox.js

@@ -40,38 +40,56 @@ const execFile = require('child_process').execFile,
     },
     categories: { default: { appenders: ['out'], level: 'info' } },
   },
+  defaultLoggerFn = () => {
+    log4js.configure(defaultLoggingConfig);
+    return log4js.getLogger('VirtualBox');
+  },
+  defaultLogger = defaultLoggerFn(),
+  defaultvboxmanage = function (cmd, callback) {
+    try {
+      this._executor(this._vBoxManageBinary, cmd)
+        .then(({ err, stdout, stderr }) => callback(err, stdout, stderr))
+        .catch(defaultErrorHandler);
+    } catch (err) {
+      this._logging.error(err);
+    }
+  },
   defaultErrorHandler = (err) => {
-    throw err;
+    console.error(err);
   },
   allowedBinaries = ['VBoxControl'];
 
 class Virtualbox {
-  constructor(logging = defaultLoggingConfig, executor = defaultExecutor) {
-    log4js.configure(logging);
-    this._logging = log4js.getLogger('VirtualBox');
+  constructor(logging = defaultLogger, executor = defaultExecutor) {
+    this._logging = logging;
     this._executor = executor;
     this._setVboxManageBinary();
     allowedBinaries.push(this._vBoxManageBinary);
-    this._logging.info(allowedBinaries);
+    this._logging.debug(allowedBinaries);
     this._detectVboxVersion();
-    this.storage = new VboxStorage(this._logging, this._executor);
-    this.guestproperty = new VboxGuestProperty(this._logging, this._executor);
-    this.extradata = new VboxExtraData(this._logging, this._executor);
+    this.storage = new VboxStorage(
+      this._logging,
+      this._executor,
+      this._vBoxManageBinary
+    );
+    this.guestproperty = new VboxGuestProperty(
+      this._logging,
+      this._executor,
+      this._vBoxManageBinary
+    );
+    this.extradata = new VboxExtraData(
+      this._logging,
+      this._executor,
+      this._vBoxManageBinary
+    );
   }
 
   static create(logging, executor) {
     return new Virtualbox({ ...defaultLoggingConfig, ...logging }, executor);
   }
 
-  vboxmanage(cmd, callback) {
-    try {
-      this._executor(this._vBoxManageBinary, cmd)
-        .then(callback)
-        .catch(defaultErrorHandler);
-    } catch (err) {
-      this._logging.error(err);
-    }
-  }
+  vboxmanage = defaultvboxmanage;
+  SCAN_CODES = require('./scan-codes');
 
   pause(vmname, callback) {
     this._logging.info('Pausing VM "%s"', vmname);
@@ -105,7 +123,7 @@ class Virtualbox {
     };
 
     this._logging.info('Listing VMs');
-    this.vboxmanage(['list', 'runningvms'], function (_, stdout) {
+    this.vboxmanage(['list', 'runningvms'], (_, stdout) => {
       var _runningvms = parse_listdata(stdout);
       this.vboxmanage(['list', 'vms'], function (error, fullStdout) {
         var _all = parse_listdata(fullStdout);
@@ -188,9 +206,7 @@ class Virtualbox {
 
   acpipowerbutton(vmname, callback) {
     this._logging.info('ACPI power button VM "%s"', vmname);
-    this.vboxmanage(['controlvm', vmname, 'acpipowerbutton'], function ({
-      error,
-    }) {
+    this.vboxmanage(['controlvm', vmname, 'acpipowerbutton'], function (error) {
       callback(error);
     });
   }
@@ -330,7 +346,7 @@ class Virtualbox {
   }
 
   isRunning(vmname, callback) {
-    this.vboxmanage(['list', 'runningvms'], function (error, stdout) {
+    this.vboxmanage(['list', 'runningvms'], (error, stdout) => {
       this._logging.info(
         'Checking virtual machine "%s" is running or not',
         vmname
@@ -354,16 +370,20 @@ class Virtualbox {
         return s;
       })
       .join(' ');
-    logging.info('Sending VM "%s" keyboard scan codes "%s"', vmname, codeStr);
-    vboxmanage(['controlvm', vmname, 'keyboardputscancode', codeStr], function (
-      error,
-      stdout
-    ) {
-      callback(error, stdout);
-    });
+    this._logging.info(
+      'Sending VM "%s" keyboard scan codes "%s"',
+      vmname,
+      codeStr
+    );
+    this.vboxmanage(
+      ['controlvm', vmname, 'keyboardputscancode', codeStr],
+      function (error, stdout) {
+        callback(error, stdout);
+      }
+    );
   }
 
-  vmExec(options, callback) {
+  exec(options, callback) {
     var vm = options.vm || options.name || options.vmname || options.title,
       username = options.user || options.username || 'Guest',
       password = options.pass || options.passwd || options.password,
@@ -385,12 +405,10 @@ class Virtualbox {
       params = '';
     }
 
-    guestproperty.os(vm, getOSTypeCb);
-
     const getOSTypeCb = (os_type) => {
       var cmd = ['guestcontrol', vm];
-      var runcmd = vbox_version === 5 ? ['run'] : ['execute', '--image'];
-      cmd.push(runcmd);
+      var runcmd = this._vboxVersion > 5 ? ['run'] : ['execute', '--image'];
+      cmd = [...cmd, ...runcmd];
       switch (os_type) {
         case known_OS_types.WINDOWS:
           path = path.replace(/\\/g, '\\\\');
@@ -422,9 +440,11 @@ class Virtualbox {
         callback(error, stdout);
       });
     };
+
+    this.guestproperty.os(vm, getOSTypeCb);
   }
 
-  vmKill(options, callback) {
+  kill(options, callback) {
     options = options || {};
     var vm = options.vm || options.name || options.vmname || options.title,
       path =
@@ -436,10 +456,10 @@ class Virtualbox {
         options.run,
       image_name = options.image_name || path;
 
-    guestproperty.os(vm, function (os_type) {
+    this.guestproperty.os(vm, function (os_type) {
       switch (os_type) {
         case known_OS_types.WINDOWS:
-          vmExec(
+          exec(
             {
               vm: vm,
               user: options.user,
@@ -452,7 +472,7 @@ class Virtualbox {
           break;
         case known_OS_types.MAC:
         case known_OS_types.LINUX:
-          vmExec(
+          exec(
             {
               vm: vm,
               user: options.user,
@@ -487,7 +507,6 @@ class Virtualbox {
   _detectVboxVersion() {
     this._executor(this._vBoxManageBinary, ['--version']).then(
       ({ error, stdout }) => {
-        this._logging.info(arguments);
         if (error) {
           throw error;
         } else {
@@ -503,11 +522,14 @@ class Virtualbox {
 }
 
 class VboxStorage {
-  constructor(logging, executor) {
+  constructor(logging, executor, vBoxManageBinary) {
     this._logging = logging;
     this._executor = executor;
+    this._vBoxManageBinary = vBoxManageBinary;
   }
 
+  vboxmanage = defaultvboxmanage;
+
   addCtl(options, callback) {
     var vm = options.vm || options.name || options.vmname || options.title,
       device_name = options.perhiperal_name || 'IDE',
@@ -554,20 +576,25 @@ class VboxStorage {
 }
 
 class VboxGuestProperty {
-  constructor(logging, executor) {
+  constructor(logging, executor, vBoxManageBinary) {
     this._logging = logging;
     this._executor = executor;
+    this._vBoxManageBinary = vBoxManageBinary;
     this.os_type = null;
   }
+
+  vboxmanage = defaultvboxmanage;
+
   get(options, callback) {
     var vm = options.vm || options.name || options.vmname || options.title,
       key = options.key,
       value = options.defaultValue || options.value;
 
-    guestproperty.os(vm, getOSTypeCallback);
-
-    function getOSTypeCallback(os_type) {
-      vboxmanage(['guestproperty', 'get', vm, key], function (error, stdout) {
+    this.os(vm, (os_type) => {
+      this.vboxmanage(['guestproperty', 'get', vm, key], function (
+        error,
+        stdout
+      ) {
         if (error) {
           throw error;
         }
@@ -577,54 +604,58 @@ class VboxGuestProperty {
         }
         callback(value);
       });
-    }
+    });
   }
 
   os(vmname, callback) {
-    function getOSTypeCallback(error, stdout, stderr) {
-      if (error) {
-        throw error;
-      }
-
-      // The ostype is matched against the ID attribute of 'vboxmanage list ostypes'
-      if (stdout.indexOf('ostype="Windows') !== -1) {
-        this.os_type = known_OS_types.WINDOWS;
-      } else if (['ostype="MacOS', 'ostype="Mac OS machine'].includes(stdout)) {
-        this.os_type = known_OS_types.MAC;
-      } else {
-        this.os_type = known_OS_types.LINUX;
-      }
-      logging.debug('Detected guest OS as: ' + this.os_type);
-      callback(this.os_type);
-    }
-
     if (this.os_type) {
       return callback(this.os_type);
     }
 
     try {
-      vboxmanage(
+      this.vboxmanage(
         ['showvminfo', '--machinereadable', vmname],
-        getOSTypeCallback
+        (error, stdout, _) => {
+          if (error) {
+            throw error;
+          }
+
+          // The ostype is matched against the ID attribute of 'vboxmanage list ostypes'
+          if (stdout.indexOf('ostype="Windows') !== -1) {
+            this.os_type = known_OS_types.WINDOWS;
+          } else if (
+            ['ostype="MacOS', 'ostype="Mac OS machine'].includes(stdout)
+          ) {
+            this.os_type = known_OS_types.MAC;
+          } else {
+            this.os_type = known_OS_types.LINUX;
+          }
+          this._logging.debug('Detected guest OS as: ' + this.os_type);
+          callback(this.os_type);
+        }
       );
     } catch (e) {
-      logging.error(e);
-      logging.info('Could not showvminfo for %s', vmname);
+      this._logging.error(e);
+      this._logging.info('Could not showvminfo for %s', vmname);
     }
   }
 }
 
 class VboxExtraData {
-  constructor(logging, executor) {
+  constructor(logging, executor, vBoxManageBinary) {
     this._logging = logging;
     this._executor = executor;
+    this._vBoxManageBinary = vBoxManageBinary;
   }
+
+  vboxmanage = defaultvboxmanage;
+
   get(options, callback) {
     var vm = options.vm || options.name || options.vmname || options.title,
       key = options.key,
       value = options.defaultValue || options.value;
 
-    vboxmanage(['getextradata', vm, key], function (error, stdout) {
+    this.vboxmanage(['getextradata', vm, key], function (error, stdout) {
       if (error) {
         callback(error);
         return;
@@ -642,8 +673,8 @@ class VboxExtraData {
       key = options.key,
       value = options.defaultValue || options.value;
 
-    var cmd = 'setextradata "' + vm + '" "' + key + '" "' + value + '"';
-    vboxmanage(cmd, function (error, stdout) {
+    var cmd = ['setextradata', vm, key, value];
+    this.vboxmanage(cmd, function (error, stdout) {
       callback(error);
     });
   }
@@ -680,3 +711,4 @@ class VboxExtraData {
 
 module.exports = new Virtualbox();
 module.exports.create = Virtualbox.create;
+module.exports.Virtualbox = Virtualbox;