-
Notifications
You must be signed in to change notification settings - Fork 0
/
update-promoted-values.ts
421 lines (388 loc) · 12.9 KB
/
update-promoted-values.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
import { RE2 } from 're2-wasm';
import * as yaml from 'yaml';
import {
ScalarTokenWriter,
getStringValue,
getTopLevelBlocks,
parseYAML,
} from './yaml';
import { PrefixingLogger } from './log';
import { DockerRegistryClient } from './artifactRegistry';
import {
EnvironmentPromotions,
PromotionInfo,
PromotionsByTargetEnvironment,
} from './promotionInfo';
import { GitHubClient, getGitConfigRefPromotionInfo } from './github';
import { LinkTemplateMap, renderLinkTemplate } from './templates';
import { createHash } from 'node:crypto';
import { AnnotatedError } from './index';
interface Promote {
scalarTokenWriter: ScalarTokenWriter;
value: string;
}
const DEFAULT_YAML_PATHS = [
['gitConfig', 'ref'],
['dockerImage', 'tag'],
];
export async function updatePromotedValues(
contents: string,
promotionTargetRegexp: string | null,
frozenEnvironments: Set<string>,
_logger: PrefixingLogger,
dockerRegistryClient: DockerRegistryClient | null = null,
gitHubClient: GitHubClient | null = null,
linkTemplateMap: LinkTemplateMap | null = null,
): Promise<{
newContents: string;
promotionsByTargetEnvironment: PromotionsByTargetEnvironment | null; // Null if empty
}> {
const logger = _logger.withExtendedPrefix('[promote] ');
// We use re2-wasm instead of built-in RegExp so we don't have to worry about
// REDOS attacks.
const promotionTargetRE2 = promotionTargetRegexp
? new RE2(promotionTargetRegexp, 'u')
: null;
const { document, stringify, lineCounter } = parseYAML(contents);
// If the file is empty (or just whitespace or whatever), that's fine; we
// can just leave it alone.
if (!document) {
return { newContents: contents, promotionsByTargetEnvironment: null };
}
// We decide what to do and then we do it, just in case there are any
// overlaps between our reads and writes.
logger.info('Looking for promote');
const { promotes, promotionsByTargetEnvironment } = await findPromotes(
document,
lineCounter,
promotionTargetRE2,
dockerRegistryClient,
gitHubClient,
linkTemplateMap,
frozenEnvironments,
);
logger.info('Copying values');
for (const { scalarTokenWriter, value } of promotes) {
scalarTokenWriter.write(value);
}
return { newContents: stringify(), promotionsByTargetEnvironment };
}
async function findPromotes(
document: yaml.Document.Parsed,
lineCounter: yaml.LineCounter,
promotionTargetRE2: RE2 | null,
dockerRegistryClient: DockerRegistryClient | null,
gitHubClient: GitHubClient | null,
linkTemplateMap: LinkTemplateMap | null,
frozenEnvironments: Set<string>,
): Promise<{
promotes: Promote[];
promotionsByTargetEnvironment: PromotionsByTargetEnvironment | null;
}> {
const { blocks, globalBlock } = getTopLevelBlocks(document);
const promotes: Promote[] = [];
const promotionsByTargetEnvironment = new Map<
string,
EnvironmentPromotions
>();
// This initialization is somewhat copy-pasted from updateDockerTags and updateGitRefs.
let globalRepoURL: string | null = null;
let globalPath: string | null = null;
let globalDockerImageRepository: string | null = null;
let globalDockerImageTag: string | null = null;
if (globalBlock?.has('gitConfig')) {
const gitConfigBlock = globalBlock.get('gitConfig');
if (!yaml.isMap(gitConfigBlock)) {
throw new AnnotatedError(
'Document has `global.gitConfig` that is not a map',
{
range: gitConfigBlock?.range,
lineCounter,
},
);
}
globalRepoURL = getStringValue(gitConfigBlock, 'repoURL');
globalPath = getStringValue(gitConfigBlock, 'path');
}
if (globalBlock?.has('dockerImage')) {
const dockerImageBlock = globalBlock.get('dockerImage');
if (!yaml.isMap(dockerImageBlock)) {
throw new AnnotatedError(
'Document has `global.dockerImageBlock` that is not a map',
{
range: dockerImageBlock?.range,
lineCounter,
},
);
}
globalDockerImageRepository = getStringValue(
dockerImageBlock,
'repository',
);
globalDockerImageTag = getStringValue(dockerImageBlock, 'tag');
}
for (const [myName, me] of blocks) {
if (frozenEnvironments.has(myName)) {
continue;
}
if (promotionTargetRE2 && !promotionTargetRE2.test(myName)) {
continue;
}
if (!me.has('promote')) {
continue;
}
const promote = me.get('promote');
if (!yaml.isMap(promote)) {
throw new AnnotatedError(`The value at ${myName}.promote must be a map`, {
range: promote?.range,
lineCounter,
});
}
const from = promote.get('from');
if (typeof from !== 'string') {
throw new AnnotatedError(
`The value at ${myName}.promote.from must be a string`,
{
range: from?.range,
lineCounter,
},
);
}
const fromBlock = blocks.get(from);
if (!fromBlock) {
throw new AnnotatedError(
`The value at ${myName}.promote.from must reference a top-level key with map value`,
{
range: promote?.range,
lineCounter,
},
);
}
const gitConfigBlock = me.get('gitConfig');
if (gitConfigBlock && !yaml.isMap(gitConfigBlock)) {
throw new AnnotatedError(
`Document has \`${myName}.gitConfig\` that is not a map`,
{
range: gitConfigBlock?.range,
lineCounter,
},
);
}
const repoURL =
(gitConfigBlock && getStringValue(gitConfigBlock, 'repoURL')) ??
globalRepoURL;
const path =
(gitConfigBlock && getStringValue(gitConfigBlock, 'path')) ?? globalPath;
const trimmedRepoURL = repoURL?.replace(/(?:\.git)?\/*$/, '');
const dockerImageBlock = me.get('dockerImage');
if (dockerImageBlock && !yaml.isMap(dockerImageBlock)) {
throw new AnnotatedError(
`Document has \`${myName}.dockerImage\` that is not a map`,
{
range: dockerImageBlock?.range,
lineCounter,
},
);
}
const dockerImageRepository =
(dockerImageBlock && getStringValue(dockerImageBlock, 'repository')) ??
globalDockerImageRepository;
const yamlPaths: CollectionPath[] = [];
if (promote.has('yamlPaths')) {
const yamlPathsSeq = promote.get('yamlPaths');
if (!yaml.isSeq(yamlPathsSeq)) {
throw new AnnotatedError(
`The value at ${myName}.promote.yamlPaths must be an array`,
{
range: yamlPathsSeq?.range,
lineCounter,
},
);
}
const explicitYamlPaths = yamlPathsSeq.toJSON();
if (!Array.isArray(explicitYamlPaths)) {
throw new AnnotatedError(
'YAMLSeq.toJSON surprisingly did not return an array',
{
range: yamlPathsSeq?.range,
lineCounter,
},
);
}
if (!explicitYamlPaths.every(isCollectionPath)) {
throw new AnnotatedError(
`The value at ${myName}.promote.yamlPaths must be an array whose elements are arrays of strings or numbers`,
{
range: yamlPathsSeq?.range,
lineCounter,
},
);
}
yamlPaths.push(...explicitYamlPaths);
} else {
// By default, promote gitConfig.ref and dockerImage.tag, but only the
// ones that are actually there.
for (const potentialCollectionPath of DEFAULT_YAML_PATHS) {
if (
fromBlock.getIn(potentialCollectionPath) &&
me.getIn(potentialCollectionPath)
) {
yamlPaths.push(potentialCollectionPath);
}
}
if (yamlPaths.length === 0) {
throw Error(
`${myName}.promote does not specify 'yamlPaths' and none of the default promoted paths (${DEFAULT_YAML_PATHS.map(
(p) => p.join('.'),
).join(', ')}) exist in both the source and the target.`,
);
}
}
let gitConfigPromotionInfo: PromotionInfo = { type: 'no-change' };
let dockerImagePromotionInfo: PromotionInfo = { type: 'no-change' };
// Will be updated if promoted.
let dockerImageTag =
(dockerImageBlock && getStringValue(dockerImageBlock, 'tag')) ??
globalDockerImageTag;
for (const collectionPath of yamlPaths) {
const sourceValue = fromBlock.getIn(collectionPath);
if (typeof sourceValue !== 'string') {
throw Error(`Could not promote from ${[from, ...collectionPath]}`);
}
// true means keepScalar, ie get the scalar node to write.
const targetNode = me.getIn(collectionPath, true);
if (!yaml.isScalar(targetNode)) {
throw Error(`Could not promote to ${[myName, ...collectionPath]}`);
}
const scalarToken = targetNode.srcToken;
if (!yaml.CST.isScalar(scalarToken)) {
// this probably can't happen, but let's make the types happy
throw Error(
`${[myName, ...collectionPath]} value must come from a scalar token`,
);
}
if (collectionPath.join('.') === 'dockerImage.tag') {
dockerImageTag = sourceValue;
}
if (
typeof targetNode.value === 'string' &&
targetNode.value !== sourceValue
) {
if (
collectionPath.join('.') === 'dockerImage.tag' &&
dockerImageRepository &&
dockerRegistryClient
) {
// We're changing a value and we may be able to look up the commits
// we're promoting in the Docker image.
dockerImagePromotionInfo =
await dockerRegistryClient.getGitCommitsBetweenTags({
prevTag: targetNode.value,
nextTag: sourceValue,
dockerImageRepository,
});
}
if (
collectionPath.join('.') === 'gitConfig.ref' &&
repoURL &&
path &&
gitHubClient
) {
gitConfigPromotionInfo = await getGitConfigRefPromotionInfo({
oldRef: targetNode.value,
newRef: sourceValue,
repoURL,
path,
gitHubClient,
});
}
}
promotes.push({
scalarTokenWriter: new ScalarTokenWriter(scalarToken, document.schema),
value: sourceValue,
});
}
const linksSeq = promote.get('links');
const linkNames: string[] = [];
if (linksSeq) {
if (!yaml.isSeq(linksSeq)) {
throw Error(
`The value at ${myName}.promote.links must be an array (if provided)`,
);
}
const links = linksSeq.toJSON();
if (!Array.isArray(links)) {
throw Error('YAMLSeq.toJSON surprisingly did not return an array');
}
if (!links.every(isString)) {
throw Error(
`The value at ${myName}.promote.links (if provided) must be an array whose elements are strings`,
);
}
linkNames.push(...links);
}
if (
trimmedRepoURL &&
(dockerImagePromotionInfo.type !== 'no-change' ||
gitConfigPromotionInfo.type !== 'no-change')
) {
const templateVariables = new Map<string, string>();
if (linkTemplateMap && linkNames.length) {
if (dockerImageRepository && dockerImageTag) {
// This particular encoding is designed to be safe for use in a
// Kubernetes label, which only allows a subset of characters and has
// a max length of 63; it's also something that can be calculated in a
// Helm chart via built-in functions printf, sha256sum, and trunc.
templateVariables.set(
'docker-image-sha256-63',
createHash('sha256')
.update(`${dockerImageRepository}:${dockerImageTag}`)
.digest('hex')
.slice(0, 63),
);
} else {
templateVariables.set('docker-image-sha256-63', 'unknown');
}
}
promotionsByTargetEnvironment.set(myName, {
trimmedRepoURL,
gitConfigPromotionInfo,
dockerImage: dockerImageRepository
? {
repository: dockerImageRepository,
promotionInfo: dockerImagePromotionInfo,
}
: null,
links: linkNames.map((linkName) => {
if (!linkTemplateMap) {
throw Error(
`${myName}.promote.links requires the link-template-file input to be set`,
);
}
return renderLinkTemplate(
linkTemplateMap,
linkName,
templateVariables,
);
}),
});
}
}
return {
promotes,
promotionsByTargetEnvironment: promotionsByTargetEnvironment.size
? promotionsByTargetEnvironment
: null,
};
}
type CollectionPath = CollectionIndex[];
type CollectionIndex = string | number;
function isCollectionPath(value: unknown): value is CollectionPath {
return Array.isArray(value) && value.every(isCollectionIndex);
}
function isCollectionIndex(value: unknown): value is CollectionIndex {
return typeof value === 'string' || typeof value === 'number';
}
function isString(value: unknown): value is string {
return typeof value === 'string';
}