feat: modularise block, add mocha and test suite utils

License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>

Author: alanshaw

js/src/block.js

@@ -0,0 +1,63 @@
+/* eslint-env mocha */
+/* eslint max-nested-callbacks: ["error", 8] */
+
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+const multihash = require('multihashes')
+const CID = require('cids')
+const Buffer = require('safe-buffer').Buffer
+const { getDescribe } = require('../utils/mocha')
+
+module.exports = (common, options) => {
+  const describe = getDescribe(options)
+
+  describe('.block.get', function () {
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should get by CID object', (done) => {
+      const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const cid = new CID(hash)
+
+      ipfs.block.get(cid, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.eql(new Buffer('blorb'))
+        expect(block.cid.multihash).to.eql(cid.multihash)
+        done()
+      })
+    })
+
+    it('should get by CID in string', (done) => {
+      const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+
+      ipfs.block.get(hash, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.eql(new Buffer('blorb'))
+        expect(block.cid.multihash).to.eql(multihash.fromB58String(hash))
+        done()
+      })
+    })
+
+    // TODO it.skip('Promises support', (done) => {})
+  })
+}

js/src/block/get.js

@@ -0,0 +1,10 @@
+'use strict'
+const { createSuite } = require('../utils/suite')
+
+const tests = {
+  put: require('./put'),
+  get: require('./get'),
+  stat: require('./stat')
+}
+
+module.exports = createSuite(tests)

js/src/block/index.js

@@ -0,0 +1,104 @@
+/* eslint-env mocha */
+/* eslint max-nested-callbacks: ["error", 8] */
+
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+const Block = require('ipfs-block')
+const multihash = require('multihashes')
+const CID = require('cids')
+const Buffer = require('safe-buffer').Buffer
+const { getDescribe } = require('../utils/mocha')
+
+module.exports = (common, options) => {
+  const describe = getDescribe(options)
+
+  describe('.block.put', () => {
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should put a buffer, using defaults', (done) => {
+      const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const blob = new Buffer('blorb')
+
+      ipfs.block.put(blob, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.be.eql(blob)
+        expect(block.cid.multihash).to.eql(multihash.fromB58String(expectedHash))
+        done()
+      })
+    })
+
+    it('should put a buffer, using CID', (done) => {
+      const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const cid = new CID(expectedHash)
+      const blob = new Buffer('blorb')
+
+      ipfs.block.put(blob, { cid: cid }, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.be.eql(blob)
+        expect(block.cid.multihash).to.eql(multihash.fromB58String(expectedHash))
+        done()
+      })
+    })
+
+    it('should put a buffer, using options', (done) => {
+      const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const blob = new Buffer('blorb')
+
+      ipfs.block.put(blob, {
+        format: 'dag-pb',
+        mhtype: 'sha2-256',
+        version: 0
+      }, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.be.eql(blob)
+        expect(block.cid.multihash).to.eql(multihash.fromB58String(expectedHash))
+        done()
+      })
+    })
+
+    it('should put a Block instance', (done) => {
+      const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const cid = new CID(expectedHash)
+      const b = new Block(new Buffer('blorb'), cid)
+
+      ipfs.block.put(b, (err, block) => {
+        expect(err).to.not.exist()
+        expect(block.data).to.eql(new Buffer('blorb'))
+        expect(block.cid.multihash).to.eql(multihash.fromB58String(expectedHash))
+        done()
+      })
+    })
+
+    it('should error with array of blocks', (done) => {
+      const blob = Buffer('blorb')
+
+      ipfs.block.put([blob, blob], (err) => {
+        expect(err).to.be.an.instanceof(Error)
+        done()
+      })
+    })
+
+    // TODO it.skip('Promises support', (done) => {})
+  })
+}

js/src/block/put.js

@@ -0,0 +1,50 @@
+/* eslint-env mocha */
+/* eslint max-nested-callbacks: ["error", 8] */
+
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+const CID = require('cids')
+const { getDescribe } = require('../utils/mocha')
+
+module.exports = (common, options) => {
+  const describe = getDescribe(options)
+
+  describe('.block.stat', () => {
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should stat by CID', (done) => {
+      const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
+      const cid = new CID(hash)
+
+      ipfs.block.stat(cid, (err, stats) => {
+        expect(err).to.not.exist()
+        expect(stats).to.have.property('key')
+        expect(stats).to.have.property('size')
+        done()
+      })
+    })
+
+    // TODO it.skip('Promises support', (done) => {})
+  })
+}

js/src/block/stat.js

@@ -0,0 +1,10 @@
+/* eslint-env mocha */
+
+// Get a describe function that is optionally 'skipped' or 'onlyed'
+function getDescribe (config) {
+  if (config && config.skip) return describe.skip
+  if (config && config.only) return describe.only
+  return describe
+}
+
+module.exports.getDescribe = getDescribe