test: add HTTP API tests for pin.* with cid-base option

License: MIT
Signed-off-by: Alan Shaw <[email protected]>

Author: Alan Shaw

src/http/api/routes/pin.js

@@ -12,7 +12,8 @@ module.exports = (server) => {
       pre: [
         { method: resources.pin.add.parseArgs, assign: 'args' }
       ],
-      handler: resources.pin.add.handler
+      handler: resources.pin.add.handler,
+      validate: resources.pin.add.validate
     }
   })
 
@@ -23,7 +24,8 @@ module.exports = (server) => {
       pre: [
         { method: resources.pin.rm.parseArgs, assign: 'args' }
       ],
-      handler: resources.pin.rm.handler
+      handler: resources.pin.rm.handler,
+      validate: resources.pin.rm.validate
     }
   })
 
@@ -34,7 +36,8 @@ module.exports = (server) => {
       pre: [
         { method: resources.pin.ls.parseArgs, assign: 'args' }
       ],
-      handler: resources.pin.ls.handler
+      handler: resources.pin.ls.handler,
+      validate: resources.pin.ls.validate
     }
   })
 }

test/http-api/inject/pin.js

@@ -3,6 +3,9 @@
 'use strict'
 
 const expect = require('chai').expect
+const FormData = require('form-data')
+const streamToPromise = require('stream-to-promise')
+const multibase = require('multibase')
 
 // We use existing pin structure in the go-ipfs-repo fixture
 // so that we don't have to stream a bunch of object/put operations
@@ -77,6 +80,62 @@ module.exports = (http) => {
           })
         })
       })
+
+      it('should remove pin and return base64 encoded CID', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+            const hash = JSON.parse(res.result).Hash
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/rm?arg=${hash}&cid-base=base64`
+            }, (res) => {
+              expect(res.statusCode).to.equal(200)
+              res.result.Pins.forEach(cid => {
+                expect(multibase.isEncoded(cid)).to.deep.equal('base64')
+              })
+              done()
+            })
+          })
+        })
+      })
+
+      it('should not remove pin for invalid cid-base option', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+            const hash = JSON.parse(res.result).Hash
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/rm?arg=${hash}&cid-base=invalid`
+            }, (res) => {
+              expect(res.statusCode).to.equal(400)
+              expect(res.result.Message).to.include('child "cid-base" fails')
+              done()
+            })
+          })
+        })
+      })
     })
 
     describe('add', () => {
@@ -115,6 +174,62 @@ module.exports = (http) => {
           done()
         })
       })
+
+      it('should add pin and return base64 encoded CID', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add?pin=false',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+            const hash = JSON.parse(res.result).Hash
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/add?arg=${hash}&cid-base=base64`
+            }, (res) => {
+              expect(res.statusCode).to.equal(200)
+              res.result.Pins.forEach(cid => {
+                expect(multibase.isEncoded(cid)).to.deep.equal('base64')
+              })
+              done()
+            })
+          })
+        })
+      })
+
+      it('should not add pin for invalid cid-base option', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add?pin=false',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+            const hash = JSON.parse(res.result).Hash
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/add?arg=${hash}&cid-base=invalid`
+            }, (res) => {
+              expect(res.statusCode).to.equal(400)
+              expect(res.result.Message).to.include('child "cid-base" fails')
+              done()
+            })
+          })
+        })
+      })
     })
 
     describe('ls', () => {
@@ -165,6 +280,60 @@ module.exports = (http) => {
           done()
         })
       })
+
+      it('should list pins and return base64 encoded CIDs', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/ls?cid-base=base64`
+            }, (res) => {
+              expect(res.statusCode).to.equal(200)
+              Object.keys(res.result.Keys).forEach(cid => {
+                expect(multibase.isEncoded(cid)).to.deep.equal('base64')
+              })
+              done()
+            })
+          })
+        })
+      })
+
+      it('should not list pins for invalid cid-base option', done => {
+        const form = new FormData()
+        form.append('data', Buffer.from('TEST' + Date.now()))
+        const headers = form.getHeaders()
+
+        streamToPromise(form).then((payload) => {
+          api.inject({
+            method: 'POST',
+            url: '/api/v0/add',
+            headers: headers,
+            payload: payload
+          }, (res) => {
+            expect(res.statusCode).to.equal(200)
+
+            api.inject({
+              method: 'POST',
+              url: `/api/v0/pin/ls?cid-base=invalid`
+            }, (res) => {
+              expect(res.statusCode).to.equal(400)
+              expect(res.result.Message).to.include('child "cid-base" fails')
+              done()
+            })
+          })
+        })
+      })
     })
   })
 }