mocha-multi incompatible with latest mocha (gulp)

[corvinrok]

In the previous version of mocha (gulp-mocha 3.0.1) all was well with the universe and definitions for the mocha-multi reporter could be specified through the "reporterOptions" property sent into mocha. That now seems to be deprecated or something is seriously broken with the latest version of mocha (gulp-mocha 4.0.1). Here is the gulp script which includes my mocha call:

gulp.task('testServer:ci', ['build:server'], function (cb) {
    log('Running Server unit tests...');
    gulp.src(config.servercoveredfiles)
        .pipe($.istanbul({includeUntested: true}))
        .pipe($.istanbul.hookRequire())
        .on('finish', function () {
            var reporterOptions = {
                xunit: config.ci + 'server-ut.xml',
                spec: '-'
            };
            var stream = gulp.src(config.tests, {read: false})
            // do the success/fail reporting on the unit tests
                .pipe($.mocha({
                    ui: 'bdd',
                    reporter: 'mocha-multi',
                    reporterOptions: reporterOptions
                }));
            stream.on('error', function (err) {
                // if the unit tests fail, report the error to the command
                // line and don't do the CI reporting.
                $.util.log($.util.colors.red(err));
                log('Server Unit Tests Failed, exiting...');
                cb();
            });
            // do the CI reporting for Code coverage
            stream.pipe($.istanbul.writeReports({
                dir: config.ccserver,
                reporters: ['text-summary', 'html', 'cobertura']
            }))
                .on('end', function () {
                    log('Server Unit Tests Completed, exiting...');
                    cb();
                });
        });
});

Up until the most recent release of mocha, this worked fine. Now the following error is spewed, declaring that "reporter definitions should be set in the multi shell variable". Here is the full error:

[17:14:20] Error in plugin 'gulp-mocha'
Message:
    spawn undefined ENOENT
Details:
    errno: ENOENT
    code: ENOENT
    syscall: spawn undefined
    killed: false
    stdout: 
    stderr: ERROR: reporter definitions should be set in the `multi` shell variable
eg. `multi='dot=- xunit=file.xml' mocha`

    failed: true
    signal: null
    cmd: mocha C:\git\my-program\ServerSide\test\fileHandler.test.js C:\git\my-program\ServerSide\test\translateData.test.js --colors --ui=bdd --reporter=mocha-multi
    timedOut: false

Seems like something fundamental has changed, or this reporter is now DOA.

Any help?

[glenjamin]

gulp-mocha v4 has made a major breaking change (hence the move to v4 from v3), which instead of calling the mocha API programatically, now shells out to run mocha. sindresorhus/gulp-mocha#151

This means that gulp-mocha options can now only be strings, not complex objects.

If you need the old behaviour, i suggest you peg the version to v3. Otherwise, you'll need to use one of the other two methods for configuring which reporters to use.

[charliekassel]

How is it possible to pass options when commands should be type=destination values?

For context my situation is this:

.pipe(mocha({
  reporter: 'mocha-multi',
  reporterOptions: 'spec=-,mocha-junit-reporter=./_output/junit/report.xml'
}));

which correctly builds the results.xml file to the provided destination path, however mocha-junit-reporter package requires a mochaFile option else it uses the default of ./test-results.xml which get's built as well.

[glenjamin]

https://github.com/glenjamin/mocha-multi#using-mocha-multi-programmatically

[charliekassel]

Thanks for the quick response - I understand from above though that using gulp-mocha v4+ (I'm using ^6.0.0) I can no longer do that as it can only be a string?

[glenjamin]

I'm not familar enough with gulp-mocha to answer that, you'd probably have to ask them.

…

On 19 June 2018 at 16:25, charliekassel ***@***.***> wrote: Thanks for the quick response - I understand from above though that using gulp-mocha v4+ (I'm using ^6.0.0) I can no longer do that as it can only be a string? — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub <#26 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAJO6FQYEE3Cm0OYewdpzLMvtsrN_R9Iks5t-Rf6gaJpZM4MIDMj> .

[charliekassel]

This means that gulp-mocha options can now only be strings, not complex objects.

Fair enough, but I'm basing this on your earlier comment.

[glenjamin]

Ah yes, I didn't scroll up - I wrote that a long time ago!

I would suggest you experiment until you find options that work using the mocha commandline, and then hopefully those should convert directly to gulp-mocha.