vagrant-cucumber 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.0.4 (August 8, 2013)
+
+ * Added missing license detail to Gem spec
+ * Improve use of Given/When/Then in examples as per idiomatic Cucumber usage
+ * Refactor to get shell runner helper into the glue and out of the step definitions
+ * Added details on how to contribute to the project
+
+ With thanks to Matt Wynne (@mattwynne) for feedback
+
 ## 0.0.3 (July 26, 2013)
 
  * Update dependencies for vagrant-multiprovider-snap

data/CONTRIBUTING.md

@@ -0,0 +1,32 @@
+Contributing to vagrant-cucumber
+================================
+
+We welcome contributions to vagrant-cucumber, either to fix bugs or to add new features.
+
+Patch workflow
+--------------
+
+ * Fork the project.
+ * Create a branch for your changes.
+ * Don't modify the version number or changelog - we'll do that on release.
+ * Send a pull request
+
+
+Working with the code
+---------------------
+
+We use Bundler to manage the development environment with the latest version of Vagrant and its dependencies.  Assuming you have Bundler installed, running ```bundle install``` in the project root will set the environment up for you.
+
+
+Testing
+-------
+
+vagrant-cucumber is a reasonably thin glue layer, so doesn't need a whole lot of testing in its current incarnation.  As long as the published example features work, you can be confident your changes haven't broken anything.  To test this, run:
+
+```
+cd example
+bundle exec vagrant cucumber
+```
+
+If you add any new behaviour to vagrant-cucumber, please add a feature file to
+the ```example/``` folder which demonstrates how to use it.

data/example/Vagrantfile

@@ -1,3 +1,5 @@
+Vagrant.require_plugin('vagrant-cucumber')
+
 Vagrant.configure("2") do |config|
 
     config.vm.box     = "precise64"

data/example/features/basic.feature

@@ -3,8 +3,8 @@ Feature: VM Running
     Scenario: Check we can run simple commands
 
         Given there is a running VM called "vm1"
-        Then running the shell command `id` should succeed
-        And the stdout of that shell command should match /vagrant/
+        When I run the shell command `id`
+        Then the stdout of that shell command should match /vagrant/
         And the stdout of that shell command should not match /root/
         And the stderr of that shell command should match /^$/
 
@@ -12,19 +12,18 @@ Feature: VM Running
     Scenario: Check we can run commands as root
 
         Given there is a running VM called "vm1"
-        Then running the shell command `id` as root should succeed
-        And the stdout of that shell command should match /root/
+        When I run the shell command `id` as root
+        Then the stdout of that shell command should match /root/
         And the stdout of that shell command should not match /vagrant/
 
 
     Scenario: Write a file so that we can check we're rolling back properly
 
         Given there is a running VM called "vm1"
-
         Then running the shell command `grep test /tmp/cucumber-written-file` should fail
 
-        When I run the shell command `echo test > /tmp/cucumber-written-file`, it should succeed
-        And running the shell command `grep test /tmp/cucumber-written-file` should succeed
+        When I run the shell command `echo test > /tmp/cucumber-written-file`
+        Then running the shell command `grep test /tmp/cucumber-written-file` should succeed
 
         When I roll back the VM called "vm1"
         Then running the shell command `grep test /tmp/cucumber-written-file` should fail

data/lib/vagrant-cucumber/glue.rb

@@ -88,6 +88,54 @@ module VagrantPlugins
                     end
                 end
 
+
+                attr_reader :last_shell_command_status
+                attr_reader :last_shell_command_output
+
+                def execute_on_vm ( command, machine, opts = {} )
+
+                    @last_shell_command_output = {
+                        :stdout => '',
+                        :stderr => '',
+                    }
+
+                    @last_shell_command_status = nil
+
+                    machine.communicate.tap do |comm|
+
+                        @last_shell_command_status = comm.execute(
+                            command, {
+                                :error_check => false,
+                                :sudo        => opts[:as_root]
+                            }
+                        ) do |type,data|
+
+                            if @vagrant_cucumber_debug
+                                puts "[:#{type}] #{data.chomp}"
+                            end
+
+                            @last_shell_command_output[type] += data
+
+                        end
+
+                    end
+
+                    if opts[:expect_nonzero]
+
+                        if @last_shell_command_status != 0
+                            raise "Expected command to return non-zero, got #{@last_shell_command_status}"
+                        end
+
+                    elsif opts.has_key?(:expect)
+
+                        if @last_shell_command_status != opts[:expect]
+                            raise "Expected command to return #{opts[:expect]}, got #{@last_shell_command_status}"
+                        end
+
+                    end
+
+                end
+
             end
 
 

data/lib/vagrant-cucumber/plugin.rb

@@ -8,6 +8,8 @@ module VagrantPlugins
     module Cucumber 
         class Plugin < Vagrant.plugin("2")
 
+            Vagrant.require_plugin("vagrant-multiprovider-snap")
+
             name "Cucumber"
 
             description <<-DESC

data/lib/vagrant-cucumber/step_definitions.rb

@@ -21,52 +21,40 @@ end
 
 Then /^(?:running|I run) the shell command `(.*)`(| as root)(#{VMRE})(?:|, it) should (succeed|fail)$/ do |command,as_root,vmre,condition|
 
-    @last_shell_command_output = {
-        :stdout => '',
-        :stderr => '',
-    }
-
-    @last_shell_command_status = nil
-
-    machine = vagrant_glue.identified_vm(vmre)
-    machine.communicate.tap do |comm|
+    options = {
+        :as_root          => ( as_root == ' as root' ),
+        :expect_non_zero  => ( condition == 'fail' ),
+    } 
 
-        @last_shell_command_status = comm.execute( 
-            command, { 
-                :error_check => false,
-                :sudo        => as_root == ' as root',
-            } 
-        ) do |type,data|
+    if condition == 'succeed'
+        options[:expect] = 0
+    end
 
-            if @vagrant_cucumber_debug
-                puts "[:#{type}] #{data.chomp}"
-            end
+    vagrant_glue.execute_on_vm( command, vagrant_glue.identified_vm(vmre), options )
 
-            @last_shell_command_output[type] += data
+end
 
-        end 
+Then /^(?:running|I run) the shell command `(.*)`(| as root)(#{VMRE})$/ do |command,as_root,vmre|
 
-    end
+    options = {
+        :machine          => vagrant_glue.identified_vm(vmre),
+        :as_root          => ( as_root == ' as root' ),
+    }
 
-    if @last_shell_command_status == 0 and condition == 'fail'
-        raise "Expected command to fail, but got 0 exit status"
-    end
-
-    if @last_shell_command_status != 0 and condition == 'succeed'
-        raise "Expected command to succeed but got #{@last_shell_command_status} exit status"
-    end
+    vagrant_glue.execute_on_vm( command, vagrant_glue.identified_vm(vmre), options )
 
 end
 
+
 Then /^the (.+) of that shell command should(| not) match (\/.+\/)$/ do |stream,condition,re|
 
     stream.downcase!
 
-    unless @last_shell_command_output.has_key?( stream.to_sym )
-        raise "@last_shell_command_output structure has no #{stream}"
+    unless vagrant_glue.last_shell_command_output.has_key?( stream.to_sym )
+        raise "vagrant_glue.last_shell_command_output structure has no #{stream}"
     end
 
-    re_result = ( @last_shell_command_output[stream.to_sym] =~ re.to_regexp )
+    re_result = ( vagrant_glue.last_shell_command_output[stream.to_sym] =~ re.to_regexp )
     re_matched = !re_result.nil?
 
     should_match = condition != ' not'

data/lib/vagrant-cucumber/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Cucumber
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/vagrant-cucumber.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/scalefactory/vagrant-cucumber"
   s.summary     = %q{Cucumber support for Vagrant}
   s.description = %q{This plugin makes it possible for Cucumber to interact with Vagrant}
+  s.license     = 'MIT'
 
   s.rubyforge_project = "vagrant-cucumber"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-cucumber
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70119409963120 !ruby/object:Gem::Requirement
+  requirement: &70291725096880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *70119409963120
+  version_requirements: *70291725096880
 - !ruby/object:Gem::Dependency
   name: vagrant-multiprovider-snap
-  requirement: &70119409962620 !ruby/object:Gem::Requirement
+  requirement: &70291725111160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *70119409962620
+  version_requirements: *70291725111160
 - !ruby/object:Gem::Dependency
   name: to_regexp
-  requirement: &70119409962160 !ruby/object:Gem::Requirement
+  requirement: &70291725109880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70119409962160
+  version_requirements: *70291725109880
 description: This plugin makes it possible for Cucumber to interact with Vagrant
 email:
 - jon@scalefactory.com
@@ -52,6 +52,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - example/Vagrantfile
@@ -70,7 +71,8 @@ files:
 - lib/vagrant-cucumber/version.rb
 - vagrant-cucumber.gemspec
 homepage: https://github.com/scalefactory/vagrant-cucumber
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: