No test instrumentation with Scala 3.2.1, ZIO 2.0.4 and ZIO Test

[longliveenduro]

I do not see that ZIO specs are instrumented:

chris@neptun:~/prj/toil/zio-geolocation$ sbt clean coverage test coverageReport
[info] welcome to sbt 1.7.1 (Ubuntu Java 11.0.16)
[info] loading settings for project global-plugins from sbt-updates.sbt ...
[info] loading global plugins from /home/chris/.sbt/1.0/plugins
[info] loading settings for project zio-geolocation-build-build-build from metals.sbt ...
[info] loading project definition from /home/chris/prj/toil/zio-geolocation/project/project/project
[info] loading settings for project zio-geolocation-build-build from metals.sbt ...
[info] loading project definition from /home/chris/prj/toil/zio-geolocation/project/project
[success] Generated .bloop/zio-geolocation-build-build.json
[success] Total time: 0 s, completed Sep 6, 2022, 9:23:00 AM
[info] loading settings for project zio-geolocation-build from metals.sbt,plugins.sbt ...
[info] loading project definition from /home/chris/prj/toil/zio-geolocation/project
[success] Generated .bloop/zio-geolocation-build.json
[success] Total time: 1 s, completed Sep 6, 2022, 9:23:01 AM
[info] loading settings for project root from build.sbt,sbt.sbt ...
[info] set current project to zio-geolocation (in build file:/home/chris/prj/toil/zio-geolocation/)
[success] Total time: 0 s, completed Sep 6, 2022, 9:23:02 AM
[info] Defining ThisBuild / coverageEnabled
[info] The new value will be used by Compile / compile / scalacOptions, libraryDependencies
[info] Reapplying settings...
[info] set current project to zio-geolocation (in build file:/home/chris/prj/toil/zio-geolocation/)
[info] scalafmt: Formatting 7 Scala sources (/home/chris/prj/toil/zio-geolocation/modules/core)...
[info] scalafmt: Formatting 23 Scala sources (/home/chris/prj/toil/zio-geolocation/modules/core)...
[info] compiling 23 Scala sources to /home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/classes ...
[info] compiling 7 Scala sources to /home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/test-classes ...
+ CellFinderSpec
  + normalizeId
timestamp=2022-09-06T07:23:25.536582Z level=INFO thread=#zio-fiber-111 message="Position based on single cell with id <1>, GeoPosition(49.0,11.0)" location=com.tsystems.toil.geolocation.logic.lookup.PositionCalculator.positionForSingleCell file=PositionCalculator.scala line=24
    + LTE Cell Hint ids are not changed
    + GSM Cell Hint ids are not changed
    + WCDMA/UMTS Cell Hint ids are normalized
  + findCell
    + An unknown cell hint returns None
  + CellFinder.findCell on all tower fixtures
    + An known Lte cell hint (id: 25605889) with lac=None for a tower returns its position and strength
    + An known Gsm cell hint (id: 978) with lac=Some(5891) for a tower returns its position and strength
    + An known Umts cell hint (id: 48358) with lac=Some(6086) for a tower returns its position and strength
+ CellHint
  + REST request cell types are correctly translated to stored cell types
+ PositionCalculatorSpec
  + calculatePosition
    + List with one cell returns its position
    + Empty list of cells produces no position output
10 tests passed. 0 tests failed. 0 tests ignored.

Executed in 954 ms

[info] Completed tests
[success] Total time: 22 s, completed Sep 6, 2022, 9:23:25 AM
[info] Waiting for measurement data to sync...
[info] Waiting for measurement data to sync...
[info] Reading scoverage instrumentation [/home/chris/prj/toil/zio-geolocation/target/scala-3.2.0/scoverage-data/scoverage.coverage]
[warn] No coverage data, skipping reports
[info] Reading scoverage instrumentation [/home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/scoverage-data/scoverage.coverage]
[info] Reading scoverage measurements...
[info] Generating scoverage reports...
[info] Written Cobertura report [/home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/coverage-report/cobertura.xml]
[info] Written XML coverage report [/home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/scoverage-report/scoverage.xml]
[error] java.lang.RuntimeException: No source root found for '/home/chris/prj/toil/zio-geolocation/core/shared/src/main/scala-3/zio/ServiceTagVersionSpecific.scala' (source roots: '/home/chris/prj/toil/zio-geolocation/modules/core/src/main/scala/')
[error] 	at scoverage.reporter.BaseReportWriter.relativeSource(BaseReportWriter.scala:35)
[error] 	at scoverage.reporter.BaseReportWriter.relativeSource(BaseReportWriter.scala:23)
[error] 	at scoverage.reporter.ScoverageHtmlWriter.classRow(ScoverageHtmlWriter.scala:249)
[error] 	at scoverage.reporter.ScoverageHtmlWriter.$anonfun$classesTable$2(ScoverageHtmlWriter.scala:239)
[error] 	at scala.collection.immutable.List.map(List.scala:293)
[error] 	at scoverage.reporter.ScoverageHtmlWriter.classesTable(ScoverageHtmlWriter.scala:239)
[error] 	at scoverage.reporter.ScoverageHtmlWriter.overview(ScoverageHtmlWriter.scala:460)
[error] 	at scoverage.reporter.ScoverageHtmlWriter.write(ScoverageHtmlWriter.scala:65)
[error] 	at scoverage.ScoverageSbtPlugin$.writeReports(ScoverageSbtPlugin.scala:324)
[error] 	at scoverage.ScoverageSbtPlugin$.$anonfun$coverageReport0$1(ScoverageSbtPlugin.scala:220)
[error] 	at scoverage.ScoverageSbtPlugin$.$anonfun$coverageReport0$1$adapted(ScoverageSbtPlugin.scala:195)
[error] 	at scala.Function1.$anonfun$compose$1(Function1.scala:49)
[error] 	at sbt.internal.util.$tilde$greater.$anonfun$$u2219$1(TypeFunctions.scala:62)
[error] 	at sbt.std.Transform$$anon$4.work(Transform.scala:68)
[error] 	at sbt.Execute.$anonfun$submit$2(Execute.scala:282)
[error] 	at sbt.internal.util.ErrorHandling$.wideConvert(ErrorHandling.scala:23)
[error] 	at sbt.Execute.work(Execute.scala:291)
[error] 	at sbt.Execute.$anonfun$submit$1(Execute.scala:282)
[error] 	at sbt.ConcurrentRestrictions$$anon$4.$anonfun$submitValid$1(ConcurrentRestrictions.scala:265)
[error] 	at sbt.CompletionService$$anon$2.call(CompletionService.scala:64)
[error] 	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
[error] 	at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:515)
[error] 	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
[error] 	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
[error] 	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
[error] 	at java.base/java.lang.Thread.run(Thread.java:829)
[error] (core / coverageReport) No source root found for '/home/chris/prj/toil/zio-geolocation/core/shared/src/main/scala-3/zio/ServiceTagVersionSpecific.scala' (source roots: '/home/chris/prj/toil/zio-geolocation/modules/core/src/main/scala/')
[error] Total time: 2 s, completed Sep 6, 2022, 9:23:27 AM

ThisBuild / scalaVersion := "3.2.0"
[...]
testFrameworks       := Seq(new TestFramework("zio.test.sbt.ZTestFramework")),
[...]
addSbtPlugin("org.scoverage"             % "sbt-scoverage"             % "2.0.1")

[ckipp01]

Hey @longliveenduro do you still have this issue using the latest sbt-scoverage? If so could you provide a minimal project for me to reproduce this?

[longliveenduro]

Thanks @ckipp01 for coming back to this.
The problem still exists in 2.0.4, see this to reproduce it: https://github.com/longliveenduro/zio-geolocation-tapir-tapir-starter

sbt clean coverage test coverageReport produces:

chris@neptun:~/prj/zio-geolocation-tapir-tapir-starter$ sbt clean coverage test coverageReport
[info] welcome to sbt 1.7.1 (Private Build Java 17.0.4)
[info] loading settings for project global-plugins from sbt-updates.sbt ...
[info] loading global plugins from /home/chris/.sbt/1.0/plugins
[info] loading settings for project zio-geolocation-tapir-tapir-starter-build from plugins.sbt ...
[info] loading project definition from /home/chris/prj/zio-geolocation-tapir-tapir-starter/project
[info] loading settings for project rootProject from build.sbt ...
[info] set current project to zio-geolocation-tapir (in build file:/home/chris/prj/zio-geolocation-tapir-tapir-starter/)
[success] Total time: 0 s, completed Sep 28, 2022, 7:00:07 PM
[info] Defining ThisBuild / coverageEnabled
[info] The new value will be used by Compile / compile / scalacOptions, libraryDependencies
[info] Reapplying settings...
[info] set current project to zio-geolocation-tapir (in build file:/home/chris/prj/zio-geolocation-tapir-tapir-starter/)
[info] compiling 2 Scala sources to /home/chris/prj/zio-geolocation-tapir-tapir-starter/target/scala-3.2.0/classes ...
[info] compiling 1 Scala source to /home/chris/prj/zio-geolocation-tapir-tapir-starter/target/scala-3.2.0/test-classes ...
+ Endpoints spec
  + return hello message
  + list available books
2 tests passed. 0 tests failed. 0 tests ignored.

Executed in 784 ms

[info] Completed tests
[success] Total time: 10 s, completed Sep 28, 2022, 7:00:18 PM
[info] Waiting for measurement data to sync...
[info] Reading scoverage instrumentation [/home/chris/prj/zio-geolocation-tapir-tapir-starter/target/scala-3.2.0/scoverage-data/scoverage.coverage]
[info] Reading scoverage measurements...
[info] Generating scoverage reports...
[error] java.lang.RuntimeException: No source root found for '/home/chris/prj/zio-geolocation-tapir-tapir-starter/src/core/impl.scala' (source roots: '/home/chris/prj/zio-geolocation-tapir-tapir-starter/src/main/scala/')
[error] 	at scoverage.reporter.BaseReportWriter.relativeSource(BaseReportWriter.scala:35)
[error] 	at scoverage.reporter.BaseReportWriter.relativeSource(BaseReportWriter.scala:23)
[error] 	at scoverage.reporter.CoberturaXmlWriter.klass(CoberturaXmlWriter.scala:54)
[error] 	at scoverage.reporter.CoberturaXmlWriter.$anonfun$pack$1(CoberturaXmlWriter.scala:78)
[error] 	at scala.collection.TraversableLike.$anonfun$map$1(TraversableLike.scala:286)
[error] 	at scala.collection.immutable.List.foreach(List.scala:431)
[error] 	at scala.collection.TraversableLike.map(TraversableLike.scala:286)
[error] 	at scala.collection.TraversableLike.map$(TraversableLike.scala:279)
[error] 	at scala.collection.immutable.List.map(List.scala:305)
[error] 	at scoverage.reporter.CoberturaXmlWriter.pack(CoberturaXmlWriter.scala:78)
[error] 	at scoverage.reporter.CoberturaXmlWriter.$anonfun$xml$3(CoberturaXmlWriter.scala:106)
[error] 	at scala.collection.immutable.List.map(List.scala:293)
[error] 	at scoverage.reporter.CoberturaXmlWriter.xml(CoberturaXmlWriter.scala:106)
[error] 	at scoverage.reporter.CoberturaXmlWriter.write(CoberturaXmlWriter.scala:30)
[error] 	at scoverage.ScoverageSbtPlugin$.writeReports(ScoverageSbtPlugin.scala:296)
[error] 	at scoverage.ScoverageSbtPlugin$.$anonfun$coverageReport0$1(ScoverageSbtPlugin.scala:228)
[error] 	at scoverage.ScoverageSbtPlugin$.$anonfun$coverageReport0$1$adapted(ScoverageSbtPlugin.scala:203)
[error] 	at scala.Function1.$anonfun$compose$1(Function1.scala:49)
[error] 	at sbt.internal.util.$tilde$greater.$anonfun$$u2219$1(TypeFunctions.scala:62)
[error] 	at sbt.std.Transform$$anon$4.work(Transform.scala:68)
[error] 	at sbt.Execute.$anonfun$submit$2(Execute.scala:282)
[error] 	at sbt.internal.util.ErrorHandling$.wideConvert(ErrorHandling.scala:23)
[error] 	at sbt.Execute.work(Execute.scala:291)
[error] 	at sbt.Execute.$anonfun$submit$1(Execute.scala:282)
[error] 	at sbt.ConcurrentRestrictions$$anon$4.$anonfun$submitValid$1(ConcurrentRestrictions.scala:265)
[error] 	at sbt.CompletionService$$anon$2.call(CompletionService.scala:64)
[error] 	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
[error] 	at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:539)
[error] 	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
[error] 	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
[error] 	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
[error] 	at java.base/java.lang.Thread.run(Thread.java:833)
[error] (coverageReport) No source root found for '/home/chris/prj/zio-geolocation-tapir-tapir-starter/src/core/impl.scala' (source roots: '/home/chris/prj/zio-geolocation-tapir-tapir-starter/src/main/scala/')
[error] Total time: 1 s, completed Sep 28, 2022, 7:00:19 PM

[ckipp01]

Sorry it took so long to get back to this @longliveenduro . Looking closer I have a feeling that whatever is impacting scala/scala3#15791 is the same issue here. Looking through what's generated in the scoverage.coverage file I'm seeing stuff generated that shouldn't be. Here are a couple examples:

4
core/src/main/scala-3/sttp/tapir/internal/CodecValueClassMacro.scala
toil
Endpoints$
Object
toil.Endpoints$
$anonfun
877
902
26
<init>
Apply
false
0
false

This looks to be actually instrumenting some macro code inside of tapir. And then related to the error you're seeing:

11
src/core/impl.scala
toil
Endpoints$
Object
toil.Endpoints$
<init>
435
438
19
Map
Ident
false
0
false

This also shouldn't be implemented. Feel free to create a report for this inside of the Dotty repo as it will need to be fixed there. I'm not 100% sure it is the same as the one I listed so feel free to just create a new one and then leave it up to them to mark it as a duplicate or not.

[TheElectronWill]

I'm preparing a PR to dotty with coverage bugfixes, it will hopefully fix this issue :)

[TheElectronWill]

scala/scala3#16235 :)

[longliveenduro]

@TheElectronWill I upgraded to Scala 3.2.1 and sbt scoverage to 2.0.5 on https://github.com/longliveenduro/zio-geolocation-tapir-tapir-starter.

And still the same error occurs

[TheElectronWill]

Ah! I should add something on the sbt-coverage side then. Thanks for warning me :)

[longliveenduro]

Thank you very much for your effort. Just realized that sbt-scoverage 2.0.6 is already out. Updated my example to reproduce the problem.

[longliveenduro]

FYI: in our closed source code we have now this when using sbt coverage test:

[info] compiling 41 Scala sources to /home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/classes ...
[info] compiling 37 Scala sources to /home/chris/prj/toil/zio-geolocation/modules/core/target/scala-3.2.0/test-classes ...
[error] Uncaught exception when running tests: java.lang.VerifyError: Constructor must call super() or this() before return
[error] Exception Details:
[error]   Location:
[error]     com/tsystems/toil/geolocation/model/RefinedTypes$UtmZone$.<init>()V @0: return
[error]   Reason:
[error]     Error exists in the bytecode
[error]   Bytecode:
[error]     0000000: b1                                     
[error] sbt.ForkMain$ForkError: java.lang.VerifyError: Constructor must call super() or this() before return
[error] Exception Details:
[error]   Location:
[error]     com/tsystems/toil/geolocation/model/RefinedTypes$UtmZone$.<init>()V @0: return
[error]   Reason:
[error]     Error exists in the bytecode
[error]   Bytecode:
[error]     0000000: b1                                     
[error] 
[error] 	at com.tsystems.toil.geolocation.model.GeoPositionSpec$.<clinit>(GeoPositionSpec.scala:8)
[error] 	at java.base/jdk.internal.misc.Unsafe.ensureClassInitialized0(Native Method)

Works without sbt coverage (i.e. sbt test only)

There is only one change that caused this to occur now:

Before (test runs were working but still got coverage error from this thread):

package com.tsystems.toil.geolocation.model
import eu.timepit.refined.*
import eu.timepit.refined.api.{ RefType, Refined, RefinedTypeOps }
import eu.timepit.refined.auto.*
import eu.timepit.refined.numeric.*
import eu.timepit.refined.collection.*
import eu.timepit.refined.numeric.Interval.*
import eu.timepit.refined.string.MatchesRegex
import eu.timepit.refined.types.numeric.*
import scala.language.adhocExtensions

trait RefinedTypes:
  [...]

  type UtmZone = Int Refined Closed[1, 60]
  // provides an "unsafeFrom()" for UtmZone:
  object UtmZone extends RefinedTypeOps[UtmZone, Int]

object RefinedTypes extends RefinedTypes

After (test runs get the 'Error exists in the bytecode' from above):

package com.tsystems.toil.geolocation.model
import eu.timepit.refined.*
import eu.timepit.refined.api.{ RefType, Refined, RefinedTypeOps }
import eu.timepit.refined.auto.*
import eu.timepit.refined.numeric.*
import eu.timepit.refined.collection.*
import eu.timepit.refined.numeric.Interval.*
import eu.timepit.refined.string.MatchesRegex
import eu.timepit.refined.types.numeric.*
import scala.language.adhocExtensions

object RefinedTypes:
  [...]
  type UtmZone = Int Refined Closed[1, 60]
  // provides an "unsafeFrom()" for UtmZone:
  object UtmZone extends RefinedTypeOps[UtmZone, Int]

So just remove the trait "RefinedTypes" and using it as an object directly.