Fixed issue skipoleschris#15. Templemore repository is now added as a resolver to any project using the plugin.

Fixed issue skipoleschris#14. It is now possible to run cucumber in the IntegrationTest config.

Author: skipoleschris

Diff for: .gitignore

@@ -5,3 +5,5 @@ project/target
 .idea/workspace.xml
 .ensime_port
 xsbt-cucumber-plugin.sublime-workspace
+deploy-repo
+

Diff for: README.markdown

@@ -3,8 +3,8 @@ xsbt-cucumber-plugin
 
 An [sbt 0.12.x](https://github.com/harrah/xsbt/wiki) plugin for running [Cucumber](http://cukes.info) features.
 
-### IMPORTANT NOTES ABOUT THIS RELEASE (0.7.0) ###
-It adds the ability to run cucumber as a standalone SBT task but also as a test runner within the standard 'test' task. To facilitate this, there has been one significant change that you should be aware of: the default location for feature files has changed from the src/test/features directory to the classpath. This is required as running as a test framework only has access to the test classpath. Features should therefore now live under src/test/resources. It is possible to change this back to another location by overriding the cucumberFeaturesLocation setting, but if you change this to anything other than the classpath then the 'test' task will not be able to find features.
+### IMPORTANT NOTES ABOUT THIS RELEASE (0.7.x) ###
+It adds the ability to run cucumber as a standalone SBT task but also as a test runner within the standard 'test' task (either within the Test or within the IntegrationTest configs). To facilitate this, there has been one significant change that you should be aware of: the default location for feature files has changed from the src/test/features directory to the classpath. This is required as running as a test framework only has access to the test classpath. Features should therefore now live under src/test/resources. It is possible to change this back to another location by overriding the cucumberFeaturesLocation setting, but if you change this to anything other than the classpath then the 'test' task will not be able to find features.
 
 ## Overview ##
 Provides the ability to run Cucumber-jvm within the SBT environment. Originally based on the [cuke4duke-sbt-plugin](https://github.com/rubbish/cuke4duke-sbt-plugin) by rubbish and my original implementation for SBT 0.7.x. Specifics for this release:
@@ -49,6 +49,24 @@ It is also possible to filter exactly which features get executed by using the t
       test-only mypackage.CucumberSuite -- @demo
       test-only mypackage.CucumberSuite -- "User admin"
 
+## Usage - Integration Test Framework ##
+Install the plugin and additional integration test framework integration (see later). Feature files MUST go in the 'src/it/resources' directory as only the classpath is visible to test frameworks. Step definitions go in 'src/it/scala'. 
+
+There must also be present somewhere in the test code the following class:
+
+  class CucumberSuite extends templemore.sbt.cucumber.RunCucumber
+
+This is required to trigger cucumber to run (as SBT only runs tests that extends a specific base class or have a specific annotation). There MUST only be one instance of a class extending RunCucumber in the test code as we only want cucumber to be executed once! Finally from the sbt console call the task:
+
+    it:test
+
+Note that none of the configuration options apply when running via a test framework. This is because the SBT integration test integration does not allow any access to these settings. Cucumber will be executed with pretty output to the console, searching the classpath from its root for features and executing all tests found in packages.
+
+It is also possible to filter exactly which features get executed by using the test-only task. To do this, specify the CucumberSuite that you defined above as the test to run and then use either the tag or name approach already described as the test arguments:
+
+      it:test-only mypackage.CucumberSuite -- @demo
+      it:test-only mypackage.CucumberSuite -- "User admin"
+
 ## Writing Features ##
 Features are written in text format and are placed in .feature files inside the 'src/test/resources' directory. For more info on writing features please see the [Cucumber](http://cukes.info) website.
 For example:
@@ -102,7 +120,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" % "sbt-cucumber-plugin" % "0.7.0")
+    addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.1")
 
 ### Basic Configuration ###
 To add the cucumber plugin settings to a basic project, just add the following to the build.sbt file:
@@ -142,6 +160,17 @@ If you wish to support cucumber running as a test framework (via the test task)
                                   settings = Defaults.defaultSettings ++ 
                                              CucumberPlugin.cucumberSettingsWithTestPhaseIntegration)
 
+#### Running as an integration test framework ####
+If you wish to support cucumber running as an integration test framework (via the it:test task) then use this alternative settings group instead:
+
+    lazy val myProject = Project ("my-project", file ("."),
+                                  settings = Defaults.defaultSettings ++ 
+                                             CucumberPlugin.cucumberSettingsWithIntegrationTestPhaseIntegration)
+                                   .configs(IntegrationTest)
+                                   .settings(Defaults.itSettings : _*)
+
+This will ensure the necessary jars and test frameworks are installed in the IntegrationTest config as opposed to the normal Test config. For more information about setting up an IntegrationTest config see the testProjects/integrationTestIntegrationProject or http://www.scala-sbt.org/release/docs/Detailed-Topics/Testing.
+
 ## Customisation ##
 The plugin supports a number of customisations and settings. Note that these setting customisations only apply to running using the standalone 'cucumber' task. Running cucumber as a test framework does not support any customisation options.
 
@@ -184,6 +213,11 @@ Requests for features can be posted to the issues list or emailed to the author.
 
 ## Release History ##
 
+### 0.7.1 ###
+
+Fix for issue #15. The templemore repository is now added as a resolver to the project when the plugin is added.
+Fix for issue #14. It is now possible to run cucumber within the IntegrationTest config.
+
 ### 0.7.0 ###
 
 Significant refactor to support running cucumber via the standalone 'cucumber' task or integrated as test framework that can run as part of the standard SBT 'test' task.

Diff for: plugin/src/main/scala/templemore/sbt/cucumber/CucumberPlugin.scala

@@ -10,7 +10,7 @@ import templemore.sbt.util._
  */
 object CucumberPlugin extends Plugin with Integration {
 
-  private val projectVersion = "0.7.0"
+  private val projectVersion = "0.7.1"
 
   type LifecycleCallback = () => Unit
 
@@ -69,6 +69,7 @@ object CucumberPlugin extends Plugin with Integration {
     if ( scalaVersion.startsWith("2.10") ) "cucumber.api.cli.Main" else "cucumber.cli.Main"
 
   val cucumberSettings: Seq[Setting[_]] = Seq(
+    resolvers += "Templemore Repository" at "http://templemore.co.uk/repo",
     libraryDependencies += "templemore" %% "sbt-cucumber-integration" % projectVersion % "test",
 
     cucumber <<= inputTask(cucumberTask),
@@ -103,4 +104,9 @@ object CucumberPlugin extends Plugin with Integration {
   val cucumberSettingsWithTestPhaseIntegration = cucumberSettings ++ Seq(
     testFrameworks += new TestFramework("templemore.sbt.cucumber.CucumberFramework")
   ) 
+
+  val cucumberSettingsWithIntegrationTestPhaseIntegration = cucumberSettings ++ Seq(
+    testFrameworks in IntegrationTest += new TestFramework("templemore.sbt.cucumber.CucumberFramework"),
+    libraryDependencies += "templemore" %% "sbt-cucumber-integration" % projectVersion % "it"
+  ) 
 }

Diff for: project/Build.scala

@@ -4,7 +4,7 @@ import Keys._
 object Settings {
   val buildOrganization = "templemore"
   val buildScalaVersion = "2.9.2"
-  val buildVersion      = "0.7.0"
+  val buildVersion      = "0.7.1"
 
   val buildSettings = Defaults.defaultSettings ++
                       Seq (organization  := buildOrganization,

Diff for: testProjects/integrationTestIntegrationProject/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+target
+project/boot
+project/target
+project/plugins/target
+project/plugins/project

Diff for: testProjects/integrationTestIntegrationProject/project/Build.scala

@@ -0,0 +1,33 @@
+import sbt._
+import Keys._
+import templemore.sbt.cucumber.CucumberPlugin
+
+object BuildSettings {
+  val buildOrganization = "templemore"
+  val buildScalaVersion = "2.9.2"
+  val buildVersion      = "0.7.1"
+
+  val buildSettings = Defaults.defaultSettings ++
+                      Seq (organization := buildOrganization,
+                           scalaVersion := buildScalaVersion,
+                           version      := buildVersion)
+
+  val cucumberSettings = CucumberPlugin.cucumberSettingsWithIntegrationTestPhaseIntegration ++
+                         Seq(CucumberPlugin.cucumberHtmlReport := true,
+                             CucumberPlugin.cucumberPrettyReport := true)
+}
+
+object Dependencies {
+
+  val scalaTest = "org.scalatest" %% "scalatest" % "1.7.2" % "it"
+}
+
+object TestProjectBuild extends Build {
+  import Dependencies._
+  import BuildSettings._
+
+  lazy val integrationTestProject = Project ("integration-test-project", file ("."),
+           settings = buildSettings ++ cucumberSettings ++ Seq (libraryDependencies += scalaTest))
+           .configs(IntegrationTest)
+           .settings(Defaults.itSettings : _*)
+}

Diff for: testProjects/integrationTestIntegrationProject/project/build.properties

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

Diff for: testProjects/integrationTestIntegrationProject/project/plugin.sbt

@@ -0,0 +1,5 @@
+resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
+
+addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.1")
+
+

Diff for: testProjects/integrationTestIntegrationProject/src/it/resources/features/CucumberJar.feature

@@ -0,0 +1,10 @@
+@example-jar
+Feature: Cucumber in Jar Project
+  In order to implement BDD in my Scala project
+  As a developer
+  I want to be able to run Cucumber from with SBT
+
+  Scenario: Execute feature in a Jar Project
+    Given an SBT project
+    When the cucumber task is called
+    Then Cucumber is executed against the features and step definitions

Diff for: testProjects/integrationTestIntegrationProject/src/it/scala/test/CucumberJarStepDefinitions.scala

@@ -0,0 +1,26 @@
+package test
+
+import cucumber.runtime.{EN, ScalaDsl}
+import org.scalatest.matchers.ShouldMatchers
+import templemore.sbt.cucumber.RunCucumber
+
+class CucumberJarStepDefinitions extends ScalaDsl with EN with ShouldMatchers {
+
+  private var givenCalled = false
+  private var whenCalled = false
+
+  Given("""^an SBT project$""") { () =>
+    givenCalled = true
+  }
+
+  When("""^the cucumber task is called$""") { () =>
+    whenCalled = true
+  }
+
+  Then("""^Cucumber is executed against the features and step definitions$""") { () =>
+    givenCalled should be (true)
+    whenCalled should be (true)
+  }
+}
+
+class CucumberSuite extends RunCucumber

Diff for: testProjects/multiModuleTestProject/project/Build.scala

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

Diff for: testProjects/multiModuleTestProject/project/plugins.sbt

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

Diff for: testProjects/testIntegrationProject/build.sbt

@@ -1,6 +1,6 @@
 name := "test-project"
 
-version := "0.7.0"
+version := "0.7.1"
 
 organization := "templemore"
 

Diff for: testProjects/testIntegrationProject/project/plugin.sbt

@@ -1,5 +1,5 @@
 resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
 
-addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.0")
+addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.1")
 
 

Diff for: testProjects/testProject/project/plugin.sbt

@@ -1,5 +1,5 @@
 resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
 
-addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.0")
+addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.1")
 
 

Diff for: testProjects/testProject2_10/build.sbt

@@ -1,6 +1,6 @@
 name := "test-project2_10"
 
-version := "0.7.0"
+version := "0.7.1"
 
 organization := "templemore"
 

Diff for: testProjects/testProject2_10/project/plugin.sbt

@@ -1,3 +1,3 @@
 resolvers += "Templemore Repository" at "http://templemore.co.uk/repo"
 
-addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.0")
+addSbtPlugin("templemore" % "sbt-cucumber-plugin" % "0.7.1")