cucumber-tcl 0.0.6 → 0.0.7

data/CONTRIBUTING.md

@@ -23,6 +23,7 @@ To become a release manager, create a pull request adding your name to the list
 Current release managers:
   * [Matt Wynne](https://rubygems.org/profiles/mattwynne)
   * [Jonathan Owers](https://rubygems.org/profiles/jowers)
+  * [Shaun Bristow](https://rubygems.org/profiles/ahhbristow)
 
 To grant release privilege, issue the following command:
 

data/README.md

@@ -88,3 +88,15 @@ and in your step definition, you might have
       puts "The first item I bought was [lindex $items 0]"
     }
 
+Resetting state between scenarios
+---------------------------------
+
+Depending on how your test and/or application code is structured, there may be a chance of data persisting between scenarios, which could result in tests that pass or fail unexpectedly.  To eliminiate the risk of this, Cucumber TCL will start a new TCL interpreter between every scenario by creating a new instance of the 'framework' object, meaning that the env.tcl file is loaded each time.  Whilst this will remove the data leakage risk, it may also cause your scenarios to run slowly if there is a lot of setup required for a scenario to run (eg, setting up fixture data, building a database or loading large amounts of data into memory).  To override the default behaviour of starting up a new interpreter, an environment variable can be passed into the 'cucumber' command enabling the sharing of the TCL interpreter via the 'framework' object:
+
+    cucumber SHARE_FRAMEWORK=1
+
+It's also possible to make the default behaviour of starting up a new interpreter explicit:
+
+    cucumber SHARE_FRAMEWORK=0
+
+If you are wrapping Cucumber around poorly understood legacy TCL code, you may wish to enable sharing of the framework object (and thus avoid starting a new TCL interpreter) during development in the interests of running tests quickly, but retain the default behaviour in your CI build to remove the risk of data leakage if you think there is a chance of this.

data/cucumber-tcl.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.9.3"
 
   s.add_dependency 'ruby-tcl', '~> 0.1.1'
-  s.add_dependency 'cucumber', '~> 2.0.0.rc.4'
+  s.add_dependency 'cucumber', '~> 2.0.0'
 
   s.add_development_dependency 'rspec', '~> 3.2'
   s.add_development_dependency 'aruba', '~> 0.6'

data/features/file_sourcing.feature

@@ -1,5 +1,76 @@
 Feature: Sourcing tcl files
 
+  Scenario: Source files in the appropriate order (no command line options)
+    Given a file named "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given testing file sourcing
+      """
+    And a file named "features/step_definitions/steps_a.tcl" with:
+      """
+      puts "Sourced step_definitions/steps_a.tcl"
+      """
+    And a file named "features/step_definitions/steps_b.tcl" with:
+      """
+      puts "Sourced step_definitions/steps_b.tcl"
+      """
+    And a file named "features/support/db.tcl" with:
+      """
+      puts "Sourced support/db.tcl"
+      """
+    And a file named "features/support/env.rb" with:
+      """
+      require 'cucumber/tcl'
+      """
+    And a file named "features/support/env.tcl" with:
+      """
+      puts "Sourced support/env.tcl"
+      """
+    When I run `cucumber`
+    Then it should pass with:
+      """
+      Sourced support/env.tcl
+      Sourced support/db.tcl
+      Sourced step_definitions/steps_a.tcl
+      Sourced step_definitions/steps_b.tcl
+      """
+
+  Scenario: Source files in the appropriate order (with command line options)
+    Given a file named "myfeatures/group one/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given testing file sourcing
+      """
+    And a file named "myfeatures/step definitions/steps.tcl" with:
+      """
+      puts "Sourced step definitions/steps.tcl"
+      """
+    And a file named "myfeatures/support/db.tcl" with:
+      """
+      puts "Sourced support/db.tcl"
+      """
+    And a file named "myfeatures/support/debug.tcl" with:
+      """
+      puts "Sourced support/debug.tcl"
+      """
+    And a file named "myfeatures/support/env.rb" with:
+      """
+      require 'cucumber/tcl'
+      """
+    And a file named "myfeatures/support/env.tcl" with:
+      """
+      puts "Sourced support/env.tcl"
+      """
+    When I run `cucumber 'myfeatures/group one/test.feature' --require myfeatures --exclude 'debug.*'`
+    Then it should pass with:
+      """
+      Sourced support/env.tcl
+      Sourced support/db.tcl
+      Sourced step definitions/steps.tcl
+      """
+
   Scenario: Display stack trace when there is an error in a sourced file
     Given a file named "features/test.feature" with:
       """
@@ -23,7 +94,10 @@ Feature: Sourcing tcl files
       "error "Fail sourcing""
           (file "features/support/helper.tcl" line 1)
           invoked from within
-      "source $x" (Tcl::Error)
+      "source features/support/helper.tcl"
+          ("uplevel" body line 1)
+          invoked from within
+      "uplevel #0 [list source $file]" (Tcl::Error)
       """
 
   Scenario: Display stack trace with multiple levels
@@ -56,5 +130,8 @@ Feature: Sourcing tcl files
       "test_proc"
           (file "features/support/helper.tcl" line 5)
           invoked from within
-      "source $x" (Tcl::Error)
+      "source features/support/helper.tcl"
+          ("uplevel" body line 1)
+          invoked from within
+      "uplevel #0 [list source $file]" (Tcl::Error)
       """

data/features/reset_state.feature

@@ -3,7 +3,14 @@ Feature: Reset state
   In order to keep state from leaking between scenarios, by default,
   we create a new Tcl interpreter for each test case.
 
-  Scenario: Set a global variable in one scenario and access it in another
+  In order to prevent long setup time before each scenario
+  we can optionally avoid starting a new TCL interpreter
+
+  Rules:
+    -- The state is maintained between scenarios if an environment variable is passed into Cucumber
+    -- Otherwise a new TCL interpreter is started and state is reset on each scenario
+
+  Background:
     Given a file named "features/test.feature" with:
       """
       Feature:
@@ -30,8 +37,25 @@ Feature: Reset state
       """
       require 'cucumber/tcl'
       """
+	
+  Scenario: State reset when running 'cucumber' with no options
     When I run `cucumber`
     Then it should fail with:
+       """
+       can't read "::g": no such variable
+       """
+
+  Scenario: State reset when running 'cucumber' with a new framework object for each scenario
+    When I run `cucumber SHARE_FRAMEWORK=0`
+    Then it should fail with:
+       """
+       can't read "::g": no such variable
+       """
+
+  Scenario: State not reset when running 'cucumber' and sharing framework object
+    When I run `cucumber SHARE_FRAMEWORK=1`
+    Then it should pass with:
       """
-      can't read "::g": no such variable
+      2 scenarios (2 passed)
+      3 steps (3 passed)
       """

data/lib/cucumber/tcl.rb

@@ -13,9 +13,23 @@ module Cucumber
   module Tcl
 
     def self.install(cucumber_config)
-      create_step_definitions = lambda {
-        StepDefinitions.new(Framework.new)
-      }
+      # Unless configured off, we should start up a new
+      # framework for each scenario, which results
+      # in a new TCL interpreter.  This can be used
+      # to check that there is no data leakage between
+      # scenarios when testing poorly understood code
+      share_framework = (ENV['SHARE_FRAMEWORK'] == '1')
+
+      if !share_framework
+          create_step_definitions = lambda {
+            StepDefinitions.new(Framework.new(cucumber_config))
+          }
+      else
+          framework = Framework.new(cucumber_config)
+          create_step_definitions = lambda {
+            StepDefinitions.new(framework)
+          }
+      end
       cucumber_config.filters << ActivateSteps.new(create_step_definitions)
     end
 

data/lib/cucumber/tcl/framework.rb

@@ -3,8 +3,12 @@ module Cucumber
     class Framework
       TCL_FRAMEWORK_PATH = File.dirname(__FILE__) + '/framework.tcl'
 
-      def initialize(path = TCL_FRAMEWORK_PATH)
+      def initialize(cucumber_config = nil, path = TCL_FRAMEWORK_PATH)
         @tcl = ::Tcl::Interp.load_from_file(path)
+
+        all_files_to_load = cucumber_config.nil? ? [] : cucumber_config.all_files_to_load
+        all_files_to_load.collect! {|f| f.gsub(/([\\\s{}])/, '\\\\\1')}
+        @tcl.proc('source_files').call(all_files_to_load.join(' '))
       end
 
       def step_definition_exists?(step_name)

data/lib/cucumber/tcl/framework.tcl

@@ -10,6 +10,7 @@ namespace eval ::cucumber:: {
     set TEST 0
   }
 
+  namespace export source_files
   namespace export step_definition_exists
   namespace export execute_step_definition
   namespace export Given
@@ -102,14 +103,43 @@ proc ::cucumber::_search_steps {step_name {execute 0} {multiline_args {}}} {
   return 0
 }
 
-proc ::cucumber::source_steps args {
+# Sort a list of files such that: */support/env.{ext} < */support/{file} < */{file}
+proc ::cucumber::_sort_by_source_priority {a b} {
+
+  if {[string equal [lindex [file split $a] end-1] "support"]} {
+    if {[string equal [file rootname [lindex [file split $a] end]] "env"]} {
+      set a_order 1
+    } else {
+      set a_order 2
+    }
+  } else {
+    set a_order 3
+  }
+
+  if {[string equal [lindex [file split $b] end-1] "support"]} {
+    if {[string equal [file rootname [lindex [file split $b] end]] "env"]} {
+      set b_order 1
+    } else {
+      set b_order 2
+    }
+  } else {
+    set b_order 3
+  }
+
+  return [expr {$a_order - $b_order}]
+}
+
+proc ::cucumber::source_files {files} {
   variable TEST
 
   if {$TEST ne 1} {
-    #TODO let that path be configurable from cucumber-ruby
-    foreach x [glob -nocomplain features/**/*.tcl] {
-      if {[catch {source $x} msg]} {
-        error $::errorInfo
+    foreach file [lsort -command _sort_by_source_priority $files] {
+      if {[string equal [file extension $file] ".tcl"]} {
+        if {[catch {
+          uplevel #0 [list source $file]
+        }]} {
+          error $::errorInfo
+        }
       }
     }
   }
@@ -120,4 +150,3 @@ proc ::cucumber::pending args {
 }
 
 namespace import ::cucumber::*
-::cucumber::source_steps

data/lib/cucumber/tcl/test/test_framework.tcl

@@ -121,6 +121,56 @@ test Then-1 {calling Then adds a new entry to the STEPS list} {
 
 
 
+#
+# Test _sort_by_source_priority procedure
+#
+test _sort_by_source_priority-1 {_sort_by_source_priority prioritises support/env.{ext} over other support/ files} {
+  -body {
+    set sort [::cucumber::_sort_by_source_priority "test/support/abc.ext" "test/support/env.ext"]
+    # only interested if sort is +ve, 0 or -ve; convert to 1, 0 or -1
+    expr { $sort == 0 ? 0 : $sort / abs($sort) }
+  }
+  -result 1
+}
+
+test _sort_by_source_priority-2 {_sort_by_source_priority prioritises support/env.{ext} over other support/ files} {
+  -body {
+    set sort [::cucumber::_sort_by_source_priority "test/support/env.ext" "test/support/abc.ext"]
+    # only interested if sort is +ve, 0 or -ve; convert to 1, 0 or -1
+    expr { $sort == 0 ? 0 : $sort / abs($sort) }
+  }
+  -result -1
+}
+
+test _sort_by_source_priority-3 {_sort_by_source_priority prioritises support/ files over other files} {
+  -body {
+    set sort [::cucumber::_sort_by_source_priority "test/features/abc.ext" "test/support/abc.ext"]
+    # only interested if sort is +ve, 0 or -ve; convert to 1, 0 or -1
+    expr { $sort == 0 ? 0 : $sort / abs($sort) }
+  }
+  -result 1
+}
+
+test _sort_by_source_priority-4 {_sort_by_source_priority prioritises support/ files over other files} {
+  -body {
+    set sort [::cucumber::_sort_by_source_priority "test/support/abc.ext" "test/features/abc.ext"]
+    # only interested if sort is +ve, 0 or -ve; convert to 1, 0 or -1
+    expr { $sort == 0 ? 0 : $sort / abs($sort) }
+  }
+  -result -1
+}
+
+test _sort_by_source_priority-5 {_sort_by_source_priority prioritises non support/ files equally} {
+  -body {
+    set sort [::cucumber::_sort_by_source_priority "test/lib/abc.ext" "test/etc/abc.ext"]
+    # only interested if sort is +ve, 0 or -ve; convert to 1, 0 or -1
+    expr { $sort == 0 ? 0 : $sort / abs($sort) }
+  }
+  -result 0
+}
+
+
+
 #
 # Test _search_steps procedure
 #

data/lib/cucumber/tcl/version

@@ -1 +1 @@
-0.0.6
+0.0.7

data/spec/cucumber/tcl/fixtures/everything_ok.tcl

@@ -1,3 +1,6 @@
+proc source_files { files } {
+}
+
 proc execute_step_definition { step_name } {
 }
 

data/spec/cucumber/tcl/step_definitions_spec.rb

@@ -12,7 +12,7 @@ module Cucumber::Tcl
 
     it "can activate a passing tcl step" do
       path = File.dirname(__FILE__) + '/fixtures/everything_ok.tcl'
-      tcl_framework = Framework.new(path)
+      tcl_framework = Framework.new(nil, path)
       step_definitions = StepDefinitions.new(tcl_framework)
       expect(step_definitions.attempt_to_activate(test_step).location).to eq location
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-tcl
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-tcl
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc.4
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc.4
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,6 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: cucumber-tcl-0.0.6
+summary: cucumber-tcl-0.0.7
 test_files: []
 has_rdoc: