Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(ecr): make validateRepositoryName errors human readable #27186

Merged
merged 11 commits into from
Sep 19, 2023
Merged

feat(ecr): make validateRepositoryName errors human readable #27186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ae65409
Merge pull request #2 from aws/main
scanlonp Sep 21, 2022
2ebdad8
Merge branch 'aws:main' into main
scanlonp Jul 18, 2023
0875c95
Merge branch 'aws:main' into main
scanlonp Aug 22, 2023
fa997db
Merge branch 'aws:main' into main
scanlonp Aug 25, 2023
01a589c
Merge branch 'aws:main' into main
scanlonp Aug 28, 2023
e307864
Merge branch 'aws:main' into main
scanlonp Sep 1, 2023
df490ed
Merge branch 'aws:main' into main
scanlonp Sep 5, 2023
4e6fece
Merge branch 'aws:main' into main
scanlonp Sep 18, 2023
bd8e258
update error message to words
scanlonp Sep 18, 2023
8f14c73
update docstring
scanlonp Sep 19, 2023
2c5f240
Merge branch 'main' into scanlonp/ecr-name-error
mergify[bot] Sep 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/aws-cdk-lib/aws-ecr/lib/repository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,11 @@ export interface OnImageScanCompletedOptions extends events.OnEventOptions {

export interface RepositoryProps {
/**
* Name for this repository
* Name for this repository.
*
* The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.
*
* > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
*
* @default Automatically generated name.
*/
Expand Down Expand Up @@ -672,7 +676,7 @@ export class Repository extends RepositoryBase {
}
const isPatternMatch = /^(?:[a-z0-9]+(?:[._-][a-z0-9]+)*\/)*[a-z0-9]+(?:[._-][a-z0-9]+)*$/.test(repositoryName);
if (!isPatternMatch) {
errors.push('Repository name must follow the specified pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*');
errors.push('Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes');
}

if (errors.length > 0) {
Expand Down
10 changes: 5 additions & 5 deletions packages/aws-cdk-lib/aws-ecr/test/repository.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,7 @@ describe('repository', () => {
const expectedErrors = [
`Invalid ECR repository name (value: ${repositoryName})`,
'Repository name must be at least 2 and no more than 256 characters',
'Repository name must follow the specified pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*',
'Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes',
].join(EOL);

expect(() => new ecr.Repository(stack, 'Repo', {
Expand All @@ -923,19 +923,19 @@ describe('repository', () => {

expect(() => new ecr.Repository(stack, 'Repo1', {
repositoryName: 'aAa',
})).toThrow(/must follow the specified pattern/);
})).toThrow('Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes');

expect(() => new ecr.Repository(stack, 'Repo2', {
repositoryName: 'a--a',
})).toThrow(/must follow the specified pattern/);
})).toThrow('Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes');

expect(() => new ecr.Repository(stack, 'Repo3', {
repositoryName: 'a./a-a',
})).toThrow(/must follow the specified pattern/);
})).toThrow('Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes');

expect(() => new ecr.Repository(stack, 'Repo4', {
repositoryName: 'a//a-a',
})).toThrow(/must follow the specified pattern/);
})).toThrow('Repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, periods and forward slashes');
});

test('return value addToResourcePolicy', () => {
Expand Down