@gradientedge/cdk-utils 10.7.0 → 10.8.0

package/src/lib/azure/services/portal/renderer.ts

@@ -0,0 +1,182 @@
+import appRoot from 'app-root-path'
+import fs from 'fs'
+import _ from 'lodash'
+import path from 'path'
+import { parse } from 'yaml'
+import { TemplateError } from './error.js'
+import { DashboardRenderer, MissingKeys, PaneTemplate, RenderParams } from './types.js'
+
+export class AzureDashboardRenderer implements DashboardRenderer {
+  private readonly paneTemplatePath: string
+  private readonly outputDir: string
+
+  constructor(basePath?: string, outputDir?: string) {
+    this.paneTemplatePath = basePath ?? path.join(appRoot.path, 'template', 'dashboard')
+    this.outputDir = outputDir ?? path.join(appRoot.path, '.artifacts')
+  }
+
+  private getPaneId(id: string): PaneTemplate {
+    const panePath = `${this.paneTemplatePath}/${id}.yaml`
+    const paneFileContent = fs.readFileSync(panePath, 'utf-8')
+    const paneTemplate = parse(paneFileContent)
+    return paneTemplate
+  }
+
+  public getMissingProperties(template: PaneTemplate, properties: RenderParams['properties'] = []): MissingKeys {
+    const keys = Object.keys(template.properties).filter(key => !(key in properties))
+    return {
+      keys,
+      hasMissingKeys: keys.length !== 0,
+    }
+  }
+
+  public getMissingVariables(template: PaneTemplate, variables: RenderParams['variables']): MissingKeys {
+    const keys = Object.keys(template.variables).filter(key => !(key in variables))
+    return {
+      keys,
+      hasMissingKeys: keys.length !== 0,
+    }
+  }
+
+  public render(params: RenderParams): string {
+    _.templateSettings.interpolate = /{{([\s\S]+?)}}/g
+
+    // if client is used instead of hosts
+    let partsIndex = 0
+    let yIndex = 0
+    const parts: Record<string, any> = {}
+    for (const pane of params.panes) {
+      try {
+        const paneTemplate = this.getPaneId(pane.id)
+        const compiled = _.template(paneTemplate.template)
+
+        function getValue(value: string | number): string | number {
+          try {
+            if (typeof value === 'number') {
+              return value
+            }
+
+            if (value.includes(':')) {
+              const [property, formatter] = value.split(':')
+              const unformattedValue = _.get(params.properties, property)
+              if (formatter === 'host') {
+                const host = new URL(unformattedValue)
+                const port = host.protocol.startsWith('https') ? '443' : '80'
+                return `${host.host}:${port}`
+              }
+
+              return unformattedValue
+            }
+
+            return value
+          } catch (e) {
+            console.error('failed to process', value, 'with error', e)
+
+            return ''
+          }
+        }
+
+        const missingVariables = this.getMissingVariables(paneTemplate, params.variables)
+        if (missingVariables.hasMissingKeys) {
+          throw new TemplateError(
+            `Failed to render pane ${pane.id}: Missing required variables [${missingVariables.keys.join(', ')}] for template substitution.`
+          )
+        }
+
+        const paneProperties: Record<string, string | number | Array<string | number>> = {}
+        for (const [key, value] of Object.entries(pane.properties ?? {})) {
+          if (value === undefined || value === null) {
+            continue
+          }
+
+          let resolvedValue: string | number | Array<string | number> = ''
+          if (typeof value === 'string') {
+            resolvedValue = getValue(value)
+          }
+
+          if (Array.isArray(value)) {
+            resolvedValue = value.map(v => getValue(v))
+          }
+
+          paneProperties[key] = resolvedValue
+        }
+
+        const properties = { ...params.properties, yIndex, ...paneProperties }
+        const missingProperties = this.getMissingProperties(paneTemplate, properties)
+        if (missingProperties.hasMissingKeys) {
+          throw new TemplateError(
+            `Failed to render pane ${pane.id}: Missing required properties [${missingProperties.keys.join(', ')}] for template substitution.`
+          )
+        }
+        const paneContent = compiled(properties)
+        const paneJSON = JSON.parse(paneContent)
+        const templateParts = paneJSON.parts
+
+        for (const part of templateParts) {
+          parts[`${partsIndex}`] = part
+          partsIndex++
+        }
+        yIndex += paneTemplate.dimensions.height
+      } catch (e) {
+        if (TemplateError.isInstance(e)) {
+          throw e
+        }
+        console.error('failed to render pane', pane.id, 'with error', e)
+      }
+    }
+
+    const dashboard = {
+      lenses: {
+        '0': {
+          order: 0,
+          parts,
+        },
+      },
+      metadata: {
+        model: {
+          timeRange: {
+            value: {
+              relative: {
+                duration: 24,
+                timeUnit: 1,
+              },
+            },
+            type: 'MsPortalFx.Composition.Configuration.ValueTypes.TimeRange',
+          },
+          filterLocale: {
+            value: params.filter?.locale ?? 'en-us',
+          },
+          filters: {
+            value: {
+              MsPortalFx_TimeRange: {
+                model: {
+                  format: params.filter?.timeFormat ?? 'utc',
+                  granularity: params.filter?.timeGranularity ?? 'auto',
+                  relative: params.filter?.timeRelative ?? '4h',
+                },
+                displayCache: {
+                  name: 'UTC Time',
+                  value: 'Past 4 hours',
+                },
+                filteredPartIds: [],
+              },
+            },
+          },
+        },
+      },
+    }
+
+    return JSON.stringify(dashboard, null, 2)
+  }
+
+  renderToFile(filename: string, params: RenderParams): string {
+    const templateOutput = this.render(params)
+    if (!fs.existsSync(this.outputDir)) {
+      fs.mkdirSync(this.outputDir, { recursive: true })
+    }
+    const filePath = path.join(this.outputDir, `${filename}.tftpl`)
+    fs.writeFileSync(filePath, templateOutput)
+
+    return filePath
+  }
+}

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

@@ -0,0 +1,45 @@
+import { DashboardArgs } from '@pulumi/azure-native/portal/index.js'
+
+export type PaneTemplate = {
+  dimensions: { height: number }
+  properties: Record<string, string>
+  variables: Record<string, string>
+  template: string
+}
+
+export type MissingKeys = {
+  keys: Array<string>
+  hasMissingKeys: boolean
+}
+
+export type Pane = {
+  id: string
+  properties?: Record<string, string | number | Array<string | number>>
+}
+
+export type Filter = {
+  locale?: string
+  timeFormat?: string
+  timeGranularity?: string
+  timeRelative?: string
+}
+
+export type RenderParams = {
+  panes: Array<Pane>
+  variables: Record<string, any>
+  properties?: Record<string, any>
+  filter?: Filter
+}
+
+export interface DashboardRenderer {
+  render(params: RenderParams): string
+  renderToFile(filename: string, params: RenderParams): string
+}
+
+export interface PortalDashboardProps extends DashboardArgs {
+  displayName: string
+  panes: Array<Pane>
+  variables: Record<string, string>
+  filter?: Filter
+  enabled?: boolean
+}

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

@@ -1,6 +1,7 @@
 import { Redis, SkuFamily, SkuName } from '@pulumi/azure-native/redis/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
-import { ManagedRedisProps } from './types.js'
+import { RedisProps } from './types.js'
 
 /**
  * @classdesc Provides operations on Azure Redis using Pulumi
@@ -25,9 +26,15 @@ export class AzureRedisManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props redis cache properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Redis]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/cache/redis/}
    */
-  public createManagedRedis(id: string, scope: CommonAzureConstruct, props: ManagedRedisProps) {
+  public createManagedRedis(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: RedisProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -53,7 +60,7 @@ export class AzureRedisManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 }

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

@@ -1,3 +1,3 @@
 import { RedisArgs } from '@pulumi/azure-native/redis/index.js'
 
-export interface ManagedRedisProps extends RedisArgs {}
+export interface RedisProps extends RedisArgs {}

package/src/lib/azure/services/resource-group/main.ts

@@ -1,4 +1,5 @@
-import { ResourceGroup } from '@pulumi/azure-native/resources/index.js'
+import { getResourceGroupOutput, ResourceGroup } from '@pulumi/azure-native/resources/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
 import { ResourceGroupProps } from './types.js'
 
@@ -25,9 +26,15 @@ export class AzureResourceGroupManager {
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
    * @param props resource group properties
+   * @param resourceOptions Optional settings to control resource behaviour
    * @see [Pulumi Azure Native Resource Group]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/resources/resourcegroup/}
    */
-  public createResourceGroup(id: string, scope: CommonAzureConstruct, props: ResourceGroupProps) {
+  public createResourceGroup(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ResourceGroupProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     return new ResourceGroup(
@@ -43,7 +50,31 @@ export class AzureResourceGroupManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
+    )
+  }
+
+  /**
+   * @summary Method to resolve an existing resource group
+   * @param scope scope in which this resource is defined
+   * @param resourceGroupName the resource group name
+   * @param resourceOptions Optional settings to control resource behaviour
+   */
+  public resolveResourceGroup(
+    scope: CommonAzureConstruct,
+    resourceGroupName: string,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!resourceGroupName) throw `Resource Group Name undefined`
+
+    return getResourceGroupOutput(
+      {
+        resourceGroupName: scope.resourceNameFormatter.format(
+          resourceGroupName?.toString(),
+          scope.props.resourceNameOptions?.resourceGroup
+        ),
+      },
+      { parent: scope, ...resourceOptions }
     )
   }
 }

package/src/lib/azure/services/security-center/index.ts

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

package/src/lib/azure/services/security-center/main.ts

@@ -0,0 +1,42 @@
+import { DefenderForStorage } from '@pulumi/azure-native/security/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
+import { CommonAzureConstruct } from '../../common/index.js'
+import { DefenderForStorageProps } from './types.js'
+
+/**
+ * @classdesc Provides operations on Azure Security Center using Pulumi
+ * - 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
+ * ```typescript
+ * import { CommonAzureConstruct, CommonAzureStackProps } from '@gradientedge/cdk-utils'
+ *
+ * class CustomConstruct extends CommonAzureConstruct {
+ *   constructor(name: string, props: CommonAzureStackProps) {
+ *     super(name, props)
+ *     this.props = props
+ *     this.securityCenterManager.createDefenderForStorage('MyDefender', this, props)
+ *   }
+ * }
+ * ```
+ */
+export class AzureSecurityCentermanager {
+  /**
+   * @summary Method to create a new defender for storage account
+   * @param id scoped id of the resource
+   * @param scope scope in which this resource is defined
+   * @param props defender for storage account properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Defender For Storage]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/security/defenderforstorage/}
+   */
+  public createDefenderForStorage(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: DefenderForStorageProps,
+    resourceOptions?: ResourceOptions
+  ) {
+    if (!props) throw `Props undefined for ${id}`
+
+    return new DefenderForStorage(`${id}`, props, { parent: scope, ...resourceOptions })
+  }
+}

package/src/lib/azure/services/security-center/types.ts

@@ -0,0 +1,3 @@
+import { DefenderForStorageArgs } from '@pulumi/azure-native/security/index.js'
+
+export interface DefenderForStorageProps extends DefenderForStorageArgs {}

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

@@ -7,13 +7,14 @@ import {
   Subscription,
   Topic,
 } from '@pulumi/azure-native/servicebus/index.js'
+import { ResourceOptions } from '@pulumi/pulumi'
 import { CommonAzureConstruct } from '../../common/index.js'
 import {
   ResolveServicebusQueueProps,
-  ServicebusNamespaceProps,
-  ServicebusQueueProps,
-  ServicebusSubscriptionProps,
-  ServicebusTopicProps,
+  ServiceBusNamespaceProps,
+  ServiceBusQueueProps,
+  ServiceBusSubscriptionProps,
+  ServiceBusTopicProps,
 } from './types.js'
 
 /**
@@ -33,15 +34,21 @@ import {
  * }
  * ```
  */
-export class AzureServicebusManager {
+export class AzureServiceBusManager {
   /**
-   * @summary Method to create a new servicebus namespace
+   * @summary Method to create a new service bus namespace
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
-   * @param props servicebus namespace properties
-   * @see [Pulumi Azure Native Service Bus Namespace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/namespace/}
+   * @param props service bus namespace properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Service Bus Namespace]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/service bus/namespace/}
    */
-  public createServicebusNamespace(id: string, scope: CommonAzureConstruct, props: ServicebusNamespaceProps) {
+  public createServiceBusNamespace(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ServiceBusNamespaceProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     // Get resource group name
@@ -71,18 +78,24 @@ export class AzureServicebusManager {
           environment: scope.props.stage,
         },
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
   /**
-   * @summary Method to create a new servicebus topic
+   * @summary Method to create a new service bus topic
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
-   * @param props servicebus topic properties
-   * @see [Pulumi Azure Native Service Bus Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/topic/}
+   * @param props service bus topic properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Service Bus Topic]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/service bus/topic/}
    */
-  public createServicebusTopic(id: string, scope: CommonAzureConstruct, props: ServicebusTopicProps) {
+  public createServiceBusTopic(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ServiceBusTopicProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     return new Topic(
@@ -96,18 +109,24 @@ export class AzureServicebusManager {
         namespaceName: props.namespaceName,
         resourceGroupName: props.resourceGroupName,
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
   /**
-   * @summary Method to create a new servicebus queue
+   * @summary Method to create a new service bus queue
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
-   * @param props servicebus queue properties
-   * @see [Pulumi Azure Native Service Bus Queue]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
+   * @param props service bus queue properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Service Bus Queue]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/service bus/queue/}
    */
-  public createServicebusQueue(id: string, scope: CommonAzureConstruct, props: ServicebusQueueProps) {
+  public createServiceBusQueue(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ServiceBusQueueProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     return new Queue(
@@ -125,18 +144,24 @@ export class AzureServicebusManager {
         deadLetteringOnMessageExpiration: props.deadLetteringOnMessageExpiration ?? true,
         defaultMessageTimeToLive: (props as any).defaultMessageTtl ?? 'P2D',
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
   /**
-   * @summary Method to create a new servicebus subscription
+   * @summary Method to create a new service bus subscription
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
-   * @param props servicebus subscription properties
-   * @see [Pulumi Azure Native Service Bus Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/subscription/}
+   * @param props service bus subscription properties
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Service Bus Subscription]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/service bus/subscription/}
    */
-  public createServicebusSubscription(id: string, scope: CommonAzureConstruct, props: ServicebusSubscriptionProps) {
+  public createServiceBusSubscription(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ServiceBusSubscriptionProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     return new Subscription(
@@ -149,18 +174,24 @@ export class AzureServicebusManager {
         ),
         maxDeliveryCount: props.maxDeliveryCount ?? 1,
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 
   /**
-   * @summary Method to resolve an existing servicebus queue
+   * @summary Method to resolve an existing service bus queue
    * @param id scoped id of the resource
    * @param scope scope in which this resource is defined
-   * @param props servicebus queue properties for lookup
-   * @see [Pulumi Azure Native Service Bus Queue Lookup]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/servicebus/queue/}
+   * @param props service bus queue properties for lookup
+   * @param resourceOptions Optional settings to control resource behaviour
+   * @see [Pulumi Azure Native Service Bus Queue Lookup]{@link https://www.pulumi.com/registry/packages/azure-native/api-docs/service bus/queue/}
    */
-  public resolveServicebusQueue(id: string, scope: CommonAzureConstruct, props: ResolveServicebusQueueProps) {
+  public resolveServiceBusQueue(
+    id: string,
+    scope: CommonAzureConstruct,
+    props: ResolveServicebusQueueProps,
+    resourceOptions?: ResourceOptions
+  ) {
     if (!props) throw `Props undefined for ${id}`
 
     return getQueueOutput(
@@ -172,7 +203,7 @@ export class AzureServicebusManager {
         namespaceName: props.namespaceName,
         resourceGroupName: props.resourceGroupName,
       },
-      { parent: scope }
+      { parent: scope, ...resourceOptions }
     )
   }
 }

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

@@ -6,12 +6,12 @@ import {
   TopicArgs,
 } from '@pulumi/azure-native/servicebus/index.js'
 
-export interface ServicebusNamespaceProps extends NamespaceArgs {}
+export interface ServiceBusNamespaceProps extends NamespaceArgs {}
 
-export interface ServicebusTopicProps extends TopicArgs {}
+export interface ServiceBusTopicProps extends TopicArgs {}
 
-export interface ServicebusQueueProps extends QueueArgs {}
+export interface ServiceBusQueueProps extends QueueArgs {}
 
-export interface ServicebusSubscriptionProps extends SubscriptionArgs {}
+export interface ServiceBusSubscriptionProps extends SubscriptionArgs {}
 
 export interface ResolveServicebusQueueProps extends GetQueueOutputArgs {}