Merge pull request #2690 from craigtaub/improveUnitCoverage

Increase tests coverage for doc reporter

test/reporters/doc.spec.js

@@ -0,0 +1,213 @@
+'use strict';
+
+var reporters = require('../../').reporters;
+var Doc = reporters.Doc;
+
+describe('Doc reporter', function () {
+  var stdout;
+  var stdoutWrite;
+  var runner = {};
+  beforeEach(function () {
+    stdout = [];
+    stdoutWrite = process.stdout.write;
+    process.stdout.write = function (string) {
+      stdout.push(string);
+    };
+  });
+
+  describe('on suite', function () {
+    describe('if suite root does not exist', function () {
+      var expectedTitle = 'expectedTitle';
+      var unescapedTitle = '<div>' + expectedTitle + '</div>';
+      var suite = {
+        root: false,
+        title: expectedTitle
+      };
+      it('should log html with indents and expected title', function () {
+        runner.on = function (event, callback) {
+          if (event === 'suite') {
+            callback(suite);
+          }
+        };
+        Doc.call(this, runner);
+        process.stdout.write = stdoutWrite;
+        var expectedArray = [
+          '    <section class="suite">\n',
+          '      <h1>' + expectedTitle + '</h1>\n',
+          '      <dl>\n'
+        ];
+        stdout.should.deepEqual(expectedArray);
+      });
+      it('should escape title where necessary', function () {
+        var suite = {
+          root: false,
+          title: unescapedTitle
+        };
+        expectedTitle = '&lt;div&gt;' + expectedTitle + '&lt;/div&gt;';
+        runner.on = function (event, callback) {
+          if (event === 'suite') {
+            callback(suite);
+          }
+        };
+        Doc.call(this, runner);
+        process.stdout.write = stdoutWrite;
+        var expectedArray = [
+          '    <section class="suite">\n',
+          '      <h1>' + expectedTitle + '</h1>\n',
+          '      <dl>\n'
+        ];
+        stdout.should.deepEqual(expectedArray);
+      });
+    });
+    describe('if suite root does exist', function () {
+      var suite = {
+        root: true
+      };
+      it('should not log any html', function () {
+        runner.on = function (event, callback) {
+          if (event === 'suite') {
+            callback(suite);
+          }
+        };
+        Doc.call(this, runner);
+        process.stdout.write = stdoutWrite;
+        stdout.should.be.empty();
+      });
+    });
+  });
+
+  describe('on suite end', function () {
+    describe('if suite root does not exist', function () {
+      var suite = {
+        root: false
+      };
+      it('should log expected html with indents', function () {
+        runner.on = function (event, callback) {
+          if (event === 'suite end') {
+            callback(suite);
+          }
+        };
+        Doc.call(this, runner);
+        process.stdout.write = stdoutWrite;
+        var expectedArray = [
+          '  </dl>\n', '</section>\n'
+        ];
+        stdout.should.deepEqual(expectedArray);
+      });
+    });
+    describe('if suite root does exist', function () {
+      var suite = {
+        root: true
+      };
+      it('should not log any html', function () {
+        runner.on = function (event, callback) {
+          if (event === 'suite end') {
+            callback(suite);
+          }
+        };
+        Doc.call(this, runner);
+        process.stdout.write = stdoutWrite;
+        stdout.should.be.empty();
+      });
+    });
+  });
+
+  describe('on pass', function () {
+    var expectedTitle = 'some tite';
+    var expectedBody = 'some body';
+    var test = {
+      title: expectedTitle,
+      body: expectedBody,
+      slow: function () {
+        return '';
+      }
+    };
+    it('should log html with indents and expected title and body', function () {
+      runner.on = function (event, callback) {
+        if (event === 'pass') {
+          callback(test);
+        }
+      };
+      Doc.call(this, runner);
+      process.stdout.write = stdoutWrite;
+      var expectedArray = [
+        '    <dt>' + expectedTitle + '</dt>\n',
+        '    <dd><pre><code>' + expectedBody + '</code></pre></dd>\n'
+      ];
+      stdout.should.deepEqual(expectedArray);
+    });
+    it('should escape title and body where necessary', function () {
+      var unescapedTitle = '<div>' + expectedTitle + '</div>';
+      var unescapedBody = '<div>' + expectedBody + '</div>';
+      test.title = unescapedTitle;
+      test.body = unescapedBody;
+
+      var expectedEscapedTitle = '&lt;div&gt;' + expectedTitle + '&lt;/div&gt;';
+      var expectedEscapedBody = '&lt;div&gt;' + expectedBody + '&lt;/div&gt;';
+      runner.on = function (event, callback) {
+        if (event === 'pass') {
+          callback(test);
+        }
+      };
+      Doc.call(this, runner);
+      process.stdout.write = stdoutWrite;
+      var expectedArray = [
+        '    <dt>' + expectedEscapedTitle + '</dt>\n',
+        '    <dd><pre><code>' + expectedEscapedBody + '</code></pre></dd>\n'
+      ];
+      stdout.should.deepEqual(expectedArray);
+    });
+  });
+
+  describe('on fail', function () {
+    var expectedTitle = 'some tite';
+    var expectedBody = 'some body';
+    var expectedError = 'some error';
+    var test = {
+      title: expectedTitle,
+      body: expectedBody,
+      slow: function () {
+        return '';
+      }
+    };
+    it('should log html with indents and expected title, body and error', function () {
+      runner.on = function (event, callback) {
+        if (event === 'fail') {
+          callback(test, expectedError);
+        }
+      };
+      Doc.call(this, runner);
+      process.stdout.write = stdoutWrite;
+      var expectedArray = [
+        '    <dt class="error">' + expectedTitle + '</dt>\n',
+        '    <dd class="error"><pre><code>' + expectedBody + '</code></pre></dd>\n',
+        '    <dd class="error">' + expectedError + '</dd>\n'
+      ];
+      stdout.should.deepEqual(expectedArray);
+    });
+    it('should escape title, body and error where necessary', function () {
+      var unescapedTitle = '<div>' + expectedTitle + '</div>';
+      var unescapedBody = '<div>' + expectedBody + '</div>';
+      var unescapedError = '<div>' + expectedError + '</div>';
+      test.title = unescapedTitle;
+      test.body = unescapedBody;
+
+      var expectedEscapedTitle = '&lt;div&gt;' + expectedTitle + '&lt;/div&gt;';
+      var expectedEscapedBody = '&lt;div&gt;' + expectedBody + '&lt;/div&gt;';
+      var expectedEscapedError = '&lt;div&gt;' + expectedError + '&lt;/div&gt;';
+      runner.on = function (event, callback) {
+        if (event === 'fail') {
+          callback(test, unescapedError);
+        }
+      };
+      Doc.call(this, runner);
+      process.stdout.write = stdoutWrite;
+      var expectedArray = [
+        '    <dt class="error">' + expectedEscapedTitle + '</dt>\n',
+        '    <dd class="error"><pre><code>' + expectedEscapedBody + '</code></pre></dd>\n',
+        '    <dd class="error">' + expectedEscapedError + '</dd>\n'
+      ];
+      stdout.should.deepEqual(expectedArray);
+    });
+  });
+});