test: eslint rule making common.js mandatory

test/.eslintrc

@@ -5,6 +5,8 @@ rules:
  no-undef: 0
  ## allow global Buffer usage
  require-buffer: 0
+ ## common module is mandatory in tests
+ required-modules: [2, "common"]
 
 globals:
  gc: false

test/addons/async-hello-world/test.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../../common');
 var assert = require('assert');
 var binding = require('./build/Release/binding');
 var called = false;

test/addons/at-exit/test.js

@@ -1,2 +1,3 @@
 'use strict';
+require('../../common');
 var binding = require('./build/Release/binding');

test/addons/heap-profiler/test.js

@@ -1,5 +1,7 @@
 'use strict';
 
+require('../../common');
+
 const binding = require('./build/Release/binding');
 
 // Create an AsyncWrap object.

test/addons/hello-world-function-export/test.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../../common');
 var assert = require('assert');
 var binding = require('./build/Release/binding');
 assert.equal('world', binding());

test/addons/hello-world/test.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../../common');
 var assert = require('assert');
 var binding = require('./build/Release/binding');
 assert.equal('world', binding.hello());

test/addons/repl-domain-abort/test.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../../common');
 var assert = require('assert');
 var repl = require('repl');
 var stream = require('stream');

test/common.js

@@ -1,3 +1,4 @@
+/* eslint-disable required-modules */
 'use strict';
 var path = require('path');
 var fs = require('fs');

test/debugger/test-debugger-repl-break-in-module.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../common');
 var repl = require('./helper-debugger-repl.js');
 
 repl.startDebugger('break-in-module/main.js');

test/debugger/test-debugger-repl-restart.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../common');
 var repl = require('./helper-debugger-repl.js');
 
 repl.startDebugger('breakpoints.js');

test/debugger/test-debugger-repl-term.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../common');
 process.env.NODE_FORCE_READLINE = 1;
 
 var repl = require('./helper-debugger-repl.js');

test/debugger/test-debugger-repl.js

@@ -1,4 +1,5 @@
 'use strict';
+require('../common');
 var repl = require('./helper-debugger-repl.js');
 
 repl.startDebugger('breakpoints.js');

test/parallel/test-domain-crypto.js

@@ -1,4 +1,4 @@
-/* eslint-disable strict */
+/* eslint-disable strict, required-modules */
 try {
  var crypto = require('crypto');
 } catch (e) {

test/parallel/test-regression-object-prototype.js

@@ -1,5 +1,5 @@
+/* eslint-disable required-modules */
 'use strict';
-//console.log('puts before');
 
 Object.prototype.xadsadsdasasdxx = function() {
 };

test/parallel/test-repl-autolibs.js

@@ -1,3 +1,4 @@
+/* eslint-disable required-modules */
 'use strict';
 var assert = require('assert');
 var util = require('util');

tools/eslint-rules/required-modules.js

@@ -0,0 +1,104 @@
+/**
+ * @fileoverview Require usage of specified node modules.
+ * @author Rich Trott
+ */
+'use strict';
+
+var path = require('path');
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = function(context) {
+ // trim required module names
+ var requiredModules = context.options;
+
+ var foundModules = [];
+
+ // if no modules are required we don't need to check the CallExpressions
+ if (requiredModules.length === 0) {
+ return {};
+ }
+
+ /**
+ * Function to check if a node is a string literal.
+ * @param {ASTNode} node The node to check.
+ * @returns {boolean} If the node is a string literal.
+ */
+ function isString(node) {
+ return node && node.type === 'Literal' && typeof node.value === 'string';
+ }
+
+ /**
+ * Function to check if a node is a require call.
+ * @param {ASTNode} node The node to check.
+ * @returns {boolean} If the node is a require call.
+ */
+ function isRequireCall(node) {
+ return node.callee.type === 'Identifier' && node.callee.name === 'require';
+ }
+
+ /**
+ * Function to check if a node has an argument that is a required module and
+ * return its name.
+ * @param {ASTNode} node The node to check
+ * @returns {undefined|String} required module name or undefined
+ */
+ function getRequiredModuleName(node) {
+ var moduleName;
+
+ // node has arguments and first argument is string
+ if (node.arguments.length && isString(node.arguments[0])) {
+ var argValue = path.basename(node.arguments[0].value.trim());
+
+ // check if value is in required modules array
+ if (requiredModules.indexOf(argValue) !== -1) {
+ moduleName = argValue;
+ }
+ }
+
+ return moduleName;
+ }
+
+ return {
+ 'CallExpression': function(node) {
+ if (isRequireCall(node)) {
+ var requiredModuleName = getRequiredModuleName(node);
+
+ if (requiredModuleName) {
+ foundModules.push(requiredModuleName);
+ }
+ }
+ },
+ 'Program:exit': function(node) {
+ if (foundModules.length < requiredModules.length) {
+ var missingModules = requiredModules.filter(
+ function(module) {
+ return foundModules.indexOf(module === -1);
+ }
+ );
+ missingModules.forEach(function(moduleName) {
+ context.report(
+ node,
+ 'Mandatory module "{{moduleName}}" must be loaded.',
+ { moduleName: moduleName }
+ );
+ });
+ }
+ }
+ };
+};
+
+module.exports.schema = {
+ 'type': 'array',
+ 'items': [
+ {
+ 'enum': [0, 1, 2]
+ }
+ ],
+ 'additionalItems': {
+ 'type': 'string'
+ },
+ 'uniqueItems': true
+};