chore: add tests for multiple refs, CBOR

Author: dirkmc

src/files-regular/refs-tests.js

@@ -12,7 +12,7 @@ module.exports = (createCommon, suiteName, ipfsRefs, options) => {
   describe(suiteName, function () {
     this.timeout(40 * 1000)
 
-    let ipfs, rootCid
+    let ipfs, pbRootCb, dagRootCid
 
     before(function (done) {
       // CI takes longer to instantiate the daemon, so we need to increase the
@@ -30,9 +30,17 @@ module.exports = (createCommon, suiteName, ipfsRefs, options) => {
     })
 
     before(function (done) {
-      loadContent(ipfs, getMockObjects(), (err, cid) => {
+      loadPbContent(ipfs, getMockObjects(), (err, cid) => {
         expect(err).to.not.exist()
-        rootCid = cid
+        pbRootCb = cid
+        done()
+      })
+    })
+
+    before(function (done) {
+      loadDagContent(ipfs, getMockObjects(), (err, cid) => {
+        expect(err).to.not.exist()
+        dagRootCid = cid
         done()
       })
     })
@@ -55,7 +63,7 @@ module.exports = (createCommon, suiteName, ipfsRefs, options) => {
         }
 
         // Call out to IPFS
-        const p = (path ? path(rootCid) : rootCid)
+        const p = (path ? path(pbRootCb) : pbRootCb)
         ipfsRefs(ipfs)(p, params, (err, refs) => {
           if (!done) {
             // Already timed out
@@ -84,6 +92,32 @@ module.exports = (createCommon, suiteName, ipfsRefs, options) => {
         })
       })
     }
+
+    it('dag refs test', function (done) {
+      this.timeout(20 * 1000)
+
+      // Call out to IPFS
+      ipfsRefs(ipfs)(`/ipfs/${dagRootCid}`, { recursive: true }, (err, refs) => {
+        // Check there was no error and the refs match what was expected
+        expect(err).to.not.exist()
+        expect(refs.map(r => r.ref).sort()).to.eql([
+          'QmPDqvcuA4AkhBLBuh2y49yhUB98rCnxPxa3eVNC1kAbSC',
+          'QmVwtsLUHurA6wUirPSdGeEW5tfBEqenXpeRaqr8XN7bNY',
+          'QmXGL3ZdYV5rNLCfHe1QsFSQGekRFzgbBu1B3XGZ7DV9fd',
+          'QmcSVZRN5E814KkPy4EHnftNAR7htbFvVhRKKqFs4FBwDG',
+          'QmcSVZRN5E814KkPy4EHnftNAR7htbFvVhRKKqFs4FBwDG',
+          'QmdBcHbK7uDQav8YrHsfKju3EKn48knxjd96KRMFs3gtS9',
+          'QmeX96opBHZHLySMFoNiWS5msxjyX6rqtr3Rr1u7uxn7zJ',
+          'Qmf8MwTnY7VdcnF8WcoJ3GB24NmNd1HsGzuEWCtUYDP38x',
+          'zdpuAkqPgGuEFBFLcixZyFezWw3bsGUWVS6W7c8YhV5sdAc6E',
+          'zdpuArVVBgigTbs6FdyqFFWUSsXymdruTtCVoboc91L3WTXi1',
+          'zdpuAsrruPqzPDYs9c1FGNR5Wuyx8on64no6z62SRPv3viHGL',
+          'zdpuAxTXSfaHaZNed3JG2WvcYNgd64v27ztB2zknrz5noPhz5'
+        ])
+
+        done()
+      })
+    })
   })
 }
 
@@ -121,7 +155,7 @@ function getRefsTests () {
     },
 
     'prints files in edges format': {
-      params: { e: true },
+      params: { edges: true },
       expected: [
         'Qmd5MhNjx3NSZm3L2QKG1TFvqkTRbtZwGJinqEfqpfHH7s -> QmYEJ7qQNZUvBnv4SZ3rEbksagaan3sGvnUq948vSG8Z34',
         'Qmd5MhNjx3NSZm3L2QKG1TFvqkTRbtZwGJinqEfqpfHH7s -> QmUXzZKa3xhTauLektUiK4GiogHskuz1c57CnnoP4TgYJD',
@@ -161,7 +195,7 @@ function getRefsTests () {
 
     'follows a path with recursion, <hash>/<subdir>': {
       path: (cid) => `/ipfs/${cid}/animals`,
-      params: { format: '<linkname>', r: true },
+      params: { format: '<linkname>', recursive: true },
       expected: [
         'land',
         'african.txt',
@@ -174,7 +208,7 @@ function getRefsTests () {
     },
 
     'recursively follows folders, -r': {
-      params: { format: '<linkname>', r: true },
+      params: { format: '<linkname>', recursive: true },
       expected: [
         'animals',
         'land',
@@ -192,7 +226,7 @@ function getRefsTests () {
     },
 
     'recursive with unique option': {
-      params: { format: '<linkname>', r: true, u: true },
+      params: { format: '<linkname>', recursive: true, unique: true },
       expected: [
         'animals',
         'land',
@@ -209,7 +243,7 @@ function getRefsTests () {
     },
 
     'max depth of 1': {
-      params: { format: '<linkname>', r: true, 'max-depth': 1 },
+      params: { format: '<linkname>', recursive: true, maxDepth: 1 },
       expected: [
         'animals',
         'atlantic-animals',
@@ -219,7 +253,7 @@ function getRefsTests () {
     },
 
     'max depth of 2': {
-      params: { format: '<linkname>', r: true, 'max-depth': 2 },
+      params: { format: '<linkname>', recursive: true, maxDepth: 2 },
       expected: [
         'animals',
         'land',
@@ -232,7 +266,7 @@ function getRefsTests () {
     },
 
     'max depth of 3': {
-      params: { format: '<linkname>', r: true, 'max-depth': 3 },
+      params: { format: '<linkname>', recursive: true, maxDepth: 3 },
       expected: [
         'animals',
         'land',
@@ -250,13 +284,13 @@ function getRefsTests () {
     },
 
     'max depth of 0': {
-      params: { r: true, 'max-depth': 0 },
+      params: { recursive: true, maxDepth: 0 },
       expected: []
     },
 
     'follows a path with max depth 1, <hash>/<subdir>': {
       path: (cid) => `/ipfs/${cid}/animals`,
-      params: { format: '<linkname>', r: true, 'max-depth': 1 },
+      params: { format: '<linkname>', recursive: true, maxDepth: 1 },
       expected: [
         'land',
         'sea'
@@ -265,7 +299,7 @@ function getRefsTests () {
 
     'follows a path with max depth 2, <hash>/<subdir>': {
       path: (cid) => `/ipfs/${cid}/animals`,
-      params: { format: '<linkname>', r: true, 'max-depth': 2 },
+      params: { format: '<linkname>', recursive: true, maxDepth: 2 },
       expected: [
         'land',
         'african.txt',
@@ -277,8 +311,23 @@ function getRefsTests () {
       ]
     },
 
+    'prints refs for multiple paths': {
+      path: (cid) => [`/ipfs/${cid}/animals`, `/ipfs/${cid}/fruits`],
+      params: { format: '<linkname>', recursive: true },
+      expected: [
+        'land',
+        'african.txt',
+        'americas.txt',
+        'australian.txt',
+        'sea',
+        'atlantic.txt',
+        'indian.txt',
+        'tropical.txt'
+      ]
+    },
+
     'cannot specify edges and format': {
-      params: { format: '<linkname>', e: true },
+      params: { format: '<linkname>', edges: true },
       expectError: true
     },
 
@@ -289,27 +338,58 @@ function getRefsTests () {
   }
 }
 
-function loadContent (ipfs, node, callback) {
+function loadPbContent (ipfs, node, callback) {
+  const store = {
+    putData: (data, cb) => ipfs.object.put({ Data: data, Links: [] }, cb),
+    putLinks: (links, cb) => {
+      ipfs.object.put({
+        Data: '',
+        Links: links.map(({ name, cid }) => ({ Name: name, Hash: cid, Size: 8 }))
+      }, cb)
+    }
+  }
+  loadContent(ipfs, store, node, callback)
+}
+
+function loadDagContent (ipfs, node, callback) {
+  const store = {
+    putData: (data, cb) => {
+      ipfs.add(Buffer.from(data), (err, res) => {
+        if (err) {
+          return callback(err)
+        }
+        return cb(null, res[0].hash)
+      })
+    },
+    putLinks: (links, cb) => {
+      const obj = {}
+      for (const { name, cid } of links) {
+        obj[name] = { '/': cid }
+      }
+      ipfs.dag.put(obj, cb)
+    }
+  }
+  loadContent(ipfs, store, node, callback)
+}
+
+function loadContent (ipfs, store, node, callback) {
   if (Array.isArray(node)) {
-    ipfs.object.put({ Data: node.join('\n'), Links: [] }, callback)
+    return store.putData(node.join('\n'), callback)
   }
 
   if (typeof node === 'object') {
     const entries = Object.entries(node)
     const sorted = entries.sort((a, b) => a[0] > b[0] ? 1 : a[0] < b[0] ? -1 : 0)
     map(sorted, ([name, child], cb) => {
-      loadContent(ipfs, child, (err, cid) => {
+      loadContent(ipfs, store, child, (err, cid) => {
         cb(err, { name, cid: cid && cid.toString() })
       })
     }, (err, res) => {
       if (err) {
         return callback(err)
       }
 
-      ipfs.object.put({
-        Data: '',
-        Links: res.map(({ name, cid }) => ({ Name: name, Hash: cid, Size: 8 }))
-      }, callback)
+      store.putLinks(res, callback)
     })
   }
 }