✨ feat: support Junit 6 (sbt#194)

Co-authored-by: eugene yokota <[email protected]>

Author: gaeljw

.github/workflows/ci.yml

@@ -24,11 +24,8 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         scala: [2.12.20]
-        java: [zulu@8, temurin@17]
+        java: [temurin@17]
         exclude:
-          - scala: 2.12.20
-            java: zulu@8
-            os: macos-latest
           - scala: 2.12.20
             java: temurin@17
             os: windows-latest
@@ -52,14 +49,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Java (zulu@8)
-        if: matrix.java == 'zulu@8'
-        uses: actions/setup-java@v5
-        with:
-          distribution: zulu
-          java-version: 8
-          cache: sbt
-
       - name: Setup Java (temurin@17)
         if: matrix.java == 'temurin@17'
         uses: actions/setup-java@v5
@@ -100,7 +89,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         scala: [2.12.20]
-        java: [zulu@8]
+        java: [temurin@17]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Ignore line ending differences in git
@@ -120,14 +109,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Setup Java (zulu@8)
-        if: matrix.java == 'zulu@8'
-        uses: actions/setup-java@v5
-        with:
-          distribution: zulu
-          java-version: 8
-          cache: sbt
-
       - name: Setup Java (temurin@17)
         if: matrix.java == 'temurin@17'
         uses: actions/setup-java@v5

README.md

@@ -40,24 +40,25 @@ ThisBuild / libraryDependencies += "com.github.sbt.junit" % "jupiter-interface"
 
 ## Releases
 
- sbt Plugin      | JUnit Platform | JUnit Engine
-:----------------|:---------------|:-------------
- 0.16.x          | 1.14.x         | 5.14.x
- 0.15.x          | 1.13.x         | 5.13.x
- 0.14.x          | 1.12.x         | 5.12.x
- 0.13.x          | 1.11.x         | 5.11.x
- 0.12.x          | 1.10.x         | 5.10.x
- 0.11.x          | 1.9.x          | 5.9.x
- 0.10.x          | 1.8.x          | 5.8.x
- 0.9.x           | 1.7.x          | 5.7.x
- 0.8.x           | 1.1.x          | 5.1.x
- 0.7.x           | 1.1.0          | 5.1.0
- 0.6.x           | 1.0.0          | 5.0.0
- 0.5.x           | 1.0.0          | 5.0.0
- 0.4.x           | 1.0.0-RC2      | 5.0.0-RC2
- 0.3.x           | 1.0.0-M6       | 5.0.0-M6
- 0.2.x           | 1.0.0-M5       | 5.0.0-M5
- 0.1.x           | 1.0.0-M4       | 5.0.0-M4
+sbt Plugin | JUnit Platform | JUnit Engine | Minimum Java version |
+:-----------|:---------------|:-------------|:---------------------|
+ 0.17.x     | 6.0.x          | 6.0.x        | 17+                  |
+ 0.16.x     | 1.14.x         | 5.14.x       | 8+                   |
+ 0.15.x     | 1.13.x         | 5.13.x       | 8+                   |
+ 0.14.x     | 1.12.x         | 5.12.x       | 8+                   |
+ 0.13.x     | 1.11.x         | 5.11.x       | 8+                   |
+ 0.12.x     | 1.10.x         | 5.10.x       | 8+                   |
+ 0.11.x     | 1.9.x          | 5.9.x        | 8+                   |
+ 0.10.x     | 1.8.x          | 5.8.x        | 8+                   |
+ 0.9.x      | 1.7.x          | 5.7.x        | 8+                   |
+ 0.8.x      | 1.1.x          | 5.1.x        | 8+                   |
+ 0.7.x      | 1.1.0          | 5.1.0        | 8+                   |
+ 0.6.x      | 1.0.0          | 5.0.0        | 8+                   |
+ 0.5.x      | 1.0.0          | 5.0.0        | 8+                   |
+ 0.4.x      | 1.0.0-RC2      | 5.0.0-RC2    | 8+                   |
+ 0.3.x      | 1.0.0-M6       | 5.0.0-M6     | 8+                   |
+ 0.2.x      | 1.0.0-M5       | 5.0.0-M5     | 8+                   |
+ 0.1.x      | 1.0.0-M4       | 5.0.0-M4     | 8+                   |
 
 **Note** `0.9.0`+ artifacts are published on Maven Central via Sonatype OSS. Previous versions were available via <https://repo.scala-sbt.org/scalasbt/sbt-plugin-releases/net.aichler/sbt-jupiter-interface/scala_2.10/sbt_0.13/>, whose underlying host has migrated from Bintray to Scala Center Artifactory instance.
 

build.sbt

@@ -24,9 +24,9 @@ ThisBuild / scalaVersion := "2.12.20"
 
 lazy val commonSettings: Seq[Setting[_]] = Def.settings(
   Compile / javacOptions ++= Seq(
-    "-encoding", "UTF-8", "-Xlint:all", "-Xlint:-processing", "-source", "1.8", "-target", "1.8"
+    "-encoding", "UTF-8", "-Xlint:all", "-Xlint:-processing", "-source", "17", "-target", "17"
   ),
-  Compile / doc / javacOptions := Seq("-encoding", "UTF-8", "-source", "1.8"),
+  Compile / doc / javacOptions := Seq("-encoding", "UTF-8", "-source", "17"),
 )
 
 lazy val library = (project in file("src/library"))
@@ -93,8 +93,8 @@ lazy val plugin = (project in file("src/plugin"))
     scriptedBufferLog := false,
     scriptedLaunchOpts ++= Seq(
       s"-Dproject.version=${version.value}",
-      s"-Djunit.jupiter.version=${junitJupiterVer}",
-      s"-Djunit.platform.version=${junitPlatformVer}"
+      s"-Djunit.jupiter.version=${junitVersion}",
+      s"-Djunit.platform.version=${junitVersion}"
     ),
     scriptedDependencies := {
       val () = publishLocal.value
@@ -123,9 +123,9 @@ def generateVersionFile = Def.task {
   val version = (library / Keys.version).value
   val file = (Compile / resourceManaged).value / "jupiter-interface.properties"
   val content = s"version=$version\n" +
-    s"junit.platform.version=${junitPlatformVer}\n" +
-    s"junit.jupiter.version=${junitJupiterVer}\n" +
-    s"junit.vintage.version=${junitVintageVer}\n"
+    s"junit.platform.version=${junitVersion}\n" +
+    s"junit.jupiter.version=${junitVersion}\n" +
+    s"junit.vintage.version=${junitVersion}\n"
   IO.write(file, content)
   Seq(file)
 }
@@ -142,11 +142,10 @@ ThisBuild / scmInfo := Some(
   )
 )
 ThisBuild / githubWorkflowOSes := Seq("ubuntu-latest", "macos-latest", "windows-latest")
-ThisBuild / githubWorkflowJavaVersions := List(JavaSpec.zulu("8"), JavaSpec.temurin("17"))
+ThisBuild / githubWorkflowJavaVersions := List(JavaSpec.temurin("17"))
 ThisBuild / githubWorkflowBuildMatrixExclusions ++= {
   val sv = (ThisBuild / scalaVersion).value
   List(
-    MatrixExclude(Map("scala" -> sv, "java" -> "zulu@8", "os" -> "macos-latest")),
     MatrixExclude(Map("scala" -> sv, "java" -> "temurin@17", "os" -> "windows-latest")),
   )
 }

project/Dependencies.scala

@@ -1,19 +1,15 @@
 import sbt.*
 
 object Dependencies {
-  val junitJupiterVer = "5.14.0"
-  // based on https://github.com/junit-team/junit5/releases/tag/r5.10.3 etc
-  // The platform version seems to be "1." of the corresponding JUnit 5.x version.
-  def junitPlatformVer = junitJupiterVer.replaceFirst("""^5\.""", "1.")
-  def junitVintageVer = junitJupiterVer
+  val junitVersion = "6.0.0"
   val testInterfaceVer = "1.0"
 
-  val junitPlatformLauncher = "org.junit.platform" % "junit-platform-launcher" % junitPlatformVer
-  val junitJupiterEngine = "org.junit.jupiter" % "junit-jupiter-engine" % junitJupiterVer
+  val junitPlatformLauncher = "org.junit.platform" % "junit-platform-launcher" % junitVersion
+  val junitJupiterEngine = "org.junit.jupiter" % "junit-jupiter-engine" % junitVersion
   val testInterface = "org.scala-sbt" % "test-interface" % testInterfaceVer
-  val junitJupiterParams = "org.junit.jupiter" % "junit-jupiter-params" % junitJupiterVer
-  val junitVintageEngine = "org.junit.vintage" % "junit-vintage-engine" % junitVintageVer
-  val junitPlatformSuite = "org.junit.platform" % "junit-platform-suite" % junitPlatformVer
+  val junitJupiterParams = "org.junit.jupiter" % "junit-jupiter-params" % junitVersion
+  val junitVintageEngine = "org.junit.vintage" % "junit-vintage-engine" % junitVersion
+  val junitPlatformSuite = "org.junit.platform" % "junit-platform-suite" % junitVersion
   val hamcrestLibrary = "org.hamcrest" % "hamcrest-library" % "3.0"
   val mockitoCore = "org.mockito" % "mockito-core" % "4.11.0"
   val junit4Interface = "com.github.sbt" % "junit-interface" % "0.13.3"

src/plugin/src/sbt-test/basic/suite-demo/build.sbt

@@ -1,13 +1,11 @@
 val junit             = Def.setting { "org.junit.jupiter"  % "junit-jupiter-api"           % JupiterKeys.junitJupiterVersion.value }
 val junitEngine       = Def.setting { "org.junit.jupiter"  % "junit-jupiter-engine"        % JupiterKeys.junitJupiterVersion.value }
-val junitRunner       = Def.setting { "org.junit.platform" % "junit-platform-runner"       % JupiterKeys.junitPlatformVersion.value }
 val junitSuiteEngine  = Def.setting { "org.junit.platform" % "junit-platform-suite-engine" % JupiterKeys.junitPlatformVersion.value }
 
 name := "test-project"
 libraryDependencies ++= Seq(
   junit.value % Test,
   junitEngine.value % Test,
-  junitRunner.value % Test,
   junitSuiteEngine.value % Test,
   "com.github.sbt.junit" % "jupiter-interface" % JupiterKeys.jupiterVersion.value % Test,
 )

src/plugin/src/sbt-test/interop/works-with-junit-interface/build.sbt

@@ -20,7 +20,6 @@
 name := "test-project"
 libraryDependencies ++= Seq(
   "com.github.sbt.junit" % "jupiter-interface" % JupiterKeys.jupiterVersion.value % Test,
-  "org.junit.platform" % "junit-platform-runner" % JupiterKeys.junitPlatformVersion.value % Test,
   "com.github.sbt" % "junit-interface" % "0.13.3" % Test,
   "junit" % "junit" % "4.13.2" % Test,
 )
@@ -37,7 +36,6 @@ checkTestDefinitions := {
 
   val expected = Map(
     "interop.JUnit4Test" -> "com.novocode.junit",
-    "interop.JUnitVintageTest" -> "com.github.sbt.junit.jupiter",
     "interop.JUnitJupiterTest" -> "com.github.sbt.junit.jupiter"
   )
 
@@ -48,5 +46,5 @@ checkTestDefinitions := {
     assert(count == 1, s"Expected test <$testName> to have annotation <$annotationName>")
   }
 
-  assert(definitions.length == 3, "Found more than the 3 tests (" + definitions.length + ")!")
+  assert(definitions.length == 2, "Found more than the 2 tests (" + definitions.length + ")!")
 }

src/plugin/src/sbt-test/interop/works-with-junit-interface/src/test/java/interop/JUnitJupiterTest.java

@@ -1,7 +1,6 @@
 package interop;
 
 import org.junit.jupiter.api.Test;
-import org.junit.platform.runner.JUnitPlatform;
 
 class JUnitJupiterTest {