sbt multi module project

This repository is setup to provide a basic understanding of SBT

Goals

• 1 create multi module sbt project
• 2 set inner module as a dependency to another inner module
• 3 produce fat-jar (uber jar)
• 4 create test coverage report

1 Multimodule project

Sbt gives a lot of freedom and flexibility in project build definition. I like the way how its defined in official documentation. Root module with 2 sub modules have next view:

lazy val rootProject = project
  .in(file("."))
  .settings(
    name := "sbtmulti",
    organization := rootPackage,
    version := projectV
  )
  .aggregate(
    schemas,
    microservice
  )

lazy val schemas = project
  .settings(
    name := "schemas",
    settings,
    libraryDependencies ++= Seq(dependencies.akkaHttpSpray)
  )

lazy val microservice = project
  .settings(
    name := "microservice",
    settings,
    libraryDependencies ++= commonDependencies ++ testDependencies,
    mainClass in assembly := Some(s"$subRootPackage.microservice.Boot"),
    assemblyJarName in assembly := "microservice-fat-jar.jar"
  )
  .dependsOn(schemas)

2 Sub module as dependency to other sub module

Use method .dependsOn() - Adds classpath dependencies on internal or external projects.

lazy val microservice = project
  .dependsOn(schemas)

3 Fat-jar

Plugin assembly is defined in /project/assembly.sbt.

addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.7")

Setup main class for each project in build.sbt. Optionally you can set name for .jar.

lazy val microservice = project
  .settings(
    mainClass in assembly := Some(s"ru.zhenik.sbtmulti.microservice.Boot"),
    assemblyJarName in assembly := "microservice-fat-jar.jar"
  )

To produce fat-jar execute sbt assembly

4 Test coverage report

Test coverage plugin in /project/plugins.sbt

addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")

Execute sbt clean coverage test coverageReport.

Check /microservice/target/scala-x.x.x/scoverage-report/index.html

Notes: sbt

SBT
Verify sbt version, it should be 1.2.X > version: sbt sbtVersion
inspect: sbt 'inspect sbtVersion'