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

fix(glue-alpha): prefix validation logic is incorrect #27472

Merged
merged 5 commits into from
Oct 10, 2023
Merged

fix(glue-alpha): prefix validation logic is incorrect #27472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f6cca37
Fix prefix validation logic in aws-glue-alpha.
Oct 9, 2023
d568be8
Merge branch 'main' into mikewrighton-27396
mikewrighton Oct 9, 2023
e07a5d5
Comments
Oct 10, 2023
598cdc3
Update packages/@aws-cdk/aws-glue-alpha/lib/job.ts
mikewrighton Oct 10, 2023
dafe1a7
Merge branch 'main' into mikewrighton-27396
mikewrighton Oct 10, 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
18 changes: 10 additions & 8 deletions packages/@aws-cdk/aws-glue-alpha/lib/job.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,13 +384,13 @@ export interface SparkUIProps {
/**
* The bucket where the Glue job stores the logs.
*
* @default a new bucket will be created.
* @default - a new bucket will be created.
*/
readonly bucket?: s3.IBucket;

/**
* The path inside the bucket (objects prefix) where the Glue job stores the logs.
* Use format `'/foo/bar'`
* Use format `'foo/bar/'`
*
* @default - the logs will be written at the root of the bucket
*/
Expand All @@ -406,13 +406,15 @@ export interface SparkUIProps {
export interface SparkUILoggingLocation {
/**
* The bucket where the Glue job stores the logs.
*
* @default - a new bucket will be created.
*/
readonly bucket: s3.IBucket;

/**
* The path inside the bucket (objects prefix) where the Glue job stores the logs.
*
* @default '/' - the logs will be written at the root of the bucket
* @default - the logs will be written at the root of the bucket
*/
readonly prefix?: string;
}
Expand Down Expand Up @@ -840,12 +842,12 @@ export class Job extends JobBase {

const errors: string[] = [];

if (!prefix.startsWith('/')) {
errors.push('Prefix must begin with \'/\'');
if (prefix.startsWith('/')) {
errors.push('Prefix must not begin with \'/\'');
}

if (prefix.endsWith('/')) {
errors.push('Prefix must not end with \'/\'');
if (!prefix.endsWith('/')) {
errors.push('Prefix must end with \'/\'');
}

if (errors.length > 0) {
Expand All @@ -854,7 +856,7 @@ export class Job extends JobBase {
}

private cleanPrefixForGrant(prefix?: string): string | undefined {
return prefix !== undefined ? prefix.slice(1) + '/*' : undefined;
return prefix !== undefined ? `${prefix}*` : undefined;
}

private setupContinuousLogging(role: iam.IRole, props: ContinuousLoggingProps) {
Expand Down
12 changes: 6 additions & 6 deletions packages/@aws-cdk/aws-glue-alpha/test/job.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -632,14 +632,14 @@ describe('Job', () => {
});
describe('with bucket and path provided', () => {
const sparkUIBucketName = 'sparkbucketname';
const prefix = '/foob/bart';
const badPrefix = 'foob/bart/';
const prefix = 'foob/bart/';
const badPrefix = '/foob/bart';
let sparkUIBucket: s3.IBucket;

const expectedErrors = [
`Invalid prefix format (value: ${badPrefix})`,
'Prefix must begin with \'/\'',
'Prefix must not end with \'/\'',
'Prefix must not begin with \'/\'',
'Prefix must end with \'/\'',
].join(EOL);
it('fails if path is mis-formatted', () => {
expect(() => new glue.Job(stack, 'BadPrefixJob', {
Expand Down Expand Up @@ -699,7 +699,7 @@ describe('Job', () => {
[
'arn:',
{ Ref: 'AWS::Partition' },
`:s3:::sparkbucketname${prefix}/*`,
`:s3:::sparkbucketname/${prefix}*`,
],
],
},
Expand All @@ -718,7 +718,7 @@ describe('Job', () => {
Template.fromStack(stack).hasResourceProperties('AWS::Glue::Job', {
DefaultArguments: {
'--enable-spark-ui': 'true',
'--spark-event-logs-path': `s3://${sparkUIBucketName}${prefix}`,
'--spark-event-logs-path': `s3://${sparkUIBucketName}/${prefix}`,
},
});
});
Expand Down