node/tools/eslint-rules/crypto-check.js
Daniel Bevenius 50ebac1124
tools: add eslint rule for hasCrypto checking
The motivation for this commit is to pick up early on missing checks for
crypto support (when Node is built --without-ssl).

There are currently usages of common.hasCrypto which are not just for
detecting if crypto support is available and then skip the test in
question. For these case we still want to have a lint error generated
which can then be disabled using an ESLint comment.

PR-URL: https://github.com/nodejs/node/pull/13813
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
2017-08-30 18:02:58 -03:00

84 lines
2.0 KiB
JavaScript

/**
* @fileoverview Check that common.hasCrypto is used if crypto, tls,
* https, or http2 modules are required.
*
* This rule can be ignored using // eslint-disable-line crypto-check
*
* @author Daniel Bevenius <daniel.bevenius@gmail.com>
*/
'use strict';
const utils = require('./rules-utils.js');
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
const msg = 'Please add a hasCrypto check to allow this test to be skipped ' +
'when Node is built "--without-ssl".';
module.exports = function(context) {
const missingCheckNodes = [];
const requireNodes = [];
var hasSkipCall = false;
function testCryptoUsage(node) {
if (utils.isRequired(node, ['crypto', 'tls', 'https', 'http2'])) {
requireNodes.push(node);
}
}
function testIfStatement(node) {
if (node.test.argument === undefined) {
return;
}
if (isCryptoCheck(node.test.argument)) {
checkCryptoCall(node);
}
}
function isCryptoCheck(node) {
return utils.usesCommonProperty(node, ['hasCrypto', 'hasFipsCrypto']);
}
function checkCryptoCall(node) {
if (utils.inSkipBlock(node)) {
hasSkipCall = true;
} else {
missingCheckNodes.push(node);
}
}
function testMemberExpression(node) {
if (isCryptoCheck(node)) {
checkCryptoCall(node);
}
}
function reportIfMissingCheck(node) {
if (hasSkipCall) {
return;
}
if (requireNodes.length > 0) {
if (missingCheckNodes.length > 0) {
report(missingCheckNodes);
} else {
report(requireNodes);
}
}
}
function report(nodes) {
nodes.forEach((node) => {
context.report(node, msg);
});
}
return {
'CallExpression': (node) => testCryptoUsage(node),
'IfStatement:exit': (node) => testIfStatement(node),
'MemberExpression:exit': (node) => testMemberExpression(node),
'Program:exit': (node) => reportIfMissingCheck(node)
};
};