luke
/
sbt
mirror of https://github.com/sbt/sbt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6830 from kpodsiad/feat/scala-test-classes-framework 

feat: add optional framework field to the bsp
This commit is contained in:
Adrien Piquerez 2022-03-16 08:56:10 +01:00 committed by GitHub
parent c7f2c046b6 ce978a19ed
commit f0552e4bc3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 62 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
main/src/main/scala/sbt/Keys.scala
View File

@ -419,7 +419,7 @@ object Keys {
val bspBuildTargetScalacOptions = inputKey[Unit]("").withRank(DTask)
val bspBuildTargetScalacOptionsItem = taskKey[ScalacOptionsItem]("").withRank(DTask)
val bspScalaTestClasses = inputKey[Unit]("Corresponds to buildTarget/scalaTestClasses request").withRank(DTask)
val bspScalaTestClassesItem = taskKey[ScalaTestClassesItem]("").withRank(DTask)
val bspScalaTestClassesItem = taskKey[Seq[ScalaTestClassesItem]]("").withRank(DTask)
val bspScalaMainClasses = inputKey[Unit]("Corresponds to buildTarget/scalaMainClasses request").withRank(DTask)
val bspScalaMainClassesItem = taskKey[ScalaMainClassesItem]("").withRank(DTask)
val bspReporter = taskKey[BuildServerReporter]("").withRank(DTask)

31
main/src/main/scala/sbt/internal/server/BuildServerProtocol.scala
View File

@ -39,6 +39,7 @@ import scala.collection.mutable
import scala.util.control.NonFatal
import scala.util.{ Failure, Success, Try }
import scala.annotation.nowarn
import sbt.testing.Framework
object BuildServerProtocol {
import sbt.internal.bsp.codec.JsonProtocol._
@ -242,7 +243,7 @@ object BuildServerProtocol {
val filter = ScopeFilter.in(workspace.scopes.values.toList)
Def.task {
val items = bspScalaTestClassesItem.result.all(filter).value
val successfulItems = anyOrThrow(items)
val successfulItems = anyOrThrow(items).flatten.toVector
val result = ScalaTestClassesResult(successfulItems.toVector, None)
s.respondEvent(result)
}
@ -840,15 +841,25 @@ object BuildServerProtocol {
}
}
private def scalaTestClassesTask: Initialize[Task[ScalaTestClassesItem]] = Def.task {
val testClasses = Keys.definedTests.?.value
.getOrElse(Seq.empty)
.map(_.name)
.toVector
ScalaTestClassesItem(
bspTargetIdentifier.value,
testClasses
)
private def scalaTestClassesTask: Initialize[Task[Seq[ScalaTestClassesItem]]] = Def.task {
Keys.definedTests.?.value match {
case None => Vector.empty
case Some(definitions) =>
val frameworks: Seq[Framework] = Keys.loadedTestFrameworks.?.value
.map(_.values.toSeq)
.getOrElse(Seq.empty)
val grouped = TestFramework.testMap(frameworks, definitions)
grouped.map {
case (framework, definitions) =>
ScalaTestClassesItem(
bspTargetIdentifier.value,
definitions.map(_.name).toVector,
framework.name()
)
}.toSeq
}
}
private def scalaMainClassesTask: Initialize[Task[ScalaMainClassesItem]] = Def.task {

14
project/Dependencies.scala
View File

@ -69,13 +69,13 @@ object Dependencies {
def addSbtLmIvy = addSbtModule(sbtLmPath, "lmIvy", libraryManagementIvy)
def addSbtLmIvyTest = addSbtModule(sbtLmPath, "lmIvy", libraryManagementIvy, Some(Test))
def addSbtCompilerInterface = addSbtModule(sbtZincPath, "compilerInterfaceJVM", compilerInterface)
def addSbtCompilerClasspath = addSbtModule(sbtZincPath, "zincClasspathJVM2_12", compilerClasspath)
def addSbtCompilerApiInfo = addSbtModule(sbtZincPath, "zincApiInfoJVM2_12", compilerApiInfo)
def addSbtCompilerBridge = addSbtModule(sbtZincPath, "compilerBridgeJVM2_12", compilerBridge)
def addSbtZinc = addSbtModule(sbtZincPath, "zincJVM2_12", zinc)
def addSbtZincCompile = addSbtModule(sbtZincPath, "zincCompileJVM2_12", zincCompile)
def addSbtZincCompileCore = addSbtModule(sbtZincPath, "zincCompileCoreJVM2_12", zincCompileCore)
def addSbtCompilerInterface = addSbtModule(sbtZincPath, "compilerInterface", compilerInterface)
def addSbtCompilerClasspath = addSbtModule(sbtZincPath, "zincClasspath", compilerClasspath)
def addSbtCompilerApiInfo = addSbtModule(sbtZincPath, "zincApiInfo", compilerApiInfo)
def addSbtCompilerBridge = addSbtModule(sbtZincPath, "compilerBridge2_12", compilerBridge)
def addSbtZinc = addSbtModule(sbtZincPath, "zinc", zinc)
def addSbtZincCompile = addSbtModule(sbtZincPath, "zincCompile", zincCompile)
def addSbtZincCompileCore = addSbtModule(sbtZincPath, "zincCompileCore", zincCompileCore)
val lmCoursierShaded = "io.get-coursier" %% "lm-coursier-shaded" % "2.0.10"

4
project/plugins.sbt
View File

@ -6,9 +6,9 @@ addSbtPlugin("com.dwijnand" % "sbt-dynver" % "4.0.0")
addSbtPlugin("com.github.sbt" % "sbt-pgp" % "2.1.2")
addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.3.0")
addSbtPlugin("org.scala-sbt" % "sbt-contraband" % "0.5.1")
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "3.0.2")
addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.6.5")
addSbtPlugin("com.lightbend" % "sbt-whitesource" % "0.1.14")
addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.9")
addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "1.2.0")
addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.8.1")
addSbtPlugin("com.swoval" % "sbt-java-format" % "0.3.1")
addDependencyTreePlugin

23
protocol/src/main/contraband-scala/sbt/internal/bsp/ScalaTestClassesItem.scala generated
View File

@ -7,25 +7,27 @@ package sbt.internal.bsp
/**
* @param target The build target that contains the test classes.
* @param classes The fully qualified names of the test classes in this target
* @param framework The name of the test framework used in test classes.
*/
final class ScalaTestClassesItem private (
val target: sbt.internal.bsp.BuildTargetIdentifier,
val classes: Vector[String]) extends Serializable {
val classes: Vector[String],
val framework: Option[String]) extends Serializable {
override def equals(o: Any): Boolean = this.eq(o.asInstanceOf[AnyRef]) || (o match {
case x: ScalaTestClassesItem => (this.target == x.target) && (this.classes == x.classes)
case x: ScalaTestClassesItem => (this.target == x.target) && (this.classes == x.classes) && (this.framework == x.framework)
case _ => false
})
override def hashCode: Int = {
37 * (37 * (37 * (17 + "sbt.internal.bsp.ScalaTestClassesItem".##) + target.##) + classes.##)
37 * (37 * (37 * (37 * (17 + "sbt.internal.bsp.ScalaTestClassesItem".##) + target.##) + classes.##) + framework.##)
}
override def toString: String = {
"ScalaTestClassesItem(" + target + ", " + classes + ")"
"ScalaTestClassesItem(" + target + ", " + classes + ", " + framework + ")"
}
private[this] def copy(target: sbt.internal.bsp.BuildTargetIdentifier = target, classes: Vector[String] = classes): ScalaTestClassesItem = {
new ScalaTestClassesItem(target, classes)
private[this] def copy(target: sbt.internal.bsp.BuildTargetIdentifier = target, classes: Vector[String] = classes, framework: Option[String] = framework): ScalaTestClassesItem = {
new ScalaTestClassesItem(target, classes, framework)
}
def withTarget(target: sbt.internal.bsp.BuildTargetIdentifier): ScalaTestClassesItem = {
copy(target = target)
@ -33,8 +35,15 @@ final class ScalaTestClassesItem private (
def withClasses(classes: Vector[String]): ScalaTestClassesItem = {
copy(classes = classes)
}
def withFramework(framework: Option[String]): ScalaTestClassesItem = {
copy(framework = framework)
}
def withFramework(framework: String): ScalaTestClassesItem = {
copy(framework = Option(framework))
}
}
object ScalaTestClassesItem {
def apply(target: sbt.internal.bsp.BuildTargetIdentifier, classes: Vector[String]): ScalaTestClassesItem = new ScalaTestClassesItem(target, classes)
def apply(target: sbt.internal.bsp.BuildTargetIdentifier, classes: Vector[String], framework: Option[String]): ScalaTestClassesItem = new ScalaTestClassesItem(target, classes, framework)
def apply(target: sbt.internal.bsp.BuildTargetIdentifier, classes: Vector[String], framework: String): ScalaTestClassesItem = new ScalaTestClassesItem(target, classes, Option(framework))
}

4
protocol/src/main/contraband-scala/sbt/internal/bsp/codec/ScalaTestClassesItemFormats.scala generated
View File

@ -13,8 +13,9 @@ implicit lazy val ScalaTestClassesItemFormat: JsonFormat[sbt.internal.bsp.ScalaT
unbuilder.beginObject(__js)
val target = unbuilder.readField[sbt.internal.bsp.BuildTargetIdentifier]("target")
val classes = unbuilder.readField[Vector[String]]("classes")
val framework = unbuilder.readField[Option[String]]("framework")
unbuilder.endObject()
sbt.internal.bsp.ScalaTestClassesItem(target, classes)
sbt.internal.bsp.ScalaTestClassesItem(target, classes, framework)
case None =>
deserializationError("Expected JsObject but found None")
}
@ -23,6 +24,7 @@ implicit lazy val ScalaTestClassesItemFormat: JsonFormat[sbt.internal.bsp.ScalaT
builder.beginObject()
builder.addField("target", obj.target)
builder.addField("classes", obj.classes)
builder.addField("framework", obj.framework)
builder.endObject()
}
}

3
protocol/src/main/contraband/bsp.contra
View File

@ -636,6 +636,9 @@ type ScalaTestClassesItem {
## The fully qualified names of the test classes in this target
classes: [String]
## The name of the test framework used in test classes.
framework: String
}
## Scala Main Class Request

3
server-test/src/test/scala/testpkg/BuildServerTest.scala
View File

@ -308,7 +308,8 @@ object BuildServerTest extends AbstractServerTest {
assert(svr.waitForString(10.seconds) { s =>
(s contains """"id":"72"""") &&
(s contains """"tests.FailingTest"""") &&
(s contains """"tests.PassingTest"""")
(s contains """"tests.PassingTest"""") &&
(s contains """"framework":"ScalaTest"""")
})
}

9
testing/src/main/scala/sbt/TestFramework.scala
View File

@ -231,21 +231,26 @@ object TestFramework {
): Vector[(String, TestFunction)] =
for (d <- inputs; act <- mapped.get(d.name)) yield (d.name, act)
private[this] def testMap(
def testMap(
frameworks: Seq[Framework],
tests: Seq[TestDefinition]
): Map[Framework, Set[TestDefinition]] = {
import scala.collection.mutable.{ HashMap, HashSet, Set }
val map = new HashMap[Framework, Set[TestDefinition]]
def assignTest(test: TestDefinition): Unit = {
def isTestForFramework(framework: Framework) = getFingerprints(framework).exists { t =>
matches(t, test.fingerprint)
}
for (framework <- frameworks.find(isTestForFramework))
frameworks.find(isTestForFramework).foreach { framework =>
map.getOrElseUpdate(framework, new HashSet[TestDefinition]) += test
}
}
if (frameworks.nonEmpty)
for (test <- tests) assignTest(test)
map.toMap.mapValues(_.toSet).toMap
}