Merge branch 'cheeseng-mima-for-3.1' into 3.1.x

Author: bvenners

README.md

@@ -117,6 +117,30 @@ If you would like to export a particular private key into a separate GPG file, y
 
 With Sonatype credentials and GPG file in place, you can now publish to Sonatype.
 
+Before publishing any patch release, binary compatibility with previous version should be checked, using Java 6 (for Scala 2.10 and 2.11):
+
+    $ sbt ++2.11.11 scalactic/package scalactic/mimaReportBinaryIssues
+    $ sbt ++2.11.11 scalatest/package scalatest/mimaReportBinaryIssues
+    $ sbt ++2.11.11 scalacticJS/package scalacticJS/mimaReportBinaryIssues
+    $ sbt ++2.11.11 scalatestJS/package scalatestJS/mimaReportBinaryIssues
+
+    $ sbt ++2.10.6 scalactic/package scalactic/mimaReportBinaryIssues
+    $ sbt ++2.10.6 scalatest/package scalatest/mimaReportBinaryIssues
+    $ sbt ++2.10.6 scalacticJS/package scalacticJS/mimaReportBinaryIssues
+    $ sbt ++2.10.6 scalatestJS/package scalatestJS/mimaReportBinaryIssues
+
+and using Java 8 (for Scala 2.12 and 2.13): 
+
+    $ sbt ++2.12.4 scalactic/package scalactic/mimaReportBinaryIssues
+    $ sbt ++2.12.4 scalatest/package scalatest/mimaReportBinaryIssues
+    $ sbt ++2.12.4 scalacticJS/package scalacticJS/mimaReportBinaryIssues
+    $ sbt ++2.12.4 scalatestJS/package scalatestJS/mimaReportBinaryIssues
+
+    $ sbt ++2.13.0-M2 scalactic/package scalactic/mimaReportBinaryIssues
+    $ sbt ++2.13.0-M2 scalatest/package scalatest/mimaReportBinaryIssues
+    $ sbt ++2.13.0-M2 scalacticJS/package scalacticJS/mimaReportBinaryIssues
+    $ sbt ++2.13.0-M2 scalatestJS/package scalatestJS/mimaReportBinaryIssues
+
 To publish scalactic, scalatest and scalatest-app (for Scala and Scala-js, version 2.11 and 2.10, and make sure you're on Java 6) to Sonatype, use the following command:
 
   `$ sbt clean publishSigned ++2.11.12 "project scalatestAppJS" clean publishSigned ++2.10.7 "project scalatestApp" clean publishSigned "project scalatestAppJS" clean publishSigned`

project/plugins.sbt

@@ -3,3 +3,5 @@ addSbtPlugin("com.typesafe.sbt" % "sbt-pgp" % "0.8.3")
 addSbtPlugin("com.typesafe.sbt" % "sbt-osgi" % "0.7.0")
 
 addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.20")
+
+addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.1.18")

project/scalatest.scala

@@ -7,6 +7,9 @@ import com.typesafe.sbt.osgi.SbtOsgi._
 import com.typesafe.sbt.SbtPgp._
 import org.scalajs.sbtplugin.ScalaJSPlugin
 import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._
+import com.typesafe.tools.mima.plugin.MimaKeys.{mimaPreviousArtifacts, mimaCurrentClassfiles, mimaBinaryIssueFilters}
+import com.typesafe.tools.mima.core._
+import com.typesafe.tools.mima.core.ProblemFilters._
 
 object ScalatestBuild extends Build {
 
@@ -21,7 +24,8 @@ object ScalatestBuild extends Build {
   // > ++ 2.10.5
   val buildScalaVersion = "2.12.4"
 
-  val releaseVersion = "3.0.1"
+  val releaseVersion = "3.1.0"
+  val previousReleaseVersion = "3.0.5"
 
   val scalacheckVersion = "1.13.5"
   val easyMockVersion = "3.2"
@@ -31,7 +35,7 @@ object ScalatestBuild extends Build {
   val junitVersion = "4.12"
   val pegdownVersion = "1.4.2"
 
-  val githubTag = "release-3.0.1" // for scaladoc source urls
+  val githubTag = "release-3.1.0" // for scaladoc source urls
 
   val scalatestDocSourceUrl =
     "https://github.com/scalatest/scalatest/tree/"+ githubTag +
@@ -321,12 +325,15 @@ object ScalatestBuild extends Build {
       publishLocal := {}
     )
 
+  lazy val deleteJsDependenciesTask = taskKey[Unit]("Delete JS_DEPENDENCIES")
+
   lazy val scalacticMacroJS = Project("scalacticMacroJS", file("scalactic-macro.js"))
     .settings(sharedSettings: _*)
     .settings(
       projectTitle := "Scalactic Macro.js",
       organization := "org.scalactic",
       sourceGenerators in Compile += {
+        // We'll delete JS_DEPENDENCIES in scalactic-macro.js
         Def.task{
           GenScalacticJS.genMacroScala((sourceManaged in Compile).value, version.value, scalaVersion.value) ++
           ScalacticGenResourcesJSVM.genResources((sourceManaged in Compile).value / "org" / "scalactic", version.value, scalaVersion.value) ++
@@ -335,7 +342,13 @@ object ScalatestBuild extends Build {
       },
       // Disable publishing macros directly, included in scalactic main jar
       publish := {},
-      publishLocal := {}
+      publishLocal := {}, 
+      deleteJsDependenciesTask <<= (classDirectory in Compile) map { jsDependenciesFile =>
+        (jsDependenciesFile/ "JS_DEPENDENCIES").delete()
+        ()
+        //val loader: ClassLoader = ClasspathUtilities.toLoader(classpath.map(_.data).map(_.getAbsoluteFile))
+        //loader.loadClass("your.class.Here").newInstance()
+      } triggeredBy(compile in Compile)
     ).enablePlugins(ScalaJSPlugin)
 
   lazy val scalactic = Project("scalactic", file("scalactic"))
@@ -356,7 +369,9 @@ object ScalatestBuild extends Build {
       // include the macro sources in the main source jar
       mappings in (Compile, packageSrc) ++= mappings.in(scalacticMacro, Compile, packageSrc).value,
       scalacticDocSourcesSetting,
-      docTaskSetting
+      docTaskSetting,
+      mimaPreviousArtifacts := Set(organization.value %% name.value % previousReleaseVersion),
+      mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (name.value + "_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar")
     ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalactic",
@@ -396,7 +411,13 @@ object ScalatestBuild extends Build {
         Def.task {
           GenScalacticJS.genResource((resourceManaged in Compile).value, version.value, scalaVersion.value)
         }.taskValue
-      }
+      },
+      // include the macro classes and resources in the main jar
+      mappings in (Compile, packageBin) ++= mappings.in(scalacticMacroJS, Compile, packageBin).value,
+      // include the macro sources in the main source jar
+      mappings in (Compile, packageSrc) ++= mappings.in(scalacticMacroJS, Compile, packageSrc).value,
+      mimaPreviousArtifacts := Set(organization.value %%% moduleName.value % previousReleaseVersion),
+      mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (moduleName.value + "_" + "sjs0.6_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar")
     ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalactic",
@@ -500,7 +521,15 @@ object ScalatestBuild extends Build {
          ScalaTestGenResourcesJVM.genFailureMessages((sourceManaged in Compile).value / "org" / "scalatest", version.value, scalaVersion.value)
        }.taskValue
      },
-     docTaskSetting
+     docTaskSetting,
+     mimaPreviousArtifacts := Set(organization.value %% name.value % previousReleaseVersion),
+     mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (name.value + "_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar"), 
+     mimaBinaryIssueFilters ++= {
+       Seq(
+         exclude[MissingClassProblem]("org.scalatest.tools.SbtCommandParser$"),
+         exclude[MissingClassProblem]("org.scalatest.tools.SbtCommandParser")
+       )
+     }
    ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalatest",
@@ -610,7 +639,9 @@ object ScalatestBuild extends Build {
           //GenSafeStyles.genMainForScalaJS((sourceManaged in Compile).value / "org" / "scalatest", version.value, scalaVersion.value)
         }.taskValue
       },
-      scalatestJSDocTaskSetting
+      scalatestJSDocTaskSetting,
+      mimaPreviousArtifacts := Set(organization.value %%% moduleName.value % previousReleaseVersion),
+      mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (moduleName.value + "_" + "sjs0.6_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar")
     ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalatest",
@@ -701,7 +732,9 @@ object ScalatestBuild extends Build {
           Seq.empty[File]
         }.taskValue
       },
-      unmanagedResourceDirectories in Compile += baseDirectory.value / "scalatest" / "src" / "main" / "resources"
+      unmanagedResourceDirectories in Compile += baseDirectory.value / "scalatest" / "src" / "main" / "resources",
+      mimaPreviousArtifacts := Set(organization.value %% name.value % previousReleaseVersion),
+      mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (name.value + "_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar")
     ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalatest",
@@ -773,7 +806,9 @@ object ScalatestBuild extends Build {
           (new File(crossTarget.value, "classes")).mkdirs()
           Seq.empty[File]
         }.taskValue
-      }
+      },
+      mimaPreviousArtifacts := Set(organization.value %%% moduleName.value % previousReleaseVersion),
+      mimaCurrentClassfiles := (classDirectory in Compile).value.getParentFile / (moduleName.value + "_" + "sjs0.6_" + scalaBinaryVersion.value + "-" + releaseVersion + ".jar")
     ).settings(osgiSettings: _*).settings(
       OsgiKeys.exportPackage := Seq(
         "org.scalatest",