Add filename to Mocha.Test objects

[lambdabaa]

I would like for the mocha runner to send my custom reporter the names of the containing files along with tests. How would people feel about a patch that made test objects aware of the file in which they are declared?

[lightsofapollo]

In both node and the browser we can do this by throwing then catching an error:

try {
 throw new Error();
} catch(e) {
  e;
}

[tomruggs]

👍

[spollack]

I think it would be great to have the filename in the test object.

[jroper]

Filename in test object would be quite useful - imagine a large project with thousands of tests, how do you know, from looking at the name of the test suite, which file contains the one that failed? It may not always be intuitive especially when projects get large with many people working on them. If the test is asynchronous, the stack trace might not contain the test filename.

It would also be very useful for tooling, for example some tools, when a test fails, lets you click on the failed test to take you to that test. Without a test name, it can't implement this.

[jroper]

Btw, this works around the issue, if you're programatically using mocha:

mocha.suite.on("post-require", function(ctx, file) {
    // Add the filename to any first level suites that don't have a filename defined
    mocha.suite.suites.forEach(function(suite) {
       if (suite.filename === undefined) {
           suite.filename = file;
       }
    });
});

[tj]

@jroper :( write little modules and build apps with those!

[jroper]

I agree, but I'm not the one writing the apps, I'm the one writing the build tool (https://github.com/sbt/sbt-mocha-plugin). I'm just anticipating what people are going to complain to me about.

[EragonJ]

👍 for this feature ! This would be really useful if we want to put more details in customized reporter.

[evanxd]

Yes, would like to have this feature.
Then we could have a reporter could show file name of the failed test case and could find the test files to fix much more easily.

[lambdabaa]

@visionmedia Thoughts? The patch is nice and small :)

[EragonJ]

@visionmedia @gaye ++

[laggingreflex]

This is good, but would be even better to have access to the filename in after/before hooks as well.. maybe the file could be attached to runner instead of test?

[lambdabaa]

@laggingreflex 55f01bc

[AakankshaDC]

Will filename be displayed when run mocha -u exports --recursive test --reporter json on command line? Do I need to change something in my arguments to enable it?