Run MiMa on modules

Modules have to specify the `mimaPreviousVersion` property.

MiMa is NOT executed if
  - the above property is not set
  - but the module of version mimaPreviousVersion cannot be resolved
    against the scalaBinaryVersion

A warning is issued if MiMa is skipped.

Author: lrytz

build.sbt

@@ -30,3 +30,6 @@ bintrayOrganization in bintray := None
 
 // this plugin depends on the sbt-osgi plugin -- 2-for-1!
 addSbtPlugin("com.typesafe.sbt" % "sbt-osgi" % "0.7.0")
+
+// TODO here or in project/plugins.sbt?
+addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.1.6")

src/main/scala/ScalaModulePlugin.scala

@@ -1,20 +1,32 @@
 import sbt._
 import Keys._
 import com.typesafe.sbt.osgi.{OsgiKeys, SbtOsgi}
+import com.typesafe.tools.mima.plugin.{MimaPlugin, MimaKeys}
 
 object ScalaModulePlugin extends Plugin {
+  // TODO add doc. not sure i really see the valid use case for this feature. yet.
+  //  - only relevant for x.y.0-SNAPSHOT, once x.y.0 is out, the binary ver of x.y.1-SNAPSHOT is x.y (patch is dropped)
+  //  - used when publishing using a scala snapshot. the module will not have SNAPSHOT in the scala binary version.
+  //    allows using a snapshot of the module more easily. eg if you're using scala 2.12.0-M1, you can say "org.scala-lang.modules" %% "scala-xml" % "1.0.2-SNAPSHOT"
+  //  - also used to resolve dependencies of modules. when building with a snapshot scala, deps will be resolved against this binver.
   val snapshotScalaBinaryVersion = settingKey[String]("The Scala binary version to use when building against Scala SNAPSHOT.")
   val repoName                   = settingKey[String]("The name of the repository under github.com/scala/.")
+  val mimaPreviousVersion        = settingKey[Option[String]]("The version of this module to compare against when running MiMa.")
+
+  private val canRunMima         = taskKey[Boolean]("Decides if MiMa should run.")
+  private val runMimaIfEnabled   = taskKey[Unit]("Run MiMa if mimaPreviousVersion and the module can be resolved against the current scalaBinaryVersion.")
 
   def deriveBinaryVersion(sv: String, snapshotScalaBinaryVersion: String) = sv match {
     case snap_211 if snap_211.startsWith("2.11") &&
                      snap_211.contains("-SNAPSHOT") => snapshotScalaBinaryVersion
     case sv => sbt.CrossVersion.binaryScalaVersion(sv)
   }
 
-  lazy val scalaModuleSettings = Seq(
+  lazy val scalaModuleSettings: Seq[Setting[_]] = Seq(
     repoName            := name.value,
 
+    mimaPreviousVersion := None,
+
     organization        := "org.scala-lang.modules",
 
     scalaBinaryVersion  := deriveBinaryVersion(scalaVersion.value, snapshotScalaBinaryVersion.value),
@@ -85,6 +97,57 @@ object ScalaModulePlugin extends Plugin {
         </developer>
       </developers>
     )
+  ) ++ mimaSettings
+
+  // adapted from https://github.com/typesafehub/migration-manager/blob/0.1.6/sbtplugin/src/main/scala/com/typesafe/tools/mima/plugin/SbtMima.scala#L69
+  def artifactExists(organization: String, name: String, scalaBinaryVersion: String, version: String, ivy: IvySbt, s: TaskStreams): Boolean = {
+    val moduleId = new ModuleID(organization, s"${name}_$scalaBinaryVersion", version)
+    val moduleSettings = InlineConfiguration(
+      "dummy" % "test" % "version",
+      ModuleInfo("dummy-test-project-for-resolving"),
+      dependencies = Seq(moduleId))
+    val ivyModule = new ivy.Module(moduleSettings)
+    try {
+      IvyActions.update(
+        ivyModule,
+        new UpdateConfiguration(
+          retrieve = None,
+          missingOk = false,
+          logging = UpdateLogging.DownloadOnly),
+        s.log)
+      true
+    } catch {
+      case _: ResolveException => false
+    }
+  }
+
+  lazy val mimaSettings: Seq[Setting[_]] = MimaPlugin.mimaDefaultSettings ++ Seq(
+    // manual cross-versioning because https://github.com/typesafehub/migration-manager/issues/62
+    MimaKeys.previousArtifact := Some(organization.value % s"${name.value}_${scalaBinaryVersion.value}" % mimaPreviousVersion.value.getOrElse("dummy")),
+
+    canRunMima := {
+      val mimaVer = mimaPreviousVersion.value
+      val s = streams.value
+      if (mimaVer.isEmpty) {
+        s.log.warn("MiMa will NOT run because no mimaPreviousVersion is provided.")
+        false
+      } else if (!artifactExists(organization.value, name.value, scalaBinaryVersion.value, mimaVer.get, ivySbt.value, s)) {
+        s.log.warn(s"""MiMa will NOT run because the previous artifact "${organization.value}" % "${name.value}_${scalaBinaryVersion.value}" % "${mimaVer.get}" could not be resolved (note the binary Scala version).""")
+        false
+      } else {
+        true
+      }
+    },
+
+    runMimaIfEnabled := Def.taskDyn({
+      if(canRunMima.value) Def.task { MimaKeys.reportBinaryIssues.value }
+      else Def.task { () }
+    }).value,
+
+    test in Test := {
+      runMimaIfEnabled.value
+      (test in Test).value
+    }
   )
 
   // a setting-transform to turn the regular version into something osgi can deal with
@@ -116,12 +179,3 @@ object ScalaModulePlugin extends Plugin {
 //    "org.scala-lang" % "scala-library" % scalaVersion.value,
 //    ("org.scala-lang" % "scala-compiler" % scalaVersion.value % "scala-tool").exclude("org.scala-lang.modules", s"scala-xml_${scalaBinaryVersion.value}")
 // )
-
-
-/* Mima blurb:
-  addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "0.1.6")
-
-  import com.typesafe.tools.mima.plugin.{MimaPlugin, MimaKeys}
-  MimaPlugin.mimaDefaultSettings
-  MimaKeys.previousArtifact := Some(... % ... % ...)
-*/