add integration tests

Integration tests test the client and the server interfaces together on
a real bus. Run integration tests with `npm run integration`.

This commit also includes fixes for bugs that were found while writing
the tests.

Author: Tony Crisci

.babelrc

@@ -0,0 +1,6 @@
+{
+  "plugins": [
+    [ "@babel/plugin-proposal-decorators", { "decoratorsBeforeExport": true, "legacy": false } ],
+    "@babel/plugin-proposal-class-properties"
+  ]
+}

.gitignore

@@ -12,4 +12,5 @@ logs
 results
 
 node_modules
-npm-debug.log
+npm-debug.log
+package-lock.json

.tern-project

@@ -0,0 +1,5 @@
+{
+  "plugins": {
+    "node": {}
+  }
+}

index.js

@@ -156,6 +156,8 @@ module.exports.createServer = server.createServer;
 
 // new stuff
 const variant = require('./lib/service/variant');
-const interface = require('./lib/service/interface');
-module.exports.interface = interface;
+const iface = require('./lib/service/interface');
+module.exports.interface = iface;
 module.exports.Variant = variant.Variant;
+// TODO move me off the interface
+module.exports.MethodError = iface.MethodError;

lib/bus.js

@@ -231,6 +231,7 @@ module.exports = function bus(conn, opts) {
             that.names = that.names || {};
             that.names[name] = new Name(that);
             let obj = that.names[name].getObject(path);
+            // TODO error interface already added at this path
             obj.addInterface(iface);
             resolve(result);
           }

lib/client/proxy-object.js

@@ -3,6 +3,7 @@ const parseSignature = require('../signature');
 const ProxyInterface = require('./proxy-interface');
 const variant = require('../service/variant');
 const Variant = variant.Variant;
+const { MethodError } = require('../service/interface');
 const {
   assertInterfaceNameValid,
   assertObjectPathValid,
@@ -130,10 +131,15 @@ class ProxyObject {
       body: body
     };
 
-    return new Promise(resolve => {
-      this.bus.invoke(msg, (err, ...busResult) => {
+    return new Promise((resolve, reject) => {
+      this.bus.invoke(msg, function(err, ...busResult) {
         if (err) {
-          throw new Error(err);
+          if (this.message && this.message.hasOwnProperty('errorName')) {
+            reject(new MethodError(this.message.errorName, err[0]));
+          } else {
+            reject(err);
+          }
+          return;
         }
         // TODO refactor this into a method
         let result = [];

lib/service/handlers.js

@@ -51,6 +51,7 @@ function handleGetProperty(bus, msg, name, path) {
   }
 
   let body = variant.jsToMarshalFmt(property.signature, propertyValue);
+
   bus.sendReply(msg, 'v', [body]);
 }
 
@@ -100,7 +101,7 @@ function handleSetProperty(bus, msg, name, path) {
   let property = properties[prop];
 
   if (!(property.access === ACCESS_WRITE || property.access === ACCESS_READWRITE)) {
-    bus.sendError(msg, INVALID_ARGS, `Property ${prop} does not have write access`);
+    bus.sendError(msg, INVALID_ARGS, `Property does not have write access: '${prop}'`);
   }
 
   let valueSignature = variant.collapseSignature(value[0][0])
@@ -115,14 +116,15 @@ function handleSetProperty(bus, msg, name, path) {
 
 function handleStdIfaces(bus, msg, name) {
   let {
-    interface,
     member,
     path,
     signature
   } = msg;
 
-  if (!isInterfaceNameValid(interface)) {
-    bus.sendError(msg, INVALID_ARGS, `Invalid interface name: '${interface}'`);
+  let ifaceName = msg.interface;
+
+  if (!isInterfaceNameValid(ifaceName)) {
+    bus.sendError(msg, INVALID_ARGS, `Invalid interface name: '${ifaceName}'`);
     return true;
   }
 
@@ -136,12 +138,12 @@ function handleStdIfaces(bus, msg, name) {
     return true;
   }
 
-  if (interface === 'org.freedesktop.DBus.Introspectable' &&
+  if (ifaceName === 'org.freedesktop.DBus.Introspectable' &&
         member === 'Introspect' &&
         !signature) {
     handleIntrospect(bus, msg, name, path);
     return true;
-  } else if (interface === 'org.freedesktop.DBus.Properties') {
+  } else if (ifaceName === 'org.freedesktop.DBus.Properties') {
     if (member === 'Get' && signature === 'ss') {
       handleGetProperty(bus, msg, name, path);
       return true;
@@ -161,11 +163,12 @@ module.exports = function(msg, bus) {
   let {
     path,
     member,
-    interface,
     destination,
     signature
   } = msg;
 
+  let ifaceName = msg.interface;
+
   signature = signature || '';
 
   if (Object.keys(bus.names) === 0) {
@@ -194,7 +197,7 @@ module.exports = function(msg, bus) {
   }
 
   let obj = name.getObject(path);
-  let iface = obj.interfaces[interface];
+  let iface = obj.interfaces[ifaceName];
 
   if (!iface) {
     return false;

lib/service/variant.js

@@ -88,8 +88,13 @@ function parse(variant) {
 }
 
 function jsToMarshalFmt(signature, value) {
-  // TODO better error handling because this is called on user functions and
-  // they may have mismatched signature and value
+  if (value === undefined) {
+    throw new Error(`expected value for signature: ${signature}`);
+  }
+  if (signature === undefined) {
+    throw new Error(`expected signature for value: ${value}`);
+  }
+
   let signatureStr = null;
   if (typeof signature === 'string') {
     signatureStr = signature;
@@ -99,17 +104,23 @@ function jsToMarshalFmt(signature, value) {
   }
 
   if (signature.child.length === 0) {
-    if (value.constructor === Variant) {
-      return [value.signature, value.value];
+    if (signature.type === 'v') {
+      if (value.constructor !== Variant) {
+        throw new Error(`expected a Variant for value (got ${typeof value})`);
+      }
+      return [ signature.type, jsToMarshalFmt(value.signature, value.value) ];
     } else {
-      return [signature.type, value];
+      return [ signature.type, value ];
     }
   }
 
   if (signature.type === 'a') {
     let result = [];
     if (signature.child[0].type === '{') {
       // this is an array of dictionary elements
+      if (value.constructor !== Object) {
+        throw new Error(`expecting an object for signature '${signatureStr}' (got ${typeof value})`);
+      }
       for (let k of Object.keys(value)) {
         let v = value[k];
         if (v.constructor === Variant) {
@@ -119,6 +130,9 @@ function jsToMarshalFmt(signature, value) {
         }
       }
     } else {
+      if (!Array.isArray(value)) {
+        throw new Error(`expecting an array for signature '${signatureStr}' (got ${typeof value})`);
+      }
       for (let v of value) {
         if (v.constructor === Variant) {
           result.push(jsToMarshalFmt(v.signature, v.value));
@@ -127,18 +141,29 @@ function jsToMarshalFmt(signature, value) {
         }
       }
     }
-    return [collapseSignature(signature), result];
+    return [ signatureStr, result ];
   } else if (signature.type === '(') {
+    if (!Array.isArray(value)) {
+      throw new Error(`expecting an array for signature '${signatureStr}' (got ${typeof value})`);
+    }
+    if (value.length !== signature.child.length) {
+      throw new Error(`expecting struct to have ${signature.child.length} members (got ${value.length} members)`);
+    }
     let result = [];
     for (let i = 0; i < value.length; ++i) {
       let v = value[i];
-      if (v.constructor === Variant) {
+      if (signature.child[i] === 'v') {
+        if (v.constructor !== Variant) {
+          throw new Error(`expected a Variant for struct member ${i+1} (got ${v})`);
+        }
         result.push(jsToMarshalFmt(v.signature, v.value));
       } else {
         result.push(jsToMarshalFmt(signature.child[i], v)[1]);;
       }
     }
-    return [signatureStr, result];
+    return [ signatureStr, result ];
+  } else {
+    throw new Error(`got unknown complex type: ${signature.type}`);
   }
 }
 

package.json

@@ -45,15 +45,22 @@
     "abstract-socket": "^2.0.0"
   },
   "devDependencies": {
+    "@babel/core": "^7.1.5",
+    "@babel/plugin-proposal-class-properties": "^7.1.0",
+    "@babel/plugin-proposal-decorators": "^7.1.2",
+    "babel-core": "^7.0.0-bridge.0",
+    "babel-jest": "^23.6.0",
     "commander": "^2.19.0",
     "eslint": "^5.0.0",
     "eslint-config-prettier": "^3.0.0",
     "eslint-plugin-markdown": "^1.0.0-beta.6",
     "eslint-plugin-prettier": "^3.0.0",
     "husky": "^1.0.0",
+    "jest": "^23.6.0",
     "lint-staged": "^8.0.0",
     "mocha": "*",
-    "prettier": "^1.7.4"
+    "prettier": "^1.7.4",
+    "regenerator-runtime": "^0.12.1"
   },
   "scripts": {
     "lint": "npm run lint:docs && npm run lint:code",
@@ -64,6 +71,7 @@
     "prettier": "prettier --write index.js '{bin,lib,examples,test}/**/*.js'",
     "prettier:docs": "prettier-markdown README.md",
     "eslint-check": "eslint --print-config .eslintrc | eslint-config-prettier-check",
+    "integration": "dbus-run-session -- jest ./test/integration",
     "prepublish": "npm prune"
   },
   "lint-staged": {

test/integration/client-standard-dbus.test.js

@@ -0,0 +1,30 @@
+// Test some of the standard dbus interfaces to make sure the client works
+// correctly
+
+let dbus = require('../../');
+let bus = dbus.sessionBus();
+
+afterAll(() => {
+  bus.connection.stream.end();
+});
+
+test('lists names on the bus', async () => {
+  let object = await bus.getProxyObject('org.freedesktop.DBus', '/org/freedesktop/DBus');
+  let iface = object.getInterface('org.freedesktop.DBus');
+  expect(iface).toBeDefined();
+  let names = await iface.ListNames();
+  expect(names.length).toBeGreaterThan(0);
+  expect(names).toEqual(expect.arrayContaining(['org.freedesktop.DBus']));
+});
+
+test('get stats', async () => {
+  let object = await bus.getProxyObject('org.freedesktop.DBus', '/org/freedesktop/DBus');
+  let iface = object.getInterface('org.freedesktop.DBus.Debug.Stats');
+  let stats = await iface.GetStats();
+  expect(stats).toBeInstanceOf(Object);
+  expect(stats).toHaveProperty('BusNames');
+  let busNames = stats['BusNames'];
+  expect(busNames).toBeInstanceOf(dbus.Variant);
+  expect(busNames.signature).toBe('u');
+  expect(busNames.value).toBeGreaterThan(0);
+});