feat: add global removal to DataLakeStorage and make it availble cros… (#104)

* feat: add global removal to DataLakeStorage and make it availble cross construct * update AnalyticsBucket * Update framework/test/unit/data-lake/data-lake-storage.test.ts Co-authored-by: Dženan Softić <dzeno10@gmail.com> --------- Co-authored-by: Dženan Softić <dzeno10@gmail.com>

Author: vgkowski

framework/src/data-lake/analytics-bucket.ts

@@ -2,11 +2,12 @@
 // SPDX-License-Identifier: MIT-0
 
 
-import { Annotations, Duration, Names, RemovalPolicy } from 'aws-cdk-lib';
+import { Duration, Names, RemovalPolicy } from 'aws-cdk-lib';
 import { Bucket, BucketEncryption, BlockPublicAccess } from 'aws-cdk-lib/aws-s3';
 import { Construct } from 'constructs';
 
 import { AnalyticsBucketProps } from './analytics-bucket-props';
+import { Context } from '../utils';
 
 /**
 * Amazon S3 Bucket configured with best-practices and defaults for analytics.
@@ -35,24 +36,13 @@ import { AnalyticsBucketProps } from './analytics-bucket-props';
 export class AnalyticsBucket extends Bucket {
 
  private static LIFECYCLE_RULE = [{ abortIncompleteMultipartUploadAfter: Duration.days(1) }];
- private static FRAMEWORK_CONTEXT_VALUES = 'adsf';
 
  constructor(scope: Construct, id: string, props: AnalyticsBucketProps) {
 
  const bucketName = (props?.bucketName || 'analytics-bucket') + '-' + Names.uniqueResourceName(scope, {}).toLowerCase();
 
- const globalRemovalPolicy = scope.node.tryGetContext(AnalyticsBucket.FRAMEWORK_CONTEXT_VALUES)?.remove_data_on_destroy.toLowerCase() == 'true' || false;
- const removalPolicy = props?.removalPolicy == RemovalPolicy.DESTROY && globalRemovalPolicy ? RemovalPolicy.DESTROY : RemovalPolicy.RETAIN;
- const autoDeleteObjects = (removalPolicy == RemovalPolicy.DESTROY) && globalRemovalPolicy;
-
- if (props?.removalPolicy == RemovalPolicy.DESTROY && !globalRemovalPolicy) {
- Annotations.of(scope).addWarning(
- `WARNING: removalPolicy was reverted back to 'RemovalPolicy.RETAIN'.
- If you wish to set 'removalPolicy' to 'DESTROY' you must also
- set the global removal policy flag context variable in the 'cdk.json'
- or 'cdk.context.json': "adsf": { "remove_data_on_destroy": "true" }.`,
- );
- }
+ const removalPolicy = Context.revertRemovalPolicy(scope, props?.removalPolicy);
+ const autoDeleteObjects = removalPolicy == RemovalPolicy.DESTROY;
 
  super(scope, id, {
  ...props,

framework/src/data-lake/data-lake-storage.ts

@@ -10,6 +10,7 @@ import { Construct } from 'constructs';
 import { AccessLogsBucket } from './access-logs-bucket';
 import { AnalyticsBucket } from './analytics-bucket';
 import { TrackedConstruct, TrackedConstructProps } from '../utils';
+import { Context } from '../utils/context';
 
 
 /**
@@ -132,7 +133,7 @@ export class DataLakeStorage extends TrackedConstruct {
  super(scope, id, trackedConstructProps);
 
  this.accessLogsBucket = new AccessLogsBucket(this, 'AccessLogsBucket');
- const removalPolicy = props?.removalPolicy || RemovalPolicy.RETAIN;
+ const removalPolicy = Context.revertRemovalPolicy(this, props?.removalPolicy);
 
  // create the key if it's not provided in the parameters
  this.dataLakeKey = props?.dataLakeKey || new Key(this, 'DataKey', {

framework/src/utils/context-options.ts

@@ -0,0 +1,41 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: MIT-0
+
+import { Annotations, RemovalPolicy } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+
+/**
+ * @internal
+ * Utils class to work with the CDK context and options
+ */
+export class Context {
+ /**
+ * Method to revert a DESTROY removal policy to RETAIN if the global removal policy parameter
+ * in the CDK context is not set to true.
+ * Also create a warning to warn the user if the retention policy has been reverted to RETAIN.
+ * @param retentionPolicy The retention policy provided to the construct
+ * @return the new retention policy based on the global retention parameter set in the CDK context
+ */
+ public static revertRemovalPolicy(scope: Construct, removalPolicy?: RemovalPolicy): RemovalPolicy {
+ const globalRemovalPolicy = scope.node.tryGetContext(ContextOptions.REMOVE_DATA_ON_DESTROY) || false;
+
+ if (removalPolicy == RemovalPolicy.DESTROY && !globalRemovalPolicy) {
+ Annotations.of(scope).addWarning(
+ `WARNING: removalPolicy was reverted back to 'RemovalPolicy.RETAIN'.
+ If you wish to set 'removalPolicy' to 'DESTROY' you must also
+ set the global removal policy flag context variable in the 'cdk.json'
+ or 'cdk.context.json': '@aws-data-solutions-framework/removeDataOnDestroy: true'`,
+ );
+ }
+ return removalPolicy == RemovalPolicy.DESTROY && globalRemovalPolicy ? RemovalPolicy.DESTROY : RemovalPolicy.RETAIN;
+ }
+}
+
+/**
+ * @internal
+ * The options used in the CDK context
+ */
+export enum ContextOptions {
+ DISABLE_CONSTRUCTS_DEPLOYMENT_TRACKING = '@aws-data-solutions-framework/disableConstructsDeploymentTracking',
+ REMOVE_DATA_ON_DESTROY = '@aws-data-solutions-framework/removeDataOnDestroy',
+}

framework/src/utils/context.ts

@@ -3,5 +3,5 @@
 
 
 export { TrackedConstruct, TrackedConstructProps } from './tracked-construct';
-export { ContextOptions } from './context-options';
+export { ContextOptions, Context } from './context';
 export { EmrVersion } from './emr-releases';

framework/src/utils/index.ts

@@ -3,7 +3,7 @@
 
 import { Stack, Tags } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { ContextOptions } from './context-options';
+import { ContextOptions } from './context';
 import { ADSF_AWS_TAG } from '../constants';
 
 /**

framework/src/utils/tracked-construct.ts

@@ -19,7 +19,7 @@ describe('AnalyticsBucket Construct with DESTROY flag set to true', () => {
  const app = new App();
  const stack = new Stack(app, 'Stack');
  // Set context value for global data removal policy
- stack.node.setContext('adsf', { remove_data_on_destroy: 'true' });
+ stack.node.setContext('@aws-data-solutions-framework/removeDataOnDestroy', true);
 
  const encryptionKey = new Key(stack, 'DataKey', {
  removalPolicy: RemovalPolicy.DESTROY,
@@ -153,7 +153,7 @@ describe('AnalyticsBucket Construct with DESTROY flag set to false', () => {
  const app = new App();
  const stack = new Stack(app, 'Stack');
  // Set context value for global data removal policy
- stack.node.setContext('adsf', { remove_data_on_destroy: 'false' });
+ stack.node.setContext('@aws-data-solutions-framework/removeDataOnDestroy', false);
 
  const encryptionKey = new Key(stack, 'DataKey', {
  removalPolicy: RemovalPolicy.DESTROY,
@@ -174,7 +174,7 @@ describe('AnalyticsBucket Construct with DESTROY flag set to false', () => {
 
  const template = Template.fromStack(stack);
 
- test('AnalyticsBucket should not destroy objects if DESTROY flag is false', () => {
+ test('DefaultAnalyticsBucket should not destroy objects if DESTROY flag is false', () => {
  // Set autoDeleteObjects only if DESTROY flag is true && Removal policy is DESTROY
  template.resourceCountIs('Custom::S3AutoDeleteObjects', 0);
  });