Pipeline support (#26)

* bump mock-fs vesrion

* add experimental support for pipelines

* fix app flag

* refactor, add push support

* fix bug

* fix bug, update header & README

.gitignore

@@ -37,4 +37,4 @@ jspm_packages
 # Optional REPL history
 .node_repl_history
 .vscode
-yarn.lock
+

README.md

@@ -24,8 +24,10 @@ You can install the package by running
 
 This package includes two commands:
 
-* `heroku config:pull`: Writes the contents of `heroku config` into a local file
-* `heroku config:push`: Writes the contents of a local file into `heroku config`
+- `heroku config:pull`: Writes the contents of `heroku config` into a local file
+- `heroku config:push`: Writes the contents of a local file into `heroku config`
+
+As of version 1.6.0, the `heroku-config` supports modifying pipeline config variables with the `--pipelie-name` and `--pipeline-stage` flags.
 
 Run `heroku help config:pull` and `heroku help config:push` to see a full list of flags.
 

commands/pull.js

@@ -6,12 +6,20 @@ const _ = require('lodash')
 
 const merge = require('../util/merge')
 const file = require('../util/file')
+const { shared: sharedFlags, pipelineFlagsAreValid, buildPullUrl } = require('../util/flags')
 
 // eslint-disable-next-line generator-star-spacing, space-before-function-paren
 function* pull(context, heroku) {
   let fname = context.flags.file // this gets defaulted in read
+
+  if (!pipelineFlagsAreValid(context.flags)){
+    cli.exit(1, 'If you specify either `pipeline-name` or `pipeline-stage`, specify them both.')
+  }
+
+  const pullUrl = yield buildPullUrl(context, heroku, cli)
+
   let config = yield {
-    remote: heroku.get(`/apps/${context.app}/config-vars`),
+    remote: heroku.get(pullUrl),
     local: file.read(fname, context.flags)
   }
   let res = merge(config.remote, config.local, context.flags)
@@ -33,7 +41,7 @@ function* pull(context, heroku) {
 
 module.exports = (() => {
   let flags = [
-    ...require('../util/flags'),
+    ...sharedFlags,
     {
       name: 'unquoted',
       char: 'u',
@@ -47,9 +55,12 @@ module.exports = (() => {
     description: 'pull env variables from heroku',
     help:
       'Write remote config vars into file FILE, favoring existing local configs in case of collision',
-    needsApp: true,
+    // doesn't seem to be documented anywhere, but this works
+    // no clue where it plugs into the CLI now, but I found it here:
+    // https://github.com/heroku/cli-engine/blob/5004250bd03c0b38e6e33e69ee962a3b50274b20/src/plugins/legacy.ts#L169
+    wantsApp: true,
     needsAuth: true,
     run: cli.command(co.wrap(pull)),
-    flags: flags
+    flags
   }
 })()

commands/push.js

@@ -5,11 +5,12 @@ const co = require('co')
 const merge = require('../util/merge')
 const file = require('../util/file')
 const _ = require('lodash')
+const { shared: sharedFlags, pipelineFlagsAreValid, buildPullUrl } = require('../util/flags')
 
 // eslint-disable-next-line generator-star-spacing, space-before-function-paren
-function* patchConfig(context, heroku, payload, success) {
+function* patchConfig(context, heroku, payload, success, url) {
   try {
-    yield heroku.patch(`/apps/${context.app}/config-vars`, { body: payload })
+    yield heroku.patch(url, { body: payload })
     if (!context.flags.quiet) {
       cli.log(success)
     }
@@ -21,8 +22,15 @@ function* patchConfig(context, heroku, payload, success) {
 // eslint-disable-next-line generator-star-spacing, space-before-function-paren
 function* push(context, heroku) {
   let fname = context.flags.file // this gets defaulted in read
+
+  if (!pipelineFlagsAreValid(context.flags)){
+    cli.exit(1, 'If you specify either `pipeline-name` or `pipeline-stage`, specify them both.')
+  }
+
+  const pullUrl = yield buildPullUrl(context, heroku, cli)
+
   let config = yield {
-    remote: heroku.get(`/apps/${context.app}/config-vars`),
+    remote: heroku.get(pullUrl),
     local: file.read(fname, context.flags)
   }
 
@@ -31,7 +39,8 @@ function* push(context, heroku) {
     context,
     heroku,
     res,
-    'Successfully wrote settings to Heroku!'
+    'Successfully wrote settings to Heroku!',
+    pullUrl
   )
 
   if (context.flags.clean) {
@@ -53,7 +62,7 @@ function* push(context, heroku) {
 
 module.exports = (() => {
   let flags = [
-    ...require('../util/flags'),
+    ...sharedFlags,
     {
       name: 'clean',
       char: 'c',
@@ -71,6 +80,6 @@ module.exports = (() => {
     needsApp: true,
     needsAuth: true,
     run: cli.command(co.wrap(push)),
-    flags: flags
+    flags
   }
 })()

package.json

@@ -1,10 +1,10 @@
 {
   "name": "heroku-config",
-  "version": "1.5.4",
+  "version": "1.6.0",
   "description": "Push and pull environment variables from a Heroku instance",
   "main": "index.js",
   "scripts": {
-    "test": "mocha && standard",
+    "test": "mocha",
     "deploy": "npx np"
   },
   "repository": {
@@ -23,14 +23,14 @@
   "dependencies": {
     "fs-extra": "8.1.0",
     "heroku-cli-util": "6.2.12",
-    "lodash": "4.17.15"
+    "lodash": "4.17.21"
   },
   "devDependencies": {
     "chai": "^3.5.0",
     "chai-as-promised": "^6.0.0",
     "js-yaml": "^3.6.1",
     "mocha": "^5.1.1",
-    "mock-fs": "^4.0.0",
+    "mock-fs": "5.1.2",
     "mock-stdin": "^0.3.0",
     "nock": "^9.0.0",
     "rewire": "^2.5.1",

util/file.js

@@ -6,7 +6,7 @@ const cli = require('heroku-cli-util')
 const HOME_DIR = require('os').homedir()
 
 const DEFAULT_FNAME = '.env'
-const header = '# this file was created automatically by heroku-config\n\n'
+const header = '# this file was created automatically by https://github.com/xavdid/heroku-config/\n\n'
 
 const objToFileFormat = (obj, flags = {}) => {
   let res = `${header}`

util/flags.js

@@ -1,21 +1,70 @@
 // command line args
 
-module.exports = [
-  {
-    name: 'file',
-    char: 'f',
-    hasValue: true,
-    description: 'specify target filename'
+module.exports = {
+  shared: [
+    {
+      name: 'file',
+      char: 'f',
+      hasValue: true,
+      description: 'specify target filename',
+    },
+    {
+      name: 'overwrite',
+      char: 'o',
+      description: 'overwrite destination config vars',
+    },
+    { name: 'quiet', char: 'q', description: 'supress all non-error output' },
+    {
+      name: 'expanded',
+      char: 'e',
+      description: 'allow non-standard characters in variable names',
+    },
+    {
+      name: 'pipeline-name',
+      description:
+        'pull or push the configuration of a specific pipeline. If provided, must also specify pipeline-stage',
+      hasValue: true,
+    },
+    {
+      name: 'pipeline-stage',
+      description:
+        'pull or push the configuration of a specific pipeline. If provided, must also specify pipeline-name',
+      hasValue: true,
+    },
+  ],
+  pipelineFlagsAreValid: (flags) => {
+    const pipelineName = flags['pipeline-name']
+    const pipelineStage = flags['pipeline-stage']
+
+    if ((pipelineName || pipelineStage) && !(pipelineName && pipelineStage)) {
+      return false
+    }
+    return true
   },
-  {
-    name: 'overwrite',
-    char: 'o',
-    description: 'overwrite destination config vars'
+  buildPullUrl: async (context, heroku, cli) => {
+    const pipelineName = context.flags['pipeline-name']
+    const pipelineStage = context.flags['pipeline-stage']
+
+    let pullUrl
+
+    if (pipelineName) {
+      let pipelineData
+      try {
+        pipelineData = await heroku.get(`/pipelines/${pipelineName}`)
+      } catch (err) {
+        cli.error('problem fetching pipeline info')
+        cli.exit(1, String(err))
+      }
+      pullUrl = `/pipelines/${pipelineData.id}/stage/${pipelineStage}/config-vars`
+    } else {
+      if (!context.app) {
+        cli.exit(
+          1,
+          'Must specify `--app` parameter, or `--pipeline-name` and `--pipeline-stage`'
+        )
+      }
+      pullUrl = `/apps/${context.app}/config-vars`
+    }
+    return pullUrl
   },
-  { name: 'quiet', char: 'q', description: 'supress all non-error output' },
-  {
-    name: 'expanded',
-    char: 'e',
-    description: 'allow non-standard characters in variable names'
-  }
-]
+}