Merge pull request #87 from Tapad/feature/specs2

Feature/specs2

Author: kurtkopchik

README.md

@@ -72,6 +72,7 @@ plugin will attempt to locate it in one of three places with the precedence orde
     testDependenciesClasspath := // The path to all managed and unmanaged Test and Compile dependencies. This path needs to include the ScalaTest Jar for the tests to execute. This defaults to all managedClasspath and unmanagedClasspath in the Test and fullClasspath in the Compile Scope.
     testCasesJar := // The path to the Jar file containing the tests to execute. This defaults to the Jar file with the tests from the current sbt project.
     testCasesPackageTask := // The sbt Task to package the test cases used when running 'dockerComposeTest'. This defaults to the 'packageBin' task in the 'Test' Scope.
+    testPassUseSpecs2 := // True if Specs2 is to be used to execute the test pass. This defaults to False and ScalaTest is used.
     variablesForSubstitution := // A Map[String,String] of variables to substitute in your docker-compose file. These are substituted substituted by the plugin and not using environment variables.
     variablesForSubstitutionTask := // An sbt task that returns a Map[String,String] of variables to substitute in your docker-compose file. These are substituted by the plugin and not using environment variables.
    ```
@@ -346,7 +347,19 @@ docker-compose.yml:
 6) [**basic-with-tests-integration**](examples/basic-with-tests-integration): This project shows how to change the default sbt Scope of the
 tests being executed from 'Test' to 'IntegrationTest' when 'dockerComposeTest' is run.
 
-    
+7) [**basic-with-tests-spec2**](examples/basic-with-tests-specs2): This project shows how to execute Specs2 based test cases via the 'specs2.files' runner
+by setting the following property in build.sbt:
+
+   ```
+    testPassUseSpecs2 := true
+   ```
+   
+Additionally, you can override the default Specs2 file runner properties as follows:
+
+   ```
+    testExecutionExtraConfigTask := Map("filesrunner.verbose" -> s"true")
+   ```
+
 Currently Unsupported Docker Compose Fields
 -------------------------------------------
 1) "build:" - All docker compose services need to specify an "image:" field.

examples/basic-with-tests-specs2/build.sbt

@@ -0,0 +1,35 @@
+name := "basic"
+
+version := "1.0.0"
+
+scalaVersion := "2.11.1"
+
+libraryDependencies ++= Seq("org.specs2" %% "specs2-core" % "3.7.3" % "test",
+  "org.scalaj" %% "scalaj-http" % "2.2.1" % "test",
+  "org.pegdown" % "pegdown" % "1.6.0" % "test"
+)
+
+enablePlugins(DockerPlugin, DockerComposePlugin)
+
+//Set the image creation Task to be the one used by sbt-docker
+dockerImageCreationTask := docker.value
+
+testPassUseSpecs2 := true
+
+testExecutionExtraConfigTask := Map("filesrunner.verbose" -> s"true")
+
+dockerfile in docker := {
+  new Dockerfile {
+    val dockerAppPath = "/app/"
+    val mainClassString = (mainClass in Compile).value.get
+    val classpath = (fullClasspath in Compile).value
+    from("java")
+    add(classpath.files, dockerAppPath)
+    entryPoint("java", "-cp", s"$dockerAppPath:$dockerAppPath/*", s"$mainClassString")
+  }
+}
+
+imageNames in docker := Seq(ImageName(
+  repository = name.value.toLowerCase,
+  tag = Some(version.value))
+)

examples/basic-with-tests-specs2/docker/docker-compose.yml

@@ -0,0 +1,7 @@
+basic:
+  image: basic:1.0.0
+  environment:
+    JAVA_TOOL_OPTIONS: -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
+  ports:
+    - "0:8080"
+    - "0:5005"

examples/basic-with-tests-specs2/project/build.properties

@@ -0,0 +1 @@
+sbt.version=0.13.16

examples/basic-with-tests-specs2/project/plugins.sbt

@@ -0,0 +1,5 @@
+addSbtPlugin("se.marcuslonnberg" % "sbt-docker" % "1.4.1")
+
+resolvers += "Sonatype Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots/"
+
+addSbtPlugin("com.tapad" % "sbt-docker-compose" % "1.0.26-SNAPSHOT")

examples/basic-with-tests-specs2/src/main/scala/BasicApp.scala

@@ -0,0 +1,20 @@
+import java.io.PrintWriter
+import java.net.ServerSocket
+
+object BasicApp extends App {
+
+  val text =
+    """HTTP/1.0 200 OK
+        Content-Type: text/html
+        Content-Length: 200
+
+        <HTML> <HEAD> <TITLE>Hello, World!</TITLE> </HEAD> <BODY LANG="en-US" BGCOLOR="#e6e6ff" DIR="LTR"> <P ALIGN="CENTER"> <FONT FACE="Arial, sans-serif" SIZE="6">Hello, World!</FONT> </P> </BODY> </HTML>"""
+  val port = 8080
+  val listener = new ServerSocket(port)
+
+  while (true) {
+    val sock = listener.accept()
+    new PrintWriter(sock.getOutputStream, true).println(text)
+    sock.shutdownOutput()
+  }
+}

examples/basic-with-tests-specs2/src/test/scala/BasicAppSpec.scala

@@ -0,0 +1,42 @@
+import scala.Console._
+import scala.sys.process._
+import org.specs2._
+import org.specs2.execute._
+import scalaj.http.Http
+import java.io.{ByteArrayOutputStream, PrintWriter}
+
+class BasicAppSpec extends mutable.Specification  {
+
+  // The System Properties will contain the connection information for the running Docker Compose
+  // services. The key into the map is "serviceName:containerPort" and it will return "host:hostPort" which is the
+  // Docker Compose generated endpoint that can be connected to at runtime. You can use this to endpoint connect to
+  // for testing. Each service will also inject a "serviceName:containerId" key with the value equal to the container id.
+  // You can use this to emulate service failures by killing and restarting the container.
+  val basicServiceName = "basic"
+  val basicServiceHostKey = s"$basicServiceName:8080"
+  val basicServiceContainerIdKey = s"$basicServiceName:containerId"
+  val hostInfo = getHostInfo()
+  val containerId = getContainerId()
+
+  "Validate that the Docker Compose endpoint returns a success code and the string 'Hello, World!'" >> {
+      println(s"Attempting to connect to: $hostInfo, container id is $containerId")
+
+      eventually {
+        val output = Http(s"http://$hostInfo").asString
+        output.isSuccess mustEqual true
+        output.body must contain ("Hello, World!")
+      }
+  }
+
+  def getHostInfo(): String = getContainerSetting(basicServiceHostKey)
+  def getContainerId(): String = getContainerSetting(basicServiceContainerIdKey)
+
+  def getContainerSetting(key: String): String = {
+    if (System.getProperty(key) !=  null) {
+      System.getProperty(key)
+    }
+    else {
+      throw new FailureException(Failure(s"Cannot find the expected Docker Compose service key '$key' in the System Properties"))
+    }
+  }
+}

src/main/scala/com/tapad/docker/ComposeTestRunner.scala

@@ -102,4 +102,54 @@ trait ComposeTestRunner extends SettingsHelper with PrintFormatting {
       state
     }
   }
+
+  /**
+   * Build up a set of parameters to pass as System Properties that can be accessed from Specs2
+   * Compiles and binPackages the latest Test code.
+   * Starts a test pass using the Specs2 Files Runner
+   * @param state The sbt state
+   * @param args The command line arguments
+   * @param instance The running Docker Compose instance to test against
+   */
+  def runTestPassSpecs2(implicit state: State, args: Seq[String], instance: Option[RunningInstanceInfo]): State = {
+    //Build the list of Docker Compose connection endpoints to pass as System Properties
+    //format: <-Dservice:containerPort=host:hostPort>
+    val testParams = instance match {
+      case Some(inst) => inst.servicesInfo.flatMap(service =>
+        service.ports.map(port =>
+          s"-D${service.serviceName}:${port.containerPort}=${service.containerHost}:${port.hostPort}")
+          :+ s"-D${service.serviceName}:containerId=${service.containerId}").mkString(" ")
+      case None => ""
+    }
+
+    val extraTestParams = runTestExecutionExtraConfigTask(state).map { case (k, v) => s"-D$k=$v" }
+
+    print("Compiling and Packaging test cases...")
+    binPackageTests
+
+    // Looks for the <-debug:port> argument and will suspend test case execution until a debugger is attached
+    val debugSettings = getArgValue(testDebugPortArg, args) match {
+      case Some(port) => s"-J-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=$port"
+      case None => ""
+    }
+
+    val suppressColor = getSetting(suppressColorFormatting)
+    val noColorOption = if (suppressColor) "-Dspecs2.color=false" else ""
+    val testArgs = getSetting(testExecutionArgs).split(" ").toSeq
+    val testDependencies = getTestDependenciesClassPath
+    if (testDependencies.matches(".*org.specs2.*")) {
+      val testParamsList = testParams.split(" ").toSeq ++ extraTestParams
+      val testRunnerCommand = (Seq("java", debugSettings, noColorOption) ++
+        testParamsList ++
+        Seq("-cp", testDependencies, "org.specs2.runner.files") ++
+        testArgs ++
+        testParamsList).filter(_.nonEmpty)
+      if (testRunnerCommand.! == 0) state
+      else state.fail
+    } else {
+      printBold("Cannot find a Specs2 Jar dependency. Please make sure it is added to your sbt projects " +
+        "libraryDependencies.", suppressColor)
+      state
+    }
+  }
 }

src/main/scala/com/tapad/docker/DockerComposeKeys.scala

@@ -22,6 +22,7 @@ trait DockerComposeKeysLocal {
   val testCasesJar = settingKey[String]("The path to the Jar file containing the tests to execute. This defaults to the Jar file with the tests from the current sbt project.")
   val testCasesPackageTask = taskKey[File]("The sbt TaskKey to package the test cases used when running 'dockerComposeTest'. This defaults to the 'packageBin' task in the 'Test' Scope.")
   val testDependenciesClasspath = taskKey[String]("The path to all managed and unmanaged Test and Compile dependencies. This path needs to include the ScalaTest Jar for the tests to execute. This defaults to all managedClasspath and unmanagedClasspath in the Test and fullClasspath in the Compile Scope.")
+  val testPassUseSpecs2 = settingKey[Boolean]("True if Specs2 is to be used to execute the test pass. This defaults to False and ScalaTest is used.")
   val runningInstances = AttributeKey[List[RunningInstanceInfo]]("For Internal Use: Contains information on the set of running Docker Compose instances.")
   val variablesForSubstitution = settingKey[Map[String, String]]("A Map[String,String] of variables to substitute in your docker-compose file. These are substituted by the plugin and not using environment variables.")
   val variablesForSubstitutionTask = taskKey[Map[String, String]]("An sbt task that returns a Map[String,String] of variables to substitute in your docker-compose file. These are substituted by the plugin and not using environment variables.")

src/main/scala/com/tapad/docker/DockerComposePlugin.scala

@@ -75,6 +75,7 @@ object DockerComposePlugin extends DockerComposePluginLocal {
     val testExecutionExtraConfigTask = DockerComposeKeys.testExecutionExtraConfigTask
     val testExecutionArgs = DockerComposeKeys.testExecutionArgs
     val testCasesJar = DockerComposeKeys.testCasesJar
+    val testPassUseSpecs2 = DockerComposeKeys.testPassUseSpecs2
     val suppressColorFormatting = DockerComposeKeys.suppressColorFormatting
     val scalaTestJar = DockerComposeKeys.testDependenciesClasspath
     val variablesForSubstitution = DockerComposeKeys.variablesForSubstitution
@@ -418,7 +419,10 @@ class DockerComposePluginLocal extends AutoPlugin with ComposeFile with DockerCo
     val requiresShutdown = getMatchingRunningInstance(newState, args).isEmpty
     val (preTestState, instance) = getTestPassInstance(newState, args)
 
-    val finalState = runTestPass(preTestState, args, instance)
+    val finalState = if (getSetting(testPassUseSpecs2))
+      runTestPassSpecs2(preTestState, args, instance)
+    else
+      runTestPass(preTestState, args, instance)
 
     if (requiresShutdown)
       stopDockerCompose(finalState, Seq(instance.get.instanceName))