Added the ability to supply system properties and other jvm arguments to the jvm that is started for running cucumber.

Fixed a couple of minor errors in the documentation.

Author: skipoleschris

README.markdown

@@ -77,7 +77,7 @@ To install the cucumber plugin, add entries to the build plugins file (project/p
 
     resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
 
-    addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.0")
+    addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.1")
 
 ### Basic Configuration ###
 To add the cucumber plugin settings to a basic project, just add the following to the build.sbt file:
@@ -127,8 +127,10 @@ If none of the above are set to true then the default output is pretty printed f
 * cucumberJsonReportFile - The location of the JSON format report file. Defaults fo a java.io.File of ./target/scala-{scalaVersion}/cucumber.json
 
 ### JVM Settings ###
-* cucumberMaxMemory - The maximum JVM memory to allocate to the JRuby process. Defaults to the string "256M"
-* cucumberMaxPermGen - The maximum PermGen space for the JRuby process. Defaults to the string "64M"
+* cucumberMaxMemory - The maximum JVM memory to allocate to the JVM process. Defaults to the string "256M"
+* cucumberMaxPermGen - The maximum PermGen space for the JVM process. Defaults to the string "64M"
+* cucumberSystemProperties - System properties to be passed to the JVM process using the -D flag. Defaults to and empty Map[String, String]
+* cucumberJVMOptions - Additional options to be passed to the JVM that runs cucumber. Defaults to an empty List[String]
 
 ### Lifecycle Settings ###
 * cucumberBefore - A function of type () => Unit that will be run BEFORE cucumber is executed. Defaults to a no-op function
@@ -141,6 +143,10 @@ Requests for features can be posted to the issues list or emailed to the author.
 
 ## Release History ##
 
+### 0.6.1 ###
+Update to allow system properties and other JVM arguments to be passed to the JVM that runs cucumber.
+Corrections to documentation.
+
 ### 0.6.0 ###
 Updated to work the SBT 0.12.0, Scala 2.9.2 and the latest Cucumber-jvm 1.0.14 versions.
 

build.sbt

@@ -1,6 +1,6 @@
 name := "xsbt-cucumber-plugin"
 
-version := "0.6.0"
+version := "0.6.1"
 
 organization := "templemore"
 

src/main/scala/templemore/xsbt/cucumber/Cucumber.scala

@@ -9,14 +9,17 @@ import sbt.OutputStrategy
  */
 case class Cucumber(classpath: List[File],
                     outputStrategy: OutputStrategy,
+                    systemProperties: Map[String, String],
+                    jvmOptions: List[String],
                     overrideMaxMemory: Option[String] = None,
                     overrideMaxPermGen: Option[String] = None) {
 
   private val maxMemory = overrideMaxMemory.getOrElse("256M")
   private val maxPermGen = overrideMaxPermGen.getOrElse("64M")
 
-  private val jvmArgs = "-classpath" :: makeClasspath(classpath) ::
-                        ("-Xmx%s" format maxMemory) :: ("-XX:MaxPermSize=%s" format maxPermGen) :: Nil
+  private val jvmArgs = ("-classpath" :: makeClasspath ::
+                        ("-Xmx%s" format maxMemory) :: ("-XX:MaxPermSize=%s" format maxPermGen) :: Nil) ++
+                        makeSystemProperties ++ jvmOptions
 
   def cuke(featuresDir: File, basePackage: String, options: List[String] = List(),
            tags: List[String] = List(), names: List[String] = List()): Int = {
@@ -30,6 +33,7 @@ case class Cucumber(classpath: List[File],
     Fork.java(None, args, None, Map.empty[String, String], outputStrategy)
   }
 
-  protected def makeClasspath(pathElements: List[File]) = pathElements.map(_.getPath).mkString(File.pathSeparator)
+  protected def makeClasspath = classpath.map(_.getPath).mkString(File.pathSeparator)
   protected def makeOptionsList(options: List[String], flag: String) = options flatMap(List(flag, _))
+  protected def makeSystemProperties = systemProperties.toList map (entry => "-D%s=%s".format(entry._1, entry._2))
 }

src/main/scala/templemore/xsbt/cucumber/CucumberIntegration.scala

@@ -42,6 +42,7 @@ trait CucumberIntegration {
     log.info("Running cucumber...")
     cucumberOptions.beforeFunc()
     val cucumber = Cucumber(cucumberSettings.classpath, cucumberSettings.outputStrategy,
+                            cucumberSettings.systemProperties, cucumberSettings.jvmOptions,
                             Some(cucumberSettings.maxMemory), Some(cucumberSettings.maxPermGen))
     val result = cucumber.cuke(cucumberOptions.featuresDir, cucumberOptions.basePackage,
                                cucumberOptions.options ++ cucumberOutput.options, tagsFromArgs(args), namesFromArgs(args))

src/main/scala/templemore/xsbt/cucumber/CucumberPlugin.scala

@@ -21,6 +21,8 @@ object CucumberPlugin extends Plugin with CucumberIntegration {
 
   val cucumberMaxMemory = SettingKey[String]("cucumber-max-memory")
   val cucumberMaxPermGen = SettingKey[String]("cucumber-max-perm-gen")
+  val cucumberSystemProperties = SettingKey[Map[String, String]]("cucumber-system-properties")
+  val cucumberJVMOptions = SettingKey[List[String]]("cucumber-jvm-options")
 
   val cucumberFeaturesDir = SettingKey[File]("cucumber-features-directory")
   val cucumberStepsBasePackage = SettingKey[String]("cucumber-steps-base-package")
@@ -43,9 +45,9 @@ object CucumberPlugin extends Plugin with CucumberIntegration {
     (argTask, cucumberTestSettings, cucumberOptions, cucumberOutput, streams) map(testWithCucumber)
 
   protected def cucumberSettingsTask: Initialize[Task[CucumberSettings]] =
-    (cucumberMaxMemory, cucumberMaxPermGen, fullClasspath in Test, streams) map {
-      (mm, mpg, cp, s) => {
-        CucumberSettings(mm, mpg, cp.toList.map(_.data), LoggedOutput(s.log))
+    (cucumberMaxMemory, cucumberMaxPermGen, cucumberSystemProperties, cucumberJVMOptions, fullClasspath in Test, streams) map {
+      (mm, mpg, sp, jvmopt, cp, s) => {
+        CucumberSettings(mm, mpg, sp, jvmopt, cp.toList.map(_.data), LoggedOutput(s.log))
       }
     }
 
@@ -83,10 +85,12 @@ object CucumberPlugin extends Plugin with CucumberIntegration {
 
     cucumberMaxMemory := "256M",
     cucumberMaxPermGen := "64M",
+    cucumberSystemProperties := Map.empty[String, String],
+    cucumberJVMOptions := Nil,
 
     cucumberFeaturesDir <<= (baseDirectory) { _ / "src" / "test" / "features" },
     cucumberStepsBasePackage := "",
-    cucumberExtraOptions := List[String](),
+    cucumberExtraOptions := List.empty[String],
 
     cucumberPrettyReport := false,
     cucumberHtmlReport := false,

src/main/scala/templemore/xsbt/cucumber/CucumberSettings.scala

@@ -8,6 +8,8 @@ import sbt.OutputStrategy
  */
 case class CucumberSettings(maxMemory: String,
                             maxPermGen: String,
+                            systemProperties: Map[String, String],
+                            jvmOptions: List[String],
                             classpath: List[File],
                             outputStrategy: OutputStrategy)
 

testProjects/multiModuleTestProject/project/Build.scala

@@ -5,7 +5,7 @@ import templemore.xsbt.cucumber.CucumberPlugin
 object BuildSettings {
   val buildOrganization = "templemore"
   val buildScalaVersion = "2.9.2"
-  val buildVersion      = "0.6.0"
+  val buildVersion      = "0.6.1"
 
   val buildSettings = Defaults.defaultSettings ++
                       Seq (organization := buildOrganization,

testProjects/multiModuleTestProject/project/plugins.sbt

@@ -1,3 +1,3 @@
 resolvers += Resolver.file("Local Repo", file((Path.userHome / ".m2" / "repository").toString))
 
-addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.0")
+addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.1")

testProjects/testProject/build.sbt

@@ -1,6 +1,6 @@
 name := "test-project"
 
-version := "0.6.0"
+version := "0.6.1"
 
 organization := "templemore"
 
@@ -19,3 +19,8 @@ cucumberHtmlReport := true
 cucumberJunitReport := true 
 
 cucumberJsonReport := true
+
+cucumberSystemProperties := Map("testing" -> "true", "demo" -> "yes")
+
+cucumberJVMOptions := List("-showversion", "-esa")
+

testProjects/testProject/project/plugin.sbt

@@ -1,3 +1,5 @@
-resolvers += Resolver.file("Local Repo", file((Path.userHome / ".m2" / "repository").toString))
+resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
+
+addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.1")
+
 
-addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.0")

testProjects/testProject/src/test/scala/test/CucumberJarStepDefinitions.scala

@@ -19,5 +19,7 @@ class CucumberJarStepDefinitions extends ScalaDsl with EN with ShouldMatchers {
   Then("""^Cucumber is executed against the features and step definitions$""") { () =>
     givenCalled should be (true)
     whenCalled should be (true)
+    System.getProperty("testing") should be ("true")
+    System.getProperty("demo") should be ("yes")
   }
 }

testProjects/testProject2_10/build.sbt

@@ -1,6 +1,6 @@
 name := "test-project"
 
-version := "0.6.0"
+version := "0.6.1"
 
 organization := "templemore"
 

testProjects/testProject2_10/project/plugin.sbt

@@ -1,3 +1,3 @@
 resolvers += Resolver.file("Local Repo", file((Path.userHome / ".m2" / "repository").toString))
 
-addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.0")
+addSbtPlugin("templemore" % "xsbt-cucumber-plugin" % "0.6.1")