fix: emit suite names as TAP comments and use test.title instead of fullTitle

Author: mostafaNazari702

lib/reporters/tap.js

@@ -20,6 +20,7 @@ var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
 var EVENT_RUN_END = constants.EVENT_RUN_END;
 var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var EVENT_TEST_END = constants.EVENT_TEST_END;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
 var sprintf = util.format;
 
 class TAP extends Base {
@@ -53,6 +54,12 @@ class TAP extends Base {
       self._producer.writeVersion();
     });
 
+    runner.on(EVENT_SUITE_BEGIN, function (suite) {
+      if (!suite.root) {
+        println("# %s", suite.title);
+      }
+    });
+
     runner.on(EVENT_TEST_END, function () {
       ++n;
     });
@@ -83,7 +90,7 @@ class TAP extends Base {
  * @return {String} title with any hash character removed
  */
 function title(test) {
-  return test.fullTitle().replace(/#/g, "");
+  return test.title.replace(/#/g, "");
 }
 
 /**

test/integration/reporters.spec.cjs

@@ -236,7 +236,7 @@ describe("reporters", function () {
         for (var i = 0; i + 1 < outputLines.length; i++) {
           if (
             testLinePredicate(outputLines[i]) &&
-            testLinePredicate(outputLines[i + 1]) === false
+            anythingElsePredicate(outputLines[i + 1])
           ) {
             var blockLinesStart = i + 1;
             var blockLinesEnd =

test/reporters/tap.spec.cjs

@@ -10,6 +10,7 @@ var makeRunReporter = helpers.createRunReporterFunction;
 
 var EVENT_RUN_BEGIN = events.EVENT_RUN_BEGIN;
 var EVENT_RUN_END = events.EVENT_RUN_END;
+var EVENT_SUITE_BEGIN = events.EVENT_SUITE_BEGIN;
 var EVENT_TEST_END = events.EVENT_TEST_END;
 var EVENT_TEST_FAIL = events.EVENT_TEST_FAIL;
 var EVENT_TEST_PASS = events.EVENT_TEST_PASS;
@@ -23,6 +24,7 @@ describe("TAP reporter", function () {
 
   function createTest() {
     return {
+      title: expectedTitle,
       fullTitle: function () {
         return expectedTitle;
       },
@@ -529,4 +531,85 @@ describe("TAP reporter", function () {
       });
     });
   });
+
+  describe("suite hierarchy", function () {
+    var options = {
+      reporterOptions: {
+        tapVersion: "12",
+      },
+    };
+
+    describe("on 'suite' event", function () {
+      var stdout;
+      var expectedSuiteTitle = "My Suite";
+
+      before(async function () {
+        var suite = { root: false, title: expectedSuiteTitle };
+        var runner = createMockRunner(
+          "suite",
+          EVENT_SUITE_BEGIN,
+          null,
+          null,
+          suite,
+        );
+        runner.suite = "";
+        ({ stdout } = await runReporter({}, runner, options));
+      });
+
+      it("should write a comment with the suite title", function () {
+        expect(stdout[0], "to equal", "# " + expectedSuiteTitle + "\n");
+      });
+    });
+
+    describe("on 'suite' event with root suite", function () {
+      var stdout;
+
+      before(async function () {
+        var suite = { root: true, title: "" };
+        var runner = createMockRunner(
+          "suite",
+          EVENT_SUITE_BEGIN,
+          null,
+          null,
+          suite,
+        );
+        runner.suite = "";
+        ({ stdout } = await runReporter({}, runner, options));
+      });
+
+      it("should not write a comment for the root suite", function () {
+        expect(stdout, "to be empty");
+      });
+    });
+
+    describe("on 'pass' event with suite context", function () {
+      var stdout;
+      var testTitle = "should work";
+
+      before(async function () {
+        var test = {
+          title: testTitle,
+          fullTitle: function () {
+            return "My Suite should work";
+          },
+          slow: noop,
+        };
+        var runner = createMockRunner(
+          "start test",
+          EVENT_TEST_END,
+          EVENT_TEST_PASS,
+          null,
+          test,
+        );
+        runner.suite = "";
+        ({ stdout } = await runReporter({}, runner, options));
+      });
+
+      it("should use test title not fullTitle in output", function () {
+        var expectedMessage =
+          "ok " + countAfterTestEnd + " " + testTitle + "\n";
+        expect(stdout[0], "to equal", expectedMessage);
+      });
+    });
+  });
 });