@gradientedge/cdk-utils 8.120.0 → 8.122.0

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

@@ -0,0 +1,164 @@
+import { CfnOutput } from 'aws-cdk-lib'
+import { Construct } from 'constructs'
+import { isDevStage, isPrdStage, isTestStage, isUatStage } from '../../common'
+import {
+  AcmManager,
+  ApiManager,
+  AppConfigManager,
+  CloudFrontManager,
+  CloudTrailManager,
+  CloudWatchManager,
+  CodeBuildManager,
+  DynamodbManager,
+  EcrManager,
+  EcsManager,
+  EfsManager,
+  EksManager,
+  ElastiCacheManager,
+  EventManager,
+  EventTargetManager,
+  EvidentlyManager,
+  IamManager,
+  KmsManager,
+  LambdaManager,
+  LogManager,
+  Route53Manager,
+  S3Manager,
+  SecretsManager,
+  SfnManager,
+  SnsManager,
+  SqsManager,
+  SsmManager,
+  VpcManager,
+  WafManager,
+} from '../services'
+import { createCfnOutput } from '../utils'
+import { CommonStackProps } from './types'
+
+/**
+ * @subcategory Construct
+ * @classdesc Common construct to use as a base for all higher level constructs.
+ * @example
+ * import { CommonConstruct } from '@gradientedge/cdk-utils';
+ *
+ * class CustomConstruct extends CommonConstruct {
+ *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *     super(parent, id, props);
+ *     this.props = props;
+ *   };
+ * };
+ */
+export class CommonConstruct extends Construct {
+  props: CommonStackProps
+  acmManager: AcmManager
+  apiManager: ApiManager
+  appConfigManager: AppConfigManager
+  codeBuildManager: CodeBuildManager
+  cloudFrontManager: CloudFrontManager
+  cloudTrailManager: CloudTrailManager
+  cloudWatchManager: CloudWatchManager
+  dynamodbManager: DynamodbManager
+  ecrManager: EcrManager
+  ecsManager: EcsManager
+  efsManager: EfsManager
+  eksManager: EksManager
+  elasticacheManager: ElastiCacheManager
+  eventManager: EventManager
+  eventTargetManager: EventTargetManager
+  evidentlyManager: EvidentlyManager
+  iamManager: IamManager
+  kmsManager: KmsManager
+  lambdaManager: LambdaManager
+  logManager: LogManager
+  route53Manager: Route53Manager
+  s3Manager: S3Manager
+  secretsManager: SecretsManager
+  sfnManager: SfnManager
+  snsManager: SnsManager
+  sqsManager: SqsManager
+  ssmManager: SsmManager
+  vpcManager: VpcManager
+  wafManager: WafManager
+
+  fullyQualifiedDomainName: string
+
+  constructor(parent: Construct, id: string, props: CommonStackProps) {
+    super(parent, id)
+    this.props = props
+    this.acmManager = new AcmManager()
+    this.apiManager = new ApiManager()
+    this.appConfigManager = new AppConfigManager()
+    this.codeBuildManager = new CodeBuildManager()
+    this.cloudFrontManager = new CloudFrontManager()
+    this.cloudTrailManager = new CloudTrailManager()
+    this.cloudWatchManager = new CloudWatchManager()
+    this.dynamodbManager = new DynamodbManager()
+    this.ecrManager = new EcrManager()
+    this.ecsManager = new EcsManager()
+    this.efsManager = new EfsManager()
+    this.eksManager = new EksManager()
+    this.elasticacheManager = new ElastiCacheManager()
+    this.eventManager = new EventManager()
+    this.eventTargetManager = new EventTargetManager()
+    this.evidentlyManager = new EvidentlyManager()
+    this.iamManager = new IamManager()
+    this.kmsManager = new KmsManager()
+    this.lambdaManager = new LambdaManager()
+    this.logManager = new LogManager()
+    this.route53Manager = new Route53Manager()
+    this.s3Manager = new S3Manager()
+    this.secretsManager = new SecretsManager()
+    this.sfnManager = new SfnManager()
+    this.snsManager = new SnsManager()
+    this.sqsManager = new SqsManager()
+    this.ssmManager = new SsmManager()
+    this.vpcManager = new VpcManager()
+    this.wafManager = new WafManager()
+
+    this.determineFullyQualifiedDomain()
+  }
+
+  /**
+   * @summary Helper method to add CloudFormation outputs from the construct
+   * @param id scoped id of the resource
+   * @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
+   */
+  protected addCfnOutput(id: string, value: string, description?: string, overrideId = true): CfnOutput {
+    return createCfnOutput(id, this, value, description, overrideId)
+  }
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  protected determineFullyQualifiedDomain() {
+    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/aws/common/index.ts

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

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

@@ -0,0 +1,150 @@
+import { App, Stack, StackProps } from 'aws-cdk-lib'
+import { Runtime } from 'aws-cdk-lib/aws-lambda'
+import fs from 'fs'
+import { CommonConstruct } from './construct'
+import { CommonStackProps } from './types'
+
+import appRoot from 'app-root-path'
+import { isDevStage } from '../../common'
+
+/**
+ * @classdesc Common stack to use as a base for all higher level constructs.
+ * @example
+ * import { CommonStack } from '@gradientedge/cdk-utils'
+ *
+ * class CustomStack extends CommonStack {
+ *   constructor(parent: App, name: string, props: StackProps) {
+ *     super(parent, name, props)
+ *     // provision resources
+ *   }
+ * }
+ */
+export class CommonStack extends Stack {
+  public static NODEJS_RUNTIME = Runtime.NODEJS_18_X
+
+  construct: CommonConstruct
+  props: CommonStackProps
+
+  constructor(parent: App, name: string, props: StackProps) {
+    super(parent, name, props)
+
+    /* determine extra cdk contexts */
+    this.determineExtraContexts()
+
+    /* determine extra cdk stage contexts */
+    this.determineStageContexts()
+
+    this.props = this.determineConstructProps(props)
+
+    /* initialise the construct */
+    this.construct = new CommonConstruct(this, 'cdk-utils', this.props)
+  }
+
+  /**
+   * @summary Method to determine the core CDK construct properties injected via context cdk.json
+   * @param props The stack properties
+   * @returns The stack properties
+   */
+  protected determineConstructProps(props: StackProps) {
+    return {
+      domainName: this.node.tryGetContext('domainName'),
+      excludeDomainNameForBuckets: this.node.tryGetContext('excludeDomainNameForBuckets'),
+      extraContexts: this.node.tryGetContext('extraContexts'),
+      logRetention: this.node.tryGetContext('logRetention'),
+      name: props.stackName || 'cdk-utils',
+      nodejsRuntime: this.node.tryGetContext('nodejsRuntime') ?? CommonStack.NODEJS_RUNTIME,
+      region: this.node.tryGetContext('region'),
+      skipStageForARecords: this.node.tryGetContext('skipStageForARecords'),
+      stackName: props.stackName,
+      stage: this.node.tryGetContext('stage'),
+      subDomain: this.node.tryGetContext('subDomain'),
+    }
+  }
+
+  /**
+   * @summary Method to determine extra cdk contexts apart from the main cdk.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 cdk.json`)
+      return
+    }
+
+    extraContexts.forEach((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 */
+      Object.keys(extraContextProps).forEach((propKey: any) => {
+        this.node.setContext(propKey, extraContextProps[propKey])
+      })
+    })
+  }
+
+  /**
+   * @summary Method to determine extra cdk stage contexts apart from the main cdk.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 */
+    Object.keys(stageContextProps).forEach((propKey: any) => {
+      /* handle object, array properties */
+      if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
+        this.node.setContext(propKey, {
+          ...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/aws/common/types.ts

@@ -0,0 +1,15 @@
+import { StackProps } from 'aws-cdk-lib'
+import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda'
+import { RetentionDays } from 'aws-cdk-lib/aws-logs'
+import { BaseProps } from '../../common'
+
+/**
+ */
+export interface CommonStackProps extends BaseProps, StackProps {
+  region: string
+  logRetention?: RetentionDays
+  defaultReservedLambdaConcurrentExecutions?: number
+  defaultTracing?: Tracing
+  excludeDomainNameForBuckets?: boolean
+  nodejsRuntime?: Runtime
+}

package/src/lib/aws/index.ts

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

package/src/lib/{utils/aws → aws/utils}/index.ts

@@ -2,7 +2,7 @@ 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'
+import { CommonConstruct } from '../common'
 
 /**
  * @summary Helper method to add CloudFormation outputs from the construct
@@ -39,3 +39,35 @@ export function determineCredentials(): AwsCredentialIdentityProvider {
   if (process.env.AWS_PROFILE) return fromIni()
   return fromEnv()
 }
+
+/**
+ */
+const defaultResponseObject = {
+  body: '',
+  headers: {
+    'Access-Control-Allow-Origin': '*',
+  },
+  isBase64Encoded: false,
+  statusCode: 200,
+}
+
+/**
+ * @param error
+ */
+export function redirectError(error: any) {
+  console.error(error, error.message, error.stack)
+  return Object.assign({}, defaultResponseObject, {
+    body: JSON.stringify(Object.assign({}, { error: error.message, success: false })),
+    statusCode: 500,
+  })
+}
+
+/**
+ * @param message
+ */
+export function redirectSuccess(message: any) {
+  return Object.assign({}, defaultResponseObject, {
+    body: JSON.stringify(Object.assign({}, { error: message, success: true })),
+    statusCode: 200,
+  })
+}

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,145 @@
+import fs from 'fs'
+import { CommonAzureConstruct } from './construct'
+import { CommonAzureStackProps } from './types'
+
+import appRoot from 'app-root-path'
+import { App, TerraformStack } from 'cdktf'
+import { isDevStage } from '../../common'
+import { Construct } from 'constructs'
+
+/**
+ * @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
+    }
+
+    extraContexts.forEach((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 */
+      Object.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 */
+    Object.keys(stageContextProps).forEach((propKey: any) => {
+      /* handle object, array properties */
+      if (typeof stageContextProps[propKey] === 'object' && !Array.isArray(stageContextProps[propKey])) {
+        this.node.setContext(propKey, {
+          ...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'