feat(variables): support JSON input on stdin and files. fixes #150 (#153)

Author: justinedelson

README.md

@@ -381,6 +381,12 @@ OPTIONS
   -v, --variable=variable      variable values in KEY VALUE format
   -y, --yaml                   output in yaml format
 
+  --jsonFile=jsonFile          if set, read variables from a JSON array provided as a file; variables set through
+                               --variable or --secret flag will take precedence
+
+  --jsonStdin                  if set, read variables from a JSON array provided as standard input; variables set
+                               through --variable or --secret flag will take precedence
+
 ALIASES
   $ aio cloudmanager:set-environment-variables
 ```
@@ -592,6 +598,12 @@ OPTIONS
   -v, --variable=variable      variable values in KEY VALUE format
   -y, --yaml                   output in yaml format
 
+  --jsonFile=jsonFile          if set, read variables from a JSON array provided as a file; variables set through
+                               --variable or --secret flag will take precedence
+
+  --jsonStdin                  if set, read variables from a JSON array provided as standard input; variables set
+                               through --variable or --secret flag will take precedence
+
 ALIASES
   $ aio cloudmanager:set-pipeline-variables
 ```
@@ -703,6 +715,37 @@ ALIASES
 _See code: [src/commands/cloudmanager/program/list-pipelines.js](https://github.com/adobe/aio-cli-plugin-cloudmanager/blob/0.17.0/src/commands/cloudmanager/program/list-pipelines.js)_
 <!-- commandsstop -->
 
+# Variables From Standard Input
+
+The `environment:set-variables` and `pipeline:set-variables` commands allow for variables to be passed both as flags to the command and as a JSON array provided as standard input or as a file. The objects in this array are expected to have a `name`, `value`, and `type` keys following the same syntax as the Cloud Manager API. Deleting a variable can be done by passing an empty `value`. For example, given a file named `variables.json` that contains this:
+
+```
+[
+  {
+    "name" : "MY_VARIABLE",
+    "value" : "something",
+    "type" : "string"
+  },
+  {
+    "name" : "MY_SECRET_VARIABLE",
+    "value" : "shhhh",
+    "type" : "secretString"
+  }
+]
+```
+
+This can be passed to the `pipeline:set-variables` command using a shell command of
+
+```
+$ cat variables.json | aio cloudmanager:pipeline:set-variables 1 --jsonStdin
+```
+
+Or
+
+```
+$ aio cloudmanager:pipeline:set-variables 1 --jsonFile variables.json
+```
+
 # Development
 
 For development, it is useful to use `aio plugins:link` to link to a local clone of this repository rather than a specific npm module, e.g.

src/base-variables-command.js

@@ -10,11 +10,16 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+const { promisify } = require('util')
+const fs = require('fs')
+
 const { Command } = require('@oclif/command')
 const { cli } = require('cli-ux')
 const { flags } = require('@oclif/command')
 const { getProgramId, createKeyValueObjectFromFlag, getOutputFormat } = require('./cloudmanager-helpers')
 const commonFlags = require('./common-flags')
+const { getPipedData } = require('@adobe/aio-lib-core-config')
+const _ = require('lodash')
 
 class BaseVariablesCommand extends Command {
   outputTable (result, flags) {
@@ -34,7 +39,7 @@ class BaseVariablesCommand extends Command {
 
     const currentVariablesList = await this.getVariables(programId, args, flags.passphrase)
 
-    const variables = this.prepareVariableList(flags, currentVariablesList)
+    const variables = await this.prepareVariableList(flags, currentVariablesList)
 
     if (variables.length > 0) {
       cli.action.start('setting variables')
@@ -56,7 +61,7 @@ class BaseVariablesCommand extends Command {
     return result
   }
 
-  prepareVariableList (flags, currentVariablesList) {
+  async prepareVariableList (flags, currentVariablesList) {
     const currentVariableTypes = {}
     currentVariablesList.forEach(variable => (currentVariableTypes[variable.name] = variable.type))
 
@@ -97,8 +102,42 @@ class BaseVariablesCommand extends Command {
       })
     }
 
+    if (flags.jsonStdin) {
+      const rawStdinData = await getPipedData()
+      this.loadVariablesFromJson(rawStdinData, currentVariableTypes, variables)
+    } else if (flags.jsonFile) {
+      const getFileData = promisify(fs.readFile)
+      const rawFileData = await getFileData(flags.jsonFile)
+      this.loadVariablesFromJson(rawFileData, currentVariableTypes, variables)
+    }
+
     return variables
   }
+
+  loadVariablesFromJson (rawData, currentVariableTypes, variables) {
+    let data
+    try {
+      data = JSON.parse(rawData)
+    } catch (e) {
+      this.error('Unable to parse variables from provided data.')
+    }
+    if (!_.isArray(data)) {
+      this.error('Provided variables input was not an array.')
+    }
+    data.forEach(item => {
+      if (item.name && !_.isUndefined(item.value)) {
+        if (!item.type) {
+          item.type = 'string'
+        }
+        if (currentVariableTypes[item.name] && !item.value) {
+          item.type = currentVariableTypes[item.name]
+        }
+        if (!variables.find(variable => variable.name === item.name)) {
+          variables.push(item)
+        }
+      }
+    })
+  }
 }
 
 BaseVariablesCommand.setterFlags = {
@@ -117,6 +156,14 @@ BaseVariablesCommand.setterFlags = {
     description: 'variables/secrets to delete',
     multiple: true
   }),
+  jsonStdin: flags.boolean({
+    default: false,
+    description: 'if set, read variables from a JSON array provided as standard input; variables set through --variable or --secret flag will take precedence'
+  }),
+  jsonFile: flags.string({
+    description: 'if set, read variables from a JSON array provided as a file; variables set through --variable or --secret flag will take precedence',
+    exclusive: ['jsonStdin']
+  }),
   ...commonFlags.outputFormat
 }
 

test/__mocks__/@adobe/aio-lib-core-config.js

@@ -14,5 +14,6 @@ let mockStore = {}
 
 module.exports = {
   get: jest.fn(k => mockStore[k]),
-  setStore: (s) => (mockStore = s)
+  setStore: (s) => (mockStore = s),
+  getPipedData: jest.fn()
 }