Merge pull request #25 from stjohnjohnson/AllowNodeArgs

feat: adding support for customizing node v8 arguments
stjohnjohnson · Jan 4, 2017 · b963219 · b963219
2 parents 2d3502e + 9619707
commit b963219
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -66,6 +66,16 @@ Any other parameters added to the command will be passed directly to mocha.
 
 If you need to configure nyc, you may create a .nycrc configuration file. Run `nyc help config` for details.
 
+If you want to configure how node is invoked (if you have a giant coverage file), you can set v8 arguments via `$(NODE_ARGS)`.
+
+``` json
+{
+    "scripts": {
+        "test": "NODE_ARGS='--max_old_space_size=4096' jenkins-mocha test/*"
+    }
+}
+```
+
 When npm-test is invoked, the module will:
  - Create XUnit test results in `$(TEST_DIR)`
  - Create LCov coverage in `$(COVERAGE_DIR)` with a HTML report at `$(COVERAGE_DIR)\lcov-report`

diff --git a/lib/jenkins.js b/lib/jenkins.js
@@ -56,11 +56,12 @@ module.exports = function (args) {
     }
 
     var command = [];
+    var nodeArgs = shell.env.NODE_ARGS || '';
 
     var noCoverageIndex = args.indexOf('--no-coverage');
     if (noCoverageIndex === -1) {
         // we want coverage
-        command.push(getBin('nyc'));
+        command.push('node', nodeArgs, getBin('nyc'));
 
         // .. but do we want cobertura?
         var coberturaIndex = args.indexOf('--cobertura');
@@ -73,11 +74,11 @@ module.exports = function (args) {
         }
 
         command.push('--report-dir ' + escape(directories.coverage) + ' --');
-        command.push(getBin('_mocha'));
+        command.push('node', nodeArgs, getBin('_mocha'));
     } else {
         // remove the --no-coverage option from args array
         args.splice(noCoverageIndex, 1);
-        command.push(getBin('mocha'));
+        command.push('node', nodeArgs, getBin('mocha'));
     }
 
     command.push('--reporter ' + escape(require.resolve('spec-xunit-file')));

diff --git a/test/jenkins.test.js b/test/jenkins.test.js
@@ -79,9 +79,9 @@ describe('Jenkins Mocha Test Case', function () {
 
             // Check exec
             A.equalObject(mocks.exec.args[0], [
-                nycPath + ' --reporter lcov --report-dir ' +
+                'node  ' + nycPath + ' --reporter lcov --report-dir ' +
                 coverage +
-                ' -- ' + _mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
+                ' -- node  ' + _mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
             ], 'mocha was called correctly');
         });
 
@@ -102,9 +102,9 @@ describe('Jenkins Mocha Test Case', function () {
 
             // Check exec
             A.equalObject(mocks.exec.args[0], [
-                nycPath + ' --reporter lcov --report-dir ' +
+                'node  ' + nycPath + ' --reporter lcov --report-dir ' +
                 coverage +
-                ' -- ' + _mochaPath + ' --reporter ' + specXunitPath + ' --foo \'tests/*\' --no-colors'
+                ' -- node  ' + _mochaPath + ' --reporter ' + specXunitPath + ' --foo \'tests/*\' --no-colors'
             ], 'mocha was called correctly');
         });
 
@@ -125,7 +125,7 @@ describe('Jenkins Mocha Test Case', function () {
 
             // Check exec
             A.equalObject(mocks.exec.args[0], [
-                mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
+                'node  ' + mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
             ], 'mocha was called correctly');
         });
 
@@ -146,9 +146,34 @@ describe('Jenkins Mocha Test Case', function () {
 
             // Check exec
             A.equalObject(mocks.exec.args[0], [
-                nycPath + ' --reporter cobertura --report-dir ' +
+                'node  ' + nycPath + ' --reporter cobertura --report-dir ' +
                 coverage +
-                ' -- ' + _mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
+                ' -- node  ' + _mochaPath + ' --reporter ' + specXunitPath + ' --colors --foo \'tests/*\''
+            ], 'mocha was called correctly');
+        });
+
+        it('should support passing Node args', function () {
+            mocks.exec.returns({
+                code: 0
+            });
+            mocks.env.NODE_ARGS = '--flop=blop';
+
+            // Run
+            require('../lib/jenkins')(['--foo', 'tests/*', '--no-colors']);
+
+            assertMkDirCallsAreReceived();
+
+            // Check environment
+            A.equalObject(mocks.env, {
+                NODE_ARGS: '--flop=blop',
+                XUNIT_FILE: path.join(process.cwd(), 'artifacts', 'test', 'xunit.xml')
+            }, 'xunit file was set');
+
+            // Check exec
+            A.equalObject(mocks.exec.args[0], [
+                'node --flop=blop ' + nycPath + ' --reporter lcov --report-dir ' +
+                coverage +
+                ' -- node --flop=blop ' + _mochaPath + ' --reporter ' + specXunitPath + ' --foo \'tests/*\' --no-colors'
             ], 'mocha was called correctly');
         });
     });