feat: support more cli args (#557)

achingbrain · web-flow · commit 2ee20b3ff469 · 2020-10-28T10:37:57.000Z
Adds support and tests for `--algorithm` and `--migrate`
diff --git a/src/ipfsd-daemon.js b/src/ipfsd-daemon.js
@@ -8,8 +8,7 @@ const execa = require('execa')
 const { nanoid } = require('nanoid')
 const path = require('path')
 const os = require('os')
-const tempWrite = require('temp-write')
-const { checkForRunningApi, repoExists, tmpDir, defaultRepo } = require('./utils')
+const { checkForRunningApi, repoExists, tmpDir, defaultRepo, buildInitArgs, buildStartArgs } = require('./utils')
 const waitFor = require('p-wait-for')
 
 const daemonLog = {
@@ -87,35 +86,23 @@ class Daemon {
       return this
     }
 
-    const opts = merge(
-      {
-        emptyRepo: false,
-        profiles: this.opts.test ? ['test'] : []
-      },
-      typeof this.opts.ipfsOptions.init === 'boolean' ? {} : this.opts.ipfsOptions.init,
-      typeof initOptions === 'boolean' ? {} : initOptions
+    initOptions = merge({
+      emptyRepo: false,
+      profiles: this.opts.test ? ['test'] : []
+    },
+    typeof this.opts.ipfsOptions.init === 'boolean' ? {} : this.opts.ipfsOptions.init,
+    typeof initOptions === 'boolean' ? {} : initOptions
     )
 
-    const args = ['init']
-
-    // default-config only for JS
-    if (this.opts.ipfsOptions.config && this.opts.type === 'js') {
-      args.push(tempWrite.sync(JSON.stringify(this.opts.ipfsOptions.config)))
-    }
+    const opts = merge(
+      this.opts, {
+        ipfsOptions: {
+          init: initOptions
+        }
+      }
+    )
 
-    // Translate ipfs options to cli args
-    if (opts.bits) {
-      args.push('--bits', opts.bits)
-    }
-    if (opts.pass && this.opts.type === 'js') {
-      args.push('--pass', '"' + opts.pass + '"')
-    }
-    if (opts.emptyRepo) {
-      args.push('--empty-repo')
-    }
-    if (Array.isArray(opts.profiles) && opts.profiles.length) {
-      args.push('--profile', opts.profiles.join(','))
-    }
+    const args = buildInitArgs(opts)
 
     const { stdout, stderr } = await execa(this.exec, args, {
       env: this.env
@@ -166,30 +153,7 @@ class Daemon {
     } else if (!this.exec) {
       throw new Error('No executable specified')
     } else {
-      const args = ['daemon']
-      const opts = this.opts.ipfsOptions
-      // add custom args
-      args.push(...this.opts.args)
-
-      if (opts.pass && this.opts.type === 'js') {
-        args.push('--pass', '"' + opts.pass + '"')
-      }
-
-      if (opts.offline) {
-        args.push('--offline')
-      }
-
-      if (opts.preload && this.opts.type === 'js') {
-        args.push('--enable-preload', Boolean(opts.preload.enabled))
-      }
-
-      if (opts.EXPERIMENTAL && opts.EXPERIMENTAL.sharding && this.opts.type === 'js') {
-        args.push('--enable-sharding-experiment')
-      }
-
-      if (opts.EXPERIMENTAL && opts.EXPERIMENTAL.ipnsPubsub) {
-        args.push('--enable-namesys-pubsub')
-      }
+      const args = buildStartArgs(this.opts)
 
       let output = ''
 
diff --git a/src/utils.js b/src/utils.js
@@ -5,6 +5,7 @@ const path = require('path')
 const fs = require('fs-extra')
 const debug = require('debug')
 const { nanoid } = require('nanoid')
+const tempWrite = require('temp-write')
 
 const log = debug('ipfsd-ctl:utils')
 
@@ -46,10 +47,83 @@ const tmpDir = (type = '') => {
   return path.join(os.tmpdir(), `${type}_ipfs_${nanoid()}`)
 }
 
+function buildInitArgs (opts = {}) {
+  const args = ['init']
+  const ipfsOptions = opts.ipfsOptions || {}
+  const initOptions = ipfsOptions.init || {}
+
+  // default-config only for JS
+  if (opts.type === 'js') {
+    if (ipfsOptions.config) {
+      args.push(tempWrite.sync(JSON.stringify(opts.ipfsOptions.config)))
+    }
+
+    if (initOptions.pass) {
+      args.push('--pass', '"' + initOptions.pass + '"')
+    }
+  }
+
+  // Translate IPFS options to cli args
+  if (initOptions.bits) {
+    args.push('--bits', initOptions.bits)
+  }
+
+  if (initOptions.algorithm) {
+    args.push('--algorithm', initOptions.algorithm)
+  }
+
+  if (initOptions.emptyRepo) {
+    args.push('--empty-repo')
+  }
+
+  if (Array.isArray(initOptions.profiles) && initOptions.profiles.length) {
+    args.push('--profile', initOptions.profiles.join(','))
+  }
+
+  return args
+}
+
+function buildStartArgs (opts = {}) {
+  const ipfsOptions = opts.ipfsOptions || {}
+  const customArgs = opts.args || []
+
+  const args = ['daemon'].concat(customArgs)
+
+  if (opts.type === 'js') {
+    if (ipfsOptions.pass) {
+      args.push('--pass', '"' + ipfsOptions.pass + '"')
+    }
+
+    if (ipfsOptions.preload != null) {
+      args.push('--enable-preload', Boolean(ipfsOptions.preload.enabled))
+    }
+
+    if (ipfsOptions.EXPERIMENTAL && ipfsOptions.EXPERIMENTAL.sharding) {
+      args.push('--enable-sharding-experiment')
+    }
+  }
+
+  if (ipfsOptions.offline) {
+    args.push('--offline')
+  }
+
+  if (ipfsOptions.EXPERIMENTAL && ipfsOptions.EXPERIMENTAL.ipnsPubsub) {
+    args.push('--enable-namesys-pubsub')
+  }
+
+  if (ipfsOptions.repoAutoMigrate) {
+    args.push('--migrate')
+  }
+
+  return args
+}
+
 module.exports = {
   removeRepo,
   repoExists,
   defaultRepo,
   checkForRunningApi,
-  tmpDir
+  tmpDir,
+  buildInitArgs,
+  buildStartArgs
 }
diff --git a/test/node.utils.js b/test/node.utils.js
@@ -5,7 +5,7 @@
 const { expect } = require('aegir/utils/chai')
 const os = require('os')
 const path = require('path')
-const { tmpDir, checkForRunningApi, defaultRepo, repoExists, removeRepo } = require('../src/utils')
+const { tmpDir, checkForRunningApi, defaultRepo, repoExists, removeRepo, buildInitArgs, buildStartArgs } = require('../src/utils')
 const { createFactory, createController } = require('../src')
 
 describe('utils node version', function () {
@@ -73,4 +73,129 @@ describe('utils node version', function () {
       expect(await repoExists('random')).to.be.false()
     })
   })
+
+  describe('buildStartArgs', function () {
+    it('custom args', () => {
+      expect(buildStartArgs({
+        args: ['--foo=bar']
+      }).join(' ')).to.include('--foo=bar')
+    })
+
+    it('pass', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          pass: 'baz'
+        }
+      }).join(' ')).to.include('--pass "baz"')
+    })
+
+    it('preload', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          preload: true
+        }
+      }).join(' ')).to.include('--enable-preload')
+    })
+
+    it('preload disabled', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          preload: false
+        }
+      }).join(' ')).to.include('--enable-preload false')
+    })
+
+    it('sharding', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          EXPERIMENTAL: {
+            sharding: true
+          }
+        }
+      }).join(' ')).to.include('--enable-sharding-experiment')
+    })
+
+    it('offline', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          offline: true
+        }
+      }).join(' ')).to.include('--offline')
+    })
+
+    it('ipns pubsub', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          EXPERIMENTAL: {
+            ipnsPubsub: true
+          }
+        }
+      }).join(' ')).to.include('--enable-namesys-pubsub')
+    })
+
+    it('migrate', () => {
+      expect(buildStartArgs({
+        ipfsOptions: {
+          repoAutoMigrate: true
+        }
+      }).join(' ')).to.include('--migrate')
+    })
+  })
+
+  describe('buildInitArgs', function () {
+    it('pass', () => {
+      expect(buildStartArgs({
+        type: 'js',
+        ipfsOptions: {
+          pass: 'baz'
+        }
+      }).join(' ')).to.include('--pass "baz"')
+    })
+
+    it('bits', () => {
+      expect(buildInitArgs({
+        ipfsOptions: {
+          init: {
+            bits: 512
+          }
+        }
+      }).join(' ')).to.include('--bits 512')
+    })
+
+    it('algorithm', () => {
+      expect(buildInitArgs({
+        ipfsOptions: {
+          init: {
+            algorithm: 'rsa'
+          }
+        }
+      }).join(' ')).to.include('--algorithm rsa')
+    })
+
+    it('empty repo', () => {
+      expect(buildInitArgs({
+        ipfsOptions: {
+          init: {
+            emptyRepo: true
+          }
+        }
+      }).join(' ')).to.include('--empty-repo')
+    })
+
+    it('profiles', () => {
+      expect(buildInitArgs({
+        ipfsOptions: {
+          init: {
+            profiles: ['foo', 'bar']
+          }
+        }
+      }).join(' ')).to.include('--profile foo,bar')
+    })
+  })
 })
