reporter: update to use TAP 13

George Adams · George Adams · commit 5f4d03356970 · 2016-11-24T09:45:57.000Z
Use yamlish instead of # to match community: nodejs/node#9262
diff --git a/lib/reporter/tap.js b/lib/reporter/tap.js
@@ -11,8 +11,11 @@ function generateTest(mod, count) {
   if (mod.error && mod.error.message) {
     mod.error = mod.error.message;
   }
+  var output = '';
   var error = mod.error ? [directive, mod.error].join(' ') : '';
-  var output = mod.testOutput ? '\n' + util.sanitizeOutput(mod.testOutput, '# ') : '';
+  if (mod.testOutput && mod.testOutput.length > 0) {
+    output = '\n  ---\n' + util.sanitizeOutput(mod.testOutput, '  #') + '\n  ...';
+  }
   return [result, count + 1, '-', mod.name, 'v' + mod.version + error + output].join(' ');
 }
 
diff --git a/package.json b/package.json
@@ -64,6 +64,8 @@
     "nyc": "^8.4.0",
     "opener": "^1.4.1",
     "rewire": "^2.4.0",
-    "tap": "^8.0.0"
+    "tap": "^8.0.0",
+    "tap-parser": "^3.0.3",
+    "string-to-stream": "^1.1.0"
   }
 }
diff --git a/test/fixtures/parsed-tap.json b/test/fixtures/parsed-tap.json
@@ -0,0 +1,24 @@
+{
+  "bailout": false,
+  "count": 3,
+  "fail": 1,
+  "failures": [
+    {
+      "diag": null,      
+      "id": 3,
+      "name": "iFail v3.0.1 I dun wurk",
+      "ok": false
+    }
+  ],
+  "ok": false,
+  "pass": 2,
+  "plan": {
+    "comment": "",
+    "start": 1,
+    "skipAll": false,
+    "skipReason": "",
+    "end": 3
+  },
+  "skip": 1,
+  "todo": 0
+}
diff --git a/test/fixtures/test-out-tap-failing.txt b/test/fixtures/test-out-tap-failing.txt
@@ -1,7 +1,11 @@
 TAP version 13
 ok 1 - iPass v4.2.2
 ok 2 - iFlakyFail v3.3.3 # SKIP I dun wurk
-#  Thanks for testing!
+  ---
+  # Thanks for testing!
+  ...
 not ok 3 - iFail v3.0.1 I dun wurk
-#  Thanks for testing!
+  ---
+  # Thanks for testing!
+  ...
 1..3
diff --git a/test/fixtures/test-out-tap-passing-append.txt b/test/fixtures/test-out-tap-passing-append.txt
@@ -2,5 +2,7 @@ This is a test!
 TAP version 13
 ok 1 - iPass v4.2.2
 ok 2 - iFlakyPass v3.0.1
-#  Thanks for testing!
+  ---
+  # Thanks for testing!
+  ...
 1..2
diff --git a/test/fixtures/test-out-tap-passing.txt b/test/fixtures/test-out-tap-passing.txt
@@ -1,5 +1,7 @@
 TAP version 13
 ok 1 - iPass v4.2.2
 ok 2 - iFlakyPass v3.0.1
-#  Thanks for testing!
+  ---
+  # Thanks for testing!
+  ...
 1..2
diff --git a/test/reporter/test-reporter-tap.js b/test/reporter/test-reporter-tap.js
@@ -7,6 +7,8 @@ var os = require('os');
 var test = require('tap').test;
 var mkdirp = require('mkdirp');
 var rimraf = require('rimraf');
+var parser = require('tap-parser');
+var str = require('string-to-stream');
 
 var tap = require('../../lib/reporter/tap');
 var fixtures = require('../fixtures/reporter-fixtures');
@@ -23,10 +25,10 @@ var passingInput = [
   fixtures.iPass,
   fixtures.iFlakyPass
 ];
-
 var passingExpectedPath = path.join(fixturesPath, 'test-out-tap-passing.txt');
 var passingExpectedPathAppend = path.join(fixturesPath, 'test-out-tap-passing-append.txt');
 
+var tapParserExpected = require('../fixtures/parsed-tap.json');
 var passingExpected = fs.readFileSync(passingExpectedPath, 'utf-8');
 var passingExpectedAppend = fs.readFileSync(passingExpectedPathAppend, 'utf-8');
 
@@ -70,6 +72,20 @@ test('reporter.tap(): failing', function (t) {
   t.end();
 });
 
+test('reporter.tap(): parser', function (t) {
+  var output = '';
+  function logger(message) {
+    output += message;
+  }
+
+  tap(logger, failingInput);
+  var p = parser(function (results) {
+    t.deepEquals(results, tapParserExpected), 'the tap parser should correctly parse the tap file';
+    t.end();
+  });
+  str(output).pipe(p);
+});
+
 test('reporter.tap(): write to disk', function (t) {
   tap(outputFile, passingInput);
   var expected = fs.readFileSync(outputFile, 'utf8');

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,11 @@ function generateTest(mod, count) {`
`11`	`11`	`if (mod.error && mod.error.message) {`
`12`	`12`	`mod.error = mod.error.message;`
`13`	`13`	`}`
	`14`	`+ var output = '';`
`14`	`15`	`var error = mod.error ? [directive, mod.error].join(' ') : '';`
`15`		`- var output = mod.testOutput ? '\n' + util.sanitizeOutput(mod.testOutput, '# ') : '';`
	`16`	`+ if (mod.testOutput && mod.testOutput.length > 0) {`
	`17`	`+ output = '\n ---\n' + util.sanitizeOutput(mod.testOutput, ' #') + '\n ...';`
	`18`	`+ }`
`16`	`19`	`return [result, count + 1, '-', mod.name, 'v' + mod.version + error + output].join(' ');`
`17`	`20`	`}`
`18`	`21`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,8 @@`
`64`	`64`	`"nyc": "^8.4.0",`
`65`	`65`	`"opener": "^1.4.1",`
`66`	`66`	`"rewire": "^2.4.0",`
`67`		`- "tap": "^8.0.0"`
	`67`	`+ "tap": "^8.0.0",`
	`68`	`+ "tap-parser": "^3.0.3",`
	`69`	`+ "string-to-stream": "^1.1.0"`
`68`	`70`	`}`
`69`	`71`	`}`