Skip to content

Commit

Permalink
feat(codebuild): add ability to customize build status reporting for …
Browse files Browse the repository at this point in the history 
…third-party Git sources (#19408)

[Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.source.buildstatusconfig.context)

The idea is to be able to customise the Github "check" through the context parameter I linked in the AWS doc.

#19403
  • Loading branch information
@Lilja
Lilja committed Apr 14, 2022
1 parent 4f3a340 commit 423d72f
Show file tree
Hide file tree
Showing 2 changed files with 153 additions and 4 deletions.
85 changes: 81 additions & 4 deletions packages/@aws-cdk/aws-codebuild/lib/source.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,18 @@ interface ThirdPartyGitSourceProps extends GitSourceProps {
* @default every push and every Pull Request (create or update) triggers a build
*/
readonly webhookFilters?: FilterGroup[];

/**
* The URL that the build will report back to the source provider.
* Can use built-in CodeBuild variables, like $AWS_REGION.
*
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.source.buildstatusconfig.targeturl
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
*
* @example "$CODEBUILD_PUBLIC_BUILD_URL"
* @default - link to the AWS Console for CodeBuild to a particular build execution
*/
readonly buildStatusUrl?: string;
}

/**
Expand All @@ -510,6 +522,7 @@ abstract class ThirdPartyGitSource extends GitSource {
private readonly reportBuildStatus: boolean;
private readonly webhook?: boolean;
private readonly webhookTriggersBatchBuild?: boolean;
protected readonly buildStatusUrl?: string;

protected constructor(props: ThirdPartyGitSourceProps) {
super(props);
Expand All @@ -518,6 +531,7 @@ abstract class ThirdPartyGitSource extends GitSource {
this.reportBuildStatus = props.reportBuildStatus ?? true;
this.webhookFilters = props.webhookFilters || [];
this.webhookTriggersBatchBuild = props.webhookTriggersBatchBuild;
this.buildStatusUrl = props.buildStatusUrl;
}

public bind(_scope: CoreConstruct, project: IProject): SourceConfig {
Expand Down Expand Up @@ -636,10 +650,53 @@ class S3Source extends Source {
}
}

/**
* Common properties between {@link GitHubSource} and {@link GitHubEnterpriseSource}.
*/
interface CommonGithubSourceProps extends ThirdPartyGitSourceProps {
/**
* This parameter is used for the `context` parameter in the GitHub commit status.
* Can use built-in CodeBuild variables, like $AWS_REGION.
*
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.source.buildstatusconfig.context
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
*
* @example "My build #$CODEBUILD_BUILD_NUMBER"
* @default "AWS CodeBuild $AWS_REGION ($PROJECT_NAME)"
*/
readonly buildStatusContext?: string
}

abstract class CommonGithubSource extends ThirdPartyGitSource {
private readonly buildStatusContext?: string;

constructor(props: CommonGithubSourceProps) {
super(props);
this.buildStatusContext = props.buildStatusContext;
}

public bind(scope: CoreConstruct, project: IProject): SourceConfig {
const superConfig = super.bind(scope, project);
return {
sourceProperty: {
...superConfig.sourceProperty,
buildStatusConfig: this.buildStatusContext !== undefined || this.buildStatusUrl !== undefined
? {
context: this.buildStatusContext,
targetUrl: this.buildStatusUrl,
}
: undefined,
},
sourceVersion: superConfig.sourceVersion,
buildTriggers: superConfig.buildTriggers,
};
}
}

/**
* Construction properties for {@link GitHubSource} and {@link GitHubEnterpriseSource}.
*/
export interface GitHubSourceProps extends ThirdPartyGitSourceProps {
export interface GitHubSourceProps extends CommonGithubSourceProps {
/**
* The GitHub account/user that owns the repo.
*
Expand All @@ -658,7 +715,7 @@ export interface GitHubSourceProps extends ThirdPartyGitSourceProps {
/**
* GitHub Source definition for a CodeBuild project.
*/
class GitHubSource extends ThirdPartyGitSource {
class GitHubSource extends CommonGithubSource {
public readonly type = GITHUB_SOURCE_TYPE;
private readonly httpsCloneUrl: string;

Expand All @@ -683,7 +740,7 @@ class GitHubSource extends ThirdPartyGitSource {
/**
* Construction properties for {@link GitHubEnterpriseSource}.
*/
export interface GitHubEnterpriseSourceProps extends ThirdPartyGitSourceProps {
export interface GitHubEnterpriseSourceProps extends CommonGithubSourceProps {
/**
* The HTTPS URL of the repository in your GitHub Enterprise installation.
*/
Expand All @@ -700,7 +757,7 @@ export interface GitHubEnterpriseSourceProps extends ThirdPartyGitSourceProps {
/**
* GitHub Enterprise Source definition for a CodeBuild project.
*/
class GitHubEnterpriseSource extends ThirdPartyGitSource {
class GitHubEnterpriseSource extends CommonGithubSource {
public readonly type = GITHUB_ENTERPRISE_SOURCE_TYPE;
private readonly httpsCloneUrl: string;
private readonly ignoreSslErrors?: boolean;
Expand Down Expand Up @@ -768,6 +825,18 @@ export interface BitBucketSourceProps extends ThirdPartyGitSourceProps {
* @example 'aws-cdk'
*/
readonly repo: string;

/**
* This parameter is used for the `name` parameter in the Bitbucket commit status.
* Can use built-in CodeBuild variables, like $AWS_REGION.
*
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.source.buildstatusconfig.context
* @see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
*
* @example "My build #$CODEBUILD_BUILD_NUMBER"
* @default "AWS CodeBuild $AWS_REGION ($PROJECT_NAME)"
*/
readonly buildStatusName?: string;
}

/**
Expand All @@ -776,10 +845,12 @@ export interface BitBucketSourceProps extends ThirdPartyGitSourceProps {
class BitBucketSource extends ThirdPartyGitSource {
public readonly type = BITBUCKET_SOURCE_TYPE;
private readonly httpsCloneUrl: any;
private readonly buildStatusName?: string;

constructor(props: BitBucketSourceProps) {
super(props);
this.httpsCloneUrl = `https://bitbucket.org/${props.owner}/${props.repo}.git`;
this.buildStatusName = props.buildStatusName;
}

public bind(_scope: CoreConstruct, _project: IProject): SourceConfig {
Expand All @@ -793,6 +864,12 @@ class BitBucketSource extends ThirdPartyGitSource {
sourceProperty: {
...superConfig.sourceProperty,
location: this.httpsCloneUrl,
buildStatusConfig: this.buildStatusName !== undefined || this.buildStatusUrl !== undefined
? {
context: this.buildStatusName,
targetUrl: this.buildStatusUrl,
}
: undefined,
},
sourceVersion: superConfig.sourceVersion,
buildTriggers: superConfig.buildTriggers,
Expand Down
72 changes: 72 additions & 0 deletions packages/@aws-cdk/aws-codebuild/test/codebuild.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1028,6 +1028,78 @@ describe('secondary sources', () => {
});
});

describe('sources with customised build status configuration', () => {
test('GitHub', () => {
const context = 'My custom CodeBuild worker!';
const stack = new cdk.Stack();
const source = codebuild.Source.gitHub({
owner: 'awslabs',
repo: 'aws-cdk',
buildStatusContext: context,
});

new codebuild.Project(stack, 'MyProject', { source });
Template.fromStack(stack).findParameters('AWS::CodeBuild::Project', {
Source: {
buildStatusConfig: {
context: context,
},
},
});
});

test('GitHub Enterprise', () => {
const context = 'My custom CodeBuild worker!';
const stack = new cdk.Stack();
const source = codebuild.Source.gitHubEnterprise({
httpsCloneUrl: 'url',
buildStatusContext: context,
});
new codebuild.Project(stack, 'MyProject', { source });
Template.fromStack(stack).findParameters('AWS::CodeBuild::Project', {
Source: {
buildStatusConfig: {
context: context,
},
},
});
});

test('BitBucket', () => {
const context = 'My custom CodeBuild worker!';
const stack = new cdk.Stack();
const source = codebuild.Source.bitBucket({ owner: 'awslabs', repo: 'aws-cdk' });
new codebuild.Project(stack, 'MyProject', { source });
Template.fromStack(stack).findParameters('AWS::CodeBuild::Project', {
Source: {
buildStatusConfig: {
context: context,
},
},
});
});
});

describe('sources with customised build status configuration', () => {
test('GitHub with targetUrl', () => {
const targetUrl = 'https://example.com';
const stack = new cdk.Stack();
const source = codebuild.Source.gitHub({
owner: 'awslabs',
repo: 'aws-cdk',
buildStatusUrl: targetUrl,
});
new codebuild.Project(stack, 'MyProject', { source });
Template.fromStack(stack).findParameters('AWS::CodeBuild::Project', {
Source: {
buildStatusConfig: {
targetUrl: targetUrl,
},
},
});
});
});

describe('secondary source versions', () => {
test('allow secondary source versions', () => {
const stack = new cdk.Stack();
Expand Down

0 comments on commit 423d72f

Please sign in to comment.