forked from aws/aws-cdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(cli): format of tags in cdk.json is not validated (aws#21050)
If tags is present in cdk.json, validate that it is an array of objects, and each object has a Tag string and a Value string. If tags is not structurally valid `cdk bootstrap` and `cdk deploy` fail with an error. `tags must be an array of { Tag: string, Value: string } objects` There is no attempt to validate the strings of each Tag and Value beyond that they are strings. closes aws#20854 ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.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
1 parent
d804573
commit 5a74a84
Showing
3 changed files
with
54 additions
and
2 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
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,20 @@ | ||
import { Tag } from '../cdk-toolkit'; | ||
|
||
/** | ||
* Throws an error if tags is neither undefined nor an array of Tags, | ||
* as defined in cdk-toolkit.ts. | ||
* | ||
* It does not attempt to validate the tags themselves. It only validates | ||
* that the objects in the array conform to the Tags interface. | ||
*/ | ||
export function validateTags(tags: any): Tag[] | undefined { | ||
const valid = tags === undefined || ( | ||
Array.isArray(tags) && | ||
tags.every(t => typeof(t.Tag) === 'string' && typeof(t.Value) === 'string') | ||
); | ||
if (valid) { | ||
return tags; | ||
} else { | ||
throw new Error('tags must be an array of { Tag: string, Value: string } objects'); | ||
} | ||
} |
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,31 @@ | ||
import { validateTags } from '../../lib/util/tags'; | ||
|
||
test('validateTags does not throw when given undefined', () => { | ||
expect(validateTags(undefined)).toBeUndefined(); | ||
}); | ||
|
||
test('validateTags does not throw when given an empty array', () => { | ||
const tags: any = []; | ||
expect(validateTags(tags)).toBe(tags); | ||
}); | ||
|
||
test('validateTags does not throw when given array of Tag objects', () => { | ||
const tags: any = [{ Tag: 'a', Value: 'b' }]; | ||
expect(validateTags(tags)).toBe(tags); | ||
}); | ||
|
||
test('validateTags throws when given an object', () => { | ||
expect(() => validateTags({ a: 'b' })).toThrow('tags must be'); | ||
}); | ||
|
||
test('validateTags throws when given an array of non-Tag objects', () => { | ||
expect(() => validateTags([{ a: 'b' }])).toThrow('tags must be'); | ||
}); | ||
|
||
test('validateTags throws when Tag is not a string', () => { | ||
expect(() => validateTags([{ Tag: null, Value: 'b' }])).toThrow(); | ||
}); | ||
|
||
test('validateTags throws when Value is not a string', () => { | ||
expect(() => validateTags([{ Tag: 'a', Value: null }])).toThrow(); | ||
}); |