feat: list all tests in check-run template

swingletree-oss · Feb 13, 2020 · f37ad84 · f37ad84
1 parent 807cee0
commit f37ad84
Show file tree

Hide file tree

Showing 4 changed files with 123 additions and 25 deletions.
diff --git a/src/status-emitter.ts b/src/status-emitter.ts
@@ -38,27 +38,29 @@ class TestNgStatusEmitter {
           testClass["test-method"]?.forEach((method: TestNg.TestMethod) => {
             report._tests.total++;
 
+            const annotation = new Harness.ProjectAnnotation();
             if (method.$.status == "FAIL") {
               report._tests.failed++;
-
-              const annotation = new Harness.ProjectAnnotation();
               annotation.severity = Harness.Severity.BLOCKER;
-              annotation.title = method.$.signature;
-              annotation.detail = method.$.description;
-              annotation.metadata = {
-                duration_ms: method.$["duration-ms"],
-                suite: suite.$.name,
-                class: testClass.$.name,
-                started: method.$["started-at"],
-                finished: method.$["finished-at"]
-              };
-
-              annotations.push(annotation);
-            } else if (method.$.status == "PASS") {
-              report._tests.succeeded++;
             } else if (method.$.status == "SKIP") {
               report._tests.skipped++;
+              annotation.severity = Harness.Severity.WARNING;
+            } else if (method.$.status == "PASS") {
+              report._tests.succeeded++;
+              return; // continue loop; do not add annotation
             }
+
+            annotation.title = method.$.signature;
+            annotation.detail = method.$.description;
+            annotation.metadata = {
+              duration_ms: method.$["duration-ms"],
+              suite: suite.$.name,
+              class: testClass.$.name,
+              started: method.$["started-at"],
+              finished: method.$["finished-at"]
+            };
+
+            annotations.push(annotation);
           });
         });
       });

diff --git a/templates/report.md.tpl b/templates/report.md.tpl
@@ -2,12 +2,17 @@
 
 <span title="Succeeded">&#x2714;&#xFE0F;</span> {{ event.report._tests.succeeded }} &bull; <span title="Skipped">&#x23ed;</span> {{ event.report._tests.skipped }} &bull; <span title="Failed">&#x274C;</span> {{ event.report._tests.failed }}
 
-{% if annotations.length > 0 %}
-## Failed tests
-
-| Test | Description |
-|:---|:---|
-{%  for annotation in annotations -%}
-| {{ annotation.title }} | {{ annotation.detail }} |
-{%  endfor %}
-{% endif %}
+{%- for suite in event['testng-results'].suite %}
+
+### Suite {{ suite.$.name }}
+
+| | Group | Class | Test | Description |
+|---|:---|:---|:---|:---|
+{%-  for test in suite.test %}
+{%-    for testClass in test.class %}
+{%-      for testMethod in testClass['test-method'] %}
+| {{ testMethod.$.status }} | {{ testClass.$.name }} | {{ testMethod.$.signature }} | {{ testMethod.$.description }} |
+{%-      endfor %}
+{%-    endfor %}
+{%-  endfor %}
+{% endfor %}
diff --git a/test/mock/testng-report-multiple.xml b/test/mock/testng-report-multiple.xml
@@ -0,0 +1,71 @@
+<testng-results>
+  <suite name="Suite1">
+    <groups>
+      <group name="group1">
+        <method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
+        <method signature="com.test.TestOne.test1()" name="test1" class="com.test.TestOne"/>
+      </group>
+      <group name="group2">
+        <method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
+      </group>
+    </groups>
+    <test name="test1">
+      <class name="com.test.TestOne">
+        <test-method status="FAIL" signature="test1()" name="test1" duration-ms="0"
+              started-at="2007-05-28T12:14:37Z" description="someDescription2"
+              finished-at="2007-05-28T12:14:37Z">
+          <exception class="java.lang.AssertionError">
+            <short-stacktrace>
+              <![CDATA[
+                java.lang.AssertionError
+                ... Removed 22 stack frames
+              ]]>
+            </short-stacktrace>
+          </exception>
+        </test-method>
+        <test-method status="PASS" signature="test2()" name="test2" duration-ms="0"
+              started-at="2007-05-28T12:14:37Z" description="someDescription1"
+              finished-at="2007-05-28T12:14:37Z">
+        </test-method>
+        <test-method status="PASS" signature="setUp()" name="setUp" is-config="true" duration-ms="15"
+              started-at="2007-05-28T12:14:37Z" finished-at="2007-05-28T12:14:37Z">
+        </test-method>
+      </class>
+    </test>
+  </suite>
+
+  <suite name="Suite2">
+    <groups>
+      <group name="group1">
+        <method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
+        <method signature="com.test.TestOne.test1()" name="test1" class="com.test.TestOne"/>
+      </group>
+      <group name="group2">
+        <method signature="com.test.TestOne.test2()" name="test2" class="com.test.TestOne"/>
+      </group>
+    </groups>
+    <test name="test1">
+      <class name="com.test.TestOne">
+        <test-method status="FAIL" signature="s2_test1()" name="test1" duration-ms="0"
+              started-at="2007-05-28T12:14:37Z" description="someDescription2"
+              finished-at="2007-05-28T12:14:37Z">
+          <exception class="java.lang.AssertionError">
+            <short-stacktrace>
+              <![CDATA[
+                java.lang.AssertionError
+                ... Removed 22 stack frames
+              ]]>
+            </short-stacktrace>
+          </exception>
+        </test-method>
+        <test-method status="SKIP" signature="s2_test2()" name="test2" duration-ms="0"
+              started-at="2007-05-28T12:14:37Z" description="someDescription1"
+              finished-at="2007-05-28T12:14:37Z">
+        </test-method>
+        <test-method status="SKIP" signature="setUp()" name="setUp" is-config="true" duration-ms="15"
+              started-at="2007-05-28T12:14:37Z" finished-at="2007-05-28T12:14:37Z">
+        </test-method>
+      </class>
+    </test>
+  </suite>
+</testng-results>
diff --git a/test/template.spec.ts b/test/template.spec.ts
@@ -46,6 +46,26 @@ describe("Templating", () => {
     expect(markdown).to.be.not.undefined;
     expect(markdown).to.include("someDescription2");
     expect(markdown).to.include("test1()");
-    expect(markdown).to.include("Failed tests");
+    expect(markdown).to.include("test2()");
+    expect(markdown).to.include("setUp()");
+  });
+
+  it(`should be able to process multiple test-suites`, async () => {
+    const data = await xml2js.parseStringPromise(fs.readFileSync("./test/mock/testng-report-multiple.xml"));
+    const result = (statusEmitter as any).processEvent(
+      data
+    );
+
+    const templateData: TestNg.ReportTemplate = {
+      event: data,
+      annotations: result
+    };
+
+    const markdown = uut.template(Templates.REPORT, templateData);
+
+    expect(markdown).to.be.not.undefined;
+    expect(markdown).to.include("s2_test1()");
+    expect(markdown).to.include("s2_test2()");
+    expect(markdown).to.include("Suite2");
   });
 });