@automattic/vip 4.1.4 → 4.1.6

package/node_modules/lando/plugins/lando-tooling/lib/utils.js

@@ -7,8 +7,11 @@ const escape = require('./../../../lib/utils').shellEscape;
 const getUser = require('./../../../lib/utils').getUser;
 const getCliEnvironment = require('./../../../lib/utils').getCliEnvironment;
 
-/*
- * Build docker exec opts
+/**
+ * Builds docker exec argv for a tooling task.
+ * @param {string} docker Docker executable path.
+ * @param {object} datum Engine task data.
+ * @returns {string[]} Docker exec argv.
  */
 const getExecOpts = (docker, datum) => {
   const exec = [docker, 'exec'];
@@ -30,8 +33,11 @@ const getExecOpts = (docker, datum) => {
   return exec;
 };
 
-/*
- * Helper to get dynamic service keys for stripping
+/**
+ * Finds argv switches that correspond to a selected dynamic service answer.
+ * @param {string} answer Selected answer.
+ * @param {object} [answers] All interactive answers.
+ * @returns {string[]} Arg keys that should be stripped from passthrough argv.
  */
 const getDynamicKeys = (answer, answers = {}) => _(answers)
     .map((value, key) => ({key, value}))
@@ -40,11 +46,12 @@ const getDynamicKeys = (answer, answers = {}) => _(answers)
     .map(key => (_.size(key) === 1) ? `-${key}` : `--${key}`)
     .value();
 
-/*
- * Helper to handle dynamic services
- *
- * Set SERVICE from answers and strip out that noise from the rest of
- * stuff, check answers/argv for --service or -s, validate and then remove
+/**
+ * Resolves dynamic service placeholders from interactive answers.
+ * @param {object} config Tooling config.
+ * @param {object} [options] Tooling option metadata.
+ * @param {object} [answers] Interactive answers.
+ * @returns {object} Updated tooling config.
  */
 const handleDynamic = (config, options = {}, answers = {}) => {
   if (_.startsWith(config.service, ':')) {
@@ -58,12 +65,11 @@ const handleDynamic = (config, options = {}, answers = {}) => {
   }
 };
 
-/*
- * Helper to process args
- *
- * We assume pass through commands so let's use argv directly and strip out
- * the first three assuming they are [node, lando.js, options.name]'
- * Check to see if we have global lando opts and remove them if we do
+/**
+ * Appends passthrough argv to a tooling config.
+ * @param {object} config Tooling config.
+ * @param {string[]} [argopts] Explicit passthrough args.
+ * @returns {object} Updated tooling config.
  */
 const handleOpts = (config, argopts = []) => {
   // Append any user specificed opts
@@ -74,8 +80,11 @@ const handleOpts = (config, argopts = []) => {
   return _.merge({}, config, {args: argopts});
 };
 
-/*
- * Helper to get passthru options
+/**
+ * Converts passthrough options into argv fragments.
+ * @param {object} [options] Tooling option metadata.
+ * @param {object} [answers] Interactive answers.
+ * @returns {string[]} Passthrough argv fragments.
  */
 const handlePassthruOpts = (options = {}, answers = {}) => _(options)
     .map((value, key) => _.merge({}, {name: key}, value))
@@ -83,16 +92,26 @@ const handlePassthruOpts = (options = {}, answers = {}) => _(options)
     .map(value => `--${value.name}=${answers[value.name]}`)
     .value();
 
-/*
- * Helper to convert a command into config object
+/**
+ * Normalizes a tooling command into a config object.
+ * @param {string|object} cmd Tooling command definition.
+ * @param {string} service Default service name.
+ * @returns {{command: string|string[], service: string}} Normalized command config.
  */
 const parseCommand = (cmd, service) => ({
   command: (_.isObject(cmd)) ? cmd[_.first(_.keys(cmd))] : cmd,
   service: (_.isObject(cmd)) ? _.first(_.keys(cmd)) : service,
 });
 
-/*
- * Helper to build commands
+/**
+ * Builds an engine run task for a tooling command.
+ * @param {import('../../../lib/app')} app App instance.
+ * @param {string|string[]} command Tooling command.
+ * @param {string} service Service name.
+ * @param {string|null} user User override.
+ * @param {object} [env] Extra environment variables.
+ * @param {string} [dir] Working directory override.
+ * @returns {object} Engine run task.
  */
 exports.buildCommand = (app, command, service, user, env = {}, dir = undefined) => ({
   id: app.getServiceContainerId(service),
@@ -110,8 +129,12 @@ exports.buildCommand = (app, command, service, user, env = {}, dir = undefined)
   },
 });
 
-/*
- * Helper to build docker exec command
+/**
+ * Runs a docker exec command for a tooling task.
+ * @param {import('../../../lib/app')|import('../../../lib/lando')} injected App or lando runtime object.
+ * @param {Array<string|null>} stdio stdio configuration.
+ * @param {object} [datum] Engine task data.
+ * @returns {Promise} Promise for the shell execution.
  */
 exports.dockerExec = (injected, stdio, datum = {}) => {
   // Depending on whether injected is the app or lando
@@ -121,16 +144,24 @@ exports.dockerExec = (injected, stdio, datum = {}) => {
   return injected.shell.sh(getExecOpts(dockerBin, datum).concat(datum.cmd), opts);
 };
 
-/*
- * Helper to get tts
+/**
+ * Normalizes tooling task config into task metadata.
+ * @param {object} config Tooling config keyed by task name.
+ * @param {import('../../../lib/app')} app App instance.
+ * @returns {object[]} Tooling tasks.
  */
 exports.getToolingTasks = (config, app) => _(config)
     .map((task, name) => _.merge({}, task, {app, name}))
     .filter(task => _.isObject(task))
     .value();
 
-/*
- * Helper to parse tooling config options
+/**
+ * Resolves tooling config into executable command configs.
+ * @param {Array<string|object>} cmd Tooling commands.
+ * @param {string} service Default service name.
+ * @param {object} [options] Tooling option metadata.
+ * @param {object} [answers] Interactive answers.
+ * @returns {object[]} Parsed tooling command configs.
  */
 exports.parseConfig = (cmd, service, options = {}, answers = {}) => _(cmd)
 // Put into an object so we can handle "multi-service" tooling
@@ -146,30 +177,35 @@ exports.parseConfig = (cmd, service, options = {}, answers = {}) => _(cmd)
 // Put into an object
     .value();
 
-/*
- * Helper to get defaults
+/**
+ * Builds default metadata for a tooling definition.
+ * @param {object} [options] Tooling definition overrides.
+ * @returns {object} Tooling defaults.
  */
-exports.toolingDefaults = ({
-  name,
-  app = {},
-  cmd = name,
-  dir,
-  description = `Runs ${name} commands`,
-  env = {},
-  options = {},
-  service = '',
-  stdio = ['inherit', 'pipe', 'pipe'],
-  user = null,
-} = {}) =>
-  ({
+exports.toolingDefaults = (options = {}) => {
+  const {
     name,
-    app: app,
+    app = {},
+    cmd = name,
+    dir,
+    description = `Runs ${name} commands`,
+    env = {},
+    options: toolOptions = {},
+    service = '',
+    stdio = ['inherit', 'pipe', 'pipe'],
+    user = null,
+  } = options;
+
+  return {
+    name,
+    app,
     cmd: !_.isArray(cmd) ? [cmd] : cmd,
     dir,
     env,
     describe: description,
-    options: options,
-    service: service,
-    stdio: stdio,
+    options: toolOptions,
+    service,
+    stdio,
     user,
-  });
+  };
+};

package/node_modules/lando/test/cli.spec.js

@@ -9,8 +9,10 @@
 const _ = require('lodash');
 const chai = require('chai');
 const Cli = require('./../lib/cli');
+const {execFileSync} = require('child_process');
+const path = require('path');
 const sinon = require('sinon');
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 
 // Take task
@@ -28,21 +30,10 @@ const fakeTask = {
       alias: ['y'],
       default: false,
       boolean: true,
-      interactive: {
-        type: 'confirm',
-        default: false,
-        message: 'Are you ok?',
-      },
     },
     other: {
       describe: 'some other thing',
       string: true,
-      interactive: {
-        type: 'input',
-        message: 'what is it?',
-        default: 'nothing',
-        weight: 4,
-      },
     },
   },
   run: options => options,
@@ -72,16 +63,27 @@ describe('cli', () => {
   });
 
   describe('#argv', () => {
-    it('should be the same as yargs.argv', () => {
+    it('should return parsed CLI arguments', () => {
       const cli = new Cli();
-      cli.argv().should.deep.equal(require('yargs').argv);
+      cli.argv().should.be.an('object');
+      cli.argv()._.should.be.an('array');
     });
-  });
 
-  describe('#checkPerms', () => {
-    it('should be the same as sudoBlock', () => {
-      const cli = new Cli();
-      cli.checkPerms();
+    it('should parse command arguments and flags without handling help or version', () => {
+      const script = [
+        'process.argv = ["node", "lando", "task", "quoted value", "--clear", "-vvv", "--help", "--version"];',
+        'const Cli = require("./lib/cli");',
+        'const cli = new Cli();',
+        'console.log(JSON.stringify({argv: cli.argv(), logLevel: cli.defaultConfig().logLevelConsole}));',
+      ].join('\n');
+      const output = execFileSync(process.execPath, ['-e', script], {
+        cwd: path.resolve(__dirname, '..'),
+        encoding: 'utf8',
+      });
+      const {argv, logLevel} = JSON.parse(output);
+      argv._.should.deep.equal(['task', 'quoted value']);
+      argv.should.include({clear: true, v: 3, verbose: 3, help: true, version: true});
+      logLevel.should.equal(4);
     });
   });
 
@@ -133,10 +135,46 @@ describe('cli', () => {
   });
 
   describe('#run', () => {
-    it('should return a yargs cli', () => {
+    it('should return a yargs cli', async () => {
       const cli = new Cli();
       const task = cli.parseToYargs({command: 'task', describe: 'desc'});
-      cli.run([task]);
+      await cli.run([task]);
+    });
+
+    it('should show registered commands for global help without invoking a handler', () => {
+      const script = [
+        'process.argv = ["node", "lando", "--help"];',
+        'const Cli = require("./lib/cli");',
+        'const cli = new Cli();',
+        'cli.updateUserConfig = () => ({});',
+        'cli.run([{command: "task", describe: "Test command", handler: () => console.log("HANDLER_RAN")}]);',
+      ].join('\n');
+      const output = execFileSync(process.execPath, ['-e', script], {
+        cwd: path.resolve(__dirname, '..'),
+        encoding: 'utf8',
+      });
+      output.should.include('Test command');
+      output.should.include('--verbose');
+      output.should.not.include('HANDLER_RAN');
+    });
+  });
+
+  describe('#init', () => {
+    it('should await an async command handler and invoke it once', async () => {
+      const cli = new Cli();
+      const yargs = require('yargs/yargs')(['task', '-vvv']);
+      let calls = 0;
+      const task = {
+        command: 'task',
+        handler: async argv => {
+          await Promise.resolve();
+          calls += 1;
+          argv.verbose.should.equal(3);
+        },
+      };
+      const argv = await cli.init(yargs, [task], {}, {});
+      calls.should.equal(1);
+      argv._.should.deep.equal(['task']);
     });
   });
 });

package/node_modules/lando/test/docker.spec.js

@@ -10,7 +10,7 @@ const chai = require('chai');
 const expect = chai.expect;
 const filesystem = require('mock-fs');
 chai.should();
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 const sinon = require('sinon');
 const Landerode = require('./../lib/docker');
 const landerode = new Landerode();
@@ -19,6 +19,11 @@ const Dockerode = require('dockerode');
 const Promise = require('./../lib/promise');
 const _ = require('lodash');
 
+/**
+ * Builds a Dockerode container stub with overridable metadata.
+ * @param {object} [overrides] Fields to merge onto the stub container.
+ * @returns {object} Dockerode container test double.
+ */
 const dummyContainer = (overrides = {}) => {
   return _.assign(
       new Dockerode.Container(),
@@ -42,6 +47,8 @@ const dummyContainer = (overrides = {}) => {
 };
 
 describe('docker', () => {
+  afterEach(() => sinon.restore());
+
   describe('#Landerode', () => {
     it('should inherit things from Dockerode', () => {
       expect(Landerode.prototype).to.be.an.instanceOf(Dockerode);
@@ -51,11 +58,9 @@ describe('docker', () => {
   describe('#createNetwork', () => {
     it('should merge name correctly into opts', () => {
       const stub = sinon.stub(landerode, 'createNetwork')
-          .usingPromise(Promise)
-          .resolves();
+          .callsFake(() => Promise.resolve());
       return landerode.createNet('elthree', {}).then(() => {
-        // for some reason should/expect doesn't work here...
-        stub.calledWith({Name: 'elthree'});
+        sinon.assert.calledOnceWithExactly(stub, {Name: 'elthree', Attachable: true, Internal: true});
         stub.restore();
       });
     });
@@ -165,11 +170,10 @@ describe('docker', () => {
 
     it('should filter out any containers that are pending removal', () => {
       const listStub = sinon.stub(landerode, 'listContainers')
-          .usingPromise(Promise)
-          .resolves([
+          .callsFake(() => Promise.resolve([
             dummyContainer({Status: 'Being Awesome'}),
             dummyContainer({Status: 'Removal In Progress'}),
-          ]);
+          ]));
       return landerode.list()
           .should.eventually.be.an('Array').with.a.lengthOf(1)
           .then(() => {
@@ -179,11 +183,10 @@ describe('docker', () => {
 
     it('should remove any "null" containers', () => {
       const listStub = sinon.stub(landerode, 'listContainers')
-          .usingPromise(Promise)
-          .resolves([
+          .callsFake(() => Promise.resolve([
             null,
             dummyContainer({identity: 'Solo'}),
-          ]);
+          ]));
 
       return landerode.list()
           .should.eventually.be.an('Array').with.a.lengthOf(1)
@@ -194,11 +197,10 @@ describe('docker', () => {
 
     it('should filter out non-lando containers', () => {
       const listStub = sinon.stub(landerode, 'listContainers')
-          .usingPromise(Promise)
-          .resolves([
+          .callsFake(() => Promise.resolve([
             dummyContainer({Labels: {'io.lando.container': 'FALSE'}}),
             dummyContainer(),
-          ]);
+          ]));
 
       return landerode.list()
           .should.eventually.be.an('Array').with.a.lengthOf(1)
@@ -209,8 +211,7 @@ describe('docker', () => {
 
     it('should filter by app name if given', () => {
       const listStub = sinon.stub(landerode, 'listContainers')
-          .usingPromise(Promise)
-          .resolves([
+          .callsFake(() => Promise.resolve([
             dummyContainer({Labels: {
               'com.docker.compose.project': 'alderaan',
               'com.docker.compose.service': 'Rescue Mission',
@@ -222,7 +223,7 @@ describe('docker', () => {
               'io.lando.src': '/tmp/.lando.yml',
             }}),
             dummyContainer(),
-          ]);
+          ]));
 
       return landerode.list({app: 'alderaan'})
           .should.eventually.be.an('Array').with.a.lengthOf(1)
@@ -231,14 +232,10 @@ describe('docker', () => {
           });
     });
 
-    it('should throw an error on all other catches', () => {
-      const container = dummyContainer();
-      delete container.lando;
-      const listStub = sinon.stub(landerode, 'listContainers').resolves([container]);
-
-      const fail = () => landerode.list();
-      expect(fail).to.throw();
-      return listStub.restore();
+    it('should reject when listing containers fails', () => {
+      sinon.stub(landerode, 'listContainers')
+          .callsFake(() => Promise.reject(new Error('Docker list failed')));
+      return landerode.list().should.be.rejectedWith('Docker list failed');
     });
 
     afterEach(() => {
@@ -252,10 +249,9 @@ describe('docker', () => {
 
       const getStub = sinon.stub(landerode, 'getContainer').returns(container);
       const removeStub = sinon.stub(container, 'remove')
-          .usingPromise(Promise)
-          .rejects('Oh No!');
+          .callsFake(() => Promise.reject(new Error('Oh No!')));
 
-      landerode.remove('1234').should.be.rejectedWith('Oh No!')
+      return landerode.remove('1234').should.be.rejectedWith('Oh No!')
           .then(() => {
             getStub.restore();
             removeStub.restore();

package/node_modules/lando/test/env.spec.js

@@ -17,9 +17,17 @@ chai.should();
 const originalPlatform = process.platform;
 
 // Helpers to manage process.platform hijacking
+/**
+ * Overrides `process.platform` for a test case.
+ * @param {string} platform Platform name to inject.
+ */
 const setPlatform = platform => {
   Object.defineProperty(process, 'platform', {value: platform});
 };
+
+/**
+ * Restores the original `process.platform` value after a test.
+ */
 const resetPlatform = () => {
   Object.defineProperty(process, 'platform', {value: originalPlatform});
 };

package/node_modules/lando/test/error.spec.js

@@ -10,7 +10,7 @@ const ErrorHandler = require('./../lib/error');
 const EventEmitter = require('events').EventEmitter;
 const sinon = require('sinon');
 chai.should();
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 
 describe('error', () => {
   describe('#ErrorHandler', () => {

package/node_modules/lando/test/events.spec.js

@@ -8,8 +8,6 @@
 const _ = require('lodash');
 const chai = require('chai');
 const sinon = require('sinon');
-const sinonChai = require('sinon-chai');
-chai.use(sinonChai);
 chai.should();
 
 const AsyncEvents = require('../lib/events');
@@ -53,10 +51,11 @@ describe('events', () => {
       events.on('event', 4, before);
       events.on('event', middle);
       events.on('event', 6, after);
-      events.emit('event').then(() => {
-        before.should.be.calledBefore(middle);
-        middle.should.be.calledBefore(after);
-        after.should.be.calledAfter(middle);
+      return events.emit('event').then(() => {
+        sinon.assert.calledOnce(before);
+        sinon.assert.calledOnce(middle);
+        sinon.assert.calledOnce(after);
+        sinon.assert.callOrder(before, middle, after);
       });
     });
   });
@@ -74,7 +73,7 @@ describe('events', () => {
         data.maneuver.should.equal('little');
         data.should.not.be.empty;
       });
-      events.emit('battle-of-tanaab', data);
+      return events.emit('battle-of-tanaab', data);
     });
   });
 });

package/node_modules/lando/test/lando.spec.js

@@ -12,7 +12,7 @@ const fs = require('fs');
 const os = require('os');
 const path = require('path');
 const Lando = require('./../lib/lando');
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 
 // This is the file we are testing

package/node_modules/lando/test/plugins.spec.js

@@ -9,16 +9,15 @@
 const _ = require('lodash');
 const chai = require('chai');
 const sinon = require('sinon');
-const fs = require('fs');
 const expect = chai.expect;
 const filesystem = require('mock-fs');
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 const os = require('os');
 const path = require('path');
 const Plugins = require('./../lib/plugins');
 
-const testPlugin = fs.readFileSync(path.resolve(__dirname, '..', 'plugins', 'lando-test', 'index.js'), 'utf8');
+const testPlugin = `module.exports = injected => ({'plugin-test': true});`;
 const searchDirs = [
   path.join(os.tmpdir(), 'dir1'),
   path.join(os.tmpdir(), 'dir2'),

package/node_modules/lando/test/promise.spec.js

@@ -8,7 +8,7 @@
 const _ = require('lodash');
 const chai = require('chai');
 const sinon = require('sinon');
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 
 // eslint-disable-next-line no-redeclare

package/node_modules/lando/test/scan.spec.js

@@ -11,7 +11,7 @@ const chai = require('chai');
 const sinon = require('sinon');
 // eslint-disable-next-line no-redeclare
 const Promise = require('./../lib/promise');
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 
 describe('scan', () => {

package/node_modules/lando/test/shell.spec.js

@@ -15,16 +15,27 @@ const os = require('os');
 const path = require('path');
 const sinon = require('sinon');
 const Shell = require('./../lib/shell');
-chai.use(require('sinon-chai'));
-chai.use(require('chai-as-promised'));
+chai.use(require('chai-as-promised').default);
 chai.should();
 
 // Return mock error code based on commands
+/**
+ * Returns a deterministic fake exit code for a command string.
+ * @param {string} cmd Command string under test.
+ * @returns {number} Zero for success-like commands, random non-zero for failures.
+ */
 const errorCode = cmd => {
   return !_.includes(cmd, 'bomb') ? 0 : _.random(1, 666);
 };
 
 // Fake Spawner
+/**
+ * Creates a fake `child_process.spawn()` result for shell tests.
+ * @param {string} cmd Command binary.
+ * @param {string[]} args Command arguments.
+ * @param {object} opts Spawn options.
+ * @returns {object} Spawn-like process stub.
+ */
 const fakeSpawn = (cmd, args, opts) => {
   const command = cmd + ' ' + args.join(' ');
   return {
@@ -41,6 +52,12 @@ const fakeSpawn = (cmd, args, opts) => {
 };
 
 // Fake execer
+/**
+ * Resolves a fake `shelljs.exec()` call for shell tests.
+ * @param {string} cmd Command string.
+ * @param {object} opts Exec options.
+ * @param {function(number, string, string): void} resolve Callback used by `shelljs.exec()`.
+ */
 const fakeExec = (cmd, opts, resolve) => {
   resolve(errorCode(cmd), 'EXEC: ' + cmd, '');
 };

package/node_modules/lando/test/utils.spec.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const expect = require('chai').expect;
+const utils = require('../lib/utils');
+const tooling = require('../plugins/lando-tooling/lib/utils');
+
+describe('utils', () => {
+  describe('#shellEscape', () => {
+    it('should parse string commands with quoted arguments when extra args are present', () => {
+      expect(utils.shellEscape('echo "hello world"', false, ['extra']))
+          .to.deep.equal(['echo', 'hello world']);
+    });
+
+    it('should preserve empty quoted arguments', () => {
+      expect(utils.shellEscape('echo ""', false, ['extra']))
+          .to.deep.equal(['echo', '']);
+    });
+
+    it('should keep adjacent quoted and unquoted segments in one argument', () => {
+      expect(utils.shellEscape('echo a" b" "a"b', false, ['extra']))
+          .to.deep.equal(['echo', 'a b', 'ab']);
+    });
+
+    it('should strip quotes inside option values', () => {
+      expect(utils.shellEscape('echo --name="Phil Taylor"', false, ['extra']))
+          .to.deep.equal(['echo', '--name=Phil Taylor']);
+    });
+
+    it('should wrap shell operators after parsing a string command', () => {
+      expect(utils.shellEscape('echo hello && echo world', true, ['extra']))
+          .to.deep.equal(['/bin/sh', '-c', 'echo hello && echo world']);
+    });
+
+    it('should preserve string commands without extra args for the shell', () => {
+      expect(utils.shellEscape('echo "hello world"', false, []))
+          .to.deep.equal(['/bin/sh', '-c', 'echo "hello world"']);
+    });
+  });
+
+  describe('tooling command parsing', () => {
+    it('should append CLI args to the parsed tooling command', () => {
+      const originalArgv = process.argv;
+      try {
+        process.argv = ['node', 'lando.js', 'say', 'extra'];
+        expect(tooling.parseConfig(['echo "hello world"'], 'appserver'))
+            .to.deep.equal([{service: 'appserver', args: ['extra'], command: ['echo', 'hello world', 'extra']}]);
+      } finally {
+        process.argv = originalArgv;
+      }
+    });
+  });
+});