-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(rds): does not print all failed validations for DatabaseCluster p…
…rops (#32841) ### Issue #32840 Closes #32840 ### Reason for this change When initializing a new RDS DB Cluster, the [current implementation](https://github.com/aws/aws-cdk/pull/32151/files#diff-49b4a9e1bf0b7db3ab71f4f08580da0cb2191d84605dc82a70c324bd122d5cf7R805-R828) fails on the first validation error, making it possible for the user to encounter another failure after fixing known validation issues. ### Description of changes Implemented a [validation function](https://github.com/aws/aws-cdk/pull/32841/files#diff-5d08d37e744e173239879212c59fd45cb9a279349f3dfb1c66923cb015ed3a3a) that collects all validation errors and presents them to the user. Used this function in RDS Database Cluster initialization. I will implement this separately for SQS Queue initialization as a POC for usability. There are several other places that can make use of this shared code, to show users all validation errors at once. Here's a non-exhaustive list: - [aws-ec2](https://github.com/aws/aws-cdk/blob/3e4f3773bfa48b75bf0adc7d53d46bbec7714a9e/packages/aws-cdk-lib/aws-ec2/lib/volume.ts#L672-L743) - [eventbridge-scheduler](https://github.com/aws/aws-cdk/blob/3e4f3773bfa48b75bf0adc7d53d46bbec7714a9e/packages/aws-cdk-lib/aws-stepfunctions-tasks/lib/eventbridge-scheduler/create-schedule.ts#L324-L362) - [aws-fsx](https://github.com/aws/aws-cdk/blob/3e4f3773bfa48b75bf0adc7d53d46bbec7714a9e/packages/aws-cdk-lib/aws-fsx/lib/lustre-file-system.ts#L360-L380) ### Describe any new or updated permissions being added No permissions changes. ### Description of how you validated changes Added unit tests and modified existing unit tests. <img width="698" alt="Screenshot 2025-01-16 at 14 51 47" src="https://github.com/user-attachments/assets/a724a16a-7ccc-43b6-8fee-599ec007566d" /> ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
- Loading branch information
Showing
6 changed files
with
199 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
packages/aws-cdk-lib/aws-rds/lib/validate-database-cluster-props.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { Construct } from 'constructs'; | ||
| import { ClusterScailabilityType, DatabaseCluster, DatabaseClusterProps, DBClusterStorageType } from './cluster'; | ||
| import { PerformanceInsightRetention } from './props'; | ||
| import { validateAllProps, ValidationRule } from '../../core/lib/helpers-internal'; | ||
|
|
||
| const standardDatabaseRules: ValidationRule<DatabaseClusterProps>[] = [ | ||
| { | ||
| condition: (props) => props.enablePerformanceInsights === false && | ||
| (props.performanceInsightRetention !== undefined || props.performanceInsightEncryptionKey !== undefined), | ||
| message: () => '`enablePerformanceInsights` disabled, but `performanceInsightRetention` or `performanceInsightEncryptionKey` was set', | ||
|
|
||
| }, | ||
| ]; | ||
|
|
||
| const limitlessDatabaseRules: ValidationRule<DatabaseClusterProps>[] = [ | ||
| { | ||
| condition: (props) => !props.enablePerformanceInsights, | ||
| message: () => 'Performance Insights must be enabled for Aurora Limitless Database', | ||
| }, | ||
| { | ||
| condition: (props) => !props.performanceInsightRetention | ||
| || props.performanceInsightRetention < PerformanceInsightRetention.MONTHS_1, | ||
| message: () => 'Performance Insights retention period must be set to at least 31 days for Aurora Limitless Database', | ||
| }, | ||
| { | ||
| condition: (props) => !props.monitoringInterval || !props.enableClusterLevelEnhancedMonitoring, | ||
| message: () => 'Cluster level enhanced monitoring must be set for Aurora Limitless Database. Please set \'monitoringInterval\' and enable \'enableClusterLevelEnhancedMonitoring\'', | ||
| }, | ||
| { | ||
| condition: (props) => !!(props.writer || props.readers), | ||
| message: () => 'Aurora Limitless Database does not support reader or writer instances', | ||
| }, | ||
| { | ||
| condition: (props) => !props.engine.engineVersion?.fullVersion?.endsWith('limitless'), | ||
| message: (props) => `Aurora Limitless Database requires an engine version that supports it, got: ${props.engine.engineVersion?.fullVersion}`, | ||
| }, | ||
| { | ||
| condition: (props) => props.storageType !== DBClusterStorageType.AURORA_IOPT1, | ||
| message: (props) => `Aurora Limitless Database requires I/O optimized storage type, got: ${props.storageType}`, | ||
| }, | ||
| { | ||
| condition: (props) => props.cloudwatchLogsExports === undefined || props.cloudwatchLogsExports.length === 0, | ||
| message: () => 'Aurora Limitless Database requires CloudWatch Logs exports to be set', | ||
| }, | ||
| ]; | ||
|
|
||
| export function validateDatabaseClusterProps(scope: Construct, props: DatabaseClusterProps): void { | ||
| const isLimitlessCluster = props.clusterScailabilityType === ClusterScailabilityType.LIMITLESS; | ||
| const applicableRules = isLimitlessCluster | ||
| ? [...standardDatabaseRules, ...limitlessDatabaseRules] | ||
| : standardDatabaseRules; | ||
|
|
||
| validateAllProps(scope, DatabaseCluster.name, props, applicableRules); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
packages/aws-cdk-lib/core/lib/helpers-internal/validate-all-props.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| import { Construct } from 'constructs'; | ||
| import { ValidationError } from '../errors'; | ||
|
|
||
| /** | ||
| * Represents a validation rule for props of type T. | ||
| * @template T The type of the props being validated. | ||
| */ | ||
| export type ValidationRule<T> = { | ||
| /** | ||
| * A function that checks if the validation rule condition is met. | ||
| * @param {T} props - The props object to validate. | ||
| * @returns {boolean} True if the condition is met (i.e., validation fails), false otherwise. | ||
| */ | ||
| condition: (props: T) => boolean; | ||
|
|
||
| /** | ||
| * A function that returns an error message if the validation fails. | ||
| * @param {T} props - The props that failed validation. | ||
| * @returns {string} The error message. | ||
| */ | ||
| message: (props: T) => string; | ||
| }; | ||
|
|
||
| /** | ||
| * Validates props against a set of rules and throws an error if any validations fail. | ||
| * | ||
| * @template T The type of the props being validated. | ||
| * @param {string} className - The name of the class being validated, used in the error message. Ex. for SQS, might be Queue.name | ||
| * @param {T} props - The props object to validate. | ||
| * @param {ValidationRule<T>[]} rules - An array of validation rules to apply. | ||
| * @throws {Error} If any validation rules fail, with a message detailing all failures. | ||
| */ | ||
| export function validateAllProps<T>(scope: Construct, className: string, props: T, rules: ValidationRule<T>[]): void { | ||
| const validationErrors = rules | ||
| .filter(rule => rule.condition(props)) | ||
| .map(rule => rule.message(props)); | ||
|
|
||
| if (validationErrors.length > 0) { | ||
| const errorMessage = `${className} initialization failed due to the following validation error(s):\n${validationErrors.map(error => `- ${error}`).join('\n')}`; | ||
| throw new ValidationError(errorMessage, scope); | ||
| } | ||
| } |
90 changes: 90 additions & 0 deletions
90
packages/aws-cdk-lib/core/test/helpers-internal/validate-all-props.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| import { Construct } from 'constructs'; | ||
| import { ValidationError } from '../../lib/errors'; | ||
| import { validateAllProps, ValidationRule } from '../../lib/helpers-internal/validate-all-props'; | ||
|
|
||
| class TestConstruct extends Construct { | ||
| constructor() { | ||
| super(undefined as any, 'TestConstruct'); | ||
| } | ||
| } | ||
|
|
||
| describe('validateAllProps', () => { | ||
| let testScope: Construct; | ||
|
|
||
| beforeEach(() => { | ||
| testScope = new TestConstruct(); | ||
| }); | ||
|
|
||
| it('should not throw an error when all validations pass', () => { | ||
| const props = { value: 5 }; | ||
| const rules: ValidationRule<typeof props>[] = [ | ||
| { | ||
| condition: (p) => p.value < 0, | ||
| message: (p) => `Value ${p.value} should be non-negative`, | ||
| }, | ||
| ]; | ||
|
|
||
| expect(() => validateAllProps(testScope, 'TestClass', props, rules)).not.toThrow(); | ||
| }); | ||
|
|
||
| it('should throw a ValidationError when a validation fails', () => { | ||
| const props = { value: -5 }; | ||
| const rules: ValidationRule<typeof props>[] = [ | ||
| { | ||
| condition: (p) => p.value < 0, | ||
| message: (p) => `Value ${p.value} should be non-negative`, | ||
| }, | ||
| ]; | ||
|
|
||
| expect(() => validateAllProps(testScope, 'TestClass', props, rules)).toThrow(ValidationError); | ||
| }); | ||
|
|
||
| it('should include all failed validation messages in the error', () => { | ||
| const props = { value1: -5, value2: 15 }; | ||
| const rules: ValidationRule<typeof props>[] = [ | ||
| { | ||
| condition: (p) => p.value1 < 0, | ||
| message: (p) => `Value1 ${p.value1} should be non-negative`, | ||
| }, | ||
| { | ||
| condition: (p) => p.value2 > 10, | ||
| message: (p) => `Value2 ${p.value2} should be 10 or less`, | ||
| }, | ||
| ]; | ||
|
|
||
| expect(() => validateAllProps(testScope, 'TestClass', props, rules)).toThrow(ValidationError); | ||
| try { | ||
| validateAllProps(testScope, 'TestClass', props, rules); | ||
| } catch (error) { | ||
| if (error instanceof ValidationError) { | ||
| expect(error.message).toBe( | ||
| 'TestClass initialization failed due to the following validation error(s):\n' + | ||
| '- Value1 -5 should be non-negative\n' + | ||
| '- Value2 15 should be 10 or less', | ||
| ); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| it('should work with complex object structures', () => { | ||
| const props = { nested: { value: 'invalid' } }; | ||
| const rules: ValidationRule<typeof props>[] = [ | ||
| { | ||
| condition: (p) => p.nested.value !== 'valid', | ||
| message: (p) => `Nested value "${p.nested.value}" is not valid`, | ||
| }, | ||
| ]; | ||
|
|
||
| expect(() => validateAllProps(testScope, 'TestClass', props, rules)).toThrow(ValidationError); | ||
| try { | ||
| validateAllProps(testScope, 'TestClass', props, rules); | ||
| } catch (error) { | ||
| if (error instanceof ValidationError) { | ||
| expect(error.message).toBe( | ||
| 'TestClass initialization failed due to the following validation error(s):\n' + | ||
| '- Nested value "invalid" is not valid', | ||
| ); | ||
| } | ||
| } | ||
| }); | ||
| }); |