project/Common.scala

/*
 * Copyright 2014 IBM Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import org.apache.commons.io.FileUtils
import sbt._
import Keys._

import scala.util.Properties

object Common {
  //  Parameters for publishing to artifact repositories
  val snapshot                  = Properties.envOrElse("IS_SNAPSHOT","true").toBoolean
  val repoPort                  = Properties.envOrElse("REPO_PORT","")
  val repoHost                  = Properties.envOrElse("REPO_HOST","")
  val repoUsername              = Properties.envOrElse("REPO_USERNAME","")
  val repoPassword              = Properties.envOrElse("REPO_PASSWORD","")
  val repoEndpoint              = Properties.envOrElse("REPO_ENDPOINT", if(snapshot) "/nexus/content/repositories/snapshots/" else "/nexus/content/repositories/releases/")
  val repoUrl                   = Properties.envOrElse("REPO_URL", s"http://${repoHost}:${repoPort}${repoEndpoint}")

  private val versionNumber     = "0.1.2"
  private val buildOrganization = "com.ibm.spark"
  private val buildVersion      =
    if (snapshot) s"$versionNumber-SNAPSHOT"
    else versionNumber
  private val buildScalaVersion = "2.10.4"
  private val buildSbtVersion   = "0.13.7"

  // Global dependencies provided to all projects
  private val buildLibraryDependencies = Seq(
    // Needed to force consistent typesafe config with play json and spark
    "com.typesafe" % "config" % "1.2.1",
    "org.slf4j" % "slf4j-log4j12" % "1.7.5" % "test",
    "log4j" % "log4j" % "1.2.17" % "test",
    "org.scalatest" %% "scalatest" % "2.2.0" % "test", // Apache v2
    "org.scalactic" %% "scalactic" % "2.2.0" % "test", // Apache v2
    "org.mockito" % "mockito-all" % "1.9.5" % "test"   // MIT
  )

  lazy val sparkVersion = settingKey[String]("The Apache Spark version to use")

  // The prefix used for our custom artifact names
  private val artifactPrefix = "ibm-spark"

  val settings: Seq[Def.Setting[_]] = Seq(
    organization := buildOrganization,
    version := buildVersion,
    scalaVersion := buildScalaVersion,
    sbtVersion := buildSbtVersion,
    libraryDependencies ++= buildLibraryDependencies,
    isSnapshot := snapshot,
    sparkVersion := {
      val sparkEnvironmentVariable = "APACHE_SPARK_VERSION"
      val defaultSparkVersion = "1.3.1"

      val _sparkVersion = Properties.envOrNone(sparkEnvironmentVariable)

      if (_sparkVersion.isEmpty) {
        scala.Console.err.println(s"""
          |[ERROR] No version of Apache Spark was specified! Please provide a
          |version using the environment variable $sparkEnvironmentVariable!
          |""".stripMargin.trim.replace('\n', ' ')
        )

        // TODO: Remove this "default value" and throw an exception in the
        //       future?
        scala.Console.err.println(s"""
          |[WARN] Defaulting to Apache Spark $defaultSparkVersion! This is not
          |a guarantee in the future! Please specify the version explicitly!
          |""".stripMargin.trim.replace('\n', ' ')
        )

        defaultSparkVersion
      } else {
        val version = _sparkVersion.get
        scala.Console.out.println(
          s"""
             |[INFO] Using Apache Spark $version provided from
             |$sparkEnvironmentVariable!
           """.stripMargin.trim.replace('\n', ' '))
        version
      }
    },

    scalacOptions in (Compile, doc) ++= Seq(
      // Ignore packages (for Scaladoc) not from our project
      "-skip-packages", Seq(
        "akka",
        "scala"
      ).mkString(":")
    ),

    // Scala-based options for compilation
    scalacOptions ++= Seq(
      "-deprecation", "-unchecked", "-feature",
      //"-Xlint", // Scala 2.11.x only
      "-Xfatal-warnings",
      "-Ywarn-all",
      "-language:reflectiveCalls"
    ),

    // Java-based options for compilation (all tasks)
    javacOptions in Compile ++= Seq(""),

    // Java-based options for just the compile task
    javacOptions in (Compile, compile) ++= Seq(
      "-Xlint:all",   // Enable all Java-based warnings
      "-Xlint:-path", // Suppress path warnings since we get tons of them
      "-Werror"       // Treat warnings as errors
    ),

    // Add additional test option to show time taken per test
    testOptions in Test += Tests.Argument("-oD"),

    // Add a global resource directory with compile/ and test/ for resources
    // in all projects
    unmanagedResourceDirectories in Compile +=
      (baseDirectory in Build.root).value / "resources/compile",
    unmanagedResourceDirectories in Test +=
      (baseDirectory in Build.root).value / "resources/test",

    publishTo := Some("Spark Kernel Nexus Repo" at repoUrl),

    credentials += Credentials("Sonatype Nexus Repository Manager", repoHost, repoUsername, repoPassword),

    // Change destination of local delivery (building ivy.xml) to have *-ivy.xml
    deliverLocalConfiguration := {
      val newDestinationPath = crossTarget.value / s"${name.value}-ivy.xml"
      val dlc = deliverLocalConfiguration.value
      new DeliverConfiguration(
        newDestinationPath.absolutePath, dlc.status,
        dlc.configurations, dlc.logging)
    },

    // Add rebuild ivy xml to the following tasks
    compile <<= (compile in Compile) dependsOn (rebuildIvyXml dependsOn deliverLocal)
  ) ++ rebuildIvyXmlSettings // Include our rebuild ivy xml settings

  // ==========================================================================
  // = REBUILD IVY XML SETTINGS BELOW
  // ==========================================================================

  lazy val rebuildIvyXml = TaskKey[Unit](
    "rebuild-ivy-xml",
    "Rebuilds the ivy xml using deliver-local and copies it to src " +
      "resource directories"
  )

  // TODO: Figure out how to retrieve the configuration being used to avoid
  //       this duplication
  lazy val rebuildIvyXmlSettings = Seq(
    rebuildIvyXml := {
      val s: TaskStreams = streams.value
      val inputFile = (crossTarget.value / s"${name.value}-ivy.xml").getAbsoluteFile
      val outputFile =
        ((resourceDirectory in Compile).value / s"${name.value}-ivy.xml").getAbsoluteFile
      s.log.info(s"Copying ${inputFile.getPath} to ${outputFile.getPath}")
      FileUtils.copyFile(inputFile, outputFile)
    }
  )
}