-
Notifications
You must be signed in to change notification settings - Fork 0
/
watcher.js
250 lines (216 loc) · 7.6 KB
/
watcher.js
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
// watcher.js - Reference Example
// Contains functions to perform actions against GitHub Repositories using
// Octokit and the GitHub REST API.
// See README.md for requirements and usage instructions.
const { Octokit } = require('@octokit/rest');
const { createAppAuth } = require('@octokit/auth-app');
const octokit = new Octokit({
authStrategy: createAppAuth,
baseUrl: (process.env.GHWATCHER_BASEURL || 'https://api.github.com'),
auth: {
appId: process.env.GHWATCHER_APP_ID,
privateKey: process.env.GHWATCHER_APP_PEM,
installationId: process.env.GHWATCHER_APP_INSTALLATION_ID,
},
});
// Fetch listing of repositories for an organization
// Returns an Array of Objects with details of repositories
async function getRepoList(orgName, repoName) {
const { data } = await octokit.rest.repos.listForOrg({
org: orgName,
});
// Filter on repoName, if present
const return_data = repoName ? data.filter(repo => repo.name.toLowerCase() === repoName.toLowerCase()) : data;
return return_data;
}
// Fetch listing of branches for provided repository
// Returns an Array of Strings
async function getBranchList(repoData) {
try {
const { data } = await octokit.rest.repos.listBranches({
owner: repoData.owner.login,
repo: repoData.name,
});
return data;
} catch (err) {
console.log('%s/%s: %s', repoData.owner.login, repoData.name, err);
}
}
// Fetch protection details of provided branch on repository
// Returns an Object
async function getBranchProtectionDetails(repoData, branch) {
const { data } = await octokit.rest.repos.getBranchProtection({
owner: repoData.owner.login,
repo: repoData.name,
branch: branch,
});
return data;
}
// Creates a default branch on a repository if one is not present with a default README.md
// TODO: Allow this content to be populated from ENV variables
async function createDefaultBranch(org, repo, branch) {
try {
console.log('%s/%s: Creating Default Branch with README.md', org, repo);
const readme_content = `# ${repo}
This file has been auto-generated.
Check out these helpful links for getting started with your new repository:
- [some-link](#)
- [some-other-link](#)`;
await octokit.rest.repos.createOrUpdateFileContents({
owner: org,
repo: repo,
branch: (branch || 'main'),
path: 'README.md',
message: 'Creates Default Branch',
content: Buffer.from(readme_content).toString('base64'),
});
} catch (err) {
console.log(err);
return err;
}
}
async function createNotificationIssue(org, repo, user) {
try {
console.log('%s/%s: Creating a notification Issue for %s', org, repo, user);
await octokit.rest.issues.create({
owner: org,
repo: repo,
title: 'watcher-bot action taken',
body: `Hello @${user}! This is a notification issue that the watcher-bot,
https://github.com/mydevsandbox-com/watcher , performed actions on this repository to
apply baseline configurations and branch protections for the default branch.`,
});
} catch (err) {
console.log(err);
}
}
// Enforces branch protection rules
// TODO: Allow all options to be populated from ENV variables
async function setBranchProtection(owner, repo, branch) {
try {
// console.log('%s/%s/%s: Updating Branch Protection', owner, repo, branch);
const { data } = await octokit.rest.repos.updateBranchProtection({
owner: owner,
repo: repo,
branch: branch,
required_status_checks: {
strict: true,
checks: [],
},
enforce_admins: false,
required_pull_request_reviews: {
dismissal_restrictions: {},
dismiss_stale_reviews: true,
require_code_owner_reviews: true,
required_approving_review_count: 1,
},
restrictions: null,
// restrictions.users: ,
// restrictions.teams: ,
});
return data;
} catch (err) {
console.log('%s/%s/%s: %s, %s', owner, repo, branch, err.response.status, err.response.data.message);
return err;
}
}
// Fetches the status of Dependabot alerting for a repository
async function getVulnerabilityAlertStatus(orgName, repoName) {
try {
const { status } = await octokit.rest.repos.checkVulnerabilityAlerts({
owner: orgName,
repo: repoName,
});
return status;
} catch (err) {
// console.log(err);
return err;
}
}
// Enables Dependabot alerting for a repository
async function enableVulnerabilityAlert(orgName, repoName) {
console.log('%s/%s: Enabling Dependabot Alert Scanning', orgName, repoName);
try {
const { status } = await octokit.rest.repos.enableVulnerabilityAlerts({
owner: orgName,
repo: repoName,
});
return status;
} catch (err) {
// console.log(err);
return err;
}
}
// Checks to see if there is a recent history of code-scanning analysis data for the repo
async function getCodeScanningAlertStatus(orgName, repoName) {
try {
const { data } = await octokit.rest.codeScanning.listRecentAnalyses({
owner: orgName,
repo: repoName,
});
return data;
} catch (err) {
console.log('%s/%s: %s', orgName, repoName, (err.response.data.message || err));
return [];
}
}
// Fetches the branch protection status and settings for default (or provided) branch on
// provided Organization(Required) and Repository(Optional)
// Returns an Array of Objects
async function getProtectionStatus(orgName, repoName, branchName) {
const reply = {
organization: orgName,
repos: [],
};
const repo_list = await getRepoList(orgName, repoName);
// Iterate through all repos returned as part of an org
for await (const repo of repo_list) {
// Skip private repos unless GHWATCHER_ENFORCE_PRIVATE is true
if (repo.private === true && process.env.GHWATCHER_ENFORCE_PRIVATE.match(/true/)) {
continue;
}
// Skip excluded repos, if present
const regexp_repo_name = '(^|\\s*|,)' + repo.name + '($|\\s*|,)';
if ((process.env.GHWATCHER_REPO_SKIP_LIST).match(RegExp(regexp_repo_name))) {
console.log('matched for SKIP_LIST to skip repo %s', repo.name);
continue;
}
// Fetch status of Dependabot Vulnerability Alerts
const vuln_alert_status = await getVulnerabilityAlertStatus(repo.owner.login, repo.name);
// Code-Scanning Analysis Data
const code_scanning_analysis = await getCodeScanningAlertStatus(repo.owner.login, repo.name);
// Create an Object which will store data for this repo
const repo_object = {
name: repo.name,
dependabot_vulnerability_alerts_enabled: (vuln_alert_status === 204 || false),
code_scanning_has_data: (code_scanning_analysis.length > 0 || false),
branches: [],
default_branch: (repo.default_branch || null),
};
// Fetch a listing of branches on the repo
// console.log('Fetching branches for %s/%s', orgName, repo.name);
const branches = await getBranchList(repo);
// Use the supplied branchName or the default_branch of a repo
const branchNameToCheck = (branchName || repo.default_branch);
for await (const branch of branches) {
if (branchNameToCheck.toLowerCase === branch.name.toLowerCase) {
const branch_protection_details = branch.protected ? await getBranchProtectionDetails(repo, branch.name) : {};
const branch_reply = {
name: branch.name,
protected: branch.protected,
protection: branch_protection_details,
};
repo_object.branches.push(branch_reply);
}
}
reply.repos.push(repo_object);
}
return reply;
}
module.exports = {
getProtectionStatus,
setBranchProtection,
enableVulnerabilityAlert,
createDefaultBranch,
createNotificationIssue,
};