gateway Essential tests

examples/traverse-ipld-graphs/git.js

@@ -47,13 +47,13 @@ createNode((err, ipfs) => {
 
     const v1tag = 'z8mWaGfwSWLMPJ6Q2JdsAjGiXTf61Nbue'
 
-    function errOrLog(comment) {
+    function errOrLog (comment) {
       return (err, result) => {
         if (err) {
           throw err
         }
 
-        if (Buffer.isBuffer(result.value)) { //Blobs (files) are returned as buffer instance
+        if (Buffer.isBuffer(result.value)) { // Blobs (files) are returned as buffer instance
           result.value = result.value.toString()
         }
 
@@ -63,7 +63,6 @@ createNode((err, ipfs) => {
       }
     }
 
-
     ipfs.dag.get(v1tag + '/', errOrLog('Tag object:'))
     ipfs.dag.get(v1tag + '/object/message', errOrLog('Tagged commit message:'))
     ipfs.dag.get(v1tag + '/object/parents/0/message', errOrLog('Parent of tagged commit:'))

src/http/gateway/resolver.js

@@ -38,7 +38,7 @@ const resolveDirectory = promisify((ipfs, path, multihash, callback) => {
       return callback(null, indexFiles)
     }
 
-    return callback(null, dirView.build(path, dagNode.links))
+    return callback(null, dirView.render(path, dagNode.links))
   })
 })
 

test/gateway/index.js

@@ -1,11 +1,21 @@
 /* eslint-env mocha */
 'use strict'
 
+const fs = require('fs')
+const path = require('path')
 const chai = require('chai')
 const dirtyChai = require('dirty-chai')
 const expect = chai.expect
 chai.use(dirtyChai)
 const API = require('../../src/http')
+const loadFixture = require('aegir/fixtures')
+const bigFile = loadFixture(__dirname, '../../node_modules/interface-ipfs-core/test/fixtures/15mb.random', 'ipfs')
+const directoryContent = {
+  'index.html': loadFixture(__dirname, './test-folder/index.html', 'ipfs'),
+  'nested-folder/hello.txt': loadFixture(__dirname, './test-folder/nested-folder/hello.txt', 'ipfs'),
+  'nested-folder/ipfs.txt': loadFixture(__dirname, './test-folder/nested-folder/ipfs.txt', 'ipfs'),
+  'nested-folder/nested.html': loadFixture(__dirname, './test-folder/nested-folder/nested.html', 'ipfs')
+}
 
 describe('HTTP Gateway', () => {
   let http = {}
@@ -15,8 +25,35 @@ describe('HTTP Gateway', () => {
     http.api = new API()
 
     http.api.start(true, () => {
-      gateway = http.api.server.select('Gateway')
-      done()
+      const content = (name) => ({
+        path: `test-folder/${name}`,
+        content: directoryContent[name]
+      })
+
+      const emptyDir = (name) => ({
+        path: `test-folder/${name}`
+      })
+
+      const expectedRootMultihash = 'QmbQD7EMEL1zeebwBsWEfA3ndgSS6F7S6iTuwuqasPgVRi'
+
+      const dirs = [
+        content('index.html'),
+        emptyDir('empty-folder'),
+        content('nested-folder/hello.txt'),
+        content('nested-folder/ipfs.txt'),
+        content('nested-folder/nested.html'),
+        emptyDir('nested-folder/empty')
+      ]
+
+      http.api.node.files.add(dirs, (err, res) => {
+        expect(err).to.not.exist()
+        const root = res[res.length - 1]
+
+        expect(root.path).to.equal('test-folder')
+        expect(root.hash).to.equal(expectedRootMultihash)
+        gateway = http.api.server.select('Gateway')
+        done()
+      })
     })
   })
 
@@ -27,7 +64,12 @@ describe('HTTP Gateway', () => {
     })
   })
 
-  describe('/ipfs/* route', () => {
+  describe('## interface tests', () => {
+    fs.readdirSync(path.join(__dirname, '/interface'))
+      .forEach((file) => require('./interface/' + file))
+  })
+
+  describe('## HTTP Gateway', () => {
     it('returns 400 for request without argument', (done) => {
       gateway.inject({
         method: 'GET',
@@ -61,5 +103,96 @@ describe('HTTP Gateway', () => {
         done()
       })
     })
+
+    it('stream a large file', (done) => {
+      let bigFileHash = 'Qme79tX2bViL26vNjPsF3DP1R9rMKMvnPYJiKTTKPrXJjq'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + bigFileHash
+      }, (res) => {
+        expect(res.statusCode).to.equal(200)
+        expect(res.rawPayload).to.deep.equal(bigFile)
+        done()
+      })
+    })
+
+    it('load a non text file', (done) => {
+      let kitty = 'QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ/cat.jpg'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + kitty
+      }, (res) => {
+        expect(res.statusCode).to.equal(200)
+        expect(res.headers['content-type']).to.equal('image/jpeg')
+        done()
+      })
+    })
+
+    it('load a directory', (done) => {
+      let dir = 'QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ/'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + dir
+      }, (res) => {
+        expect(res.statusCode).to.equal(200)
+        expect(res.headers['content-type']).to.equal('text/html; charset=utf-8')
+        done()
+      })
+    })
+
+    it('load a webpage index.html', (done) => {
+      let dir = 'QmbQD7EMEL1zeebwBsWEfA3ndgSS6F7S6iTuwuqasPgVRi/index.html'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + dir
+      }, (res) => {
+        expect(res.statusCode).to.equal(200)
+        expect(res.rawPayload).to.deep.equal(directoryContent['index.html'])
+        done()
+      })
+    })
+
+    it('load a webpage {hash}/nested-folder/nested.html', (done) => {
+      let dir = 'QmbQD7EMEL1zeebwBsWEfA3ndgSS6F7S6iTuwuqasPgVRi/nested-folder/nested.html'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + dir
+      }, (res) => {
+        expect(res.statusCode).to.equal(200)
+        expect(res.rawPayload).to.deep.equal(directoryContent['nested-folder/nested.html'])
+        done()
+      })
+    })
+
+    it('redirect to generated index', (done) => {
+      let dir = 'QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + dir
+      }, (res) => {
+        expect(res.statusCode).to.equal(301)
+        expect(res.headers['location']).to.equal('/ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ/')
+        done()
+      })
+    })
+
+    it('redirect to webpage index.html', (done) => {
+      let dir = 'QmbQD7EMEL1zeebwBsWEfA3ndgSS6F7S6iTuwuqasPgVRi/'
+
+      gateway.inject({
+        method: 'GET',
+        url: '/ipfs/' + dir
+      }, (res) => {
+        expect(res.statusCode).to.equal(302)
+        expect(res.headers['location']).to.equal('/ipfs/QmbQD7EMEL1zeebwBsWEfA3ndgSS6F7S6iTuwuqasPgVRi/index.html')
+        done()
+      })
+    })
   })
 })

test/gateway/interface/block.js

@@ -0,0 +1,20 @@
+/* eslint-env mocha */
+
+'use strict'
+
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.block(common)

test/gateway/interface/config.js

@@ -0,0 +1,20 @@
+/* eslint-env mocha */
+
+'use strict'
+
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.config(common)

test/gateway/interface/files.js

@@ -0,0 +1,20 @@
+/* eslint-env mocha */
+
+'use strict'
+
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.files(common)

test/gateway/interface/object.js

@@ -0,0 +1,20 @@
+/* eslint-env mocha */
+
+'use strict'
+
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.object(common)

test/gateway/interface/pubsub.js

@@ -0,0 +1,23 @@
+/* eslint-env mocha */
+
+'use strict'
+
+// TODO needs: https://github.com/ipfs/js-ipfs-api/pull/493
+/*
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.pubsub(common)
+*/

test/gateway/interface/swarm.js

@@ -0,0 +1,20 @@
+/* eslint-env mocha */
+
+'use strict'
+
+const test = require('interface-ipfs-core')
+const FactoryClient = require('./../../utils/ipfs-factory-daemon')
+
+let fc
+
+const common = {
+  setup: function (callback) {
+    fc = new FactoryClient()
+    callback(null, fc)
+  },
+  teardown: function (callback) {
+    fc.dismantle(callback)
+  }
+}
+
+test.swarm(common)

test/gateway/test-folder/index.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>IPFS test index.html</title>
+</head>
+<body>
+  index.html
+</body>
+</html>

test/gateway/test-folder/nested-folder/hello.txt

@@ -0,0 +1 @@
+Hello

test/gateway/test-folder/nested-folder/ipfs.txt

@@ -0,0 +1 @@
+IPFS

test/gateway/test-folder/nested-folder/nested.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>IPFS test nested.html</title>
+</head>
+<body>
+  nested.html
+</body>
+</html>