Don't mutate xml literals (#931)

stryker-mutator · Aug 11, 2021 · f30953b · f30953b
1 parent f3871c0
commit f30953b
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 1 deletion.
diff --git a/core/src/main/scala/stryker4s/extension/mutationtype/StringLiteral.scala b/core/src/main/scala/stryker4s/extension/mutationtype/StringLiteral.scala
@@ -6,7 +6,10 @@ case object EmptyString extends StringLiteral[Lit.String] {
   override val tree: Lit.String = Lit.String("")
 
   override def unapply(arg: Lit.String): Option[Lit.String] =
-    super.unapply(arg).filterNot(ParentIsInterpolatedString(_))
+    super
+      .unapply(arg)
+      .filterNot(ParentIsInterpolatedString(_))
+      .filterNot(IsXmlLiteral(_))
 }
 
 case object StrykerWasHereString extends StringLiteral[Lit.String] {
@@ -21,6 +24,7 @@ case object NonEmptyString extends NoInvalidPlacement[Lit.String] {
       .unapply(arg)
       .filter(_.value.nonEmpty)
       .filterNot(ParentIsInterpolatedString(_))
+      .filterNot(IsXmlLiteral(_))
 }
 
 /** Not a mutation, just an extractor for pattern matching on interpolated strings
@@ -41,3 +45,13 @@ private object ParentIsInterpolatedString {
       case _                         => false
     }
 }
+
+private object IsXmlLiteral {
+  def apply(arg: Lit.String): Boolean =
+    arg.parent match {
+      // Do not mutate XML literal strings
+      case Some(Term.Xml(parts, _)) if parts.contains(arg) => true
+      case Some(Pat.Xml(parts, _)) if parts.contains(arg)  => true
+      case _                                               => false
+    }
+}
diff --git a/core/src/test/scala/stryker4s/mutants/findmutants/MutantMatcherTest.scala b/core/src/test/scala/stryker4s/mutants/findmutants/MutantMatcherTest.scala
@@ -412,6 +412,47 @@ class MutantMatcherTest extends Stryker4sSuite {
         Lit.String("")
       )
     }
+
+    it("should not match xml literals") {
+      val tree = source"""class Foo {
+        def bar = ${Term.Xml(List(Lit.String("<foo>"), Lit.String("</foo>")), List(q"foo"))}
+      }"""
+
+      val result = tree collect sut.allMatchers
+
+      result should be(empty)
+    }
+
+    it("should not match empty strings on xml literals") {
+      val tree = source"""class Foo {
+        def bar = ${Term.Xml(List(Lit.String("<foo>"), Lit.String("")), List(q"foo"))}
+      }"""
+
+      val result = tree collect sut.allMatchers
+
+      result should be(empty)
+    }
+
+    it("should match inside xml literal args") {
+      val str = Lit.String("str")
+      val tree = source"""class Foo {
+        def bar = ${Term.Xml(List(Lit.String("<foo>"), Lit.String("</foo>")), List(str))}
+      }"""
+      expectMutations(
+        sut.matchStringLiteral,
+        tree,
+        str,
+        Lit.String("")
+      )
+    }
+
+    it("should not match xml interpolation") {
+      val tree = Pat.Xml(List(Lit.String("<foo></xml>")), List.empty)
+
+      val result = tree collect sut.allMatchers
+
+      result should be(empty)
+    }
   }
 
   describe("regexMutator") {