feat(mutant-view): show status reason in drawer (#1290)

stryker-mutator · Jul 31, 2021 · 0e6750d · 0e6750d
1 parent ea9a948
commit 0e6750d
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 29 deletions.
diff --git a/packages/elements/package-lock.json b/packages/elements/package-lock.json
diff --git a/packages/elements/src/components/drawer-mutant/drawer-mutant.component.ts b/packages/elements/src/components/drawer-mutant/drawer-mutant.component.ts
@@ -42,20 +42,20 @@ export class MutationTestReportDrawerMutant extends LitElement {
             ${this.mutant.killedByTests.length > 1 ? html`(and ${this.mutant.killedByTests.length - 1} more)` : undefined}</h6
           >`
         : undefined}
-      ${renderIf(
-        this.mutant?.static || this.mutant?.coveredByTests,
-        html`<h6 class="pe-4">
-          ${this.mutant?.static
-            ? html`🗿 Static mutant`
-            : renderIfPresent(
-                this.mutant?.coveredByTests,
-                (coveredTests) =>
-                  html`☂️ Covered by ${coveredTests.length} test${plural(coveredTests)}
-                  ${renderIf(this.mutant?.status === MutantStatus.Survived, '(yet still survived)')}`
-              )}
-        </h6>`
+      ${renderIf(this.mutant?.static, html`<h6 class="pe-4">🗿 Static mutant</h6>`)}
+      ${renderIfPresent(
+        this.mutant?.coveredByTests,
+        (coveredTests) =>
+          html`<h6 class="pe-4"
+            >☂️ Covered by ${coveredTests.length} test${plural(coveredTests)}
+            ${renderIf(this.mutant?.status === MutantStatus.Survived, '(yet still survived)')}</h6
+          >`
+      )}
+      ${renderIfPresent(
+        this.mutant?.statusReason,
+        (reason) => html`<h6 class="pe-4" title="Reason for the ${this.mutant!.status} status">🕵️ ${reason}</h6>`
       )}
-      ${renderIfPresent(this.mutant?.description, (description) => html`<h6>📖 ${description}</h6>`)}
+      ${renderIfPresent(this.mutant?.description, (description) => html`<h6 class="pe-4">📖 ${description}</h6>`)}
     </div>`;
   }
 

diff --git a/packages/elements/test/integration/drawer.it.spec.ts b/packages/elements/test/integration/drawer.it.spec.ts
@@ -43,6 +43,15 @@ describe('Drawer', () => {
         await actScreenshotMatch(this);
       });
 
+      it('should show the statusReason', async function () {
+        // Mutant 17 has a statusReason
+        await page.mutantView.mutant(17).toggleMutant();
+        await drawer.whenHalfOpen();
+        const summary = await drawer.summaryText();
+        expect(summary).contains('Survived despite covered by 3 tests');
+        await actScreenshotMatch(this);
+      });
+
       it('should close the drawer when deselecting the mutant', async () => {
         await mutant.toggleMutant();
         await drawer.whenClosed();

diff --git a/...mutant-view-when-a-mutant-is-opened-should-show-the-statusreason.linux.snap.png b/...mutant-view-when-a-mutant-is-opened-should-show-the-statusreason.linux.snap.png
diff --git a/...mutant-view-when-a-mutant-is-opened-should-show-the-statusreason.win32.snap.png b/...mutant-view-when-a-mutant-is-opened-should-show-the-statusreason.win32.snap.png
diff --git a/packages/elements/test/integration/po/Drawer.po.ts b/packages/elements/test/integration/po/Drawer.po.ts
@@ -42,6 +42,10 @@ export class Drawer extends PageObject {
     return this.header.getText();
   }
 
+  public summaryText() {
+    return this.$('[slot="summary"]').getText();
+  }
+
   public whenOpen() {
     return this.browser.wait(() => this.isOpen(), DEFAULT_TIMEOUT);
   }

diff --git a/...-dark-theme-when-opening-a-code-file-should-match-the-dark-theme.linux.snap.png b/...-dark-theme-when-opening-a-code-file-should-match-the-dark-theme.linux.snap.png
diff --git a/...ight-theme-when-opening-a-code-file-should-match-the-light-theme.linux.snap.png b/...ight-theme-when-opening-a-code-file-should-match-the-light-theme.linux.snap.png
diff --git a/packages/elements/test/unit/components/mutation-test-report-drawer-mutant.spec.ts b/packages/elements/test/unit/components/mutation-test-report-drawer-mutant.spec.ts
@@ -104,6 +104,15 @@ describe(MutationTestReportDrawerMutant.name, () => {
         expect(summary).contains('📖 Replaced "foo" with "bar"');
       });
 
+      it('should contain the status reason', async () => {
+        mutant.status = MutantStatus.Timeout;
+        mutant.statusReason = 'Hit limit reached (501 > 500)';
+        sut.element.mutant = mutant;
+        await sut.whenStable();
+        const summary = summaryText();
+        expect(summary).contains('🕵️ Hit limit reached (501 > 500)');
+      });
+
       function summaryText() {
         return sut.$('[slot="summary"]').innerText;
       }

diff --git a/packages/elements/testResources/test-files-example/mutation-report.json b/packages/elements/testResources/test-files-example/mutation-report.json
@@ -960,6 +960,7 @@
           "mutatorName": "ConditionalExpression",
           "replacement": "false",
           "status": "Survived",
+          "statusReason": "Survived despite covered by 3 tests",
           "testsCompleted": 3,
           "static": false,
           "coveredBy": ["1", "2", "3"]
@@ -979,7 +980,6 @@
           "mutatorName": "EqualityOperator",
           "replacement": "defaultValue !== undefined",
           "status": "Killed",
-          "description": "Killed by: deepMerge should deep merge overrides into the target object",
           "testsCompleted": 2,
           "static": false,
           "coveredBy": ["1", "2", "3"],