feat: support loading config from JS and JSON files

Author: duro

lib/yamlParser.js

@@ -11,10 +11,18 @@ module.exports = {
       return BbPromise.resolve();
     }
 
+    const fromYamlFile = serverlessYmlPath => this.serverless.yamlParser.parse(serverlessYmlPath);
+
+    let parse = null;
     const serviceFileName = this.options.config || this.serverless.config.serverless.service.serviceFilename || 'serverless.yml';
     const serverlessYmlPath = path.join(servicePath, serviceFileName);
-    return this.serverless.yamlParser
-      .parse(serverlessYmlPath)
+
+    if (['.js', '.json'].includes(path.extname(serverlessYmlPath))) {
+      parse = this.loadFromRequiredFile;
+    } else {
+      parse = fromYamlFile;
+    }
+    return parse(serverlessYmlPath)
       .then(serverlessFileParam => this.serverless.variables.populateObject(serverlessFileParam)
         .then((parsedObject) => {
           this.serverless.service.stepFunctions = {
@@ -44,6 +52,16 @@ module.exports = {
         }));
   },
 
+  // This function must be ignored since mocking the require system is more
+  // dangerous than beneficial
+  loadFromRequiredFile(serverlessYmlPath) {
+    /* istanbul ignore next */
+    // eslint-disable-next-line global-require, import/no-dynamic-require
+    const fileContents = require(serverlessYmlPath);
+    /* istanbul ignore next */
+    return BbPromise.resolve(fileContents);
+  },
+
   getAllStateMachines() {
     if (Object.prototype.toString.call(this.serverless.service.stepFunctions.stateMachines)
       !== '[object Object]') {

lib/yamlParser.test.js

@@ -114,6 +114,40 @@ describe('#yamlParse', () => {
         });
     });
 
+    it('should be able to load from a js file', () => {
+      serverless.config.serverless.service.serviceFilename = 'serverless.js';
+      const requireFileStub = sinon.stub(serverlessStepFunctions, 'loadFromRequiredFile')
+        .returns(BbPromise.resolve({
+          stepFunctions: {
+            stateMachines: 'stepFunctions',
+            activities: 'my-activity',
+          },
+        }));
+      serverlessStepFunctions.yamlParse()
+        .then(() => {
+          expect(requireFileStub.calledOnce).to.be.equal(true);
+          expect(serverless.service.stepFunctions.stateMachines).to.be.equal('stepFunctions');
+          expect(serverless.service.stepFunctions.activities).to.be.equal('my-activity');
+        });
+    });
+
+    it('should be able to load from a json file', () => {
+      serverless.config.serverless.service.serviceFilename = 'serverless.json';
+      const requireFileStub = sinon.stub(serverlessStepFunctions, 'loadFromRequiredFile')
+        .returns(BbPromise.resolve({
+          stepFunctions: {
+            stateMachines: 'stepFunctions',
+            activities: 'my-activity',
+          },
+        }));
+      serverlessStepFunctions.yamlParse()
+        .then(() => {
+          expect(requireFileStub.calledOnce).to.be.equal(true);
+          expect(serverless.service.stepFunctions.stateMachines).to.be.equal('stepFunctions');
+          expect(serverless.service.stepFunctions.activities).to.be.equal('my-activity');
+        });
+    });
+
     it('should create empty object when stepfunctions param are not given', () => {
       serverlessStepFunctions.serverless.yamlParser.parse.restore();
       serverlessStepFunctions.serverless.variables.populateObject.restore();