-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
331 lines (270 loc) · 7.89 KB
/
index.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
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
const exec = require("child_process").exec;
const execSync = require("child_process").execSync;
const path = require("path");
const fs = require("fs");
const crypto = require("crypto");
const util = require("util");
const _ = require("lodash");
const stripJsonComments = require("strip-json-comments");
const readFile = util.promisify(fs.readFile);
const logger = require("pino")({
prettyPrint: { colorize: true },
translateTime: false
});
const { fileExists } = require("./utilities");
const configs = require("./configs");
/**
* utils
*
* Used to store all non-related methods used through the project.
*
* @author Luis Cardoso (luis.cardoso@feedzai.com)
* @author Henrique Dias (henrique.dias@feedzai.com)
*/
const TMP_DIR = "./tmp";
const METRIC_GROUPS = {
RANDOM: "Random",
VERSIONS: "Versions",
COMMANDS: "Commands",
HAS: "Has"
};
module.exports.TMP_DIR = TMP_DIR;
/**
* Loads jest config file for a given `repoFolder`
* @param {string} repoFolder
* @returns {string}
*/
async function loadJestConfig(repoFolder) {
let rawTextFile;
try {
rawTextFile = await readFile(path.join(repoFolder, "jest.config.js"), "utf8");
} catch (err) {
logger.error("error openning file");
return null;
}
return rawTextFile;
}
/**
* Checks whether a repository is installed or not
* @param {string} repoFolder
* @returns {boolean}
*/
function isInstalled(repoFolder) {
const r = `${repoFolder}/node_modules`;
if (fs.existsSync(r)) {
return true;
}
return false;
}
/**
* Loads Eslint config for a given `repoFolder`
* @param {string} repoFolder
*/
async function loadEslintFile(repoFolder) {
let eslintRc;
if (await fileExists(repoFolder, ".eslintrc.json")) {
const rawTextFile = await readFile(path.join(repoFolder, ".eslintrc.json"), "utf8");
eslintRc = JSON.parse(stripJsonComments(rawTextFile));
} else if (await fileExists(repoFolder, ".eslintrc")) {
const rawTextFile = await readFile(path.join(repoFolder, ".eslintrc"), "utf8");
try {
eslintRc = JSON.parse(stripJsonComments(rawTextFile));
} catch (error) {
eslintRc = null;
}
} else {
eslintRc = {};
}
return eslintRc;
}
/**
* Gets the SHA1 checksum for the package.json in the `repoFolder`
* @param {string} repoFolder
* @returns {string}
*/
function getPackageChecksum(repoFolder) {
try {
const file = fs.readFileSync(path.resolve(repoFolder, "package.json"));
const shasum = crypto.createHash("sha1");
shasum.update(file);
return shasum.digest("hex");
} catch (err) {
logger.error("Error calculating checksum");
return 0;
}
}
/**
* Returns all Dependencies for a given `packageJson`
* @param {object} packageJson
* @returns {Array}
*/
function getAllDependencies(packageJson) {
return Object.assign({}, packageJson.devDependencies, packageJson.dependencies);
}
/**
* Executes the given `command` on the given `folder`
* @param {string} folder
* @param {string} command
* @returns {boolean}
*/
function executeCommand(folder, command) {
const com = `cd ${folder} && ${command} `;
return new Promise((resolve) => {
// eslint-disable-next-line no-unused-vars
exec(com, { maxBuffer: 1024 * 1024 * 100 }, function (err, stdout, stderr) {
if (err) {
resolve(false);
}
resolve(true);
});
});
}
/**
* Executes a `command` in a `folder`
* @param {string} folder
* @param {string} command
* @returns {string}
*/
function executeCommandSync(folder, command) {
try {
return execSync(`cd ${folder} && ${command}`);
} catch (err) {
logger.error(`Error executing ${command} on ${folder}`);
}
}
/**
* As the name implies, this method will execute a `command` on
* a `folder` and return its output
* @param {string} folder
* @param {string} command
* @returns {Promise<string>}
*/
function executeCommandGetOutput(folder, command) {
const com = `cd ${folder} && ${command} `;
return new Promise((resolve, reject) => {
// eslint-disable-next-line no-unused-vars
exec(com, { maxBuffer: Infinity }, function (err, stdout, stderr) {
if (!_.isNull(err)) {
reject(null);
}
resolve(stdout);
});
});
}
/**
* Reads `file` from `repoFolder`
* @param {string} repoFolder
* @param {string} file
* @returns {string}
*/
function getFileFolder(repoFolder, file) {
return new Promise((resolve) => {
fs.readFile(path.join(repoFolder, file), "utf8", (err, data) => {
resolve(data);
});
});
}
/**
* Open a file with the fiven full path (including filename)
* @param {string} completePath
* @returns {Promise<string>}
*/
function openFileFromPath(completePath) {
return new Promise((resolve) => {
fs.readFile(completePath, "utf8", (err, data) => {
resolve(data);
});
});
}
/**
* Gets last commit hash for a given repo
* @param {string} repoFolder
* @returns {string}
*/
function getLastCommitHash(repoFolder) {
const result = executeCommandSync(repoFolder, "git rev-parse HEAD").toString();
result.replace("\n", "");
return result;
}
/**
* Loads the last report from his config file
* @returns {object | null}
*/
function loadLastReport() {
return openFileFromPath(configs.getJsonReporter()["output-file"]).then((file) => {
try {
return JSON.parse(file);
} catch (e) {
return null;
}
});
}
/**
* Returns the repository folder path to run the analysis.
*
* @param {Object} repo
* @returns {string}
*/
function getRepoFolder(repo) {
if (_.isBoolean(repo.isLocal)) {
return process.cwd();
}
return "/tmp/repo-analyzer";
}
/**
* Checks out a git repository in `repoFolder` to a git `hash`
* @param {string} repoFolder
* @param {string} hash
*/
async function checkoutToCommit(repoFolder, hash) {
return executeCommandSync(repoFolder, `git checkout -f && git checkout ${hash}`);
}
/**
* Returns all the commits for a given folder
* @param {string} repoFolder
* @returns {Array}
*/
async function getAllCommits(repoFolder) {
return executeCommandGetOutput(repoFolder, "git log --decorate --pretty=oneline ").then((res) => {
let lines = [];
lines = res.split("\n");
const hashes = [];
for (let i = 0; i < lines.length; i++) {
if (lines[i] !== "") {
hashes.push(lines[i].split(" ")[0]);
}
}
return hashes;
});
}
/**
* Returns the date for a given repo in `repoFolder` with the following`commit`
* @param {string} repoFolder
* @param {string} commit
* @returns {Date}
*/
function getDateForCommit(repoFolder, commit) {
if (!_.isString(commit)) {
return null;
}
const out = executeCommandSync(repoFolder, `git show -s --format=%ci ${commit} `);
return new Date(out);
}
module.exports.getRepoFolder = getRepoFolder;
module.exports.fileExists = fileExists;
module.exports.executeCommand = executeCommand;
module.exports.getFileFolder = getFileFolder;
module.exports.isInstalled = isInstalled;
module.exports.METRIC_GROUPS = METRIC_GROUPS;
module.exports.getAllDependencies = getAllDependencies;
module.exports.loadEslintFile = loadEslintFile;
module.exports.loadJestConfig = loadJestConfig;
module.exports.openFileFromPath = openFileFromPath;
module.exports.executeCommandGetOutput = executeCommandGetOutput;
module.exports.getLastCommitHash = getLastCommitHash;
module.exports.loadLastReport = loadLastReport;
module.exports.getAllCommits = getAllCommits;
module.exports.checkoutToCommit = checkoutToCommit;
module.exports.getDateForCommit = getDateForCommit;
module.exports.executeCommandSync = executeCommandSync;
module.exports.getPackageChecksum = getPackageChecksum;