added tests and refactored to handle multiple option variables within a stack name (from the serverless config file)

Ben Gowers · Ben Gowers · commit b511267476c0 · 2021-03-03T16:56:08.000Z
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -2,6 +2,7 @@ module.exports = {
   env: {
     node: true,
     es6: true,
+    "jest/globals": true,
   },
   extends: ["airbnb-base", "prettier"],
   globals: {
@@ -12,7 +13,7 @@ module.exports = {
     ecmaVersion: 2018,
     sourceType: "module",
   },
-  plugins: ["prettier"],
+  plugins: ["prettier", "jest"],
   rules: {
     "prettier/prettier": "error",
     quotes: ["error", "double"],
@@ -22,5 +23,11 @@ module.exports = {
     "no-new": "off",
     "import/named": "off",
     "import/no-cycle": "off",
+    // jest
+    "jest/no-disabled-tests": "warn",
+    "jest/no-focused-tests": "error",
+    "jest/no-identical-title": "error",
+    "jest/prefer-to-have-length": "warn",
+    "jest/valid-expect": "error",
   },
 };
diff --git a/__test__/util/serverlessConfigParser.test.js b/__test__/util/serverlessConfigParser.test.js
@@ -0,0 +1,215 @@
+import fs from "fs";
+
+import {
+  transformArgsToDict,
+  replaceStacknameOpt,
+  CYAN_STRING_FORMAT,
+} from "../../src/services/severlessConfigParser/helpers";
+import ServerlessConfigParser from "../../src/services/severlessConfigParser/serverlessConfigParser";
+
+const TEST_YAML_FILE = `
+service:
+  name: test-\${opt:testArg1}
+
+package:
+  exclude:
+    - .git/**
+    - .gitignore
+
+plugins:
+  - serverless-webpack
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+  region: eu-west-1
+  stage: \${opt:stage, 'dev'}
+  usagePlan:
+    quota:
+      limit: 5000
+      offset: 2
+      period: MONTH
+    throttle:
+      burstLimit: 200
+      rateLimit: 100
+  iamRoleStatements:
+    - Effect: Allow
+      Action:
+        - dynamodb:DescribeTable
+        - dynamodb:Query
+        - dynamodb:Scan
+        - dynamodb:GetItem
+        - dynamodb:PutItem
+        - dynamodb:UpdateItem
+        - dynamodb:DeleteItem
+      Resource:
+        - 'Fn::GetAtt': [Table, Arn]
+  environment:
+    tableName: \${self:custom.dynamodbTableName}
+
+functions:
+  hello:
+    handler: hello.main
+    memorySize: 1024
+    timeout: 6
+    events:
+      - http:
+          method: get
+          path: hello
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+  create:
+    handler: create.main
+    events:
+      - http:
+          method: post
+          path: items
+          cors: true
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+  list:
+    handler: list.main
+    events:
+      - http:
+          method: get
+          path: items
+          cors: true
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+  get:
+    handler: get.main
+    events:
+      - http:
+          method: get
+          path: items/{id}
+          cors: true
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+  update:
+    handler: update.main
+    events:
+      - http:
+          method: put
+          path: items/{id}
+          cors: true
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+  delete:
+    handler: delete.main
+    events:
+      - http:
+          method: delete
+          path: items/{id}
+          cors: true
+          authorizer:
+            type: COGNITO_USER_POOLS
+            authorizerId:
+              Ref: ApiGatewayAuthorizer
+`;
+
+// eslint-disable-next-line no-template-curly-in-string
+const STACK_NAME_WITH_OPT = "test-${opt:testArg1}";
+const STACK_NAME_WITHOUT_OPT = "test-backend";
+const CMD_VAR_1 = "--testArg1";
+const CMD_VAL_1 = "backend";
+const CMD_VAR_2 = "-testArg2";
+const CMD_VAL_2 = "arg2";
+const INVALID_ARGUMENT_EXIT_CODE = 9;
+
+jest.mock("fs");
+
+describe("Serverless Config Options", () => {
+  /*
+   * Transform Args
+   */
+  it("should transform 1 arg (double dash) to dict", () => {
+    const args = [CMD_VAR_1, CMD_VAL_1];
+    const result = { testArg1: CMD_VAL_1 };
+    expect(transformArgsToDict(args)).toStrictEqual(result);
+  });
+
+  it("should transform 1 arg (single dash) to dict", () => {
+    const args = [CMD_VAR_2, CMD_VAL_2];
+    const result = { testArg2: CMD_VAL_2 };
+    expect(transformArgsToDict(args)).toStrictEqual(result);
+  });
+
+  it("should not remove dashes from middle of option in service name", () => {
+    const args = ["--env-name", CMD_VAL_1];
+    const result = { "env-name": CMD_VAL_1 };
+    expect(transformArgsToDict(args)).toStrictEqual(result);
+  });
+
+  it("should transform multiple args (mixed dash) to dict", () => {
+    const args = [CMD_VAR_1, CMD_VAL_1, CMD_VAR_2, CMD_VAL_2];
+    const result = {
+      testArg1: CMD_VAL_1,
+      testArg2: CMD_VAL_2,
+    };
+    expect(transformArgsToDict(args)).toStrictEqual(result);
+  });
+
+  /*
+   * Replace service.name Opt
+   */
+  it("should replace the service name option with stored option", () => {
+    const testOptions = { testArg1: CMD_VAL_1 };
+    expect(replaceStacknameOpt(STACK_NAME_WITH_OPT, testOptions)).toBe(
+      STACK_NAME_WITHOUT_OPT
+    );
+  });
+
+  it("should not replace the stack name where there is not opt variable in the YAML configuration file", () => {
+    const testOptions = { testArg1: CMD_VAL_1 };
+    expect(replaceStacknameOpt(STACK_NAME_WITHOUT_OPT, testOptions)).toBe(
+      STACK_NAME_WITHOUT_OPT
+    );
+  });
+
+  it("should output an error message when an opt varibale exists in serverless configuration but no option is passed", () => {
+    console.error = jest.fn();
+    process.exit = jest.fn();
+    replaceStacknameOpt(STACK_NAME_WITH_OPT, []);
+
+    expect(console.error).toHaveBeenCalledWith(
+      CYAN_STRING_FORMAT,
+      `Your project requires stack name option ${CMD_VAR_1} to be passed when starting sls-dev-tools`
+    );
+    expect(process.exit).toHaveBeenCalledWith(INVALID_ARGUMENT_EXIT_CODE);
+  });
+});
+
+describe("Serverless Config Parsing", () => {
+  let SLS;
+
+  beforeAll(() => {
+    fs.readFileSync.mockReturnValue(TEST_YAML_FILE);
+    fs.existsSync.mockReturnValue(true);
+
+    const program = {
+      args: [CMD_VAR_1, CMD_VAL_1],
+      location: "~/Dev/testProject/backend",
+    };
+
+    SLS = new ServerlessConfigParser(program);
+  });
+
+  it("should read YAML file and replace opt in service.name with stored arg", () => {
+    expect(SLS.getStackName("dev")).toBe("test-backend-dev");
+  });
+
+  it("should get a stackname given a stage", () => {
+    const stage = "test";
+    expect(SLS.getStackName(stage)).toBe("test-backend-test");
+  });
+});
diff --git a/package.json b/package.json
@@ -20,11 +20,15 @@
     "@babel/cli": "^7.5.5",
     "@babel/core": "^7.5.5",
     "@babel/preset-env": "^7.5.5",
-    "eslint": "^7.0.0",
+    "@types/jest": "^26.0.20",
+    "babel-jest": "^26.6.3",
+    "eslint": "^7.21.0",
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^24.1.5",
     "eslint-plugin-prettier": "^3.1.3",
+    "jest": "^26.6.3",
     "prettier": "^2.0.4",
     "release-it": "^14.0.3"
   },
@@ -36,7 +40,7 @@
     "debug": "node --nolazy --inspect-brk=9229 ./lib/index.js",
     "lint": "eslint ./src",
     "fix": "yarn lint --fix",
-    "test": "yarn lint",
+    "test": "yarn lint && jest",
     "release": "release-it"
   },
   "babel": {
diff --git a/src/guardian/index.js b/src/guardian/index.js
@@ -12,7 +12,7 @@ import {
   getStackResources,
   getLambdaFunctions,
 } from "../services";
-import ServerlessConfigParser from "../services/serverlessConfigParser";
+import ServerlessConfigParser from "../services/severlessConfigParser/serverlessConfigParser";
 
 const infoLog = chalk.greenBright;
 const titleLog = chalk.greenBright.underline.bold;
diff --git a/src/index.js b/src/index.js
@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import ServerlessConfigParser from "./services/serverlessConfigParser";
+import ServerlessConfigParser from "./services/severlessConfigParser/serverlessConfigParser";
 import GuardianCI from "./guardian/index";
 import Main from "./CLIMain";
 
diff --git a/src/services/severlessConfigParser/helpers.js b/src/services/severlessConfigParser/helpers.js
@@ -0,0 +1,33 @@
+export const CYAN_STRING_FORMAT = "\x1b[36m%s\x1b[0m";
+
+export const transformArgsToDict = (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 const replaceStacknameOpt = (stackname, cmdOptions) => {
+  const optRegex = /\$\{opt:.*\}/;
+
+  if (!stackname.match(optRegex)) return stackname;
+
+  let variable = stackname.match(optRegex)[0];
+
+  variable = variable.replace(/[${}]/g, "");
+  const varName = variable.split(":")[1];
+
+  if (cmdOptions[varName] === undefined) {
+    console.error(
+      CYAN_STRING_FORMAT,
+      `Your project requires stack name option --${varName} to be passed when starting sls-dev-tools`
+    );
+    process.exit(9);
+  }
+
+  return stackname.replace(/\$\{opt:.*\}/, cmdOptions[varName]);
+};
diff --git a/src/services/severlessConfigParser/serverlessConfigParser.js b/src/services/severlessConfigParser/serverlessConfigParser.js
@@ -1,5 +1,4 @@
-import transformArgsToDict from "../utils/transformArgsToDict";
-import replaceVariablesInYml from "../utils/replaceVariablesInYml";
+import { transformArgsToDict, replaceStacknameOpt } from "./helpers";
 
 const fs = require("fs");
 const path = require("path");
@@ -15,15 +14,18 @@ class ServerlessConfigParser {
 
     if (fs.existsSync(ymlPath)) {
       this.config = YAML.load(fs.readFileSync(ymlPath).toString("utf8"));
-    }
-    if (fs.existsSync(yamlPath)) {
+    } else if (fs.existsSync(yamlPath)) {
       this.config = YAML.load(fs.readFileSync(yamlPath).toString("utf8"));
-    }
-    if (fs.existsSync(jsonPath)) {
+    } else if (fs.existsSync(jsonPath)) {
       this.config = JSON.parse(fs.readFileSync(jsonPath).toString("utf8"));
     }
 
-    replaceVariablesInYml(this.config, options);
+    if (!this.config) return;
+
+    this.config.service.name = replaceStacknameOpt(
+      this.config.service.name,
+      options
+    );
   }
 
   getFunctionConfig(functionName) {
diff --git a/src/utils/replaceVariablesInYml.js b/src/utils/replaceVariablesInYml.js
diff --git a/src/utils/transformArgsToDict.js b/src/utils/transformArgsToDict.js
diff --git a/yarn.lock b/yarn.lock
