@gradientedge/cdk-utils 8.121.0 → 8.123.0

package/src/lib/aws/services/lambda/main.ts

@@ -15,6 +15,7 @@ import {
   LayerVersion,
 } from 'aws-cdk-lib/aws-lambda'
 import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources'
+import _ from 'lodash'
 import { CommonConstruct, CommonStack } from '../../common'
 import { createCfnOutput } from '../../utils'
 import { CloudFrontManager } from '../cloudfront'
@@ -144,7 +145,7 @@ export class LambdaManager {
       )
     }
 
-    if (props.lambdaAliases && props.lambdaAliases.length > 0) {
+    if (props.lambdaAliases && !_.isEmpty(props.lambdaAliases)) {
       props.lambdaAliases.forEach(alias => {
         const aliasId = alias.id ?? `${id}-${alias.aliasName}`
         const functionAlias = this.createLambdaFunctionAlias(`${aliasId}`, scope, alias, lambdaFunction.currentVersion)
@@ -160,8 +161,8 @@ export class LambdaManager {
       })
     }
 
-    if (props.tags && props.tags.length > 0) {
-      props.tags.forEach(tag => {
+    if (props.tags && !_.isEmpty(props.tags)) {
+      _.forEach(props.tags, tag => {
         Tags.of(lambdaFunction).add(tag.key, tag.value)
       })
     }

package/src/lib/aws/services/simple-notification-service/main.ts

@@ -1,6 +1,7 @@
 import { IFunction } from 'aws-cdk-lib/aws-lambda'
 import { Topic } from 'aws-cdk-lib/aws-sns'
 import { EmailSubscription, LambdaSubscription } from 'aws-cdk-lib/aws-sns-subscriptions'
+import _ from 'lodash'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
 import { SubscriptionProps } from './types'
@@ -43,8 +44,8 @@ export class SnsManager {
       topicName: `${props.topicName}-${scope.props.stage}`,
     })
 
-    if (emails && emails.length > 0) {
-      emails.forEach((email: string) => topic.addSubscription(new EmailSubscription(email)))
+    if (emails && !_.isEmpty(emails)) {
+      _.forEach(emails, (email: string) => topic.addSubscription(new EmailSubscription(email)))
     }
 
     createCfnOutput(`${id}-subscriptionArn`, scope, topic.topicArn)

package/src/lib/aws/services/simple-queue-service/main.ts

@@ -1,5 +1,6 @@
 import { Duration, RemovalPolicy, Tags } from 'aws-cdk-lib'
 import { IQueue, Queue } from 'aws-cdk-lib/aws-sqs'
+import _ from 'lodash'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
 import { LambdaProps } from '../lambda'
@@ -59,8 +60,8 @@ export class SqsManager {
         : props.visibilityTimeout,
     })
 
-    if (props.tags && props.tags.length > 0) {
-      props.tags.forEach(tag => {
+    if (props.tags && !_.isEmpty(props.tags)) {
+      _.forEach(props.tags, tag => {
         Tags.of(queue).add(tag.key, tag.value)
       })
     }

package/src/lib/aws/services/simple-storage-service/main.ts

@@ -3,6 +3,7 @@ import { IDistribution } from 'aws-cdk-lib/aws-cloudfront'
 import { Effect, PolicyDocument, PolicyStatement, ServicePrincipal } from 'aws-cdk-lib/aws-iam'
 import { BlockPublicAccess, Bucket, BucketEncryption, CfnBucket, CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3'
 import { BucketDeployment, ISource, ServerSideEncryption, Source } from 'aws-cdk-lib/aws-s3-deployment'
+import _ from 'lodash'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
 import { LifecycleRule, S3BucketProps } from './types'
@@ -32,7 +33,7 @@ export class S3Manager {
     if (!props.lifecycleRules) return undefined
 
     const bucketLifecycleRules: LifecycleRule[] = []
-    props.lifecycleRules.forEach(lifecycleRule => {
+    _.forEach(props.lifecycleRules, lifecycleRule => {
       bucketLifecycleRules.push({
         abortIncompleteMultipartUploadAfter: lifecycleRule.abortIncompleteMultipartUploadAfter,
         enabled: lifecycleRule.enabled,
@@ -135,8 +136,8 @@ export class S3Manager {
       }
     }
 
-    if (props.tags && props.tags.length > 0) {
-      props.tags.forEach(tag => {
+    if (props.tags && !_.isEmpty(props.tags)) {
+      _.forEach(props.tags, tag => {
         Tags.of(bucket).add(tag.key, tag.value)
       })
     }
@@ -222,7 +223,7 @@ export class S3Manager {
       throw `Folder unspecified for ${id}`
     }
 
-    folders.forEach(folder => {
+    _.forEach(folders, folder => {
       new BucketDeployment(scope, `${id}-${folder}`, {
         destinationBucket: bucket,
         destinationKeyPrefix: folder,

package/src/lib/aws/services/step-function/main.ts

@@ -30,6 +30,7 @@ import {
   SqsSendMessage,
   StepFunctionsStartExecution,
 } from 'aws-cdk-lib/aws-stepfunctions-tasks'
+import _ from 'lodash'
 import { v4 as uuidv4 } from 'uuid'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
@@ -214,12 +215,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -267,12 +268,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -320,12 +321,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -364,12 +365,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -396,12 +397,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -436,12 +437,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -474,12 +475,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }
@@ -510,12 +511,12 @@ export class SfnManager {
       retries = DEFAULT_RETRY_CONFIG
     }
 
-    retries.forEach(retry =>
+    _.forEach(retries, retry => {
       step.addRetry({
         ...retry,
         ...{ interval: retry.intervalInSecs ? Duration.seconds(retry.intervalInSecs) : retry.interval },
       })
-    )
+    })
 
     return step
   }

package/src/lib/aws/services/virtual-private-cloud/main.ts

@@ -2,6 +2,7 @@ import { Tags } from 'aws-cdk-lib'
 import { Vpc, VpcProps } from 'aws-cdk-lib/aws-ec2'
 import { CommonConstruct } from '../../common'
 import { createCfnOutput } from '../../utils'
+import _ from 'lodash'
 
 /**
  */
@@ -38,17 +39,17 @@ export class VpcManager {
     })
 
     createCfnOutput(`${id}Id`, scope, vpc.vpcId)
-    createCfnOutput(`${id}PublicSubnetIds`, scope, vpc.publicSubnets.map(subnet => subnet.subnetId).toString())
-    createCfnOutput(`${id}PrivateSubnetIds`, scope, vpc.privateSubnets.map(subnet => subnet.subnetId).toString())
+    createCfnOutput(`${id}PublicSubnetIds`, scope, _.map(vpc.publicSubnets, subnet => subnet.subnetId).toString())
+    createCfnOutput(`${id}PrivateSubnetIds`, scope, _.map(vpc.privateSubnets, subnet => subnet.subnetId).toString())
     createCfnOutput(
       `${id}PublicSubnetRouteTableIds`,
       scope,
-      vpc.publicSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
+      _.map(vpc.publicSubnets, subnet => subnet.routeTable.routeTableId).toString()
     )
     createCfnOutput(
       `${id}PrivateSubnetRouteTableIds`,
       scope,
-      vpc.privateSubnets.map(subnet => subnet.routeTable.routeTableId).toString()
+      _.map(vpc.privateSubnets, subnet => subnet.routeTable.routeTableId).toString()
     )
     createCfnOutput(`${id}AvailabilityZones`, scope, vpc.availabilityZones.toString())
     createCfnOutput(`${id}DefaultSecurityGroup`, scope, vpc.vpcDefaultSecurityGroup.toString())

package/src/lib/aws/types/index.ts

@@ -1 +1,6 @@
-export * from './aws'
+/**
+ */
+export interface TagProps {
+  key: string
+  value: string
+}

package/src/lib/aws/utils/index.ts

@@ -1,43 +1,55 @@
-export * from './aws'
+import { fromEnv, fromIni } from '@aws-sdk/credential-providers'
+import { AwsCredentialIdentityProvider } from '@aws-sdk/types'
+import { CfnOutput } from 'aws-cdk-lib'
+import _ from 'lodash'
+import { CommonConstruct } from '../common'
 
 /**
+ * @summary Helper method to add CloudFormation outputs from the construct
+ * @param id scoped id of the resource
+ * @param scope scope in which this resource is defined
+ * @param value the value of the exported output
+ * @param description optional description for the output
+ * @param overrideId Flag which indicates whether to override the default logical id of the output
+ * @returns The CloudFormation output
  */
-const defaultResponseObject = {
-  body: '',
-  headers: {
-    'Access-Control-Allow-Origin': '*',
-  },
-  isBase64Encoded: false,
-  statusCode: 200,
+export function createCfnOutput(
+  id: string,
+  scope: CommonConstruct,
+  value?: string,
+  description?: string,
+  overrideId = true
+): CfnOutput {
+  const camelName = _.camelCase(id)
+  const output = new CfnOutput(scope, id, {
+    description,
+    exportName: `${scope.props.stackName}-${camelName}`,
+    value: value ?? '',
+  })
+  if (overrideId) {
+    output.overrideLogicalId(camelName)
+  }
+  return output
 }
 
 /**
+ *
  */
-export enum LogLevel {
-  DEBUG = 'DEBUG',
-  INFO = 'INFO',
-  WARNING = 'WARNING',
-  TRACE = 'TRACE',
-  ERROR = 'ERROR',
-  CRITICAL = 'CRITICAL',
+export function determineCredentials(): AwsCredentialIdentityProvider {
+  if (process.env.AWS_PROFILE) return fromIni()
+  return fromEnv()
 }
 
 /**
- * @param stage
- */
-export const isDevStage = (stage: string) => stage === 'dev'
-/**
- * @param stage
- */
-export const isTestStage = (stage: string) => stage === 'tst'
-/**
- * @param stage
- */
-export const isUatStage = (stage: string) => stage === 'uat'
-/**
- * @param stage
  */
-export const isPrdStage = (stage: string) => stage === 'prd'
+const defaultResponseObject = {
+  body: '',
+  headers: {
+    'Access-Control-Allow-Origin': '*',
+  },
+  isBase64Encoded: false,
+  statusCode: 200,
+}
 
 /**
  * @param error

package/src/lib/azure/common/construct.ts

@@ -0,0 +1,57 @@
+import { AzurermProvider } from '@cdktf/provider-azurerm/lib/provider'
+import { TerraformStack } from 'cdktf'
+import { Construct } from 'constructs'
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
+import { AzureStorageManager } from '../services'
+import { CommonAzureStackProps } from './types'
+
+export class CommonAzureConstruct extends TerraformStack {
+  declare props: CommonAzureStackProps
+  id: string
+  fullyQualifiedDomainName: string
+  storageManager: AzureStorageManager
+
+  constructor(scope: Construct, id: string, props: CommonAzureStackProps) {
+    super(scope, id)
+    this.props = props
+    this.id = id
+
+    this.storageManager = new AzureStorageManager()
+
+    this.determineFullyQualifiedDomain()
+    new AzurermProvider(this, `${this.id}-provider`, this.props)
+  }
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  protected determineFullyQualifiedDomain(): void {
+    this.fullyQualifiedDomainName = this.props.subDomain
+      ? `${this.props.subDomain}.${this.props.domainName}`
+      : this.props.domainName
+  }
+
+  /**
+   * @summary Utility method to determine if the initialisation is in development (dev) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isDevelopmentStage = () => isDevStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in test (tst) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isTestStage = () => isTestStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in uat (uat) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isUatStage = () => isUatStage(this.props.stage)
+
+  /**
+   * @summary Utility method to determine if the initialisation is in production (prd) stage
+   * This is determined by the stage property injected via cdk context
+   */
+  public isProductionStage = () => isPrdStage(this.props.stage)
+}

package/src/lib/azure/common/index.ts

@@ -0,0 +1,3 @@
+export * from './construct'
+export * from './stack'
+export * from './types'

package/src/lib/azure/common/stack.ts

@@ -0,0 +1,143 @@
+import fs from 'fs'
+import { CommonAzureConstruct } from './construct'
+import { CommonAzureStackProps } from './types'
+
+import appRoot from 'app-root-path'
+import { TerraformStack } from 'cdktf'
+import { Construct } from 'constructs'
+import _ from 'lodash'
+import { isDevStage } from '../../common'
+
+/**
+ * @classdesc Common stack to use as a base for all higher level constructs.
+ * @example
+ * import { CommonAzureStack } from '@gradientedge/cdk-utils'
+ *
+ * class CustomStack extends CommonAzureStack {
+ *   constructor(parent: App, name: string, props: StackProps) {
+ *     super(parent, name, props)
+ *     // provision resources
+ *   }
+ * }
+ */
+export class CommonAzureStack extends TerraformStack {
+  construct: CommonAzureConstruct
+  props: CommonAzureStackProps
+
+  constructor(parent: Construct, name: string, props: CommonAzureStackProps) {
+    super(parent, name)
+
+    /* determine extra cdk contexts */
+    this.determineExtraContexts()
+
+    /* determine extra cdk stage contexts */
+    this.determineStageContexts()
+
+    this.props = this.determineConstructProps(props)
+
+    /* initialise the construct */
+    this.construct = new CommonAzureConstruct(this, 'cdk-utils', this.props)
+  }
+
+  /**
+   * @summary Method to determine the core CDK construct properties injected via context cdktf.json
+   * @param props The stack properties
+   * @returns The stack properties
+   */
+  protected determineConstructProps(props: CommonAzureStackProps) {
+    return {
+      domainName: this.node.tryGetContext('domainName'),
+      extraContexts: this.node.tryGetContext('extraContexts'),
+      features: this.node.tryGetContext('features'),
+      name: this.node.tryGetContext('resourceGroupName'),
+      resourceGroupName: this.node.tryGetContext('resourceGroupName'),
+      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
+      stage: this.node.tryGetContext('stage'),
+      subDomain: this.node.tryGetContext('subDomain'),
+    }
+  }
+
+  /**
+   * @summary Method to determine extra cdk contexts apart from the main cdktf.json
+   * - Sets the properties from the extra contexts into cdk node context
+   * - Primary use is to have layered config in separate files to enable easier maintenance and readability
+   */
+  protected determineExtraContexts() {
+    const extraContexts = this.node.tryGetContext('extraContexts')
+    const debug = this.node.tryGetContext('debug')
+
+    if (!extraContexts) {
+      if (debug) console.debug(`No additional contexts provided. Using default context properties from cdktf.json`)
+      return
+    }
+
+    _.forEach(extraContexts, (context: string) => {
+      const extraContextPath = `${appRoot.path}/${context}`
+
+      /* scenario where extra context is configured in cdk.json but absent in file system */
+      if (!fs.existsSync(extraContextPath)) throw `Extra context properties unavailable in path:${extraContextPath}`
+
+      /* read the extra properties */
+      const extraContextPropsBuffer = fs.readFileSync(extraContextPath)
+      if (debug) console.debug(`Adding additional contexts provided in ${extraContextPath}`)
+
+      /* parse as JSON properties */
+      const extraContextProps = JSON.parse(extraContextPropsBuffer.toString('utf-8'))
+
+      /* set each of the property into the cdk node context */
+      _.keys(extraContextProps).forEach((propKey: any) => {
+        this.node.setContext(propKey, extraContextProps[propKey])
+      })
+    })
+  }
+
+  /**
+   * @summary Method to determine extra cdk stage contexts apart from the main cdktf.json
+   * - Sets the properties from the extra stage contexts into cdk node context
+   * - Primary use is to have layered config for each environment which is injected into the context
+   */
+  protected determineStageContexts() {
+    const stage = this.node.tryGetContext('stage')
+    const stageContextPath = this.node.tryGetContext('stageContextPath') || 'cdkEnv'
+    const stageContextFilePath = `${appRoot.path}/${stageContextPath}/${stage}.json`
+    const debug = this.node.tryGetContext('debug')
+
+    if (isDevStage(stage)) {
+      if (debug) console.debug(`Development stage. Using default stage context properties`)
+    }
+
+    /* alert default context usage when extra stage config is missing */
+    if (!fs.existsSync(stageContextFilePath)) {
+      if (debug) console.debug(`Stage specific context properties unavailable in path:${stageContextFilePath}`)
+      if (debug) console.debug(`Using default stage context properties for ${stage} stage`)
+      return
+    }
+
+    /* read the extra properties */
+    const stageContextPropsBuffer = fs.readFileSync(stageContextFilePath)
+    if (debug) console.debug(`Adding additional stage contexts provided in ${stageContextFilePath}`)
+
+    /* parse as JSON properties */
+    const stageContextProps = JSON.parse(stageContextPropsBuffer.toString('utf-8'))
+
+    /* set each of the property into the cdk node context */
+    _.keys(stageContextProps).forEach((propKey: any) => {
+      /* handle object, array properties */
+      if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
+        this.node.setContext(propKey, _.merge(this.node.tryGetContext(propKey), stageContextProps[propKey]))
+      } else {
+        /* handle all other primitive properties */
+        this.node.setContext(propKey, stageContextProps[propKey])
+      }
+    })
+  }
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  protected fullyQualifiedDomain() {
+    const domainName = this.node.tryGetContext('domainName')
+    const subDomain = this.node.tryGetContext('subDomain')
+    return subDomain ? `${subDomain}.${domainName}` : domainName
+  }
+}

package/src/lib/azure/common/types.ts

@@ -0,0 +1,8 @@
+import { AzurermProviderConfig } from '@cdktf/provider-azurerm/lib/provider'
+import { BaseProps } from '../../common'
+
+/**
+ */
+export interface CommonAzureStackProps extends BaseProps, AzurermProviderConfig {
+  resourceGroupName?: string
+}

package/src/lib/azure/index.ts

@@ -0,0 +1,4 @@
+export * from './common'
+export * from './services'
+export * from './types'
+export * from './utils'

package/src/lib/azure/services/index.ts

@@ -0,0 +1 @@
+export * from './storage'

package/src/lib/azure/services/storage/index.ts

@@ -0,0 +1,2 @@
+export * from './main'
+export * from './types'