-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
shell-script-action.ts
233 lines (207 loc) · 7.16 KB
/
shell-script-action.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
import * as codebuild from '@aws-cdk/aws-codebuild';
import * as codepipeline from '@aws-cdk/aws-codepipeline';
import * as codepipeline_actions from '@aws-cdk/aws-codepipeline-actions';
import * as ec2 from '@aws-cdk/aws-ec2';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { Construct } from '@aws-cdk/core';
import { StackOutput } from '../stage';
/**
* Properties for ShellScriptAction
*/
export interface ShellScriptActionProps {
/**
* Name of the validation action in the pipeline
*/
readonly actionName: string;
/**
* Stack outputs to make available as environment variables
*
* @default - No outputs used
*/
readonly useOutputs?: Record<string, StackOutput>;
/**
* Commands to run
*/
readonly commands: string[];
/**
* Bash options to set at the start of the script
*
* @default '-eu' (errexit and nounset)
*/
readonly bashOptions?: string;
/**
* Additional artifacts to use as input for the CodeBuild project
*
* You can use these files to load more complex test sets into the
* shellscript build environment.
*
* The files artifact given here will be unpacked into the current
* working directory, the other ones will be unpacked into directories
* which are available through the environment variables
* $CODEBUILD_SRC_DIR_<artifactName>.
*
* The CodeBuild job must have at least one input artifact, so you
* must provide either at least one additional artifact here or one
* stack output using `useOutput`.
*
* @default - No additional artifacts
*/
readonly additionalArtifacts?: codepipeline.Artifact[];
/**
* RunOrder for this action
*
* Use this to sequence the shell script after the deployments.
*
* The default value is 100 so you don't have to supply the value if you just
* want to run this after the application stacks have been deployed, and you
* don't have more than 100 stacks.
*
* @default 100
*/
readonly runOrder?: number;
/**
* Additional policy statements to add to the execution role
*
* @default - No policy statements
*/
readonly rolePolicyStatements?: iam.PolicyStatement[];
/**
* The VPC where to execute the specified script.
*
* @default - No VPC
*/
readonly vpc?: ec2.IVpc;
/**
* Which subnets to use.
*
* Only used if 'vpc' is supplied.
*
* @default - All private subnets.
*/
readonly subnetSelection?: ec2.SubnetSelection
/**
* Which security group to associate with the script's project network interfaces.
* If no security group is identified, one will be created automatically.
*
* Only used if 'vpc' is supplied.
*
* @default - Security group will be automatically created.
*
*/
readonly securityGroups?: ec2.ISecurityGroup[];
}
/**
* Validate a revision using shell commands
*/
export class ShellScriptAction implements codepipeline.IAction, iam.IGrantable {
private _project?: codebuild.IProject;
private _action?: codepipeline_actions.CodeBuildAction;
private _actionProperties: codepipeline.ActionProperties;
constructor(private readonly props: ShellScriptActionProps) {
// A number of actionProperties get read before bind() is even called (so before we
// have made the Project and can construct the actual CodeBuildAction)
//
// - actionName
// - resource
// - region
// - category
// - role
// - owner
this._actionProperties = {
actionName: props.actionName,
category: codepipeline.ActionCategory.BUILD,
provider: 'CodeBuild',
artifactBounds: { minInputs: 0, maxInputs: 5, minOutputs: 0, maxOutputs: 5 },
inputs: [],
outputs: [],
};
if (Object.keys(props.useOutputs ?? {}).length + (props.additionalArtifacts ?? []).length === 0) {
throw new Error('You must supply either \'useOutputs\' or \'additionalArtifacts\', since a CodeBuild Action must always have at least one input artifact.');
}
}
/**
* The CodeBuild Project's principal
*/
public get grantPrincipal(): iam.IPrincipal {
return this.project.grantPrincipal;
}
/**
* Exists to implement IAction
*/
public get actionProperties(): codepipeline.ActionProperties {
return this._actionProperties;
}
/**
* Exists to implement IAction
*/
public bind(scope: Construct, stage: codepipeline.IStage, options: codepipeline.ActionBindOptions): codepipeline.ActionConfig {
const inputs = new Array<codepipeline.Artifact>();
inputs.push(...this.props.additionalArtifacts ?? []);
const envVarCommands = new Array<string>();
const bashOptions = this.props.bashOptions ?? '-eu';
if (bashOptions) {
envVarCommands.push(`set ${bashOptions}`);
}
for (const [varName, output] of Object.entries(this.props.useOutputs ?? {})) {
const outputArtifact = output.artifactFile;
// Add the artifact to the list of inputs, if it's not in there already. Determine
// the location where CodeBuild is going to stick it based on whether it's the first (primary)
// input or an 'extra input', then parse.
let artifactIndex = inputs.findIndex(a => a.artifactName === outputArtifact.artifact.artifactName);
if (artifactIndex === -1) {
artifactIndex = inputs.push(outputArtifact.artifact) - 1;
}
const dirEnv = artifactIndex === 0 ? 'CODEBUILD_SRC_DIR' : `CODEBUILD_SRC_DIR_${outputArtifact.artifact.artifactName}`;
envVarCommands.push(`export ${varName}="$(node -pe 'require(process.env.${dirEnv} + "/${outputArtifact.fileName}")["${output.outputName}"]')"`);
}
this._project = new codebuild.PipelineProject(scope, 'Project', {
environment: { buildImage: codebuild.LinuxBuildImage.STANDARD_4_0 },
vpc: this.props.vpc,
securityGroups: this.props.securityGroups,
subnetSelection: this.props.subnetSelection,
buildSpec: codebuild.BuildSpec.fromObject({
version: '0.2',
phases: {
build: {
commands: [
...envVarCommands,
...this.props.commands,
],
},
},
}),
});
for (const statement of this.props.rolePolicyStatements ?? []) {
this._project.addToRolePolicy(statement);
}
this._action = new codepipeline_actions.CodeBuildAction({
actionName: this.props.actionName,
input: inputs[0],
extraInputs: inputs.slice(1),
runOrder: this.props.runOrder ?? 100,
project: this._project,
});
// Replace the placeholder actionProperties at the last minute
this._actionProperties = this._action.actionProperties;
return this._action.bind(scope, stage, options);
}
/**
* Project generated to run the shell script in
*/
public get project(): codebuild.IProject {
if (!this._project) {
throw new Error('Project becomes available after ShellScriptAction has been bound to a stage');
}
return this._project;
}
/**
* Exists to implement IAction
*/
public onStateChange(name: string, target?: events.IRuleTarget, options?: events.RuleProps): events.Rule {
if (!this._action) {
throw new Error('Need bind() first');
}
return this._action.onStateChange(name, target, options);
}
}