feat: Adds support for stream-connection 'Sample' type (#246)

Author: EspenAlbert

API.md

@@ -1,32 +1,31 @@
 import * as cdk from 'aws-cdk-lib';
 import { Construct } from 'constructs';
-import { CfnStreamConnection, CfnStreamConnectionPropsType } from 'awscdk-resources-mongodbatlas'
-import { env } from 'node:process';
+import { CfnStreamConnection, CfnStreamConnectionPropsType, DbRoleToExecute, DbRoleToExecuteType } from 'awscdk-resources-mongodbatlas'
 
 interface AtlasStackProps {
 	readonly projectId: string;
 	readonly profile: string;
 	readonly instanceName: string;
 	readonly connectionName: string;
-	readonly type: CfnStreamConnectionPropsType;
 	readonly clusterName: string;
 }
 
 const app = new cdk.App();
 
 
-export class CdkTestStack extends cdk.Stack {
+export class CdkTestStackCluster extends cdk.Stack {
 	constructor(scope: Construct, id: string, props?: cdk.StackProps) {
 		super(scope, id, props);
 
 		const atlasProps = this.getContextProps();
-		const streamConnection = new CfnStreamConnection(this, "stream-connection-testing-stack", {
+		const streamConnection = new CfnStreamConnection(this, "stream-connection-cluster-stack", {
 			profile: atlasProps.profile,
 			instanceName: atlasProps.instanceName,
 			projectId: atlasProps.projectId,
 			connectionName: atlasProps.connectionName,
 			type: CfnStreamConnectionPropsType.CLUSTER,
-			clusterName: atlasProps.clusterName
+			clusterName: atlasProps.clusterName,
+			dbRoleToExecute: {role: "atlasAdmin", type: DbRoleToExecuteType.BUILT_IN}
 		});
 	}
 
@@ -36,7 +35,7 @@ export class CdkTestStack extends cdk.Stack {
 		const projectId = this.node.tryGetContext('projectId');
 		const instanceName = this.node.tryGetContext('instanceName');
 		const connectionName = this.node.tryGetContext('connectionName');
-		const type = this.node.tryGetContext('type');
+		const clusterName = this.node.tryGetContext('clusterName');
 		if (!projectId) {
 			throw "No context value specified for projectId. Please specify via the cdk context."
 		}
@@ -46,17 +45,13 @@ export class CdkTestStack extends cdk.Stack {
 		if (!connectionName) {
 			throw "No context value specified for connectionName. Please specify via the cdk context."
 		}
-		if (!type) {
-			throw "No context value specified for type. Please specify via the cdk context."
-		}
 
 		return {
 			projectId,
 			profile,
 			instanceName,
 			connectionName,
-			type
+			clusterName
 		}
 	}
-
 }

examples/l1-resources/stream-connection.ts renamed to examples/l1-resources/stream-connection-cluster.ts

@@ -0,0 +1,52 @@
+import * as cdk from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+import { CfnStreamConnection, CfnStreamConnectionPropsType } from 'awscdk-resources-mongodbatlas'
+
+interface AtlasStackProps {
+	readonly projectId: string;
+	readonly profile: string;
+	readonly instanceName: string;
+	readonly sampleDataset: string;
+}
+
+const app = new cdk.App();
+
+
+export class CdkTestStack extends cdk.Stack {
+	constructor(scope: Construct, id: string, props?: cdk.StackProps) {
+		super(scope, id, props);
+
+		const atlasProps = this.getContextProps();
+		const streamConnection = new CfnStreamConnection(this, "stream-connection-sample-stack", {
+			profile: atlasProps.profile,
+			instanceName: atlasProps.instanceName,
+			projectId: atlasProps.projectId,
+			connectionName: atlasProps.sampleDataset,
+			type: CfnStreamConnectionPropsType.SAMPLE,
+		});
+	}
+
+
+	getContextProps(): AtlasStackProps {
+		const profile = this.node.tryGetContext('profile') ?? 'default';
+		const projectId = this.node.tryGetContext('projectId');
+		const instanceName = this.node.tryGetContext('instanceName');
+		const sampleDataset = this.node.tryGetContext('sampleDataset');
+		if (!projectId) {
+			throw "No context value specified for projectId. Please specify via the cdk context."
+		}
+		if (!instanceName) {
+			throw "No context value specified for instanceName. Please specify via the cdk context."
+		}
+		if (!sampleDataset) {
+			throw "No context value specified for sampleDataset. Please specify via the cdk context."
+		}
+
+		return {
+			projectId,
+			profile,
+			instanceName,
+			sampleDataset,
+		}
+	}
+}

examples/l1-resources/stream-connection-sample.ts

@@ -61,7 +61,9 @@ for file in "${dir}"/mongodb-atlas-*.json; do
 		# When the Resource is not merged to main branch of submodule, you see the above error. 
 		cdk-import cfn -l typescript -s "${file}" -o "src/l1-resources/${path}" "${src}"
 		# need rename resource file to index.ts file
-		mv "src/l1-resources/${path}/mongodb-atlas-${path//-/}.ts" "src/l1-resources/${path}/index.ts"
+		dest="src/l1-resources/${path}/index.ts"
+		mv "src/l1-resources/${path}/mongodb-atlas-${path//-/}.ts" "${dest}"
+		python "${root_dir}/scripts/rename_in_file.py" "${dest}"
 	fi
 done
 

scripts/cdk.sh

@@ -0,0 +1,30 @@
+import re
+import sys
+import pathlib
+
+_underscore_pattern = re.compile(r"\w+_UNDERSCORE_\w+")
+
+
+def rename_underscore(text: str) -> str:
+    def remove_underscore(match: re.Match):
+        return match.group(0).replace("UNDERSCORE_", "")
+
+    return _underscore_pattern.sub(remove_underscore, text)
+
+
+def perform_renaming(path_str: str):
+    path = pathlib.Path(path_str)
+    assert path.exists(), f"no path @ {path}"
+    assert path.name == "index.ts"
+    print(f"renaming: {path_str}")
+    old_text = path.read_text()
+    new_text = rename_underscore(old_text)
+    if old_text != new_text:
+        path.write_text(new_text)
+    else:
+        print(f"renamed content in {path}")
+
+
+if __name__ == "__main__":
+    *_, index_ts = sys.argv
+    perform_renaming(index_ts)

scripts/rename_in_file.py

@@ -0,0 +1,35 @@
+import pytest
+import rename_in_file
+
+examples = {
+    "remove_underscore": (
+        """\
+export enum DbRoleToExecuteType {
+  /** BUILT_IN */
+  BUILT_UNDERSCORE_IN = "BUILT_IN",
+  /** CUSTOM */
+  CUSTOM = "CUSTOM",
+}""",
+        """\
+export enum DbRoleToExecuteType {
+  /** BUILT_IN */
+  BUILT_IN = "BUILT_IN",
+  /** CUSTOM */
+  CUSTOM = "CUSTOM",
+}""",
+    ),
+    "unchanged_not_found": (
+        "some text", "some text"
+    )
+}
+
+
+@pytest.mark.parametrize(
+    "input_text,output_text", examples.values(), ids=examples.keys()
+)
+def test_examples(input_text, output_text, tmp_path):
+    path = tmp_path / "index.ts"
+    path.write_text(input_text)
+    rename_in_file.perform_renaming(str(path))
+    text_after = path.read_text()
+    assert text_after == output_text

scripts/rename_in_file_test.py

@@ -25,7 +25,7 @@ export interface CfnStreamConnectionProps {
   readonly profile?: string;
 
   /**
-   * Human-readable label that identifies the stream connection.
+   * Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source.
    *
    * @schema CfnStreamConnectionProps#ConnectionName
    */
@@ -39,7 +39,7 @@ export interface CfnStreamConnectionProps {
   readonly instanceName: string;
 
   /**
-   * Type of the connection. Can be either Cluster or Kafka.
+   * Type of the connection. Can be either Cluster, Kafka, or Sample.
    *
    * @schema CfnStreamConnectionProps#Type
    */
@@ -112,7 +112,7 @@ export function toJson_CfnStreamConnectionProps(
 /* eslint-enable max-len, quote-props */
 
 /**
- * Type of the connection. Can be either Cluster or Kafka.
+ * Type of the connection. Can be either Cluster, Kafka, or Sample.
  *
  * @schema CfnStreamConnectionPropsType
  */
@@ -121,6 +121,8 @@ export enum CfnStreamConnectionPropsType {
   KAFKA = "Kafka",
   /** Cluster */
   CLUSTER = "Cluster",
+  /** Sample */
+  SAMPLE = "Sample",
 }
 
 /**
@@ -267,7 +269,7 @@ export function toJson_StreamsKafkaSecurity(
  */
 export enum DbRoleToExecuteType {
   /** BUILT_IN */
-  BUILT_UNDERSCORE_IN = "BUILT_IN",
+  BUILT_IN = "BUILT_IN",
   /** CUSTOM */
   CUSTOM = "CUSTOM",
 }

src/l1-resources/stream-connection/index.ts

@@ -25,6 +25,7 @@ const PROFILE = "default";
 const PROJECT_ID = "testProjectId";
 const INSTANCE_NAME = "testInstanceName";
 const CONNECTION_NAME = "testConnectionName";
+const CONNECTION_NAME_SAMPLE_STREAM_SOLAR = "sample_stream_solar";
 const CLUSTER_NAME = "testClusterName";
 const ROLE = "testRole";
 const PROTOCOL = "PLAINTEXT";
@@ -47,7 +48,7 @@ test("AtlasStreamConnection of type Cluster construct should contain default pro
     clusterName: CLUSTER_NAME,
     dbRoleToExecute: {
       role: ROLE,
-      type: DbRoleToExecuteType.BUILT_UNDERSCORE_IN,
+      type: DbRoleToExecuteType.BUILT_IN,
     },
   });
 
@@ -62,7 +63,7 @@ test("AtlasStreamConnection of type Cluster construct should contain default pro
     ClusterName: CLUSTER_NAME,
     DbRoleToExecute: {
       Role: ROLE,
-      Type: DbRoleToExecuteType.BUILT_UNDERSCORE_IN,
+      Type: DbRoleToExecuteType.BUILT_IN,
     },
   });
 });
@@ -109,3 +110,26 @@ test("AtlasStreamConnection of type Kafka construct should contain default prope
     },
   });
 });
+
+test("AtlasStreamConnection of type Sample construct should contain default properties", () => {
+  const mockApp = new App();
+  const stack = new Stack(mockApp);
+
+  new CfnStreamConnection(stack, "stream-connection-testing-stack", {
+    profile: PROFILE,
+    instanceName: INSTANCE_NAME,
+    projectId: PROJECT_ID,
+    connectionName: CONNECTION_NAME_SAMPLE_STREAM_SOLAR,
+    type: CfnStreamConnectionPropsType.SAMPLE,
+  });
+
+  const template = Template.fromStack(stack);
+
+  template.hasResourceProperties(RESOURCE_NAME, {
+    Profile: PROFILE,
+    InstanceName: INSTANCE_NAME,
+    ProjectId: PROJECT_ID,
+    ConnectionName: CONNECTION_NAME_SAMPLE_STREAM_SOLAR,
+    Type: CfnStreamConnectionPropsType.SAMPLE,
+  });
+});