WIP: Reporter Output via Mixins #3874
Conversation
Created reporter output mixins for file, stdout, and console.log.
Revamped reporter to use mixin instead, removing output-specific code. Added class method `XUnit.getSuiteName`. Now uses `XUnit.prototype.writeln`.
Updated to use 'sinon' stubs. No longer screws with `process`. Other additions.
plroebuck
added
type: feature
| */ | ||
| this.writeln = function(str) { | ||
| this.write(str); | ||
| console.log(buffer); |
There was a problem hiding this comment.
Worth saving a reference like the timer? (let users stub)
There was a problem hiding this comment.
I hadn't bothered integrating with your PR at this point, but it would be done in this one file for any reporter implementing ReportWriter. It's quite honestly trivial to implement for a reporter; it's writing the unit tests that takes all the time...
| var delay = 1000; // One second | ||
|
|
||
| this.writeln(); | ||
| setTimeout(cb, delay); |
There was a problem hiding this comment.
Why does console writer need a timeout? Why 1s?
There was a problem hiding this comment.
As this method is invoked immediately prior to Mocha.run finishing up, the delay is there to (hopefully) allow completion of flushing any buffered (i.e., unwritten) output to the screen. The '1s' time is arbirtrary for the moment; it's rather long for CPU-related tasks, but as this is IO-related I'm uncertain just what a good value would be.
Be happy to change the comment to "arbitrary", as I usually would have...
|
Few questions. Approach makes sense to me. |
Description of the Change
Created class mixins to allow a reporter to support multiple output destinations.
Hope would be to eventually make reporters use these mixins to standardize
built-in reporters across the board.
This PR transformed
XUnitfirst, since it already had unit tests dealing with file output.Would like both
JSONandTAPto get the "treatment" soon.Looking for comments on the approach taken.
Alternate Designs
We could add the same "XUnit" code to each reporter that desired file output.
Why should this be in core?
Magnets!!!
Benefits
Trivializes adding support for file output to another reporter.
Possible Drawbacks
None found in XUnit thusfar.
Applicable issues
semver-minor