Merge pull request ipfs#487 from Prabhakar-Poudel/block-remove

test(block.rm): add block remove tests

Author: achingbrain

SPEC/BLOCK.md

@@ -2,6 +2,7 @@
 
 * [block.get](#blockget)
 * [block.put](#blockput)
+* [block.rm](#blockrm)
 * [block.stat](#blockstat)
 
 #### `block.get`
@@ -106,6 +107,44 @@ ipfs.block.put(blob, cid, (err, block) => {
 
 A great source of [examples][] can be found in the tests for this API.
 
+#### `block.rm`
+
+> Remove one or more IPFS block(s).
+
+##### `ipfs.block.rm(cid, [options], [callback])`
+
+`cid` is a [cid][cid] which can be passed as:
+
+- Buffer, the raw Buffer of the cid
+- CID, a CID instance
+- String, the base58 encoded version of the multihash
+- Array, list of CIDs in any of the above three formats
+
+`options` is an Object that can contain the following properties:
+
+- force (boolean): Ignores nonexistent blocks.
+- quiet (boolean): write minimal output
+
+`callback` must follow `function (err, result) {}` signature, where `err` is an error if the operation was not successful and `result` is an object, containing hash and error strings.
+
+If no `callback` is passed, a promise is returned.
+
+NOTE: If the specified block is pinned it won't be removed and no error
+will be returned
+
+**Example:**
+
+```JavaScript
+ipfs.block.rm(cid, function (err, result) {
+  if (err) {
+    throw err
+  }
+  console.log(result.hash)
+})
+```
+
+A great source of [examples][] can be found in the tests for this API.
+
 #### `block.stat`
 
 > Print information of a raw IPFS block.
@@ -150,7 +189,7 @@ ipfs.block.stat(cid, (err, stats) => {
 
 A great source of [examples][] can be found in the tests for this API.
 
-[block]:https://github.com/ipfs/js-ipfs-block
-[multihash]:https://github.com/multiformats/multihash
+[block]: https://github.com/ipfs/js-ipfs-block
+[multihash]: https://github.com/multiformats/multihash
 [examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/block
 [cid]: https://www.npmjs.com/package/cids

src/block/index.js

@@ -2,8 +2,9 @@
 const { createSuite } = require('../utils/suite')
 
 const tests = {
-  put: require('./put'),
   get: require('./get'),
+  put: require('./put'),
+  rm: require('./rm'),
   stat: require('./stat')
 }
 

src/block/rm.js

@@ -0,0 +1,85 @@
+/* eslint-env mocha */
+'use strict'
+
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.block.rm', function () {
+    let ipfs, cid
+
+    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()
+        })
+      })
+    })
+
+    beforeEach(function (done) {
+      const blob = Buffer.from('blorb')
+      ipfs.block.put(blob, (err, block) => {
+        if (err) return done(err)
+        cid = block.cid
+        done()
+      })
+    })
+
+    afterEach(function () {
+      cid = undefined
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should remove by CID object', (done) => {
+      ipfs.block.rm(cid, (err, resp) => {
+        expect(err).to.not.exist()
+        expect(resp).to.have.property('hash')
+        expect(resp.error).to.not.exist()
+        done()
+      })
+    })
+
+    it('should remove by CID in string', (done) => {
+      ipfs.block.rm(cid.toString(), (err, resp) => {
+        expect(err).to.not.exist()
+        expect(resp).to.have.property('hash')
+        expect(resp.error).to.not.exist()
+        done()
+      })
+    })
+
+    it('should remove by CID in buffer', (done) => {
+      ipfs.block.rm(cid.buffer, (err, resp) => {
+        expect(err).to.not.exist()
+        expect(resp).to.have.property('hash')
+        expect(resp.error).to.not.exist()
+        done()
+      })
+    })
+
+    it('should remove multiple CIDs', (done) => {
+      const blob = Buffer.from('more blorb')
+      ipfs.block.put(blob, (err, block) => {
+        if (err) return done(err)
+        const cid1 = block.cid
+        ipfs.block.rm([cid, cid1], (err, resp) => {
+          expect(err).to.not.exist()
+          expect(resp).to.have.property('hash')
+          expect(resp.error).to.not.exist()
+          done()
+        })
+      })
+    })
+  })
+}