feat: Add support for RemovalPolicy in config (#306)

* Support Removal Policy * fix condition * fixing type
awslabs · Apr 17, 2023 · 8799d19 · 8799d19
1 parent 98bd743
commit 8799d19
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 2 deletions.
diff --git a/src/config/configurator.ts b/src/config/configurator.ts
@@ -34,6 +34,17 @@ function readConfigFile(path: string): object {
     throw TypeError("Config file must be in YAML or JSON format");
   }
 }
+function setRemovalPolicy(value: string, node: cdk.CfnResource): void {
+  if (value.toLowerCase() == "destroy") {
+    node.applyRemovalPolicy(cdk.RemovalPolicy.DESTROY);
+  } else if (value.toLowerCase() == "retain") {
+    node.applyRemovalPolicy(cdk.RemovalPolicy.RETAIN);
+  } else if (value.toLowerCase() == "snapshot") {
+    node.applyRemovalPolicy(cdk.RemovalPolicy.SNAPSHOT);
+  } else {
+    throw new Error(`${value} is not a valid removal policy type. Must be one of ['DESTROY', 'RETAIN', & 'SNAPSHOT']`);
+  }
+}
 interface getConfigProps {
   readonly config?: string | object;
 }
@@ -125,13 +136,21 @@ class ConfiguratorAspect implements cdk.IAspect {
   }
   public visit(node: constructs.IConstruct): void {
     if (this.resourceType && cdk.CfnResource.isCfnResource(node) && node.cfnResourceType == this.resourceType) {
-      node.addPropertyOverride(this.propertyName, this.propertyValue);
+      if (this.propertyName == "RemovalPolicy") {
+        setRemovalPolicy(this.propertyValue, node);
+      } else {
+        node.addPropertyOverride(this.propertyName, this.propertyValue);
+      }
     }
 
     const nodePathItemRegex = new RegExp(`^(.*\/)?(${this.resourceId}\/Resource)(\/.*)?$`);
 
     if (this.resourceId && cdk.CfnResource.isCfnResource(node) && nodePathItemRegex.test(node.node.path)) {
-      node.addPropertyOverride(this.propertyName, this.propertyValue);
+      if (this.propertyName == "RemovalPolicy") {
+        setRemovalPolicy(this.propertyValue, node);
+      } else {
+        node.addPropertyOverride(this.propertyName, this.propertyValue);
+      }
     }
   }
 }

diff --git a/test/config.test.ts b/test/config.test.ts
@@ -497,3 +497,64 @@ test("Get Tags", () => {
   assert(prodTags.CostCenter === "2015");
   assert(globalTags["global:foo"] === "bar");
 });
+
+test("Config Removal Policy", () => {
+  const sampleConfig = {
+    environments: {
+      dev: {
+        resources: {
+          MyBucket: {
+            RemovalPolicy: cdk.RemovalPolicy.DESTROY,
+          },
+          MyOtherBucket: {
+            RemovalPolicy: cdk.RemovalPolicy.RETAIN,
+          },
+        },
+      },
+    },
+  };
+  const stack = new cdk.Stack();
+  new s3.Bucket(stack, "MyBucket");
+  new s3.Bucket(stack, "MyOtherBucket");
+  new Configurator(stack, sampleConfig, "dev");
+  const template = Template.fromStack(stack);
+  template.hasResource("AWS::S3::Bucket", {
+    DeletionPolicy: "Delete",
+    UpdateReplacePolicy: "Delete",
+  });
+  template.hasResource("AWS::S3::Bucket", {
+    DeletionPolicy: "Retain",
+    UpdateReplacePolicy: "Retain",
+  });
+});
+
+test("Config Removal Policy Invalid", () => {
+  const sampleConfig = {
+    environments: {
+      dev: {
+        resources: {
+          MyBucket: {
+            RemovalPolicy: "foobar",
+          },
+        },
+      },
+    },
+  };
+  const stack = new cdk.Stack();
+  new s3.Bucket(stack, "MyBucket");
+  new Configurator(stack, sampleConfig, "dev");
+  expect(() => {
+    Template.fromStack(stack);
+  }).toThrowError("foobar is not a valid removal policy type. Must be one of ['DESTROY', 'RETAIN', & 'SNAPSHOT']");
+});
+
+test("Config Removal Policy JSON Config", () => {
+  const stack = new cdk.Stack();
+  new s3.Bucket(stack, "MyBucket");
+  new Configurator(stack, "./test/test-config.json", "dev");
+  const template = Template.fromStack(stack);
+  template.hasResource("AWS::S3::Bucket", {
+    DeletionPolicy: "Delete",
+    UpdateReplacePolicy: "Delete",
+  });
+});
diff --git a/test/test-config.json b/test/test-config.json
@@ -12,6 +12,9 @@
         "AWS::Lambda::Function": {
           "MemorySize": 128,
           "Runtime": "python3.8"
+        },
+        "AWS::S3::Bucket": {
+          "RemovalPolicy": "DESTROY"
         }
       },
       "tags": {"CostCenter": "2014"}