fix detection of two part engine tooling commands (#60)

* fix detection of two part engine tooling commands

* fix busted tests

* add some tooling tests around engine scripts

* add some tooling tests around engine scripts part 2

* add some tooling tests around engine scripts part 3

Author: pirog

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v3.20.1 - [September 27, 2023](https://github.com/lando/core/releases/tag/3.20.1)
+
+### Fixes
+
+* Fixed bug where `tooling` commands using `app` bootstrap would use `/` instead of `appMount`
+
 ## v3.20.0 - [September 22, 2023](https://github.com/lando/core/releases/tag/3.20.0)
 
 ### New Features

examples/tooling/.lando.yml

@@ -124,6 +124,29 @@ tooling:
           message: What is the word?
           default: bird
           weight: 600
+  word-engine [word]:
+    service: :service
+    cmd: /app/word-engine.sh
+    level: engine
+    options:
+      service:
+        default: web
+        alias:
+          - s
+        describe: Runs in this service
+      random:
+        passthrough: true
+        alias:
+          - w
+        describe: Random number
+        interactive:
+          type: input
+          message: What is the random number?
+          default: 7
+          weight: 600
+  lonely-bird:
+    service: web
+    cmd: /app/word.sh
   dynamic:
     cmd: env
     service: :service
@@ -171,3 +194,12 @@ tooling:
         alias:
           - s
         describe: Runs in this service
+  'pwd-app [file]':
+    cmd: pwd
+    service: :container
+    options:
+      container:
+        default: node
+        alias:
+          - s
+        describe: Runs in this service

examples/tooling/README.md

@@ -46,13 +46,21 @@ lando notme --service l337-node | grep www-data
 lando test
 lando test2
 
-# Should be able to define and pass down options to a script
+# Should be able to define and pass down options and args to a script
 lando word --word bird | grep "bird is the word"
 lando word -w gird | grep "gird is the word"
 lando word --word "this is actually a phrase" | grep "this is actually a phrase"
 lando word --service l337-node --word bird | grep "bird is the word"
 lando word --service l337-node -w gird | grep "gird is the word"
 lando word --service l337-node --word "this is actually a phrase" | grep "this is actually a phrase"
+lando word-engine --random 1 | grep "bird is the word"
+lando word-engine bird --random 1 | grep "bird is the word"
+lando word-engine gird --random 1 | grep "gird is the word"
+lando word-engine "this is actually a phrase" --random 1 | grep "this is actually a phrase"
+lando word-engine --random 1 --service l337-node bird | grep "bird is the word"
+lando word-engine --random 1 --service l337-node gird | grep "gird is the word"
+lando word-engine --random 1 --service l337-node "this is actually a phrase" | grep "this is actually a phrase"
+lando lonely-bird
 
 # Should be able to run multiple commands on multiple services
 lando env
@@ -96,6 +104,10 @@ lando ssh --service node -c "pwd" | grep /app
 # Should use and track appMount by default
 lando pwd | grep /app
 cd folder && lando pwd | grep /app/folder && cd ..
+lando pwd-app | grep /app
+cd folder && lando pwd-app | grep /app/folder && cd ..
+lando pwd-app --container l337-node | grep /app
+cd folder && lando pwd-app --container l337-node | grep /app/folder && cd ..
 lando ssh -c "pwd" | grep /app
 cd folder && lando ssh -c "pwd" | grep /app/folder && cd ..
 lando pwd --service l337-node | grep /app
@@ -116,8 +128,6 @@ lando pwd --service l337-slim | grep /tmp
 
 # Should use first lando 3 service as default if no appserver
 lando ssh -c "env" | grep PRIMARY_SERVICE | grep yes
-
-
 ```
 
 Destroy tests

examples/tooling/word-engine.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# Set default opts
+WORD="bird"
+
+# PARSE THE ARGZZ
+# TODO: compress the mostly duplicate code below?
+while (( "$#" )); do
+  case "$1" in
+    --random|--random=*)
+      if [ "${1##--random=}" != "$1" ]; then
+        shift
+      else
+        shift 2
+      fi
+      ;;
+    --surprise)
+      echo "MUHAHAH! You've found a non explicitly declared option for this script which is going to give you an error!"
+      exit 666
+      ;;
+    --)
+      shift
+      break
+      ;;
+    -*|--*=)
+      echo "Error: Unsupported flag $1" >&2
+      exit 1
+      ;;
+    *)
+      WORD="$1"
+      shift
+      ;;
+  esac
+done
+
+# Demonstrate interactive option passthrough
+echo "$WORD, $WORD, $WORD the $WORD is the word!"

lib/bootstrap.js

@@ -12,6 +12,7 @@ const yaml = require('js-yaml');
  */
 const getBsLevel = (config, command) => {
   if (_.has(config, `tooling.${command}.level`)) return config.tooling[command].level;
+  else if (_.find(config.tooling, {id: command}).level) return _.find(config.tooling, {id: command}).level;
   else return (!fs.existsSync(config.composeCache)) ? 'app' : 'engine';
 };
 
@@ -66,7 +67,8 @@ const engineRunner = (config, command) => (argv, lando) => {
   // @NOTE: can we actually assume this will always find something? i **THINK** we catch upstream?
   const task = _.find(app.config.tooling, task => task.name === command);
   // get service, note this is not trivial because dynamic services are a thing
-  const service = task.service !== ':service' ? task.service : argv.service;
+
+  const service = !_.startsWith(task.service, ':') ? task.service : argv[_.trim(task.service, ':')];
   lando.log.debug('resolved tooling command %s service to %s', command, service);
 
   // ensure all v3 services have their appMount set to /app
@@ -269,18 +271,25 @@ exports.getTasks = (config = {}, argv = {}, tasks = []) => {
     config.tooling = _.merge({}, loadCacheFile(config.toolingCache), config.tooling);
   }
 
+  // lets add ids to help match commands with args?
+  _.forEach(config.tooling, (task, command) => {
+    task.id = task.id || command.split(' ')[0];
+  });
+
   // If the tooling command is being called lets assess whether we can get away with engine bootstrap level
-  const level = (_.includes(_.keys(config.tooling), argv._[0])) ? getBsLevel(config, argv._[0]) : 'app';
+  const ids = _.map(config.tooling, tooling => tooling.id);
+  const level = (_.includes(ids, argv._[0])) ? getBsLevel(config, argv._[0]) : 'app';
 
   // Load all the tasks, remember we need to remove "disabled" tasks (eg non-object tasks) here
   _.forEach(_.get(config, 'tooling', {}), (task, command) => {
     if (_.isObject(task)) {
       tasks.push({
         command,
+        id: command.split(' ')[0],
         level,
         describe: _.get(task, 'description', `Runs ${command} commands`),
         options: _.get(task, 'options', {}),
-        run: (level === 'app') ? appRunner(command) : engineRunner({...config, argv}, command),
+        run: (level === 'app') ? appRunner(command) : engineRunner({...config, argv}, command, task),
         delegate: _.isEmpty(_.get(task, 'options', {})),
       });
     }