@gradientedge/cdk-utils 8.121.0 → 8.122.0

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'

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

@@ -0,0 +1,134 @@
+import { DataAzurermResourceGroup } from '@cdktf/provider-azurerm/lib/data-azurerm-resource-group'
+import { DataAzurermStorageAccount } from '@cdktf/provider-azurerm/lib/data-azurerm-storage-account'
+import { DataAzurermStorageContainer } from '@cdktf/provider-azurerm/lib/data-azurerm-storage-container'
+import { StorageAccount } from '@cdktf/provider-azurerm/lib/storage-account'
+import { StorageBlob } from '@cdktf/provider-azurerm/lib/storage-blob'
+import { StorageContainer } from '@cdktf/provider-azurerm/lib/storage-container'
+import { CommonAzureConstruct } from '../../common'
+import { createTfOutput } from '../../utils'
+import { StorageAccountProps, StorageBlobProps, StorageContainerProps } from './types'
+
+/**
+ * @classdesc Provides operations on Azure Storage
+ * - A new instance of this class is injected into {@link CommonAzureConstruct} constructor.
+ * - If a custom construct extends {@link CommonAzureConstruct}, an instance is available within the context.
+ * @example
+ * ```
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(parent: Construct, id: string, props: CommonAzureStackProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.storageManager.createStorageAccount('MyAccount', this, props)
+ *   }
+ * }
+ * @see [CDKTF S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
+ * ```
+ */
+export class AzureStorageManager {
+  /**
+   * @summary Method to create a new storage account
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props storage account properties
+   */
+  public createStorageAccount(id: string, scope: CommonAzureConstruct, props: StorageAccountProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
+      name: scope.props.resourceGroupName
+        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+        : `${props.resourceGroupName}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const storageAccount = new StorageAccount(scope, `${id}-sa`, {
+      ...props,
+      accountTier: props.accountTier ?? 'Standard',
+      location: props.location ?? resourceGroup.location,
+      name: `${props.name}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+      tags: props.tags ?? {
+        environment: scope.props.stage,
+      },
+    })
+
+    createTfOutput(`${id}-storageAccountName`, scope, storageAccount.name)
+    createTfOutput(`${id}-storageAccountFriendlyUniqueId`, scope, storageAccount.friendlyUniqueId)
+    createTfOutput(`${id}-storageAccountId`, scope, storageAccount.id)
+  }
+
+  /**
+   * @summary Method to create a new storage container
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props storage container properties
+   */
+  public createStorageContainer(id: string, scope: CommonAzureConstruct, props: StorageContainerProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sc-rg`, {
+      name: scope.props.resourceGroupName
+        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+        : `${props.resourceGroupName}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const storageAccount = new DataAzurermStorageAccount(scope, `${id}-sa`, {
+      name: `${props.storageAccountName}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    const storageContainer = new StorageContainer(scope, `${id}-sc`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      storageAccountName: storageAccount.name,
+    })
+
+    createTfOutput(`${id}-storageContainerName`, scope, storageContainer.name)
+    createTfOutput(`${id}-storageContainerFriendlyUniqueId`, scope, storageContainer.friendlyUniqueId)
+    createTfOutput(`${id}-storageContainerId`, scope, storageContainer.id)
+  }
+
+  /**
+   * @summary Method to create a new storage blob
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props storage blob properties
+   */
+  public createStorageBlob(id: string, scope: CommonAzureConstruct, props: StorageBlobProps) {
+    if (!props) throw `Props undefined for ${id}`
+
+    const resourceGroup = new DataAzurermResourceGroup(scope, `${id}-sb-rg`, {
+      name: scope.props.resourceGroupName
+        ? `${scope.props.resourceGroupName}-${scope.props.stage}`
+        : `${props.resourceGroupName}-${scope.props.stage}`,
+    })
+
+    if (!resourceGroup) throw `Resource group undefined for ${id}`
+
+    const storageAccount = new DataAzurermStorageAccount(scope, `${id}-sa`, {
+      name: `${props.storageAccountName}-${scope.props.stage}`,
+      resourceGroupName: resourceGroup.name,
+    })
+
+    const storageContainer = new DataAzurermStorageContainer(scope, `${id}-sc`, {
+      name: `${props.storageContainerName}-${scope.props.stage}`,
+      storageAccountName: storageAccount.name,
+    })
+
+    const storageBlob = new StorageBlob(scope, `${id}-sb`, {
+      ...props,
+      name: `${props.name}-${scope.props.stage}`,
+      storageAccountName: storageAccount.name,
+      storageContainerName: storageContainer.name,
+    })
+
+    createTfOutput(`${id}-storageBlobName`, scope, storageBlob.name)
+    createTfOutput(`${id}-storageBlobFriendlyUniqueId`, scope, storageBlob.friendlyUniqueId)
+    createTfOutput(`${id}-storageBlobId`, scope, storageBlob.id)
+  }
+}

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

@@ -0,0 +1,10 @@
+import { StorageAccountConfig } from '@cdktf/provider-azurerm/lib/storage-account'
+import { StorageBlobConfig } from '@cdktf/provider-azurerm/lib/storage-blob'
+import { StorageContainerConfig } from '@cdktf/provider-azurerm/lib/storage-container'
+import { BaseConfigProps } from '../../types'
+
+export interface StorageAccountProps extends StorageAccountConfig {}
+
+export interface StorageContainerProps extends BaseConfigProps, StorageContainerConfig {}
+
+export interface StorageBlobProps extends BaseConfigProps, StorageBlobConfig {}

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

@@ -0,0 +1,3 @@
+export interface BaseConfigProps {
+  resourceGroupName: string
+}

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

@@ -0,0 +1,23 @@
+import { TerraformOutput } from 'cdktf'
+import _ from 'lodash'
+import { CommonAzureConstruct } from '../common'
+
+export const createTfOutput = (
+  id: string,
+  scope: CommonAzureConstruct,
+  value?: string,
+  description?: string,
+  sensitive?: boolean,
+  overrideId = true
+) => {
+  const output = new TerraformOutput(scope, id, {
+    description,
+    sensitive,
+    value,
+  })
+
+  if (overrideId) {
+    output.overrideLogicalId(_.camelCase(id))
+  }
+  return output
+}

package/src/lib/common/construct.ts

@@ -0,0 +1,35 @@
+import { Construct } from 'constructs'
+import { BaseProps } from './types'
+
+export abstract class BaseConstruct extends Construct {
+  props: BaseProps
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  public abstract determineFullyQualifiedDomain(): void
+
+  /**
+   * @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 abstract isDevelopmentStage(): void
+
+  /**
+   * @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 abstract isTestStage(): void
+
+  /**
+   * @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 abstract isUatStage(): void
+
+  /**
+   * @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 abstract isProductionStage(): void
+}

package/src/lib/common/index.ts

@@ -0,0 +1,16 @@
+export * from './construct'
+export * from './stack'
+export * from './types'
+export * from './utils'
+
+export const applyMixins = (derivedCtor: any, constructors: any[]) => {
+  constructors.forEach(baseCtor => {
+    Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
+      Object.defineProperty(
+        derivedCtor.prototype,
+        name,
+        Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null)
+      )
+    })
+  })
+}

package/src/lib/common/stack.ts

@@ -0,0 +1,26 @@
+import { Construct } from 'constructs'
+import { BaseProps } from './types'
+
+export abstract class BaseStack extends Construct {
+  props: BaseProps
+
+  /**
+   * @summary Method to determine the core CDK construct properties injected via context cdktf.json
+   */
+  protected abstract determineConstructProps(props: BaseProps): void
+
+  /**
+   * @summary Method to determine extra cdk contexts apart from the main cdktf.json
+   */
+  public abstract determineExtraContexts(): void
+
+  /**
+   * @summary Method to determine extra cdk stage contexts apart from the main cdktf.json
+   */
+  public abstract determineStageContexts(): void
+
+  /**
+   * @summary Determine the fully qualified domain name based on domainName & subDomain
+   */
+  public abstract fullyQualifiedDomain(): void
+}

package/src/lib/common/types.ts

@@ -0,0 +1,9 @@
+export interface BaseProps {
+  domainName: string
+  extraContexts?: string[]
+  name: string
+  skipStageForARecords: boolean
+  stage: string
+  stageContextPath?: string
+  subDomain?: string
+}

package/src/lib/common/utils.ts

@@ -0,0 +1,27 @@
+/**
+ */
+export enum LogLevel {
+  DEBUG = 'DEBUG',
+  INFO = 'INFO',
+  WARNING = 'WARNING',
+  TRACE = 'TRACE',
+  ERROR = 'ERROR',
+  CRITICAL = 'CRITICAL',
+}
+
+/**
+ * @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'

package/src/lib/index.ts

@@ -1 +1,3 @@
 export * from './aws'
+export * from './azure'
+export * from './common'

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

@@ -1,6 +0,0 @@
-/**
- */
-export interface TagProps {
-    key: string;
-    value: string;
-}

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

@@ -1,17 +0,0 @@
-import { AwsCredentialIdentityProvider } from '@aws-sdk/types';
-import { CfnOutput } from 'aws-cdk-lib';
-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
- */
-export declare function createCfnOutput(id: string, scope: CommonConstruct, value?: string, description?: string, overrideId?: boolean): CfnOutput;
-/**
- *
- */
-export declare function determineCredentials(): AwsCredentialIdentityProvider;

package/dist/src/lib/aws/utils/aws/index.js

@@ -1,40 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.determineCredentials = exports.createCfnOutput = void 0;
-const credential_providers_1 = require("@aws-sdk/credential-providers");
-const aws_cdk_lib_1 = require("aws-cdk-lib");
-const lodash_1 = __importDefault(require("lodash"));
-/**
- * @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
- */
-function createCfnOutput(id, scope, value, description, overrideId = true) {
-    const camelName = lodash_1.default.camelCase(id);
-    const output = new aws_cdk_lib_1.CfnOutput(scope, id, {
-        description,
-        exportName: `${scope.props.stackName}-${camelName}`,
-        value: value ?? '',
-    });
-    if (overrideId) {
-        output.overrideLogicalId(camelName);
-    }
-    return output;
-}
-exports.createCfnOutput = createCfnOutput;
-/**
- *
- */
-function determineCredentials() {
-    if (process.env.AWS_PROFILE)
-        return (0, credential_providers_1.fromIni)();
-    return (0, credential_providers_1.fromEnv)();
-}
-exports.determineCredentials = determineCredentials;

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

@@ -1,6 +0,0 @@
-/**
- */
-export interface TagProps {
-  key: string
-  value: string
-}

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

@@ -1,41 +0,0 @@
-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
- */
-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 function determineCredentials(): AwsCredentialIdentityProvider {
-  if (process.env.AWS_PROFILE) return fromIni()
-  return fromEnv()
-}