show coveredTests in report on click

hcoles · Aug 13, 2024 · 6c95a22 · 6c95a22
1 parent 25a8460
commit 6c95a22
Show file tree

Hide file tree

Showing 21 changed files with 106 additions and 76 deletions.
diff --git a/pitest-aggregator/src/main/java/org/pitest/aggregate/MutationResultDataLoader.java b/pitest-aggregator/src/main/java/org/pitest/aggregate/MutationResultDataLoader.java
@@ -57,7 +57,7 @@ private MutationResult xmlToResult(MutationXml xml) {
     return new MutationResult(new MutationDetails(id,
             xml.sourceFile, xml.description,
             xml.lineNumber, xml.blocks),
-            new MutationStatusTestPair(xml.numberOfTestsRun, DetectionStatus.valueOf(xml.status), Arrays.asList(killingTests), Arrays.asList(succeedingTests)));
+            new MutationStatusTestPair(xml.numberOfTestsRun, DetectionStatus.valueOf(xml.status), Arrays.asList(killingTests), Arrays.asList(succeedingTests), Arrays.asList(succeedingTests)));
   }
 
 }
diff --git a/pitest-entry/src/main/java/org/pitest/mutationtest/MutationResult.java b/pitest-entry/src/main/java/org/pitest/mutationtest/MutationResult.java
@@ -18,7 +18,6 @@
 import java.util.Objects;
 import java.util.Optional;
 import org.pitest.mutationtest.engine.MutationDetails;
-
 public final class MutationResult {
 
   private final MutationDetails        details;
@@ -30,6 +29,9 @@ public MutationResult(final MutationDetails md,
     this.status = status;
   }
 
+  public String getId() {
+    return this.details.getId().toString().replace(" ","-");
+  }
   public MutationDetails getDetails() {
     return this.details;
   }
@@ -46,6 +48,10 @@ public List<String> getSucceedingTests() {
     return this.status.getSucceedingTests();
   }
 
+  public List<String> getCoveringTests() {
+    return this.status.getCoveringTests();
+  }
+
   public DetectionStatus getStatus() {
     return this.status.getStatus();
   }

diff --git a/pitest-entry/src/main/java/org/pitest/mutationtest/MutationStatusMap.java b/pitest-entry/src/main/java/org/pitest/mutationtest/MutationStatusMap.java
@@ -14,17 +14,14 @@
  */
 package org.pitest.mutationtest;
 
-import static org.pitest.functional.prelude.Prelude.putToMap;
-import static org.pitest.mutationtest.DetectionStatus.SURVIVED;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
-import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Map.Entry;
+import java.util.Set;
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
@@ -44,27 +41,16 @@ public void setStatusForMutation(final MutationDetails mutation,
 
   public void setStatusForMutation(final MutationDetails mutation,
       final MutationStatusTestPair status) {
-    MutationStatusTestPair finalStatus = status;
-    if (status.getStatus().equals(SURVIVED)) {
-
-      List<TestInfo> testsInOrder = mutation.getTestsInOrder();
-      List<String> passingTests = new ArrayList<>();
-      for (TestInfo test : testsInOrder) {
-          passingTests.add(test.getName());
-      }
-      finalStatus = new MutationStatusTestPair(status.getNumberOfTestsRun(),
-              status.getStatus(),
-              status.getKillingTests(),
-              passingTests);
-
-    }
-    this.mutationMap.put(mutation, finalStatus);
+    this.mutationMap.put(mutation, status);
   }
 
-
   public void setStatusForMutations(
       final Collection<MutationDetails> mutations, final DetectionStatus status) {
-    mutations.forEach(putToMap(this.mutationMap, MutationStatusTestPair.notAnalysed(0, status)));
+      mutations.forEach(mutationDetails -> {
+        List<String> coveringTests = mutationDetails.getTestsInOrder().stream().map(TestInfo::getName).collect(Collectors.toList());
+        MutationStatusTestPair pair = MutationStatusTestPair.notAnalysed(0, status, coveringTests);
+        mutationMap.put(mutationDetails, pair);
+      });
   }
 
   public List<MutationResult> createMutationResults() {

diff --git a/pitest-entry/src/main/java/org/pitest/mutationtest/execute/Receive.java b/pitest-entry/src/main/java/org/pitest/mutationtest/execute/Receive.java
@@ -45,7 +45,7 @@ private void handleReport(final SafeDataInputStream is) {
     private void handleDescribe(final SafeDataInputStream is) {
         final MutationIdentifier mutation = is.read(MutationIdentifier.class);
         this.idMap.put(mutation, MutationStatusTestPair.notAnalysed(1,
-                DetectionStatus.STARTED));
+                DetectionStatus.STARTED,null));
     }
 
 }
diff --git a/pitest-entry/src/main/java/org/pitest/mutationtest/incremental/IncrementalAnalyser.java b/pitest-entry/src/main/java/org/pitest/mutationtest/incremental/IncrementalAnalyser.java
@@ -161,7 +161,8 @@ private MutationResult makeResult(final MutationDetails each,
       final List<String> succeedingTests) {
     updatePreanalysedTotal(status);
     return new MutationResult(each, new MutationStatusTestPair(0, status,
-        killingTests, succeedingTests));
+        killingTests, succeedingTests, each.getTestsInOrder().stream()
+            .map(TestInfo::getName).collect(Collectors.toList())));
   }
 
   private void updatePreanalysedTotal(final DetectionStatus status) {

diff --git a/pitest-entry/src/main/java/org/pitest/mutationtest/report/xml/XMLReportListener.java b/pitest-entry/src/main/java/org/pitest/mutationtest/report/xml/XMLReportListener.java
@@ -14,8 +14,23 @@
  */
 package org.pitest.mutationtest.report.xml;
 
+import java.io.IOException;
+import java.io.Writer;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+
+import org.apache.commons.text.StringEscapeUtils;
+import org.pitest.mutationtest.ClassMutationResults;
+import org.pitest.mutationtest.MutationResult;
+import org.pitest.mutationtest.MutationResultListener;
+import org.pitest.mutationtest.engine.MutationDetails;
+import org.pitest.util.ResultOutputStrategy;
+import org.pitest.util.Unchecked;
+
 import static org.pitest.mutationtest.report.xml.Tag.block;
 import static org.pitest.mutationtest.report.xml.Tag.blocks;
+import static org.pitest.mutationtest.report.xml.Tag.coveringTests;
 import static org.pitest.mutationtest.report.xml.Tag.description;
 import static org.pitest.mutationtest.report.xml.Tag.index;
 import static org.pitest.mutationtest.report.xml.Tag.indexes;
@@ -30,22 +45,8 @@
 import static org.pitest.mutationtest.report.xml.Tag.sourceFile;
 import static org.pitest.mutationtest.report.xml.Tag.succeedingTests;
 
-import java.io.IOException;
-import java.io.Writer;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Optional;
-
-import org.apache.commons.text.StringEscapeUtils;
-import org.pitest.mutationtest.ClassMutationResults;
-import org.pitest.mutationtest.MutationResult;
-import org.pitest.mutationtest.MutationResultListener;
-import org.pitest.mutationtest.engine.MutationDetails;
-import org.pitest.util.ResultOutputStrategy;
-import org.pitest.util.Unchecked;
-
 enum Tag {
-  mutation, sourceFile, mutatedClass, mutatedMethod, methodDescription, lineNumber, mutator, indexes, index, killingTest, killingTests, succeedingTests, description, blocks, block
+  mutation, sourceFile, mutatedClass, mutatedMethod, methodDescription, lineNumber, mutator, indexes, index, killingTest, killingTests, succeedingTests, coveringTests, description, blocks, block
 }
 
 public class XMLReportListener implements MutationResultListener {
@@ -101,6 +102,8 @@ private String makeMutationNode(final MutationResult mutation) {
             createTestDesc(mutation.getKillingTests()), killingTests)
         + makeNodeWhenConditionSatisfied(fullMutationMatrix,
             createTestDesc(mutation.getSucceedingTests()), succeedingTests)
+        + makeNodeWhenConditionSatisfied(fullMutationMatrix,
+            createTestDesc(mutation.getCoveringTests()), coveringTests)
         + makeNode(clean(details.getDescription()), description);
   }
 

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/MutationMetaDataTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/MutationMetaDataTest.java
@@ -59,7 +59,7 @@ private MutationResult makeResult(String clazz, String method) {
     final MutationDetails md = aMutationDetail().withId(
         aMutationId().withLocation(location)).build();
     return new MutationResult(md,
-        MutationStatusTestPair.notAnalysed(0, DetectionStatus.KILLED));
+        MutationStatusTestPair.notAnalysed(0, DetectionStatus.KILLED,Collections.emptyList()));
   }
 
 }
diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/MutationResultTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/MutationResultTest.java
@@ -20,6 +20,8 @@
 
 import nl.jqno.equalsverifier.EqualsVerifier;
 
+import java.util.Collections;
+
 public class MutationResultTest {
 
   private MutationResult testee;
@@ -34,14 +36,14 @@ public void shouldReturnNameOfKillingTestWhenKnown() {
   @Test
   public void shouldNoneWhenNoKillingTest() {
     this.testee = new MutationResult(null, MutationStatusTestPair.notAnalysed(1,
-        DetectionStatus.TIMED_OUT));
+        DetectionStatus.TIMED_OUT, Collections.emptyList()));
     assertEquals("none", this.testee.getKillingTestDescription());
   }
 
   @Test
   public void shouldReturnStatusDescription() {
     this.testee = new MutationResult(null, MutationStatusTestPair.notAnalysed(1,
-        DetectionStatus.TIMED_OUT));
+        DetectionStatus.TIMED_OUT,Collections.emptyList()));
     assertEquals("TIMED_OUT", this.testee.getStatusDescription());
   }
 

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/MutationStatusMapTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/MutationStatusMapTest.java
@@ -105,12 +105,13 @@ public void shouldCreateResultsForAllMutations() {
   @Test
   public void shouldCreateResultsForSurvivedMutations(){
     final MutationStatusTestPair statusPairOne = new MutationStatusTestPair(42,
-            DetectionStatus.SURVIVED, "foo");
+            DetectionStatus.SURVIVED, Collections.singletonList("foo"),Arrays.asList("foo1","bar"), Arrays.asList("foo","foo1","bar"));
     this.testee.setStatusForMutation(this.aSurvivedMutationDetails, statusPairOne);
 
     assertEquals(DetectionStatus.SURVIVED, this.testee.createMutationResults().get(0).getStatus());
     assertThat(this.testee.createMutationResults().get(0).getKillingTests()).contains("foo");
-    assertThat(this.testee.createMutationResults().get(0).getSucceedingTests()).contains("foo","bar");
+    assertThat(this.testee.createMutationResults().get(0).getSucceedingTests()).contains("foo1","bar");
+    assertThat(this.testee.createMutationResults().get(0).getCoveringTests()).contains("foo","foo1","bar");
 
   }
 

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/build/MutationTestUnitTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/build/MutationTestUnitTest.java
@@ -5,6 +5,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 
 import org.junit.Before;
@@ -63,7 +64,7 @@ public void shouldReportWhenMutationsNotCoveredByAnyTest() throws Exception {
     this.tests.add(ClassName.fromString("foo"));
     final MutationMetaData actual = this.testee.call();
     final MutationResult expected = new MutationResult(this.mutations.get(0),
-        MutationStatusTestPair.notAnalysed(0, DetectionStatus.NO_COVERAGE));
+        MutationStatusTestPair.notAnalysed(0, DetectionStatus.NO_COVERAGE, Collections.emptyList()));
     assertThat(actual.getMutations()).contains(expected);
   }
 

diff --git a/...entry/src/test/java/org/pitest/mutationtest/incremental/HistoryResultInterceptorTest.java b/...entry/src/test/java/org/pitest/mutationtest/incremental/HistoryResultInterceptorTest.java
@@ -13,6 +13,7 @@
 import org.pitest.mutationtest.report.MutationTestResultMother;
 
 import java.util.Collection;
+import java.util.Collections;
 
 import static java.util.Arrays.asList;
 import static org.assertj.core.api.Assertions.assertThat;
@@ -37,7 +38,7 @@ public void recordsMutationResults() {
     private MutationResult makeResult() {
         return new MutationResult(
                 MutationTestResultMother.createDetails(), MutationStatusTestPair.notAnalysed(0,
-                DetectionStatus.KILLED));
+                DetectionStatus.KILLED, Collections.emptyList()));
     }
 
 }
diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/incremental/IncrementalAnalyserTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/incremental/IncrementalAnalyserTest.java
@@ -306,6 +306,7 @@ public void assessMultipleMutationsAtATime() {
                             0,
                             KILLED,
                             singletonList(killingTest),
+                            emptyList(),
                             emptyList())));
 
     when(this.history.getPreviousResult(md2.getId()))
@@ -314,11 +315,12 @@ public void assessMultipleMutationsAtATime() {
                             0,
                             KILLED,
                             singletonList(killingTest),
+                            emptyList(),
                             emptyList())));
 
     when(this.history.getPreviousResult(md3.getId()))
             .thenReturn(Optional.of(
-                    new MutationStatusTestPair(0, SURVIVED, emptyList(), emptyList())));
+                    new MutationStatusTestPair(0, SURVIVED, emptyList(), emptyList(),emptyList())));
 
     when(this.history.getPreviousResult(md4.getId()))
             .thenReturn(Optional.empty());
@@ -414,7 +416,7 @@ private void setHistoryForAllMutationsTo(final DetectionStatus status,
       final String... test) {
     when(this.history.getPreviousResult(any(MutationIdentifier.class)))
     .thenReturn(Optional.of(
-            new MutationStatusTestPair(0, status, asList(test), emptyList())));
+            new MutationStatusTestPair(0, status, asList(test), emptyList(), emptyList())));
   }
 
   private static class LogCatcher extends Handler {

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/report/MutationTestResultMother.java b/pitest-entry/src/test/java/org/pitest/mutationtest/report/MutationTestResultMother.java
@@ -46,7 +46,7 @@ public interface MutationTestResultBuilder extends SequenceBuilder<MutationResul
   public static MutationTestResultBuilder aMutationTestResult() {
     return QB.builder(MutationTestResultBuilder.class, seed())
             .withMutationDetails(aMutationDetail())
-            .withStatusTestPair(MutationStatusTestPair.notAnalysed(0, DetectionStatus.SURVIVED));
+            .withStatusTestPair(MutationStatusTestPair.notAnalysed(0, DetectionStatus.SURVIVED, Collections.emptyList()));
   }
 
   private static Generator<MutationTestResultBuilder, MutationResult> seed() {

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/report/csv/CSVReportListenerTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/report/csv/CSVReportListenerTest.java
@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.io.Writer;
+import java.util.Collections;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -71,7 +72,7 @@ public void shouldQuoteKillingTestWhenNeeded() throws IOException {
   public void shouldOutputNoneWhenNoKillingTestFound() throws IOException {
     final MutationResult mr = new MutationResult(
         MutationTestResultMother.createDetails(), MutationStatusTestPair.notAnalysed(1,
-            DetectionStatus.SURVIVED));
+            DetectionStatus.SURVIVED, Collections.emptyList()));
     this.testee.handleMutationResult(MutationTestResultMother
         .createClassResults(mr));
     final String expected = "file,clazz,mutator,method,42,SURVIVED,none"

diff --git a/pitest-entry/src/test/java/org/pitest/mutationtest/report/xml/XMLReportListenerTest.java b/pitest-entry/src/test/java/org/pitest/mutationtest/report/xml/XMLReportListenerTest.java
@@ -25,6 +25,7 @@
 import java.io.StringWriter;
 import java.io.Writer;
 import java.util.Arrays;
+import java.util.List;
 
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 
@@ -64,12 +65,12 @@ public void shouldOutputFullMutationMatrixWhenEnabled() {
     this.testee = new XMLReportListener(this.out, true, false);
     final MutationResult mr = new MutationResult(
             MutationTestResultMother.createDetails(),
-            new MutationStatusTestPair(3, DetectionStatus.KILLED, Arrays.asList("foo", "foo2"), Arrays.asList("bar")));
+            new MutationStatusTestPair(3, DetectionStatus.KILLED, Arrays.asList("foo", "foo2"), Arrays.asList("bar"), Arrays.asList("foo","foo2","bar")));
     this.testee
         .handleMutationResult(MutationTestResultMother.createClassResults(mr));
     final String expected = "<mutation detected='true' status='KILLED' numberOfTestsRun='3'><sourceFile>file</sourceFile>" +
             "<mutatedClass>clazz</mutatedClass><mutatedMethod>method</mutatedMethod><methodDescription>()I</methodDescription><lineNumber>42</lineNumber><mutator>mutator</mutator>" +
-            "<indexes><index>1</index></indexes><blocks><block>0</block></blocks><killingTests>foo|foo2</killingTests><succeedingTests>bar</succeedingTests><description>desc</description></mutation>\n";
+            "<indexes><index>1</index></indexes><blocks><block>0</block></blocks><killingTests>foo|foo2</killingTests><succeedingTests>bar</succeedingTests><coveringTests>foo|foo2|bar</coveringTests><description>desc</description></mutation>\n";
     assertThat(expected).isEqualTo(this.out.toString());
   }
 
@@ -110,7 +111,7 @@ public void shouldOutputNoneWhenNoKillingTestFound() throws IOException {
   private MutationResult createSurvivingMutant() {
     return new MutationResult(
         MutationTestResultMother.createDetails(),
-        MutationStatusTestPair.notAnalysed(1, DetectionStatus.SURVIVED));
+        MutationStatusTestPair.notAnalysed(1, DetectionStatus.SURVIVED,Arrays.asList("foo","bar")));
   }
 
 }
diff --git a/pitest-html-report/src/main/resources/templates/mutation/mutation_report.st b/pitest-html-report/src/main/resources/templates/mutation/mutation_report.st
@@ -44,12 +44,14 @@ $sourceFile.groups:{ group |
 
 $group.mutations: { mutation | <p class='$mutation.status$'><span class='pop'>$i$.<span><b>$i$</b><br/><b>Location : </b>$mutation.details.location$<br/><b>Killed by : </b>$mutation.killingTestDescription$</span></span> $mutation.details.htmlSafeDescription$ &rarr; $mutation.statusDescription$</span>
 $if(mutation.survived)$
-<p>Covered by  tests: </p>
+<a title="Click to view covering tests" class="view-covered-by-tests" onClick="document.getElementById('$mutation.id$').style.display=(document.getElementById('$mutation.id$').style.display == 'block')?'none':'block';">Covering tests</a>
+<div class="covered-tests" id="$mutation.id$" style="display:none;">Covered by tests:
 <ul>
-$mutation.succeedingTests: { test | <li>$test$</li> }$
+$mutation.coveringTests: { test | <li>$test$</li> }$
 </ul>
+</div>
 $endif$
-</p> }$
+</div> }$
 </td>
 </tr>
 }$

diff --git a/pitest-html-report/src/main/resources/templates/mutation/style.css b/pitest-html-report/src/main/resources/templates/mutation/style.css
@@ -560,4 +560,15 @@ body{
 
 .width-100 {
     width: 100%;
+}
+
+.view-covered-by-tests{
+         cursor:pointer;
+         color:blue;
+         text-decoration:underline;
+}
+
+.view-covered-by-tests:hover{
+        text-decoration:none;
+         text-shadow: 1px 1px 1px #555;
 }
diff --git a/...t-html-report/src/test/java/org/pitest/mutationtest/report/html/ResultComparatorTest.java b/...t-html-report/src/test/java/org/pitest/mutationtest/report/html/ResultComparatorTest.java
@@ -3,6 +3,7 @@
 import static org.junit.Assert.assertEquals;
 
 import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 
 import org.junit.Test;
@@ -27,7 +28,7 @@ public void shouldSortInDesiredOrder() {
   }
 
   private MutationResult make(final DetectionStatus status) {
-    return new MutationResult(null, MutationStatusTestPair.notAnalysed(0, status));
+    return new MutationResult(null, MutationStatusTestPair.notAnalysed(0, status, Collections.emptyList()));
   }
 
 }