Merge pull request ipfs#536 from ipfs/add-listing-config-profiles

feat: add test and docs for listing config profiles

Author: achingbrain

SPEC/CONFIG.md

@@ -3,6 +3,8 @@
 * [config.get](#configget)
 * [config.set](#configset)
 * [config.replace](#configreplace)
+* [config.profiles.list](#configprofileslist)
+* [config.profiles.apply](#configprofilesapply)
 
 #### `config.get`
 
@@ -85,5 +87,62 @@ ipfs.config.replace(newConfig, (err) => {
 
 A great source of [examples][] can be found in the tests for this API.
 
+#### `config.profiles.list`
+
+> List available config profiles
+
+##### `ipfs.config.profiles.list([options], [callback])`
+
+`options` is a object.
+`callback` must follow `function (err, result) {}` signature, where `err` is an error if the operation was not successful.
+
+If no callback is passed, a [promise][] is returned
+
+**Example:**
+
+```JavaScript
+ipfs.config.profiles.list(newConfig, (err, profiles) => {
+  if (err) {
+    throw err
+  }
+
+  profiles.forEach(profile => {
+    console.info(profile.name, profile.description)
+  })
+})
+```
+
+A great source of [examples][] can be found in the tests for this API.
+
+#### `config.profiles.apply`
+
+> Apply a config profile
+
+##### `ipfs.config.profiles.apply(name, [options], [callback])`
+
+`name` is a string. Call `config.profiles.list()` for a list of valid profile names.
+`options` an object that might contain the following values:
+  - `dryRun` is a boolean which if true does not apply the profile
+`callback` must follow the `function (err, result) {}` signature, where `err` is an error if the operation was not successful.
+
+If no callback is passed, a [promise][] is returned
+
+**Example:**
+
+```JavaScript
+ipfs.config.profiles.apply('lowpower', (err, diff) => {
+  if (err) {
+    throw err
+  }
+
+  console.info(diff.old)
+  console.info(diff.new)
+})
+```
+
+Note that you will need to restart your node for config changes to take effect.
+
+A great source of [examples][] can be found in the tests for this API.
+
 [promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
 [examples]: https://github.com./ipfs/interface-ipfs-core/blob/master/src/config

src/config/index.js

@@ -5,7 +5,7 @@ const tests = {
   get: require('./get'),
   set: require('./set'),
   replace: require('./replace'),
-  profile: require('./profile')
+  profiles: require('./profiles')
 }
 
 module.exports = createSuite(tests)

src/config/profile.js

@@ -0,0 +1,49 @@
+/* eslint-env mocha */
+'use strict'
+
+const { getDescribe, getIt, expect } = require('../../utils/mocha')
+const waterfall = require('async/waterfall')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.config.profiles.apply', function () {
+    this.timeout(30 * 1000)
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should apply a config profile', (done) => {
+      let diff
+      waterfall([
+        (cb) => ipfs.config.profiles.apply('lowpower', cb),
+        (_diff, cb) => {
+          diff = _diff
+          expect(diff.old.Swarm.ConnMgr.LowWater).to.not.equal(diff.new.Swarm.ConnMgr.LowWater)
+          ipfs.config.get(cb)
+        },
+        (newConfig, cb) => {
+          expect(newConfig.Swarm.ConnMgr.LowWater).to.equal(diff.new.Swarm.ConnMgr.LowWater)
+          cb()
+        }
+      ], done)
+    })
+  })
+}

src/config/profiles/apply.js

@@ -0,0 +1,9 @@
+'use strict'
+const { createSuite } = require('../../utils/suite')
+
+const tests = {
+  list: require('./list'),
+  apply: require('./apply')
+}
+
+module.exports = createSuite(tests)

src/config/profiles/index.js

@@ -0,0 +1,50 @@
+/* eslint-env mocha */
+'use strict'
+
+const { getDescribe, getIt, expect } = require('../../utils/mocha')
+const waterfall = require('async/waterfall')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.config.profiles.list', function () {
+    this.timeout(30 * 1000)
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should list config profiles', (done) => {
+      waterfall([
+        (cb) => ipfs.config.profiles.list(cb),
+        (profiles, cb) => {
+          expect(profiles).to.be.an('array')
+          expect(profiles).not.to.be.empty()
+
+          profiles.forEach(profile => {
+            expect(profile.name).to.be.a('string')
+            expect(profile.description).to.be.a('string')
+          })
+
+          cb()
+        }
+      ], done)
+    })
+  })
+}