added support for option variable in the serverless YAML parsing

Author: Ben Gowers

src/guardian/index.js

@@ -12,7 +12,7 @@ import {
   getStackResources,
   getLambdaFunctions,
 } from "../services";
-import Serverless from "../services/serverless";
+import ServerlessConfigParser from "../services/serverlessConfigParser";
 
 const infoLog = chalk.greenBright;
 const titleLog = chalk.greenBright.underline.bold;
@@ -57,7 +57,7 @@ class GuardianCI {
       this.ignoreConfig = this.config.ignore;
     }
 
-    this.SLS = new Serverless(program.location);
+    this.SLS = new ServerlessConfigParser(program.location);
   }
 
   async getAllLambdaFunctions() {

src/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import Serverless from "./services/serverless";
+import ServerlessConfigParser from "./services/serverlessConfigParser";
 import GuardianCI from "./guardian/index";
 import Main from "./CLIMain";
 
@@ -33,11 +33,11 @@ program
   .option("--sam", "use the SAM framework to execute commands")
   .option("-c, --ci", "ci mode for sls-dev-guardian checks")
   .option("--mfa <mfa>", "mfa token for profiles with mfa authentication")
-  .ignoreUnknownOptions()
+  .allowUnknownOption()
   .parse(process.argv);
 
 program.location = program.location || process.cwd();
-const SLS = new Serverless(program);
+const SLS = new ServerlessConfigParser(program);
 if (!program.stage) {
   program.stage = SLS.getStage();
 }

src/services/serverless.js src/services/serverlessConfigParser.js

@@ -1,27 +1,29 @@
 import transformArgsToDict from "../utils/transformArgsToDict";
+import replaceVariablesInYml from "../utils/replaceVariablesInYml";
 
 const fs = require("fs");
 const path = require("path");
 const YAML = require("js-yaml");
 
-class Serverless {
+class ServerlessConfigParser {
   constructor(program) {
-    const { argv, location } = program;
-    const options = transformArgsToDict(argv);
+    const { args, location } = program;
+    const options = transformArgsToDict(args);
     const ymlPath = path.join(location, "serverless.yml");
     const yamlPath = path.join(location, "serverless.yaml");
     const jsonPath = path.join(location, "serverless.json");
 
     if (fs.existsSync(ymlPath)) {
       this.config = YAML.load(fs.readFileSync(ymlPath).toString("utf8"));
-      return;
     }
     if (fs.existsSync(yamlPath)) {
       this.config = YAML.load(fs.readFileSync(yamlPath).toString("utf8"));
     }
     if (fs.existsSync(jsonPath)) {
       this.config = JSON.parse(fs.readFileSync(jsonPath).toString("utf8"));
     }
+
+    replaceVariablesInYml(this.config, options);
   }
 
   getFunctionConfig(functionName) {
@@ -95,4 +97,4 @@ class Serverless {
   }
 }
 
-export default Serverless;
+export default ServerlessConfigParser;

src/utils/replaceVariablesInYml.js

@@ -0,0 +1,17 @@
+const replaceVariablesInYml = (config, cmdOptions) => {
+  const optRegex = /\$\{opt:.*\}/;
+
+  if (config.service.name.match(optRegex)) {
+    let variable = config.service.name.match(optRegex)[0];
+
+    variable = variable.replace(/[${}]/g, "");
+    const varName = variable.split(":")[1];
+
+    config.service.name = config.service.name.replace(
+      /\$\{opt:.*\}/,
+      cmdOptions[varName]
+    );
+  }
+};
+
+export default replaceVariablesInYml;

src/utils/transformArgsToDict.js

@@ -0,0 +1,12 @@
+const tranformArgsToDict = (args) => {
+  const options = {};
+
+  for (let i = 0; i < args.length; i += 2) {
+    const key = args[i].replace(/^-+/, "");
+    options[key] = args[i + 1];
+  }
+
+  return options;
+};
+
+export default tranformArgsToDict;