-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
codepipeline-source.ts
424 lines (385 loc) · 14 KB
/
codepipeline-source.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
import * as codecommit from '@aws-cdk/aws-codecommit';
import * as cp from '@aws-cdk/aws-codepipeline';
import { Artifact } from '@aws-cdk/aws-codepipeline';
import * as cp_actions from '@aws-cdk/aws-codepipeline-actions';
import { Action, CodeCommitTrigger, GitHubTrigger, S3Trigger } from '@aws-cdk/aws-codepipeline-actions';
import { IRepository } from '@aws-cdk/aws-ecr';
import * as iam from '@aws-cdk/aws-iam';
import { IBucket } from '@aws-cdk/aws-s3';
import { SecretValue, Token } from '@aws-cdk/core';
import { Node } from 'constructs';
import { FileSet, Step } from '../blueprint';
import { CodePipelineActionFactoryResult, ProduceActionOptions, ICodePipelineActionFactory } from './codepipeline-action-factory';
/**
* CodePipeline source steps
*
* This class contains a number of factory methods for the different types
* of sources that CodePipeline supports.
*/
export abstract class CodePipelineSource extends Step implements ICodePipelineActionFactory {
/**
* Returns a GitHub source, using OAuth tokens to authenticate with
* GitHub and a separate webhook to detect changes. This is no longer
* the recommended method. Please consider using `connection()`
* instead.
*
* Pass in the owner and repository in a single string, like this:
*
* ```ts
* CodePipelineSource.gitHub('owner/repo', 'main');
* ```
*
* Authentication will be done by a secret called `github-token` in AWS
* Secrets Manager (unless specified otherwise).
*
* The token should have these permissions:
*
* * **repo** - to read the repository
* * **admin:repo_hook** - if you plan to use webhooks (true by default)
*/
public static gitHub(repoString: string, branch: string, props: GitHubSourceOptions = {}): CodePipelineSource {
return new GitHubSource(repoString, branch, props);
}
/**
* Returns an S3 source.
*
* @param bucket The bucket where the source code is located.
* @param props The options, which include the key that identifies the source code file and
* and how the pipeline should be triggered.
*
* Example:
*
* ```ts
* const bucket: IBucket = ...
* CodePipelineSource.s3(bucket, {
* key: 'path/to/file.zip',
* });
* ```
*/
public static s3(bucket: IBucket, objectKey: string, props: S3SourceOptions = {}): CodePipelineSource {
return new S3Source(bucket, objectKey, props);
}
/**
* Returns an ECR source.
*
* @param repository The repository that will be watched for changes.
* @param props The options, which include the image tag to be checked for changes.
*
* Example:
*
* ```ts
* const repository: IRepository = ...
* CodePipelineSource.ecr(repository, {
* imageTag: 'latest',
* });
* ```
*/
public static ecr(repository: IRepository, props: ECRSourceOptions = {}): CodePipelineSource {
return new ECRSource(repository, props);
}
/**
* Returns a CodeStar connection source. A CodeStar connection allows AWS CodePipeline to
* access external resources, such as repositories in GitHub, GitHub Enterprise or
* BitBucket.
*
* To use this method, you first need to create a CodeStar connection
* using the AWS console. In the process, you may have to sign in to the external provider
* -- GitHub, for example -- to authorize AWS to read and modify your repository.
* Once you have done this, copy the connection ARN and use it to create the source.
*
* Example:
*
* ```ts
* CodePipelineSource.connection('owner/repo', 'main', {
* connectionArn: 'arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41', // Created using the AWS console
* });
* ```
*
* @param repoString A string that encodes owner and repository separated by a slash (e.g. 'owner/repo').
* @param branch The branch to use.
* @param props The source properties, including the connection ARN.
*
* @see https://docs.aws.amazon.com/dtconsole/latest/userguide/welcome-connections.html
*/
public static connection(repoString: string, branch: string, props: ConnectionSourceOptions): CodePipelineSource {
return new CodeStarConnectionSource(repoString, branch, props);
}
/**
* Returns a CodeCommit source.
*
* @param repository The CodeCommit repository.
* @param branch The branch to use.
* @param props The source properties.
*
* Example:
*
* ```ts
* const repository: IRepository = ...
* CodePipelineSource.codeCommit(repository, 'main');
* ```
*/
public static codeCommit(repository: codecommit.IRepository, branch: string, props: CodeCommitSourceOptions = {}): CodePipelineSource {
return new CodeCommitSource(repository, branch, props);
}
// tells `PipelineGraph` to hoist a "Source" step
public readonly isSource = true;
public produceAction(stage: cp.IStage, options: ProduceActionOptions): CodePipelineActionFactoryResult {
const output = options.artifacts.toCodePipeline(this.primaryOutput!);
const action = this.getAction(output, options.actionName, options.runOrder);
stage.addAction(action);
return { runOrdersConsumed: 1 };
}
protected abstract getAction(output: Artifact, actionName: string, runOrder: number): Action;
}
/**
* Options for GitHub sources
*/
export interface GitHubSourceOptions {
/**
* A GitHub OAuth token to use for authentication.
*
* It is recommended to use a Secrets Manager `Secret` to obtain the token:
*
* ```ts
* const oauth = cdk.SecretValue.secretsManager('my-github-token');
* new GitHubSource(this, 'GitHubSource', { authentication: oauth, ... });
* ```
*
* The GitHub Personal Access Token should have these scopes:
*
* * **repo** - to read the repository
* * **admin:repo_hook** - if you plan to use webhooks (true by default)
*
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/GitHub-create-personal-token-CLI.html
*
* @default - SecretValue.secretsManager('github-token')
*/
readonly authentication?: SecretValue;
/**
* How AWS CodePipeline should be triggered
*
* With the default value "WEBHOOK", a webhook is created in GitHub that triggers the action.
* With "POLL", CodePipeline periodically checks the source for changes.
* With "None", the action is not triggered through changes in the source.
*
* To use `WEBHOOK`, your GitHub Personal Access Token should have
* **admin:repo_hook** scope (in addition to the regular **repo** scope).
*
* @default GitHubTrigger.WEBHOOK
*/
readonly trigger?: GitHubTrigger;
}
/**
* Extend CodePipelineSource so we can type-test in the CodePipelineEngine.
*/
class GitHubSource extends CodePipelineSource {
private readonly owner: string;
private readonly repo: string;
private readonly authentication: SecretValue;
constructor(repoString: string, readonly branch: string, readonly props: GitHubSourceOptions) {
super(repoString);
const parts = repoString.split('/');
if (Token.isUnresolved(repoString) || parts.length !== 2) {
throw new Error(`GitHub repository name should be a resolved string like '<owner>/<repo>', got '${repoString}'`);
}
this.owner = parts[0];
this.repo = parts[1];
this.authentication = props.authentication ?? SecretValue.secretsManager('github-token');
this.configurePrimaryOutput(new FileSet('Source', this));
}
protected getAction(output: Artifact, actionName: string, runOrder: number) {
return new cp_actions.GitHubSourceAction({
output,
actionName,
runOrder,
oauthToken: this.authentication,
owner: this.owner,
repo: this.repo,
branch: this.branch,
trigger: this.props.trigger,
});
}
}
/**
* Options for S3 sources
*/
export interface S3SourceOptions {
/**
* How should CodePipeline detect source changes for this Action.
* Note that if this is S3Trigger.EVENTS, you need to make sure to include the source Bucket in a CloudTrail Trail,
* as otherwise the CloudWatch Events will not be emitted.
*
* @default S3Trigger.POLL
* @see https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/log-s3-data-events.html
*/
readonly trigger?: S3Trigger;
/**
* The action name used for this source in the CodePipeline
*
* @default - The bucket name
*/
readonly actionName?: string;
}
class S3Source extends CodePipelineSource {
constructor(readonly bucket: IBucket, private readonly objectKey: string, readonly props: S3SourceOptions) {
super(Node.of(bucket).addr);
this.configurePrimaryOutput(new FileSet('Source', this));
}
protected getAction(output: Artifact, _actionName: string, runOrder: number) {
return new cp_actions.S3SourceAction({
output,
// Bucket names are guaranteed to conform to ActionName restrictions
actionName: this.props.actionName ?? this.bucket.bucketName,
runOrder,
bucketKey: this.objectKey,
trigger: this.props.trigger,
bucket: this.bucket,
});
}
}
/**
* Options for ECR sources
*/
export interface ECRSourceOptions {
/**
* The image tag that will be checked for changes.
*
* @default latest
*/
readonly imageTag?: string;
/**
* The action name used for this source in the CodePipeline
*
* @default - The repository name
*/
readonly actionName?: string;
}
class ECRSource extends CodePipelineSource {
constructor(readonly repository: IRepository, readonly props: ECRSourceOptions) {
super(Node.of(repository).addr);
this.configurePrimaryOutput(new FileSet('Source', this));
}
protected getAction(output: Artifact, _actionName: string, runOrder: number) {
return new cp_actions.EcrSourceAction({
output,
// Repository names are guaranteed to conform to ActionName restrictions
actionName: this.props.actionName ?? this.repository.repositoryName,
runOrder,
repository: this.repository,
imageTag: this.props.imageTag,
});
}
}
/**
* Configuration options for CodeStar source
*/
export interface ConnectionSourceOptions {
/**
* The ARN of the CodeStar Connection created in the AWS console
* that has permissions to access this GitHub or BitBucket repository.
*
* @example 'arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh'
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/connections-create.html
*/
readonly connectionArn: string;
// long URL in @see
/**
* Whether the output should be the contents of the repository
* (which is the default),
* or a link that allows CodeBuild to clone the repository before building.
*
* **Note**: if this option is true,
* then only CodeBuild actions can use the resulting {@link output}.
*
* @default false
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html#action-reference-CodestarConnectionSource-config
*/
readonly codeBuildCloneOutput?: boolean;
/**
* Controls automatically starting your pipeline when a new commit
* is made on the configured repository and branch. If unspecified,
* the default value is true, and the field does not display by default.
*
* @default true
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodestarConnectionSource.html
*/
readonly triggerOnPush?: boolean;
}
class CodeStarConnectionSource extends CodePipelineSource {
private readonly owner: string;
private readonly repo: string;
constructor(repoString: string, readonly branch: string, readonly props: ConnectionSourceOptions) {
super(repoString);
const parts = repoString.split('/');
if (Token.isUnresolved(repoString) || parts.length !== 2) {
throw new Error(`CodeStar repository name should be a resolved string like '<owner>/<repo>', got '${repoString}'`);
}
this.owner = parts[0];
this.repo = parts[1];
this.configurePrimaryOutput(new FileSet('Source', this));
}
protected getAction(output: Artifact, actionName: string, runOrder: number) {
return new cp_actions.CodeStarConnectionsSourceAction({
output,
actionName,
runOrder,
connectionArn: this.props.connectionArn,
owner: this.owner,
repo: this.repo,
branch: this.branch,
codeBuildCloneOutput: this.props.codeBuildCloneOutput,
triggerOnPush: this.props.triggerOnPush,
});
}
}
/**
* Configuration options for a CodeCommit source
*/
export interface CodeCommitSourceOptions {
/**
* How should CodePipeline detect source changes for this Action.
*
* @default CodeCommitTrigger.EVENTS
*/
readonly trigger?: CodeCommitTrigger;
/**
* Role to be used by on commit event rule.
* Used only when trigger value is CodeCommitTrigger.EVENTS.
*
* @default a new role will be created.
*/
readonly eventRole?: iam.IRole;
/**
* Whether the output should be the contents of the repository
* (which is the default),
* or a link that allows CodeBuild to clone the repository before building.
*
* **Note**: if this option is true,
* then only CodeBuild actions can use the resulting {@link output}.
*
* @default false
* @see https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-CodeCommit.html
*/
readonly codeBuildCloneOutput?: boolean;
}
class CodeCommitSource extends CodePipelineSource {
constructor(private readonly repository: codecommit.IRepository, private readonly branch: string, private readonly props: CodeCommitSourceOptions) {
super(Token.isUnresolved(repository.repositoryName)
? Node.of(repository).addr
: repository.repositoryName);
this.configurePrimaryOutput(new FileSet('Source', this));
}
protected getAction(output: Artifact, _actionName: string, runOrder: number) {
return new cp_actions.CodeCommitSourceAction({
output,
// Guaranteed to be okay as action name
actionName: this.repository.repositoryName,
runOrder,
branch: this.branch,
trigger: this.props.trigger,
repository: this.repository,
eventRole: this.props.eventRole,
codeBuildCloneOutput: this.props.codeBuildCloneOutput,
});
}
}