feat(Variables): Add support for Terraform state file parsing (#8755)

Signed-off-by: Brian Dwyer <Brian.Dwyer@broadridge.com>
serverless · Jan 15, 2021 · 461a396 · 461a396
1 parent d1c6568
commit 461a396
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 1 deletion.
diff --git a/lib/utils/fs/parse.js b/lib/utils/fs/parse.js
@@ -18,7 +18,7 @@ const loadYaml = (contents, options) => {
 
 function parse(filePath, contents) {
   // Auto-parse JSON
-  if (filePath.endsWith('.json')) {
+  if (filePath.endsWith('.json') || filePath.endsWith('.tfstate')) {
     return jc.parse(contents);
   } else if (filePath.endsWith('.yml') || filePath.endsWith('.yaml')) {
     const options = {

diff --git a/test/fixtures/variables/serverless.yml b/test/fixtures/variables/serverless.yml
@@ -7,6 +7,8 @@ provider:
 custom:
   importedFile: ${file(config.json)}
   importedFileWithKey: ${file(config.json):foo}
+  importedTerraformState: ${file(terraform.tfstate)}
+  importedTerraformStateWithKey: ${file(terraform.tfstate):outputs.listenerarn.type}
   awsVariable: ${AWS::Region}
   cloudFormationReference: ${AnotherResource}
   selfReference: ${self:custom.importedFileWithKey}

diff --git a/test/fixtures/variables/terraform.tfstate b/test/fixtures/variables/terraform.tfstate
@@ -0,0 +1,13 @@
+{
+  "version": 4,
+  "terraform_version": "0.14.4",
+  "serial": 11,
+  "lineage": "12ab3c45-abc1-0a1b-1a23-a12b34567c89",
+  "outputs": {
+    "listenerarn": {
+      "value": "arn:aws:elasticloadbalancing:us-west-2:123456789876:listener/app/myapp/1a2b3c4f1a23456b/a1b23c45de6789fa",
+      "type": "string"
+    }
+  },
+  "resources": []
+}
diff --git a/test/unit/lib/classes/Variables.test.js b/test/unit/lib/classes/Variables.test.js
@@ -2776,6 +2776,27 @@ describe('test/unit/lib/classes/Variables.test.js', () => {
     expect(processedConfig.custom.importedFileWithKey).to.equal('bar');
   });
 
+  it('should support ${file(...)} syntax for Terraform state', () => {
+    expect(processedConfig.custom.importedTerraformState).to.deep.equal({
+      version: 4,
+      terraform_version: '0.14.4',
+      serial: 11,
+      lineage: '12ab3c45-abc1-0a1b-1a23-a12b34567c89',
+      outputs: {
+        listenerarn: {
+          value:
+            'arn:aws:elasticloadbalancing:us-west-2:123456789876:listener/app/myapp/1a2b3c4f1a23456b/a1b23c45de6789fa',
+          type: 'string',
+        },
+      },
+      resources: [],
+    });
+  });
+
+  it('should support ${file(...):key} syntax for Terraform state', () => {
+    expect(processedConfig.custom.importedTerraformStateWithKey).to.equal('string');
+  });
+
   it('should ignore native CloudFormation variables', () => {
     expect(processedConfig.custom.awsVariable).to.equal('${AWS::Region}');
   });