Add deployment trackers to evaluate adoption (#169)

* Track ref arch deployments

* Add tracking code capability

Co-authored-by: Chazal <chazalf@88665a14a6c3.ant.amazon.com>
Co-authored-by: Vincent Gromakowski <vgkowski@users.noreply.github.com>

Author: 3 people

core/src/common/context-options.ts

@@ -0,0 +1,3 @@
+export enum ContextOptions {
+  DISABLE_CONSTRUCTS_DEPLOYMENT_TRACKING = '@aws-analytics-reference-architecture/disableConstructsDeploymentTracking'
+}

core/src/common/tracked-construct.ts

@@ -0,0 +1,17 @@
+import * as cdk from '@aws-cdk/core';
+
+export interface TrackedConstructProps {
+  trackingCode: string;
+}
+
+export class TrackedConstruct extends cdk.Construct {
+  constructor(scope: cdk.Construct, id: string, props: TrackedConstructProps) {
+    super(scope, id);
+
+    if (!scope.node.tryGetContext('@aws-analytics-reference-architecture/disableConstructsDeploymentTracking')) {
+      const stack = cdk.Stack.of(this);
+      const description = `${stack.templateOptions.description} (${props.trackingCode})`;
+      stack.templateOptions.description = description;
+    }
+  }
+}

core/test/tracked-construct.test.ts

@@ -0,0 +1,45 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: MIT-0
+
+import { App, Stack } from '@aws-cdk/core';
+import { ContextOptions } from '../src/common/context-options';
+import * as trackedConstruct from '../src/common/tracked-construct';
+
+import '@aws-cdk/assert/jest';
+
+test('tracked construct add tracking code to description if not explicitely disabled', () => {
+
+  // GIVEN
+  const initialStackDescription = 'My Analytics stack';
+  const trackingCode = 'trackingcode';
+  const testApp = new App();
+  const exampleStack = new Stack(testApp, 'testTrackedConstruct', {
+    description: initialStackDescription,
+  });
+
+  // WHEN
+  new trackedConstruct.TrackedConstruct(exampleStack, 'MyCoreAnalyticsConstruct', { trackingCode: trackingCode });
+
+  // THEN
+  expect(exampleStack.templateOptions).toHaveProperty('description', `${initialStackDescription} (${trackingCode})`);
+});
+
+
+test('tracked construct don\'t add tracking code to description if  explicitely disabled', () => {
+
+  // GIVEN
+  const initialStackDescription = 'My Analytics stack';
+  const trackingCode = 'trackingcode';
+  const context: any = {};
+  context[ContextOptions.DISABLE_CONSTRUCTS_DEPLOYMENT_TRACKING] = true;
+  const testApp = new App({ context });
+  const exampleStack = new Stack(testApp, 'testTrackedConstruct', {
+    description: initialStackDescription,
+  });
+
+  // WHEN
+  new trackedConstruct.TrackedConstruct(exampleStack, 'MyCoreAnalyticsConstruct', { trackingCode: trackingCode });
+
+  // THEN
+  expect(exampleStack.templateOptions).toHaveProperty('description', initialStackDescription);
+});

refarch/aws-native/cdk.json

@@ -6,6 +6,7 @@
     "EnableBatch": "true",
     "EnableDWH": "true",
     "EnableDataviz": "true",
-    "EnableStreaming": "true"
+    "EnableStreaming": "true",
+    "EnableDeploymentTracking": "true"
   }
 }

refarch/aws-native/common/common_cdk/data_lake.py

@@ -14,13 +14,20 @@
 
 
 def is_module_enabled(param: str):
-    return param.lower() in ("yes", "true")
+    return param and (param.lower() in ("yes", "true"))
 
 
 class DataLake(Stack):
 
-    def __init__(self, scope: Construct, id: str, **kwargs) -> None:
-        super().__init__(scope, id, **kwargs)
+    def __init__(self, scope: Construct, id: str, **kwargs) -> None:   
+
+        # Set Stack description
+        deployment_tracking_param = scope.node.try_get_context("EnableDeploymentTracking")
+        stack_description = "Analytics Ref Arch - DataLake stack"
+        if is_module_enabled(deployment_tracking_param):
+            stack_description = stack_description + " (uksb-1scq97upu)" 
+
+        super().__init__(scope, id, description = stack_description, **kwargs)
 
         data_lake = DataLakeFoundations(self, "Foundations")
 

refarch/aws-native/setup.py

@@ -49,7 +49,7 @@
         "cdk_ec2_key_pair"
     ],
 
-    python_requires=">=3.8,<3.9",
+    python_requires=">=3.8",
 
     classifiers=[
         "Development Status :: 4 - Beta",