#23 Added synthetic checks

Author: sksamuel

src/main/scala/scoverage/plugin.scala

@@ -278,11 +278,18 @@ class ScoverageInstrumentationComponent(val global: Global)
       }
     }
 
+    private def isSynthetic(t: Tree): Boolean = Option(t.symbol).fold(false)(_.isSynthetic)
+    private def isNonSynthetic(t: Tree): Boolean = !isSynthetic(t)
+    private def containsNonSynthetic(t: Tree): Boolean = isNonSynthetic(t) || t.children.exists(containsNonSynthetic)
+
     def allConstArgs(args: List[Tree]) = args.forall(arg => arg.isInstanceOf[Literal] || arg.isInstanceOf[Ident])
 
     def process(tree: Tree): Tree = {
       tree match {
 
+        // ignore synthetic trees that contain non-syths. Probably macros. Either way breaks due to range validation
+        case t if isSynthetic(t) && containsNonSynthetic(t) => super.transform(t)
+
         /**
          * Object creation from new.
          * Ignoring creation calls to anon functions
@@ -349,6 +356,8 @@ class ScoverageInstrumentationComponent(val global: Global)
             c
           }
 
+        //case d : DefDef => d
+
         // this will catch methods defined as macros, eg def test = macro testImpl
         // it will not catch macro implemenations
         case d: DefDef if d.symbol != null && d.symbol.annotations.size > 0

src/test/scala/scoverage/PluginASTSupportTest.scala

@@ -75,23 +75,23 @@ class PluginASTSupportTest
                           |    }
                           |  }
                           |} """.stripMargin)
+    assert(!reporter.hasErrors)
     assert(!reporter.hasWarnings)
   }
 
-  //  test("scoverage supports skinny #23") {
-//    addToClassPath("org.joda", "joda-convert", "1.3.1")
-//    addToClassPath("joda-time", "joda-time", "2.3")
-//    addToClassPath("org.scalikejdbc", "scalikejdbc_2.10", "1.7.5")
-//    addToClassPath("org.scalikejdbc", "scalikejdbc-interpolation_2.10", "1.7.5")
-//    addToClassPath("org.scalikejdbc", "scalikejdbc-interpolation-core_2.10", "1.7.5")
-//    addToClassPath("org.scalikejdbc", "scalikejdbc-interpolation-macro_2.10", "1.7.5")
-//    addToClassPath("org.scalikejdbc", "scalikejdbc-config_2.10", "1.7.5")
-//    addToClassPath("org.skinny-framework", "skinny-common_2.10", "1.0.8")
-//    addToClassPath("org.skinny-framework", "skinny-framework_2.10", "1.0.8")
-//    addToClassPath("org.skinny-framework", "skinny-orm_2.10", "1.0.8")
-//    addToClassPath("org.slf4j", "slf4j-api", "1.7.7")
-//    compileSourceResources(getClass.getResource("/scoverage/skinny/Member.scala"))
-//    assert(!reporter.hasErrors)
-//  }
+  // https://github.com/skinny-framework/skinny-framework/issues/97
+  test("macro range positions should not break plugin") {
+    addToClassPath("org.slf4j", "slf4j-api", "1.7.7")
+    addToClassPath("com.typesafe.scala-logging", "scala-logging-api_" + shortScalaVersion, "2.1.2")
+    addToClassPath("com.typesafe.scala-logging", "scala-logging-slf4j_" + shortScalaVersion, "2.1.2")
+    compileCodeSnippet( """import com.typesafe.scalalogging.slf4j.StrictLogging
+                          |
+                          |object MacroTest extends StrictLogging {
+                          |  println("Hello")
+                          |  logger.info("will break")
+                          |} """.stripMargin)
+    assert(!reporter.hasErrors)
+    assert(!reporter.hasWarnings)
+  }
 }
 

src/test/scala/scoverage/PluginCoverageTest.scala

@@ -71,7 +71,7 @@ class PluginCoverageTest
     assertNMeasuredStatements(7)
   }
 
-  test("scoverage component should not instrument any macro code") {
+  test("scoverage should not instrument local macro implementation") {
     compileCodeSnippet( """
                           | object MyMacro {
                           | import scala.language.experimental.macros
@@ -85,6 +85,21 @@ class PluginCoverageTest
                           |  }
                           |} """.stripMargin)
     assert(!reporter.hasErrors)
-    assertNMeasuredStatements(0)
+    assertNoCoverage
+  }
+
+  // https://github.com/skinny-framework/skinny-framework/issues/97
+  test("scoverage should not instrument expanded macro code") {
+    addToClassPath("org.slf4j", "slf4j-api", "1.7.7")
+    addToClassPath("com.typesafe.scala-logging", "scala-logging-api_" + shortScalaVersion, "2.1.2")
+    addToClassPath("com.typesafe.scala-logging", "scala-logging-slf4j_" + shortScalaVersion, "2.1.2")
+    compileCodeSnippet( """import com.typesafe.scalalogging.slf4j.StrictLogging
+                          |
+                          |object MacroTest extends StrictLogging {
+                          |  logger.info("will break")
+                          |} """.stripMargin)
+    assert(!reporter.hasErrors)
+    assert(!reporter.hasWarnings)
+    assertNoCoverage
   }
 }

src/test/scala/scoverage/PluginRunner.scala

@@ -62,7 +62,7 @@ trait PluginSupport {
     if (file.exists) {
       println(s"Located ivy jar [$file]")
       file
-    } else throw new FileNotFoundException(s"Could not locate [$jarPath]. Tests require SBT 0.13+")
+    } else throw new FileNotFoundException(s"Could not locate [$jarPath].")
   }
 
   def sbtCompileDir: File = {
@@ -71,6 +71,8 @@ trait PluginSupport {
     else throw new FileNotFoundException(s"Could not locate SBT compile directory for plugin files [$dir]")
   }
 
+  def assertNoCoverage() = assert(!compiler.testStore.sources.mkString(" ").contains(s"scoverage.Invoker.invoked"))
+
   def assertNMeasuredStatements(n: Int): Unit = {
     for ( k <- 1 to n ) {
       assert(compiler.testStore.sources.mkString(" ").contains(s"scoverage.Invoker.invoked($k,"),