-
-
Notifications
You must be signed in to change notification settings - Fork 65
/
parseConfigFile.ts
322 lines (281 loc) · 10.2 KB
/
parseConfigFile.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
import {
IDependabotConfig,
IDependabotRegistry,
IDependabotUpdate,
} from "../IDependabotConfig";
import { load } from "js-yaml";
import * as fs from "fs";
import * as path from "path";
import * as tl from "azure-pipelines-task-lib/task";
import { getVariable } from "azure-pipelines-task-lib/task";
import { ISharedVariables } from "./getSharedVariables";
import { convertPlaceholder } from "./convertPlaceholder";
import axios from "axios";
/**
* Parse the dependabot config YAML file to specify update configuration
*
* The file should be located at '/.github/dependabot.yml' or '/.github/dependabot.yaml'
*
* To view YAML file format, visit
* https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#allow
*
* @param variables the shared variables of the task
* @returns {IDependabotConfig} config - the dependabot configuration
*/
async function parseConfigFile(variables: ISharedVariables): Promise<IDependabotConfig> {
const possibleFilePaths = [
"/.github/dependabot.yaml",
"/.github/dependabot.yml",
];
let contents: null | string;
/*
* The configuration file can be available locally if the repository is cloned.
* Otherwise, we should get it via the API which supports 2 scenarios:
* 1. Running the pipeline without cloning, which is useful for huge repositories (multiple submodules or large commit log)
* 2. Running a single pipeline to update multiple repositories https://github.com/tinglesoftware/dependabot-azure-devops/issues/328
*/
if (variables.repositoryOverridden) {
tl.debug(`Attempting to fetch configuration file via REST API ...`);
for (const fp of possibleFilePaths) {
// make HTTP request
var url = `${variables.organizationUrl}${variables.project}/_apis/git/repositories/${variables.repository}/items?path=${fp}`;
tl.debug(`GET ${url}`);
try {
var response = await axios.get(url, {
auth: {
username: "x-access-token",
password: variables.systemAccessToken,
},
headers: {
Accept: "*/*", // Gotcha!!! without this SH*T fails terribly
},
});
if (response.status === 200) {
tl.debug(`Found configuration file at '${url}'`);
contents = response.data;
break;
}
} catch (error) {
var responseStatusCode = error?.response?.status;
if (responseStatusCode === 404) {
tl.debug(`No configuration file at '${url}'`);
continue;
} else if (responseStatusCode === 401) {
throw new Error(
`No access token has been provided to access '${url}'`
);
} else if (responseStatusCode === 403) {
throw new Error(
`The access token provided does not have permissions to access '${url}'`
);
} else {
throw error;
}
}
}
} else {
let rootDir = getVariable("Build.SourcesDirectory");
for (const fp of possibleFilePaths) {
var filePath = path.join(rootDir, fp);
if (fs.existsSync(filePath)) {
tl.debug(`Found configuration file cloned at ${filePath}`);
contents = fs.readFileSync(filePath, "utf-8");
break;
} else {
tl.debug(`No configuration file cloned at ${filePath}`);
}
}
}
// Ensure we have file contents. Otherwise throw a well readable error.
if (!contents || typeof contents !== "string") {
throw new Error(
`Configuration file not found at possible locations: ${possibleFilePaths.join(
", "
)}`
);
} else {
tl.debug("Configuration file contents read.");
}
let config: any = load(contents);
// Ensure the config object parsed is an object
if (config === null || typeof config !== "object") {
throw new Error("Invalid dependabot config object");
} else {
tl.debug("Parsed YAML content from configuration file contents.");
}
const rawVersion = config["version"];
let version = -1;
// Ensure the version has been specified
if (!!!rawVersion)
throw new Error("The version must be specified in dependabot.yml");
// Try convert the version to integer
try {
version = parseInt(rawVersion, 10);
} catch (e) {
throw new Error("Dependabot version specified must be a valid integer");
}
// Ensure the version is == 2
if (version !== 2) {
throw new Error(
"Only version 2 of dependabot is supported. Version specified: " + version
);
}
var dependabotConfig: IDependabotConfig = {
version: version,
updates: parseUpdates(config),
registries: parseRegistries(config),
};
return dependabotConfig;
}
function parseUpdates(config: any): IDependabotUpdate[] {
var updates: IDependabotUpdate[] = [];
// Check the updates parsed
var rawUpdates = config["updates"];
// Check if the array of updates exists
if (!Array.isArray(rawUpdates)) {
throw new Error(
"Invalid dependabot config object: Dependency updates config array not found"
);
}
// Parse the value of each of the updates obtained from the file
rawUpdates.forEach((update) => {
var dependabotUpdate: IDependabotUpdate = {
packageEcosystem: update["package-ecosystem"],
directory: update["directory"],
openPullRequestsLimit: update["open-pull-requests-limit"],
targetBranch: update["target-branch"],
vendor: update["vendor"] ? JSON.parse(update["vendor"]) : null,
versioningStrategy: update["versioning-strategy"],
milestone: update["milestone"],
branchNameSeparator: update["pull-request-branch-name"]
? update["pull-request-branch-name"]["separator"]
: undefined,
rejectExternalCode: update["insecure-external-code-execution"] === "deny",
// Convert to JSON or as required by the script
allow: update["allow"] ? JSON.stringify(update["allow"]) : undefined,
labels: update["labels"] ? JSON.stringify(update["labels"]) : undefined,
reviewers: update["reviewers"]
? JSON.stringify(update["reviewers"])
: undefined,
assignees: update["assignees"]
? JSON.stringify(update["assignees"])
: undefined,
};
if (!dependabotUpdate.packageEcosystem) {
throw new Error(
"The value 'package-ecosystem' in dependency update config is missing"
);
}
// zero is a valid value
if (
!dependabotUpdate.openPullRequestsLimit &&
dependabotUpdate.openPullRequestsLimit !== 0
) {
dependabotUpdate.openPullRequestsLimit = 5;
}
if (!dependabotUpdate.directory) {
throw new Error(
"The value 'directory' in dependency update config is missing"
);
}
updates.push(dependabotUpdate);
});
return updates;
}
function parseRegistries(config: any): IDependabotRegistry[] {
var registries: IDependabotRegistry[] = [];
var rawRegistries = config["registries"];
if (rawRegistries == undefined) return registries;
// Parse the value of each of the registries obtained from the file
Object.entries(rawRegistries).forEach((item) => {
var registryConfigKey = item[0];
var registryConfig = item[1];
// parse the type
var rawType = registryConfig["type"]
if (!rawType) {
throw new Error(
`The value for 'type' in dependency registry config '${registryConfigKey}' is missing`
);
}
// ensure the type is a known one
if (!KnownRegistryTypes.includes(rawType)) {
throw new Error(
`The value '${rawType}' for 'type' in dependency registry config '${registryConfigKey}' is not among the supported values.`
);
}
var type = rawType?.replace("-", "_");
var parsed: IDependabotRegistry = { type: type, };
registries.push(parsed);
// handle special fields for 'hex-organization' types
if (type === 'hex_organization') {
var organization = registryConfig["organization"];
if (!organization) {
throw new Error(
`The value 'organization' in dependency registry config '${registryConfigKey}' is missing`
);
}
parsed.organization = organization;
}
// handle special fields for 'hex-repository' types
if (type === 'hex_repository') {
var repo = registryConfig["repo"];
if (!repo) {
throw new Error(
`The value 'repo' in dependency registry config '${registryConfigKey}' is missing`
);
}
parsed.repo = repo;
parsed["auth-key"] = registryConfig["auth-key"];
parsed["public-key-fingerprint"] = registryConfig["public-key-fingerprint"];
}
// parse username, password, key, and token while replacing tokens where necessary
parsed.username = registryConfig["username"];
parsed.password = convertPlaceholder(registryConfig["password"]);
parsed.key = convertPlaceholder(registryConfig["key"]);
parsed.token = convertPlaceholder(registryConfig["token"]);
// add "replaces-base" if present
var replacesBase = registryConfig["replaces-base"];
if (replacesBase !== undefined) {
parsed["replaces-base"] = replacesBase;
}
// parse the url
var url = registryConfig["url"];
if (!url && type !== 'hex_organization') {
throw new Error(
`The value 'url' in dependency registry config '${registryConfigKey}' is missing`
);
}
if (url) {
// Some credentials do not use the 'url' property in the Ruby updater.
// npm_registry and docker_registry use 'registry' which should be stripped off the scheme.
// terraform_registry uses 'host' which is the hostname from the given URL.
if (type === 'docker_registry' || type === 'npm_registry') {
parsed.registry = url.replace("https://", "").replace("http://", "");
}
else if (type === 'terraform_registry') {
parsed.host = new URL(url).hostname;
}
else if (type === 'python_index') {
parsed["index-url"] = url;
}
else {
parsed.url = url;
}
}
});
return registries;
}
const KnownRegistryTypes = [
"composer-repository",
"docker-registry",
"git",
"hex-organization",
"hex-repository",
"maven-repository",
"npm-registry",
"nuget-feed",
"python-index",
"rubygems-server",
"terraform-registry",
];
export { parseConfigFile, parseUpdates, parseRegistries, };