Merge pull request #674 from ipfs/feat/add-interop-tests

Set up interop and benchmark tests

Author: daviddias

README.md

@@ -223,22 +223,58 @@ Every IPFS instance also exposes the libp2p API at `ipfs.libp2p`. The formal int
 > npm install
 ```
 
-### Run Tests
+### Run unit tests
 
 ```sh
-> npm test
+# run all the unit tsts
+> npm test 
+
+# run just IPFS tests in Node.js
+> npm run test:unit:node:core
 
 # run just IPFS core tests
-> npm run test:node:core
+> npm run test:unit:node:core
 
 # run just IPFS HTTP-API tests
-> npm run test:node:http
+> npm run test:unit:node:http
 
 # run just IPFS CLI tests
-> npm run test:node:cli
+> npm run test:unit:node:cli
+
+# run just IPFS core tests in the Browser (Chrome)
+> npm run test:unit:browser
+```
+
+### Run interop tests
+
+```sh
+# run all the interop tsts
+> npm test:interop 
+
+# run just IPFS interop tests in Node.js using one go-ipfs daemon and one js-ipfs daemon
+> npm run test:interop:node
+
+# run just IPFS interop testsin the Browser (Chrome) using one instance in the browser and one go-ipfs daemon
+> npm run test:interop:browser
+```
+
+### Run benchmark tests
+
+```sh
+# run all the interop tsts
+> npm test:benchmark 
+
+# run just IPFS benchmarks in Node.js
+> npm run test:benchmark:node
+
+# run just IPFS benchmarks in Node.js for an IPFS instance
+> npm run test:benchmark:node:core
+
+# run just IPFS benchmarks in Node.js for an IPFS daemon
+> npm run test:benchmark:node:http
 
-# run just IPFS Browser tests
-> npm run test:browser
+# run just IPFS benchmarks in the browser (Chrome)
+> npm run test:benchmark:browser
 ```
 
 ### Lint

package.json

@@ -21,11 +21,19 @@
     "lint": "aegir-lint",
     "coverage": "gulp coverage",
     "test": "gulp test",
-    "test:node": "gulp test:node",
-    "test:node:core": "TEST=core npm run test:node",
-    "test:node:http": "TEST=http npm run test:node",
-    "test:node:cli": "TEST=cli npm run test:node",
-    "test:browser": "gulp test:browser",
+    "test:unit:node": "gulp test:node",
+    "test:unit:node:core": "TEST=core npm run test:node",
+    "test:unit:node:http": "TEST=http npm run test:node",
+    "test:unit:node:cli": "TEST=cli npm run test:node",
+    "test:unit:browser": "gulp test:browser",
+    "test:interop": "mocha -t 60000 test/interop",
+    "test:interop:node": "mocha -t 60000 test/interop/node.js",
+    "test:interop:browser": "mocha test/interop/browser.js",
+    "test:benchmark": "echo \"Error: no benchmarks yet\" && exit 1",
+    "test:benchmark:node": "echo \"Error: no benchmarks yet\" && exit 1",
+    "test:benchmark:node:core": "echo \"Error: no benchmarks yet\" && exit 1",
+    "test:benchmark:node:http": "echo \"Error: no benchmarks yet\" && exit 1",
+    "test:benchmark:browser": "echo \"Error: no benchmarks yet\" && exit 1",
     "build": "gulp build",
     "release": "gulp release",
     "release-minor": "gulp release --type minor",
@@ -60,9 +68,11 @@
     "form-data": "^2.1.2",
     "fs-pull-blob-store": "^0.4.1",
     "gulp": "^3.9.1",
-    "interface-ipfs-core": "^0.22.1",
+    "interface-ipfs-core": "^0.23.0",
+    "ipfsd-ctl": "^0.18.0",
     "left-pad": "^1.1.3",
     "lodash": "^4.17.2",
+    "mocha": "^3.2.0",
     "ncp": "^2.0.0",
     "nexpect": "^0.5.0",
     "pre-commit": "^1.2.2",
@@ -75,15 +85,15 @@
     "async": "^2.1.4",
     "bl": "^1.2.0",
     "boom": "^4.2.0",
-    "debug": "^2.4.5",
+    "debug": "^2.5.1",
     "fs-pull-blob-store": "^0.3.0",
     "glob": "^7.1.1",
-    "hapi": "^16.0.1",
+    "hapi": "^16.0.2",
     "hapi-set-header": "^1.0.2",
     "idb-pull-blob-store": "^0.5.1",
-    "ipfs-api": "^12.1.0",
+    "ipfs-api": "^12.1.2",
     "ipfs-bitswap": "^0.8.3",
-    "ipfs-block": "^0.5.3",
+    "ipfs-block": "^0.5.4",
     "ipfs-block-service": "^0.7.2",
     "ipfs-multipart": "^0.1.0",
     "ipfs-repo": "^0.11.2",

src/core/components/go-online.js

@@ -14,7 +14,7 @@ module.exports = function goOnline (self) {
       }
 
       self._bitswap = new Bitswap(
-        self._libp2pNode.peerInfo,
+        {}, // TODO remove when new bitswap is merged
         self._libp2pNode,
         self._repo.blockstore,
         self._libp2pNode.peerBook

test/interop/browser.js

@@ -0,0 +1,70 @@
+'use strict'
+
+const ctl = require('ipfsd-ctl')
+const waterfall = require('async/waterfall')
+
+class GoDaemon {
+  constructor (opts) {
+    opts = opts || {
+      disposable: true,
+      init: true
+    }
+
+    this.init = opts.init
+    this.path = opts.path
+    this.disposable = opts.disposable
+    this.node = null
+    this.api = null
+  }
+
+  start (callback) {
+    waterfall([
+      (cb) => {
+        if (this.disposable) {
+          ctl.disposable({init: this.init}, cb)
+        } else if (this.init) {
+          ctl.local(this.path, (err, node) => {
+            if (err) {
+              return cb(err)
+            }
+            node.init((err) => cb(err, node))
+          })
+        } else {
+          ctl.local(this.path, cb)
+        }
+      },
+      (node, cb) => {
+        this.node = node
+        this.node.setConfig('Bootstrap', '[]', cb)
+      },
+      (res, cb) => this.node.startDaemon(cb),
+      (api, cb) => {
+        this.api = api
+
+        if (process.env.DEBUG) {
+          this.api.log.tail((err, stream) => {
+            if (err) {
+              return console.error(err)
+            }
+            stream.on('data', (chunk) => {
+              console.log('go-log: %s.%s %s (%s)', chunk.system, chunk.subsystem || '', chunk.event, chunk.error)
+            })
+          })
+          this.node._run(
+            ['log', 'level', 'all', 'debug'],
+            {env: this.node.env},
+            cb
+          )
+        } else {
+          cb()
+        }
+      }
+    ], (err) => callback(err))
+  }
+
+  stop (callback) {
+    this.node.stopDaemon(callback)
+  }
+}
+
+module.exports = GoDaemon

test/interop/daemons/go.js

@@ -0,0 +1,99 @@
+'use strict'
+
+const os = require('os')
+const IPFSAPI = require('ipfs-api')
+const series = require('async/series')
+const rimraf = require('rimraf')
+const IPFSRepo = require('ipfs-repo')
+
+const IPFS = require('../../../src/core')
+const HTTPAPI = require('../../../src/http-api')
+
+function setPorts (ipfs, port, callback) {
+  series([
+    (cb) => ipfs.config.set(
+      'Addresses.Gateway',
+      '/ip4/127.0.0.1/tcp/' + (9090 + port),
+      cb
+    ),
+    (cb) => ipfs.config.set(
+      'Addresses.API',
+      '/ip4/127.0.0.1/tcp/' + (5002 + port),
+      cb
+    ),
+    (cb) => ipfs.config.set(
+      'Addresses.Swarm',
+      ['/ip4/0.0.0.0/tcp/' + (4002 + port)],
+      cb
+    )
+  ], callback)
+}
+
+class JsDaemon {
+  constructor (opts) {
+    opts = Object.assign({}, {
+      disposable: true,
+      init: true
+    }, opts || {})
+
+    this.path = opts.path
+    this.disposable = opts.disposable
+    this.init = opts.init
+    this.port = opts.port
+
+    this.path = opts.path || os.tmpdir() + `/${Math.ceil(Math.random() * 1000)}`
+    if (this.init) {
+      this.ipfs = new IPFS(this.path)
+    } else {
+      const repo = new IPFSRepo(this.path, {stores: require('fs-pull-blob-store')})
+      this.ipfs = new IPFS(repo)
+    }
+    this.node = null
+    this.api = null
+  }
+
+  start (callback) {
+    console.log('starting js', this.path)
+    series([
+      (cb) => {
+        if (this.init) {
+          this.ipfs.init(cb)
+        } else {
+          cb()
+        }
+      },
+      (cb) => this.ipfs.config.set('Bootstrap', [], cb),
+      (cb) => {
+        if (this.port) {
+          console.log('setting to port', this.port)
+          setPorts(this.ipfs, this.port, cb)
+        } else {
+          cb()
+        }
+      },
+      (cb) => {
+        this.node = new HTTPAPI(this.ipfs._repo)
+        this.node.start(cb)
+      },
+      (cb) => {
+        this.api = new IPFSAPI(this.node.apiMultiaddr)
+        cb()
+      }
+    ], (err) => callback(err))
+  }
+
+  stop (callback) {
+    series([
+      (cb) => this.node.stop(cb),
+      (cb) => {
+        if (this.disposable) {
+          rimraf(this.path, cb)
+        } else {
+          cb()
+        }
+      }
+    ], (err) => callback(err))
+  }
+}
+
+module.exports = JsDaemon