Merge pull request #256 from umccr/feature/universal-event-archiver

custom event bus archiver props and stateful unit testing fixing
umccr · Apr 29, 2024 · 1b81581 · 1b81581
2 parents ebeea05 + f7160eb
commit 1b81581
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 28 deletions.
diff --git a/config/stacks/shared.ts b/config/stacks/shared.ts
@@ -20,7 +20,10 @@ import {
 } from '../constants';
 import { Duration, RemovalPolicy } from 'aws-cdk-lib';
 import { SchemaRegistryProps } from '../../lib/workload/stateful/stacks/shared/constructs/schema-registry';
-import { EventBusProps } from '../../lib/workload/stateful/stacks/shared/constructs/event-bus';
+import {
+ EventBusProps,
+ EventBusArchiverProps,
+} from '../../lib/workload/stateful/stacks/shared/constructs/event-bus';
 import { ComputeProps } from '../../lib/workload/stateful/stacks/shared/constructs/compute';
 import { EventSourceProps } from '../../lib/workload/stateful/stacks/shared/constructs/event-source';
 
@@ -37,31 +40,36 @@ const getEventBusConstructProps = (n: AccountName): EventBusProps => {
  archiveName: 'OrcaBusMainArchive',
  archiveDescription: 'OrcaBus main event bus archive',
  archiveRetention: 365,
+ };
 
-  // common config for custom event archiver
+ const baseUniversalEventArchiverProps: EventBusArchiverProps = {
  vpcProps: vpcProps,
  archiveBucketName: 'orcabus-universal-events-archive-' + accountIdAlias[n],
- lambdaSecurityGroupName: 'OrcaBusSharedEventBusEventArchiveSecurityGroup',
+ lambdaSecurityGroupName: 'OrcaBusSharedEventBusUniversalEventArchiveSecurityGroup',
+ bucketRemovalPolicy: RemovalPolicy.DESTROY,
  };
 
  switch (n) {
  case 'beta':
  return {
  ...baseConfig,
  addCustomEventArchiver: true,
- bucketRemovalPolicy: RemovalPolicy.DESTROY,
+ universalEventArchiverProps: baseUniversalEventArchiverProps,
  };
  case 'gamma':
  return {
  ...baseConfig,
  addCustomEventArchiver: true,
- bucketRemovalPolicy: RemovalPolicy.DESTROY,
+ universalEventArchiverProps: baseUniversalEventArchiverProps,
  };
  case 'prod':
  return {
  ...baseConfig,
  addCustomEventArchiver: true,
- bucketRemovalPolicy: RemovalPolicy.RETAIN,
+ universalEventArchiverProps: {
+ ...baseUniversalEventArchiverProps,
+ bucketRemovalPolicy: RemovalPolicy.RETAIN,
+ },
  };
  }
 };

diff --git a/lib/workload/stateful/stacks/shared/constructs/event-bus/index.ts b/lib/workload/stateful/stacks/shared/constructs/event-bus/index.ts
@@ -5,6 +5,14 @@ import { Vpc, VpcLookupOptions, SecurityGroup } from 'aws-cdk-lib/aws-ec2';
 import { Bucket } from 'aws-cdk-lib/aws-s3';
 import { UniversalEventArchiverConstruct } from './custom-event-archiver/construct/universal-event-archiver';
 
+// generic event bus archiver props
+export interface EventBusArchiverProps {
+ vpcProps: VpcLookupOptions;
+ lambdaSecurityGroupName: string;
+ archiveBucketName: string;
+ bucketRemovalPolicy: RemovalPolicy;
+}
+
 export interface EventBusProps {
  eventBusName: string;
  archiveName: string;
@@ -13,10 +21,7 @@ export interface EventBusProps {
 
  // Optional for custom event archiver
  addCustomEventArchiver?: boolean;
- vpcProps?: VpcLookupOptions;
- lambdaSecurityGroupName?: string;
- archiveBucketName?: string;
- bucketRemovalPolicy?: RemovalPolicy;
+ universalEventArchiverProps?: EventBusArchiverProps;
 }
 
 export class EventBusConstruct extends Construct {
@@ -28,7 +33,8 @@ export class EventBusConstruct extends Construct {
 
  // Optional for custom event archiver
  if (props.addCustomEventArchiver) {
- this.createUniversalEventArchiver(props);
+ props.universalEventArchiverProps &&
+ this.createUniversalEventArchiver(props.universalEventArchiverProps);
  }
  }
 
@@ -49,18 +55,7 @@ export class EventBusConstruct extends Construct {
  return mainBus;
  }
 
- private createUniversalEventArchiver(props: EventBusProps) {
- if (
- !props.vpcProps ||
- !props.archiveBucketName ||
- !props.lambdaSecurityGroupName ||
- !props.bucketRemovalPolicy
- ) {
- throw new Error(
- 'VPC, Security Group, Archive Bucket Name and Removal Policy are required for custom event archiver function.'
- );
- }
-
+ private createUniversalEventArchiver(props: EventBusArchiverProps) {
  const vpc = Vpc.fromLookup(this, 'MainVpc', props.vpcProps);
 
  // dedicated bucket for archiving all events

diff --git a/test/stateful/shared/eventbusConstruct.test.ts b/test/stateful/shared/eventbusConstruct.test.ts
@@ -1,5 +1,5 @@
 import * as cdk from 'aws-cdk-lib';
-import { Template } from 'aws-cdk-lib/assertions';
+import { Template, Match } from 'aws-cdk-lib/assertions';
 import { getEnvironmentConfig } from '../../../config/config';
 import { EventBusConstruct } from '../../../lib/workload/stateful/stacks/shared/constructs/event-bus';
 import { vpcProps } from '../../../config/constants';
@@ -31,11 +31,12 @@ test('Test EventBusConstruct Creation With Custome Events Archiver', () => {
  template.hasResourceProperties('AWS::Events::EventBus', {
  Name: 'OrcaBusMain',
  });
- template.hasResourceProperties('AWS::S3::Bucket', {
- BucketName: 'event-archive-bucket',
- });
+ template.hasResourceProperties(
+ 'AWS::S3::Bucket',
+ Match.objectLike({ BucketName: Match.stringLikeRegexp('orcabus-universal-events-') })
+ );
  template.hasResourceProperties('AWS::EC2::SecurityGroup', {
- GroupName: 'OrcaBusEventArchiveSecurityGroup',
+ GroupName: 'OrcaBusSharedEventBusUniversalEventArchiveSecurityGroup',
  });
  template.hasResourceProperties('AWS::Lambda::Function', {
  Handler: 'universal_event_archiver.handler',