update preview command to support -e key value env var assignments

Fixes #719

Author: starpit

app/plugins/modules/composer/lib/create-from-source.js

@@ -37,14 +37,31 @@ openwhiskComposer.wsk = {
     triggers: nope
 }
 
-const usage = cmd => `Usage: app ${cmd} </path/to/app-src.js>`
-
 const patterns = {
     require: /(const [^\s]+)\s*=\s*require\('@ibm-functions\/composer'\)/,
     constAppEquals: /.*const ([^\s]+)\s*=\s+composer(.*)/,
     return: /^return\s+/
 }
 
+/** override values in A with those from B, returning any overwritten values */
+const save = (A, B) => {
+    const overwritten = {}
+    for (let key in B) {
+        overwritten[key] = A[key]
+        A[key] = B[key]
+    }
+    return overwritten
+}
+
+/** restore values to A using values from B */
+const restore = (A, B) => {
+    for (let key in B) {
+        if (B[key]) {
+            A[key] = B[key]
+        }
+    }
+}
+
 /**
  * Take as input a file on disk that makes use of the
  * openwhisk-composer library, and return the corresponding FSM.
@@ -130,7 +147,7 @@ exports.compileToFSM = (src, opts={}) => new Promise((resolve, reject) => {
                     logMessage = ''
                     try {
                         const module = { exports: {},
-                                         process: { env: process.env, exit: doExit },
+                                         process: { env: opts.env || process.env, exit: doExit },
                                          console: { error: msg => errorMessage += msg + '\n',
                                                     log: doLog }
                                        },
@@ -150,6 +167,7 @@ exports.compileToFSM = (src, opts={}) => new Promise((resolve, reject) => {
                         if (typeof res === 'function') {
                             res = res()
                         }
+
                         if (isValidFSM(res)) {
                             return res
                         } else {
@@ -175,14 +193,19 @@ exports.compileToFSM = (src, opts={}) => new Promise((resolve, reject) => {
                         process.exit = doExit
                         try {
                             errorMessage = ''
-                            const json = eval(originalCode)
-                            if (isValidFSM(json)) {
-                                return json
-                            } else {
-                                const maybe = json
-                                console.log = log
-                                process.exit = exit
-                                return maybe
+                            const tmp = save(process.env, opts.env)
+                            try {
+                                const json = eval(originalCode)
+                                if (isValidFSM(json)) {
+                                    return json
+                                } else {
+                                    const maybe = json
+                                    console.log = log
+                                    process.exit = exit
+                                    return maybe
+                                }
+                            } finally {
+                                restore(process.env, tmp)
                             }
                         } catch (e2) {
                             console.log = log
@@ -198,10 +221,15 @@ exports.compileToFSM = (src, opts={}) => new Promise((resolve, reject) => {
                                     console.log = doLog
                                     process.exit = doExit
                                     errorMessage = ''
-                                    const composition = eval(bootstrapWithRequire(originalCode))
-                                    console.log = log
-                                    process.exit = exit
-                                    return composition
+                                    const tmp = save(process.env, opts.env)
+                                    try {
+                                        const composition = eval(bootstrapWithRequire(originalCode))
+                                        console.log = log
+                                        process.exit = exit
+                                        return composition
+                                    } finally {
+                                        restore(process.env, tmp)
+                                    }
 
                                 } catch (e4) {
                                     console.log = log

app/plugins/modules/composer/lib/usage.js

@@ -160,7 +160,8 @@ exports.preview = command => ({
     },
     oneof: [{ name: 'src.js', docs: 'generate a preview of a Composer source file', file: true },
             { name: 'src.json', docs: 'ibid, but for a pre-compiled composition', file: true }],
-    optional: [{ name: '--fsm', boolean: true, docs: 'validate and show raw FSM' } ],
+    optional: [{ name: '--fsm', boolean: true, docs: 'validate and show raw FSM' },
+               { name: '--env', alias: '-e', docs: 'Assign a value to an environment variable', narg: 2 }],
     sampleInputs: sampleInputs(command),
     parents: ['composer', { command: 'composer app' }],
     related: ['app create']

app/plugins/modules/composer/lib/viz.js

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+const debug = require('debug')('app preview')
+debug('loading')
+
 const { isValidFSM, wskflow, zoomToFitButtons, vizAndfsmViewModes, codeViewMode, handleError } = require('./composer'),
       badges = require('./badges'),
       { readFSMFromDisk, compileToFSM } = require('./create-from-source'),
@@ -35,7 +38,9 @@ const viewName = 'preview',               // for back button and sidecar header
  *
  */
 module.exports = (commandTree, prequire) => {
-     const render = (input, options) => new Promise((resolve, reject) => {
+    const render = (input, options) => new Promise((resolve, reject) => {
+         debug('options', options)
+
          let fsmPromise, type, extraModes=[]
 
          if (input.endsWith('.fsm') || input.endsWith('.json')) {
@@ -49,7 +54,7 @@ module.exports = (commandTree, prequire) => {
              }
          } else if (input.endsWith('.js')) {
              type = badges.composerLib
-             fsmPromise = compileToFSM(input, { code: true })
+             fsmPromise = compileToFSM(input, Object.assign({ code: true }, options))
              extraModes.push(codeViewMode)
 
          } else {
@@ -136,6 +141,22 @@ module.exports = (commandTree, prequire) => {
                  reject('The specified file does not exist')
              }
 
+             if (options.env) {
+                 debug('parsing environment variables from command line', options.env)
+
+                 const environment = {}
+                 for (let idx = 0; idx < options.env.length; idx += 2) {
+                     const key = options.env[idx],
+                           value = options.env[idx + 1]
+                     environment[key] = value
+                 }
+
+                 options.env = environment
+                 delete options.e
+
+                 debug('environment', environment)
+             }
+
              // render now
              render(input, options).then(resolve, reject)
 

tests/data/composer-source-expect-errors/addSubscription.js

@@ -0,0 +1,43 @@
+'use strict'
+
+const dbname = 'travis2slack'
+const cloudantBinding = process.env['CLOUDANT_PACKAGE_BINDING'];
+const slackConfig = {
+  token: process.env['SLACK_TOKEN'],
+  username: 'whiskbot',
+  url: 'https://slack.com/api/chat.postMessage'
+}
+
+if (slackConfig.token === undefined) {
+  console.error('SLACK_TOKEN required in environment.')
+  process.exit(-1)
+}
+
+if (cloudantBinding === undefined) {
+  console.error('CLOUDANT_PACKAGE_BINDING required in environment.')
+  process.exit(-1)
+}
+
+composer.let({ db: dbname, sc: slackConfig, userID: undefined, name: undefined },
+  composer.sequence(
+    `/whisk.system/utils/echo`,
+    p => { name = p.text; userID = p.user_id },
+    composer.try(
+      composer.sequence(
+        _ => ({ dbname: db, doc: { _id: name, display_name: name, userID: userID, onSuccess: true }, overwrite: false }),
+        `${cloudantBinding}/write`,
+        _ => ({ message: "Hi, " + name + ". I will now notify you when TravisCI jobs for your Apache OpenWhisk PRs complete." })
+      ),
+      // write failed.  Try to figure out why
+      composer.try(
+        composer.sequence(
+          p => ({ dbname: db, docid: name }),
+          `${cloudantBinding}/read-document`,
+          doc => ({ message: "I'm sorry, but <@" + doc.userID + "> is already subscribed to be notified for PRs by `" + name + "`" })
+        ),
+        _ => ({ message: "I'm sorry. There was an error updating Cloudant. Try again later." })
+      )
+    ),
+    p => Object.assign(sc, { channel: "@" + userID, text: p.message }),
+    `/whisk.system/slack/post`
+))

tests/lib/composer-viz-util.js

@@ -30,6 +30,7 @@ const input = (file, subdir='.') => ({
     path: path.join('data', subdir, file)
 })
 const composerInput = file => input(file, 'composer-source')
+const composerErrorInput = file => input(file, 'composer-source-expect-errors')
 
 /**
  * Verify that a node with the given action name exists on the canvas
@@ -38,8 +39,8 @@ const composerInput = file => input(file, 'composer-source')
 const verifyNodeExists = (name, isDeployed=false) => app => {
     const selector = `#wskflowSVG .node[data-name="/_/${name}"][data-deployed="${isDeployed ? 'deployed' : 'not-deployed'}"]`
     console.error(`CHECKING NODE ${name} ${selector}`)
-    return app.client.elements(selector)
-        .then(nodes => assert.equal(nodes.value.length, 1))
+    return app.client.waitUntil(() => app.client.elements(selector)
+                                .then(nodes => nodes.value.length === 1))
         .then(() => app)
 }
 const verifyNodeExistsById = id => app => {
@@ -93,6 +94,7 @@ const verifyTheBasicStuff = (file, badge) => _ => Promise.resolve(_)
 module.exports = {
     input,
     composerInput,
+    composerErrorInput,
     verifyNodeExists,
     verifyNodeExistsById,
     verifyEdgeExists,

tests/tests/passes/07/composer-viz.js

@@ -24,6 +24,7 @@ const fs = require('fs'),
       {
           input,
           composerInput,
+          composerErrorInput,
           verifyNodeExists,
           verifyNodeExistsById,
           verifyEdgeExists,
@@ -44,7 +45,8 @@ const fsm = input('fsm.json'), fsmStruct = JSON.parse(fs.readFileSync(fsm.path).
       whileSeq = composerInput('while-seq.js'),
       retry5Times = composerInput('retry-5-times.js'),
       demo = composerInput('demo.js'),
-      demoRetain = composerInput('demo-retain.js')
+      demoRetain = composerInput('demo-retain.js'),
+      addSubscription = composerErrorInput('addSubscription.js')
 
 /**
  * Here starts the test
@@ -222,4 +224,20 @@ describe('show the composer visualization without creating openwhisk assets', fu
        .then(verifyEdgeExists('TripleAndIncrement', 'DivideByTwo'))
        .then(verifyOutgoingEdgeExists('DivideByTwo'))
        .catch(common.oops(this)))
+
+    it(`fail to show visualization for addSubscription without -e for env var assignment`, () => cli.do(`preview ${addSubscription.path}`, this.app)
+       .then(cli.expectError(0, 'SLACK_TOKEN required in environment'))
+       .catch(common.oops(this)))
+
+    it(`fail to show visualization for addSubscription with partial -e for env var assignment`, () => cli.do(`preview ${addSubscription.path} -e SLACK_TOKEN yo`, this.app)
+       .then(cli.expectError(0, 'CLOUDANT_PACKAGE_BINDING required in environment'))
+       .catch(common.oops(this)))
+
+    it(`show visualization for addSubscription using -e for env var assignment`, () => cli.do(`preview ${addSubscription.path} -e SLACK_TOKEN yo -e CLOUDANT_PACKAGE_BINDING mo`, this.app)
+       .then(verifyTheBasicStuff(addSubscription.file, 'composerLib'))
+       .then(verifyNodeExists('write'))
+       .then(verifyNodeExists('read-document'))
+       //.then(verifyNodeExists('post'))
+       //.then(verifyEdgeExists('post', 'Exit'))
+       .catch(common.oops(this)))
 })