Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

fix: Add tests for .block promise API #170

Closed
wants to merge 2 commits into from
Closed

fix: Add tests for .block promise API #170

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a885f5
fix: Add tests for .block promise API
haadcode Nov 17, 2017
2da5ef0
Skip .rm() tests for now (see code for details)
haadcode Nov 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
271 changes: 199 additions & 72 deletions src/block.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const series = require('async/series')
const Block = require('ipfs-block')
const multihash = require('multihashes')
const CID = require('cids')
Expand All @@ -22,8 +23,9 @@ module.exports = (common) => {
let ipfs

before(function (done) {
// CI takes longer to instantiate the daemon, so we need to increase the
// timeout for the before step
// 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) => {
Expand All @@ -38,108 +40,233 @@ module.exports = (common) => {

after((done) => common.teardown(done))

describe('.put', () => {
it('a buffer, using defaults', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const blob = new Buffer('blorb')
describe('callback API', () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@haadcode I believe you missed that there is no more separation between Callback API and Promise API and through your rebase you brought it back and duplicated some come.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not notice that. Will fix it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@diasdavid I started to look into this but I'm little confused. Can you help here to elaborate what you mean with "no more separation between Callback and Promise API"? We still have them both, right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still have both, but we don't duplicate the tests anymore :)

describe('.put', () => {
it('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)
expectKey(block, multihash.fromB58String(expectedHash), done)
ipfs.block.put(blob, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.be.eql(blob)
expectKey(block, multihash.fromB58String(expectedHash), done)
})
})
})

it('a buffer, using CID', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(expectedHash)
const blob = new Buffer('blorb')
it('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)
expectKey(block, multihash.fromB58String(expectedHash), done)
ipfs.block.put(blob, { cid: cid }, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.be.eql(blob)
expectKey(block, multihash.fromB58String(expectedHash), done)
})
})
})

it('a buffer, using options', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const blob = new Buffer('blorb')
it('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)
expectKey(block, multihash.fromB58String(expectedHash), done)
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)
expectKey(block, multihash.fromB58String(expectedHash), done)
})
})

it('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'))
expectKey(block, multihash.fromB58String(expectedHash), done)
})
})

it('error with array of blocks', (done) => {
const blob = Buffer('blorb')

ipfs.block.put([blob, blob], (err) => {
expect(err).to.be.an.instanceof(Error)
done()
})
})
})

it('a Block instance', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(expectedHash)
const b = new Block(new Buffer('blorb'), cid)
describe('.get', () => {
it('by CID object', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(hash)

ipfs.block.put(b, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, multihash.fromB58String(expectedHash), done)
ipfs.block.get(cid, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, cid.multihash, done)
})
})

it('by CID in Str', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'

ipfs.block.get(hash, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, multihash.fromB58String(hash), done)
})
})
})

it('error with array of blocks', (done) => {
const blob = Buffer('blorb')
describe('.stat', () => {
it('by CID', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(hash)

ipfs.block.put([blob, blob], (err) => {
expect(err).to.be.an.instanceof(Error)
done()
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) => {})
describe('.rm', function () {
// We need to skip this part of the test for now:
// By default, block.get() will try to get the block from
// bitswap thus causing a long timeout. What we want here is
// to get the block.get() to return an error as fast as possible,
// indicating that we don't have the block anymore.
// See: https://github.com/ipfs/interface-ipfs-core/pull/170#discussion_r151633508
it.skip('by CID', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(expectedHash)
const b = new Block(new Buffer('blorb'), cid)

series([
(cb) => {
// Add a block
ipfs.block.put(b, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.be.eql(b.data)
expectKey(block, multihash.fromB58String(expectedHash), cb)
})
},
(cb) => {
// Remove the block
ipfs.block.rm(cid, (err) => {
expect(err).to.not.exist()
cb()
})
},
(cb) => {
// Verify that the block was removed
ipfs.block.get(cid, (err, block) => {
expect(err).to.exist()
expect(block).to.not.exist()
// Verifying the error message with a function due to chai
// NOT supporting .to.include.any([str1, str2])
expect(err.toString()).to.satisfy((str) => {
return str.indexOf('Error: ENOENT: no such file or directory') > -1 ||
str.indexOf('NotFoundError: Key not found in database') > -1
})
cb()
})
}
], done)
})
})
})

describe('.get', () => {
it('by CID object', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(hash)
describe('promise API', () => {
describe('.put', () => {
it('a buffer, using defaults', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const blob = new Buffer('blorb')

ipfs.block.get(cid, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, cid.multihash, done)
ipfs.block.put(blob)
.then((block) => {
expect(block.data).to.be.eql(blob)
expectKey(block, multihash.fromB58String(expectedHash), done)
})
.catch(done)
})
})

it('by CID in Str', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
describe('.get', () => {
it('by CID object', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(hash)

ipfs.block.get(hash, (err, block) => {
expect(err).to.not.exist()
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, multihash.fromB58String(hash), done)
ipfs.block.get(cid)
.then((block) => {
expect(block.data).to.eql(new Buffer('blorb'))
expectKey(block, cid.multihash, done)
})
.catch(done)
})
})

// TODO it.skip('Promises support', (done) => {})
})

describe('.stat', () => {
it('by CID', (done) => {
const hash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(hash)
describe('.stat', () => {
it('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()
ipfs.block.stat(cid)
.then((stats) => {
expect(stats).to.have.property('key')
expect(stats).to.have.property('size')
done()
})
.catch(done)
})
})

// TODO it.skip('Promises support', (done) => {})
describe('.rm', function () {
// We need to skip this part of the test for now:
// By default, block.get() will try to get the block from
// bitswap thus causing a long timeout. What we want here is
// to get the block.get() to return an error as fast as possible,
// indicating that we don't have the block anymore.
// See: https://github.com/ipfs/interface-ipfs-core/pull/170#discussion_r151633508
it.skip('by CID', (done) => {
const expectedHash = 'QmPv52ekjS75L4JmHpXVeuJ5uX2ecSfSZo88NSyxwA3rAQ'
const cid = new CID(expectedHash)
const b = new Block(new Buffer('blorb'), cid)

ipfs.block.put(b)
.then((block) => {
expect(block.data).to.be.eql(b.data)
})
.then(() => ipfs.block.rm(cid)) // Remove the block
.then(() => {
// Verify that the block was removed
return ipfs.block.get(cid)
})
.then((block) => {
// We should never end here
expect(block).to.not.exist()
done(new Error('Block was not removed!'))
})
.catch((err) => {
// Verifying the error message with a function due to chai
// NOT supporting .to.include.any([str1, str2])
expect(err.toString()).to.satisfy((str) => {
return str.indexOf('Error: ENOENT: no such file or directory') > -1 ||
str.indexOf('NotFoundError: Key not found in database') > -1
})
done()
})
})
})
})
})
}