test: refactor tests (#193)

* test: refactor tests

* now yes

* final touch

Author: daviddias

package.json

@@ -45,13 +45,13 @@
     "dirty-chai": "^2.0.1",
     "ipfs": "~0.26.0",
     "ipfs-block-service": "~0.13.0",
-    "ipfs-repo": "~0.18.2",
+    "ipfs-repo": "~0.18.3",
     "ncp": "^2.0.0",
     "pre-commit": "^1.2.2",
     "pull-generate": "^2.2.0",
     "pull-zip": "^2.0.1",
     "rimraf": "^2.6.2",
-    "sinon": "^4.1.1",
+    "sinon": "^4.1.2",
     "split": "^1.0.1"
   },
   "dependencies": {

test/browser.js

@@ -34,23 +34,35 @@ describe('IPFS data importing tests on the Browser', function () {
     ], done)
   })
 
-  require('./test-builder')(repo)
-  require('./test-flat-builder')
-  require('./test-balanced-builder')
-  require('./test-trickle-builder')
-  require('./test-fixed-size-chunker')
-
-  // relies on data in the repo
-  // require('./test-exporter')(repo)
-
-  require('./test-consumable-buffer')
-  require('./test-consumable-hash')
-  require('./test-hamt')
-  require('./test-importer')(repo)
-  require('./test-importer-flush')(repo)
-  require('./test-import-export')(repo)
-  require('./test-hash-parity-with-go-ipfs')(repo)
-  require('./test-nested-dir-import-export')(repo)
-  require('./test-dirbuilder-sharding')(repo)
-  require('./test-builder-only-hash')(repo)
+  // HAMT
+  require('./hamt')
+  require('./hamt-consumable-buffer')
+  require('./hamt-consumable-hash')
+
+  // Chunkers
+  require('./chunker-fixed-size')
+
+  // Graph Builders
+  require('./builder')(repo)
+  require('./builder-flat')
+  require('./builder-balanced')
+  require('./builder-trickle-dag')
+  require('./builder-only-hash')(repo)
+  // TODO: make these tests not require data on the repo
+  // require('./builder-dir-sharding')(repo)
+
+  // Importer
+  require('./importer')(repo)
+  require('./importer-flush')(repo)
+
+  // Exporter
+  // TODO: make these tests not require data on the repo
+  // require('./exporter')(repo)
+  // require('./exporter-subtree')(repo)
+
+  // Other
+  require('./import-export')(repo)
+  require('./import-export-nested-dir')(repo)
+  require('./hash-parity-with-go-ipfs')(repo)
+  // require('./with-dag-api')
 })

test/test-balanced-builder.js renamed to test/builder-balanced.js

@@ -20,7 +20,7 @@ const options = {
   maxChildrenPerNode: 3
 }
 
-describe('balanced builder', () => {
+describe('builder: balanced', () => {
   it('reduces one value into itself', (callback) => {
     pull(
       pull.values([1]),

test/test-dirbuilder-sharding.js renamed to test/builder-dir-sharding.js

@@ -17,7 +17,7 @@ const setImmediate = require('async/setImmediate')
 const leftPad = require('left-pad')
 
 module.exports = (repo) => {
-  describe('dirbuilder sharding', function () {
+  describe('builder: directory sharding', function () {
     this.timeout(20 * 1000)
 
     let ipldResolver

test/test-flat-builder.js renamed to test/builder-flat.js

@@ -16,7 +16,7 @@ function reduce (leaves, callback) {
   }
 }
 
-describe('flat builder', () => {
+describe('builder: flat', () => {
   it('reduces one value into itself', (callback) => {
     pull(
       pull.values([1]),
@@ -35,9 +35,7 @@ describe('flat builder', () => {
       builder(reduce),
       pull.collect((err, result) => {
         expect(err).to.not.exist()
-        expect(result).to.be.eql([{
-          children: [1, 2]
-        }])
+        expect(result).to.eql([{ children: [1, 2] }])
         callback()
       })
     )

test/test-builder-only-hash.js renamed to test/builder-only-hash.js

@@ -12,7 +12,7 @@ const createBuilder = require('../src/builder')
 const FixedSizeChunker = require('../src/chunker/fixed-size')
 
 module.exports = (repo) => {
-  describe('builder', () => {
+  describe('builder: onlyHash', () => {
     let ipldResolver
 
     before(() => {

test/test-trickle-builder.js renamed to test/builder-trickle-dag.js

@@ -21,7 +21,7 @@ const options = {
   layerRepeat: 2
 }
 
-describe('trickle builder', () => {
+describe('builder: trickle', () => {
   it('reduces one value into itself', callback => {
     pull(
       pull.values([1]),

test/test-builder.js renamed to test/builder.js

@@ -52,6 +52,7 @@ describe('chunker: fixed size', () => {
 
   it('256 KiB chunks', (done) => {
     const KiB256 = 262144
+
     pull(
       pull.values(rawFile),
       chunker(KiB256),
@@ -88,7 +89,7 @@ describe('chunker: fixed size', () => {
           }
         })
 
-        expect(counter).to.be.eql(1)
+        expect(counter).to.equal(1)
         done()
       })
     )

test/test-fixed-size-chunker.js renamed to test/chunker-fixed-size.js

@@ -5,7 +5,7 @@ const expect = require('chai').expect
 
 const ConsumableBuffer = require('../src/hamt/consumable-buffer')
 
-describe('consumable buffer', () => {
+describe('HAMT: consumable buffer', () => {
   let buf
 
   it('can create an empty one', () => {

test/test-export-subtree.js renamed to test/exporter-subtree.js

@@ -9,7 +9,7 @@ const whilst = require('async/whilst')
 
 const ConsumableHash = require('../src/hamt/consumable-hash')
 
-describe('consumable hash', () => {
+describe('HAMT: consumable hash', () => {
   let hash, h
   const maxIter = 100
   const values = []

test/test-exporter.js renamed to test/exporter.js

@@ -30,7 +30,7 @@ module.exports = (repo) => {
       strategy: strategy
     }
 
-    describe(strategy + ' importer', () => {
+    describe('go-ipfs interop using importer:' + strategy, () => {
       let ipldResolver
 
       before(() => {

test/test-consumable-buffer.js renamed to test/hamt-consumable-buffer.js

@@ -13,7 +13,7 @@ const map = require('async/map')
 const unixFSEngine = require('./../')
 
 module.exports = (repo) => {
-  describe('import adn export big nested dir', () => {
+  describe('import and export: directory', () => {
     const rootHash = 'QmdCrquDwd7RfZ6GCZFEVADwe8uyyw1YmF9mtAB7etDgmK'
     let ipldResolver
 

test/test-consumable-hash.js renamed to test/hamt-consumable-hash.js

@@ -0,0 +1,69 @@
+/* eslint-env mocha */
+'use strict'
+
+const chai = require('chai')
+chai.use(require('dirty-chai'))
+const expect = chai.expect
+const BlockService = require('ipfs-block-service')
+const IPLDResolver = require('ipld-resolver')
+const pull = require('pull-stream')
+const loadFixture = require('aegir/fixtures')
+const bigFile = loadFixture(__dirname, 'fixtures/1.2MiB.txt')
+
+const unixFSEngine = require('./../')
+const exporter = unixFSEngine.exporter
+
+const strategies = [
+  'flat',
+  'balanced',
+  'trickle'
+]
+
+function fileEql (f1, fileData, callback) {
+  pull(
+    f1.content,
+    pull.concat((err, data) => {
+      expect(err).to.not.exist()
+      // TODO: eql is super slow at comparing large buffers
+      // expect(data).to.eql(fileData)
+      callback()
+    })
+  )
+}
+
+module.exports = (repo) => {
+  describe('import and export', () => {
+    strategies.forEach((strategy) => {
+      const importerOptions = { strategy: strategy }
+
+      describe('using builder: ' + strategy, () => {
+        let ipldResolver
+
+        before(() => {
+          const bs = new BlockService(repo)
+          ipldResolver = new IPLDResolver(bs)
+        })
+
+        it('import and export', (done) => {
+          const path = strategy + '-big.dat'
+
+          pull(
+            pull.values([{ path: path, content: pull.values(bigFile) }]),
+            unixFSEngine.importer(ipldResolver, importerOptions),
+            pull.map((file) => {
+              expect(file.path).to.eql(path)
+
+              return exporter(file.multihash, ipldResolver)
+            }),
+            pull.flatten(),
+            pull.collect((err, files) => {
+              expect(err).to.not.exist()
+              expect(files[0].size).to.eql(bigFile.length)
+              fileEql(files[0], bigFile, done)
+            })
+          )
+        })
+      })
+    })
+  })
+}

test/test-hamt.js renamed to test/hamt.js

@@ -12,7 +12,7 @@ const pull = require('pull-stream')
 const pushable = require('pull-pushable')
 
 module.exports = (repo) => {
-  describe('importer flush', () => {
+  describe('importer: flush', () => {
     let ipldResolver
 
     before(() => {

test/test-hash-parity-with-go-ipfs.js renamed to test/hash-parity-with-go-ipfs.js

@@ -160,7 +160,7 @@ module.exports = (repo) => {
 
     const expected = extend({}, defaultResults, strategies[strategy])
 
-    describe(strategy + ' importer', function () {
+    describe('importer: ' + strategy, function () {
       this.timeout(20 * 1000)
 
       let ipldResolver

test/test-nested-dir-import-export.js renamed to test/import-export-nested-dir.js

@@ -4,13 +4,14 @@
 const ncp = require('ncp').ncp
 const rimraf = require('rimraf')
 const path = require('path')
+const os = require('os')
 const IPFSRepo = require('ipfs-repo')
 const mkdirp = require('mkdirp')
 const series = require('async/series')
 
 describe('IPFS UnixFS Engine', () => {
   const repoExample = path.join(process.cwd(), '/test/test-repo')
-  const repoTests = path.join(process.cwd(), '/test/repo-tests' + Date.now())
+  const repoTests = path.join(os.tmpdir(), '/unixfs-tests-' + Date.now())
 
   const repo = new IPFSRepo(repoTests)
 
@@ -36,22 +37,33 @@ describe('IPFS UnixFS Engine', () => {
     ], done)
   })
 
-  require('./test-builder')(repo)
-  require('./test-flat-builder')
-  require('./test-balanced-builder')
-  require('./test-trickle-builder')
-  require('./test-fixed-size-chunker')
-  require('./test-consumable-buffer')
-  require('./test-consumable-hash')
-  require('./test-hamt')
-  require('./test-exporter')(repo)
-  require('./test-export-subtree')(repo)
-  require('./test-importer')(repo)
-  require('./test-importer-flush')(repo)
-  require('./test-import-export')(repo)
-  require('./test-hash-parity-with-go-ipfs')(repo)
-  require('./test-nested-dir-import-export')(repo)
-  require('./test-dirbuilder-sharding')(repo)
-  require('./test-dag-api')
-  require('./test-builder-only-hash')(repo)
+  // HAMT
+  require('./hamt')
+  require('./hamt-consumable-buffer')
+  require('./hamt-consumable-hash')
+
+  // Chunkers
+  require('./chunker-fixed-size')
+
+  // Graph Builders
+  require('./builder')(repo)
+  require('./builder-flat')
+  require('./builder-balanced')
+  require('./builder-trickle-dag')
+  require('./builder-only-hash')(repo)
+  require('./builder-dir-sharding')(repo)
+
+  // Importer
+  require('./importer')(repo)
+  require('./importer-flush')(repo)
+
+  // Exporter
+  require('./exporter')(repo)
+  require('./exporter-subtree')(repo)
+
+  // Other
+  require('./import-export')(repo)
+  require('./import-export-nested-dir')(repo)
+  require('./hash-parity-with-go-ipfs')(repo)
+  require('./with-dag-api')
 })

test/import-export.js

@@ -1 +1 @@
-5
+6

test/test-importer-flush.js renamed to test/importer-flush.js

@@ -158,7 +158,7 @@ describe('with dag-api', () => {
 
     const expected = extend({}, defaultResults, strategies[strategy])
 
-    describe(strategy + ' importer', function () {
+    describe('importer: ' + strategy, function () {
       this.timeout(20 * 1000)
 
       let node