rspec-system 1.7.1 → 2.0.0

data/.gitignore

@@ -6,3 +6,4 @@ doc/
 vendor/
 .bundle
 spec/reports/
+.rspec_system/

data/CHANGELOG.md

@@ -1,11 +1,50 @@
-1.7.1
+2.0.0
 =====
 
-This fixes the nokogiri 1.6.0 issue, whereby that version no longer supports Ruby 1.8.7 any more. Instead we have pinned nokogiri to 1.5.x.
+This major release adds some syntactical sugar, providing the user with the ability to use helpers in subjects.
 
-#### Detailed Changes
+So for example, where before you could use `shell` as a helper:
+
+    describe 'shell tests' do
+      it 'test 1' do
+        shell('cat /etc/hosts') do |r|
+          r.stdout.should =~ /localhost/
+          r.stderr.should be_empty
+          r.exit_code.should be_zero
+        end
+      end
+    end
+
+Now you can use it as the subject of a `describe` or `context`:
+
+    describe 'shell tests' do
+      context shell 'cat /etc/hosts' do
+        its(:stdout) { should =~ /localhost/ }
+        its(:stderr) { should be_empty }
+        its(:exit_code) { should be_zero }
+      end
+    end
+
+The helper `rcp` has also been modified to benefit from this change:
+
+    describe 'rcp tests' do
+      context rcp :dp => '/tmp/foo', :sp => '/tmp/foo' do
+        its(:success) { should be_true }
+      end
+    end
+
+The fact that you can use the helpers in both places should provide the user with greater flexibility to create more succinct tests, while still providing simple sequences of commands in a single test when needed as before.
+
+This facility is also available to other plugins by providing a new `RSpecSystem::Helper` object that can be extended to provide a new helper with all the syntactic sugar features as the core methods `shell` and `rcp`.
+
+As part of this release, we have also removed some prior deprecations:
+
+* The system_* methods no longer work: system_run, system_rcp and system_node
+* system_setup_block no longer works.
+
+Before upgrading, we suggest you upgrade to 1.7.0, paying heed to any deprecation warnings before upgrading to 2.0.0.
 
-* Fix nokogiri for 1.8.7 (Ken Barber)
+#### Detail Changes
 
 -------------------------------
 

data/README.md

@@ -46,21 +46,25 @@ An example file would look like this:
     require 'spec_helper_system'
 
     describe 'basics' do
+      # Here we use the 'shell' helper as a subject
+      context shell 'cat /etc/hosts' do
+        its(:stdout) { should =~ /localhost/ }
+        its(:stderr) { should be_empty }
+        its(:exit_code) { should be_zero }
+      end
+
       it 'should cat /etc/resolv.conf' do
+        # Here we run the shell command as a helper
         shell 'cat /etc/hosts' do |r|
           r.stdout.should =~ /localhost/
-          r.exit_code.should be_zero
           r.stderr.should be_empty
+          r.exit_code.should be_zero
         end
       end
     end
 
 Also consult the examples in the `examples` directory in the source of this library for more details.
 
-For your reference, here are the list of custom rspec configuration items that can be overriden in your `spec_helper_system.rb` file:
-
-* *system_tmp* - For some of our activity, we require a temporary file area. By default we just a random temporary path, so you normally do not need to set this.
-
 Currently to get the nice formatting rspec-system specific formatter its recommended to use the Rake task, so add the following to your `Rakefile`:
 
     require 'rspec-system/rake_task'

data/lib/rspec-system.rb

@@ -5,7 +5,9 @@ module RSpecSystem; end
 
 require 'rspec-system/util'
 require 'rspec-system/log'
+require 'rspec-system/helper'
 require 'rspec-system/helpers'
+require 'rspec-system/internal_helpers'
 require 'rspec-system/node_set'
 require 'rspec-system/prefab'
 require 'rspec-system/node'

data/lib/rspec-system/helper.rb

@@ -0,0 +1,160 @@
+require 'rspec-system'
+require 'rspec-system/result'
+require 'rspec-system/internal_helpers'
+
+module RSpecSystem
+  # This class represents an abstract 'helper' object.
+  #
+  # It provides some DSL and convenience helpers to create rspec-system
+  # compatible helper objects so others can create their own helper methods
+  # with the same syntactical sugar.
+  #
+  # Start by sub-classing this feature and providing your own #execute
+  # method, name & properties declaration. See other sub-classes for examples
+  # on proper usage.
+  #
+  # @abstract Subclass and override methods to create a helper object
+  class Helper
+    include RSpecSystem::InternalHelpers
+
+    # Cache of previous result data
+    # @api private
+    attr_reader :rd
+
+    # Options when called
+    attr_reader :opts
+
+    class << self
+      attr_accessor :name_value
+
+      # DSL method for setting the helper name
+      #
+      # @param name [String] unique helper method name
+      def name(name)
+        @name_value = name
+      end
+
+      # Accepts a list of properties to automatically create
+      #
+      # @param props [Array <Symbol>] an array of property methods to create
+      def properties(*props)
+        props.each do |prop|
+          define_method(prop) { result_data.send(prop) }
+        end
+      end
+    end
+
+    # Setup the helper object.
+    #
+    # Here we establish laziness detection, provide the default :node setting
+    # and handle been called as a block automatically for the consumer. This is
+    # the main setup for the magic that is behind these helper objects.
+    #
+    # This initialize method is usually not overridden for simple cases, but can
+    # be overridden for the purposes of munging options and providing defaults.
+    #
+    # @abstract Override, but make sure you call super(opts, clr, &block)
+    def initialize(opts, clr, &block)
+      dn = default_node
+
+      # This is a test for the context of how this command was called
+      #
+      # If clr is Class or Object then it could be called as a subject, and it
+      # should lazy execute its action.
+      lazy = nil
+      if [Class, Object].include?(clr.class) # presumes being used as a subject
+        lazy = true
+      elsif clr.is_a? RSpec::Core::ExampleGroup # anything inside an 'it'
+        lazy = false
+      else
+        # We presume everything else wants results immediately
+        lazy = false
+      end
+
+      opts = {
+        :node => opts[:n] || dn,
+        :n => opts[:node] || dn,
+        :lazy => lazy,
+      }.merge(opts)
+
+      @opts = opts
+      r = result_data unless opts[:lazy]
+
+      # If called as a block, yield the result as a block
+      if block_given?
+        yield(self)
+      end
+    end
+
+    # This method is executed to retrieve the data for this helper. It is always
+    # overridden by sub-classes.
+    #
+    # Here we perform the actual step to retrieve the helper data, returning
+    # the result as a basic hash which gets stored for later retrieval via the
+    # helper object.
+    #
+    # @return [Hash <Symbol, Any>] return a hash of results, with symbolic keys
+    # @abstract Always override this method with your own execution routine.
+    def execute
+      raise "The #execute method has not be overridden in this class"
+    end
+
+    # Internal method to return any result data from resource execution time
+    #
+    # If there are no previous results, it will execute the resource action
+    # and return those result. The action only runs once, so subsequent
+    # requests return the last result.
+    #
+    # @return [RSpecSystem::Result] result object
+    # @api private
+    def result_data
+      return rd unless rd.nil?
+      @rd = RSpecSystem::Result.new(execute)
+    end
+
+    # Refresh the data, re-running the action associated with this helper.
+    #
+    # @return [void]
+    def refresh
+      @rd = nil
+      result_data
+      nil
+    end
+
+    # Allow run as an alias to refresh
+    alias_method :run, :refresh
+
+    # This allows the data to be treated as a hash
+    #
+    # @param key [Symbol] key of value to retrieve
+    def [](key)
+      result_data[key]
+    end
+
+    # Retrieve the data from this helper object as a hash
+    #
+    # @return [Hash] result data as a hash
+    def to_hash
+      result_data.to_hash
+    end
+
+    # Return the helper name of this helper object
+    #
+    # @return [String] name of helper
+    def name
+      self.class.name_value
+    end
+
+    # String representation of helper
+    #
+    # @return [String] helper_name(args) formatted string
+    def to_s
+      name + "(" + opts.inspect + ")"
+    end
+
+    # Return default node
+    def default_node
+      rspec_system_node_set.default_node
+    end
+  end
+end

data/lib/rspec-system/helpers.rb

@@ -1,4 +1,6 @@
 require 'rspec-system/result'
+require 'rspec-system/helpers/shell'
+require 'rspec-system/helpers/rcp'
 
 # This module contains the main rspec helpers that are to be used within
 # rspec-system tests. These are the meat-and-potatoes of your system tests,
@@ -56,22 +58,6 @@ module RSpecSystem::Helpers
   # @!group Actions
 
   # @!macro shell_method
-  #   @api public
-  #   @overload $0(options)
-  #     @param options [Hash] options for command execution
-  #     @option options [String] :command command to execute. Mandatory.
-  #     @option options [String] :c alias for :command
-  #     @option options [RSpecSystem::Node] :node (defaults to what was defined
-  #       default in your YAML file, otherwise if there is only one node it uses
-  #       that) specifies node to execute command on.
-  #     @option options [RSpecSystem::Node] :n alias for :node
-  #   @overload $0(command)
-  #     @param command [String] command to execute
-  #   @yield [result] yields result when called as a block
-  #   @yieldparam result [RSpecSystem::Result] result of run containing
-  #     :exit_code, :stdout and :stderr
-  #   @return [RSpecSystem::Result] result of run containing :exit_code,
-  #     :stdout and :stderr
 
   # Runs a shell command on a test host.
   #
@@ -88,7 +74,20 @@ module RSpecSystem::Helpers
   # to worry about that.
   #
   # @api public
-  # @macro shell_method
+  # @api public
+  # @overload $0(options)
+  #   @param options [Hash] options for command execution
+  #   @option options [String] :command command to execute. Mandatory.
+  #   @option options [String] :c alias for :command
+  #   @option options [RSpecSystem::Node] :node (defaults to what was defined
+  #     default in your YAML file, otherwise if there is only one node it uses
+  #     that) specifies node to execute command on.
+  #   @option options [RSpecSystem::Node] :n alias for :node
+  # @overload $0(command)
+  #   @param command [String] command to execute
+  # @yield [result] yields result when called as a block
+  # @yieldparam result [RSpecSystem::Helpers::Shell] result of run
+  # @return [RSpecSystem::Helpers::Shell] result of run
   # @example Using it as a helper
   #   it 'test a command' do
   #     shell 'cat /etc/hosts' do |r|
@@ -111,61 +110,15 @@ module RSpecSystem::Helpers
   #     end
   #   end
   def shell(options, &block)
-    ns = rspec_system_node_set
-    dn = ns.default_node
-
     # If options is a string, turn the string into a command in the normal
     # options hash.
     if options.is_a?(String)
       options = {:c => options}
     end
 
-    # Defaults etc.
-    options = {
-      :node => options[:n] || dn,
-      :n => options[:node] || dn,
-      :c => options[:command],
-      :command => options[:c],
-    }.merge(options)
-
-    if options[:c].nil?
-      raise "Cannot use shell with no :command option"
-    end
-
-    result = RSpecSystem::Result.new(ns.run(options))
-
-    if block_given?
-      yield(result)
-    else
-      result
-    end
-  end
-
-  # Legacy method for running a shell command.
-  #
-  # @deprecated Use {#shell} instead
-  # @macro shell_method
-  def system_run(options, &block)
-    log.warn('system_run is deprecated, use shell instead')
-
-    shell(options, &block)
+    RSpecSystem::Helpers::Shell.new(options, self, &block)
   end
 
-  # @!macro rcp_method
-  #   @param options [Hash] options for command execution
-  #   @option options [String] :source_path source to copy files from (currently
-  #      only locally)
-  #   @option options [String] :sp alias for source_path
-  #   @option options [String] :destination_path destination for copy
-  #   @option options [String] :dp alias for dest_path
-  #   @option options [RSpecSystem::Node] :destination_node (default_node) destination node
-  #     to transfer files to. Optional.
-  #   @option options [RSpecSystem::Node] :d alias for destination_node
-  #   @option options [RSpecSystem::Node] :source_node ('') Reserved
-  #     for future use. Patches welcome.
-  #   @option options [RSpecSystem::Node] :s alias for source_node
-  #   @return [Bool] returns true if successful
-
   # Remotely copy files to a test host
   #
   # Just specify a source path, destination path, and optionally a destination
@@ -175,56 +128,41 @@ module RSpecSystem::Helpers
   # node provider, however this abstraction should mean you shouldn't need
   # to worry about that.
   #
-  # @macro rcp_method
+  # @param options [Hash] options for command execution
+  # @option options [String] :source_path source to copy files from (currently
+  #    only locally)
+  # @option options [String] :sp alias for source_path
+  # @option options [String] :destination_path destination for copy
+  # @option options [String] :dp alias for dest_path
+  # @option options [RSpecSystem::Node] :destination_node (default_node) destination node
+  #   to transfer files to. Optional.
+  # @option options [RSpecSystem::Node] :d alias for destination_node
+  # @option options [RSpecSystem::Node] :source_node ('') Reserved
+  #   for future use. Patches welcome.
+  # @option options [RSpecSystem::Node] :s alias for source_node
+  # @yield [result] yields result when called as a block
+  # @yieldparam result [RSpecSystem::Helpers::Rcp] result of rcp
+  # @return [RSpecSystem::Helpers::Rcp] result of rcp
   # @example Copying a path remotely
   #   describe 'test running' do
   #     it 'copy my files' do
   #       rcp :sp => 'mydata', :dp => '/srv/data'.should be_true
   #     end
   #   end
-  def rcp(options)
-    ns = rspec_system_node_set
-    options = {
-      :source_path => options[:sp],
-      :destination_path => options[:dp],
-      :dp => options[:destination_path],
-      :sp => options[:source_path],
-      :destination_node => ns.default_node,
-      :d => ns.default_node,
-      :source_node => nil,
-      :s => nil,
-    }.merge(options)
-
-    d = options[:d]
-    sp = options[:sp]
-    dp = options[:dp]
-
-    log.info("rcp from #{sp} to #{d.name}:#{dp} executed")
-    ns.rcp(options)
-  end
-
-  # Legacy method for copying a file to a test host
-  #
-  # @deprecated Use {#rcp} instead
-  # @macro rcp_method
-  def system_rcp(options)
-    log.warn('system_rcp is deprecated, use rcp instead')
-    rcp(options)
+  def rcp(options, &block)
+    RSpecSystem::Helpers::Rcp.new(options, self, &block)
   end
 
   # @!group Queries
 
-  # @!macro node_method
-  #   @param options [Hash] search criteria
-  #   @option options [String] :name the canonical name of the node
-  #   @return [RSpecSystem::Node] node object
-
   # Returns a particular node object from the current nodeset given a set of
   # criteria.
   #
   # If no options are supplied, it tries to return the default node.
   #
-  # @macro node_method
+  # @param options [Hash] search criteria
+  # @option options [String] :name the canonical name of the node
+  # @return [RSpecSystem::Node] node object
   def node(options = {})
     ns = rspec_system_node_set
     options = {
@@ -239,13 +177,4 @@ module RSpecSystem::Helpers
       return ns.nodes[name]
     end
   end
-
-  # Legacy method for querying nodes
-  #
-  # @deprecated Use {#node} instead
-  # @macro node_method
-  def system_node(options = {})
-    log.warn('system_node is deprecated, use node instead')
-    node(options)
-  end
 end

data/lib/rspec-system/helpers/rcp.rb

@@ -0,0 +1,37 @@
+require 'rspec-system'
+
+module RSpecSystem::Helpers
+  # Helper object behind RSpecSystem::Helpers#shell
+  class Rcp < RSpecSystem::Helper
+    name 'rcp'
+    properties :success
+
+    def initialize(opts, clr, &block)
+      ns = rspec_system_node_set
+      opts = {
+        :source_path => opts[:sp],
+        :destination_path => opts[:dp],
+        :dp => opts[:destination_path],
+        :sp => opts[:source_path],
+        :destination_node => ns.default_node,
+        :d => ns.default_node,
+        :source_node => nil,
+        :s => nil,
+      }.merge(opts)
+
+      super(opts, clr, &block)
+    end
+
+    # Gathers new results by executing the resource action
+    def execute
+      ns = rspec_system_node_set
+      d = opts[:d]
+      sp = opts[:sp]
+      dp = opts[:dp]
+
+      log.info("rcp from #{sp} to #{d.name}:#{dp} executed")
+      result = ns.rcp(opts)
+      { :success => result }
+    end
+  end
+end

data/lib/rspec-system/helpers/shell.rb

@@ -0,0 +1,37 @@
+require 'rspec-system'
+
+module RSpecSystem::Helpers
+  # Helper object behind RSpecSystem::Helpers#shell
+  class Shell < RSpecSystem::Helper
+    name 'shell'
+    properties :stdout, :stderr, :exit_code
+
+    # Initializer for Shell object.
+    #
+    # This should be initialized via the helper method, not directly.
+    #
+    # @api private
+    # @param opts [Hash] options hash
+    # @param clr [Object] caller object
+    # @param block [Proc] code block
+    # @see RSpecSystem::Helpers#shell helper method
+    def initialize(opts, clr, &block)
+      # Defaults
+      opts = {
+        :c => opts[:command],
+        :command => opts[:c],
+      }.merge(opts)
+
+      if opts[:c].nil?
+        raise "Cannot use shell with no :command or :c option"
+      end
+
+      super(opts, clr, &block)
+    end
+
+    # Gathers new results by executing the resource action
+    def execute
+      rspec_system_node_set.run(opts)
+    end
+  end
+end

data/lib/rspec-system/internal_helpers.rb

@@ -0,0 +1,98 @@
+require 'rspec-system'
+
+# This is a helper module that exposes some internal helpers used by the main
+# public ones, also the startup and teardown routines.
+#
+# @api private
+module RSpecSystem::InternalHelpers
+  # Return the path to the nodeset file
+  #
+  # @return [Pathname]
+  def nodeset
+    Pathname.new(File.join(File.basename(__FILE__), '..', '.nodeset.yml'))
+  end
+
+  # Return the path to the custom prefabs file
+  #
+  # @return [Pathname]
+  def custom_prefabs_path
+    Pathname.new(File.expand_path(File.join(File.basename(__FILE__), '..', '.prefabs.yml')))
+  end
+
+  # Return the path to the temporary directory
+  #
+  # @return [Pathname]
+  def rspec_system_tmp
+    path = ENV["RSPEC_SYSTEM_TMP"] || File.expand_path(File.join(File.basename(__FILE__), '..', '.rspec_system'))
+    FileUtils.mkdir_p(path)
+    Pathname.new(path)
+  end
+
+  # Return the nodeset configuration hash
+  #
+  # @return [Hash] nodeset configuration
+  def rspec_system_config
+    YAML.load_file('.nodeset.yml')
+  end
+
+  # Grab the type of virtual environment we wish to run these tests in
+  #
+  # @return [String] current virtual env type
+  def rspec_virtual_env
+    ENV["RSPEC_VIRTUAL_ENV"] || 'vagrant'
+  end
+
+  # Defines if a set will be destroyed before and after tests
+  #
+  # @return [Boolean]
+  def rspec_destroy
+    return false if ENV["RSPEC_DESTROY"] =~ /(no|false)/
+    return true
+  end
+
+  # Return the current nodeset object
+  #
+  # @return [RSpecSystem::NodeSet::Base] current nodeset object
+  def rspec_system_node_set
+    setname = ENV['RSPEC_SET'] || rspec_system_config['default_set']
+    config = rspec_system_config['sets'][setname]
+    options = {}
+    options[:destroy] = rspec_destroy
+    RSpecSystem::NodeSet.create(setname, config, rspec_virtual_env, custom_prefabs_path, options)
+  end
+
+  # Start all nodes
+  #
+  # @return [void]
+  def start_nodes
+    ns = rspec_system_node_set
+
+    puts "Starting nodes"
+    puts
+    puts "Setname is: " + ns.setname
+    puts "Configuration is: " + ns.config.pretty_inspect
+    puts "Virtual Environment type is: #{ns.env_type}"
+    puts "Default node is: #{ns.default_node.name}"
+    puts "Destroy node is: #{ns.destroy}"
+    puts
+
+    ns.setup
+
+    puts
+    puts "Finished starting nodes"
+    puts "================================================================="
+    nil
+  end
+
+  # Stop all nodes
+  #
+  # @return [void]
+  def stop_nodes
+    puts 'Stopping nodes'
+    puts
+    rspec_system_node_set.teardown
+    puts 'Finished stopping nodes'
+    puts "================================================================="
+    nil
+  end
+end

data/lib/rspec-system/node.rb

@@ -1,6 +1,10 @@
+require 'rspec-system'
+
 module RSpecSystem
   # This class represents a node in a nodeset
   class Node
+    include RSpecSystem::InternalHelpers
+
     # Static helper for generating a node direct from the hash returned by
     # the nodeset YAML file.
     #
@@ -77,5 +81,19 @@ module RSpecSystem
     def provider_specifics
       @provider_specifics
     end
+
+    # Return name when stringified
+    #
+    # @return [String] name of node
+    def to_s
+      name
+    end
+
+    # Return name when inspected
+    #
+    # @return [String] name of node
+    def inspect
+      name
+    end
   end
 end

data/lib/rspec-system/node_set/base.rb

@@ -48,7 +48,7 @@ module RSpecSystem
     # @param opts [Hash] options hash containing :n (node) and :c (command)
     # @return [Hash] a hash containing :stderr, :stdout and :exit_code
     # @abstract Override this method providing your own shell running code
-    def run(options)
+    def run(opts)
       raise "Unimplemented method #run"
     end
 
@@ -60,7 +60,7 @@ module RSpecSystem
     # @option opts [String] :dp destination path
     # @return [Boolean] returns true if command succeeded, false otherwise
     # @abstract Override this method providing your own file transfer code
-    def rcp(options)
+    def rcp(opts)
       raise "Unimplemented method #rcp"
     end
 

data/lib/rspec-system/result.rb

@@ -1,11 +1,21 @@
+require 'rspec-system'
 require 'ostruct'
 
 module RSpecSystem
-  # This class represents a result from a helper command
+  # This class represents raw results from a helper command
   class Result < OpenStruct
-    # Returns the value of a member.
+    # Returns the value of a member, with hash syntax.
+    #
+    # @param name [String, Symbol] name of parameter to retrieve
     def [](name)
       @table[name.to_sym]
     end
+
+    # Return a hash
+    #
+    # @return [Hash] a hash representation of the results
+    def to_hash
+      @table
+    end
   end
 end

data/lib/rspec-system/spec_helper.rb

@@ -10,90 +10,17 @@ include RSpecSystem::Helpers
 
 RSpec.configure do |c|
   include RSpecSystem::Log
+  include RSpecSystem::InternalHelpers
   c.include RSpecSystem::Helpers
+  c.include RSpecSystem::InternalHelpers
+  c.extend RSpecSystem::Helpers
 
   # This provides a path to save vagrant files
   c.add_setting :system_tmp
-  # Block to execute for environment setup
-  c.add_setting :system_setup_block
   # Storage for ssh channels
   c.add_setting :ssh_channels, :default => {}
   c.add_setting :rspec_storage, :default => {}
 
-  def nodeset
-    Pathname.new(File.join(File.basename(__FILE__), '..', '.nodeset.yml'))
-  end
-
-  def custom_prefabs_path
-    File.expand_path(File.join(File.basename(__FILE__), '..', '.prefabs.yml'))
-  end
-  
-  def rspec_system_tmp
-    path = ENV["RSPEC_SYSTEM_TMP"] || File.expand_path(File.join(File.basename(__FILE__), '..', '.rspec_system'))
-    FileUtils.mkdir_p(path)
-    path
-  end
-
-  def rspec_system_config
-    YAML.load_file('.nodeset.yml')
-  end
-
-  # Grab the type of virtual environment we wish to run these tests in
-  def rspec_virtual_env
-    ENV["RSPEC_VIRTUAL_ENV"] || 'vagrant'
-  end
-
-  # Defines if a set will be destroyed before and after tests
-  def rspec_destroy
-    return false if ENV["RSPEC_DESTROY"] =~ /(no|false)/
-    return true
-  end
-
-  def rspec_system_node_set
-    setname = ENV['RSPEC_SET'] || rspec_system_config['default_set']
-    config = rspec_system_config['sets'][setname]
-    options = {}
-    options[:destroy] = rspec_destroy
-    RSpecSystem::NodeSet.create(setname, config, rspec_virtual_env, custom_prefabs_path, options)
-  end
-
-  def start_nodes
-    ns = rspec_system_node_set
-
-    puts "Starting nodes"
-    puts
-    puts "Setname is: " + ns.setname
-    puts "Configuration is: " + ns.config.pretty_inspect
-    puts "Virtual Environment type is: #{ns.env_type}"
-    puts "Default node is: #{ns.default_node.name}"
-    puts "Destroy node is: #{ns.destroy}"
-    puts
-
-    ns.setup
-
-    puts
-    puts "Finished starting nodes"
-    puts "================================================================="
-  end
-
-  def stop_nodes
-    puts 'Stopping nodes'
-    puts
-    rspec_system_node_set.teardown
-    puts 'Finished stopping nodes'
-    puts "================================================================="
-  end
-
-  def call_custom_setup_block
-    # Run test specific setup routines
-    if pr = RSpec.configuration.system_setup_block then
-      log.info "Running custom setup block"
-      log.warn "The system_setup_block methodology will be deprecated in the next major release, use before :suite instead"
-      pr.call
-      log.info "Finished running custom setup block"
-    end
-  end
-
   # Default the system_tmp dir to something random
   c.system_tmp = rspec_system_tmp
 
@@ -101,7 +28,6 @@ RSpec.configure do |c|
     # Before Suite exceptions get captured it seems
     begin
       start_nodes
-      call_custom_setup_block
     rescue => ex
       puts ex.inspect + " in"
       puts ex.backtrace.join("\n  ")

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "1.7.1"
+  s.version     = "2.0.0"
   s.authors     = ["Ken Barber"]
   s.email       = ["ken@bob.sh"]
   s.homepage    = "https://github.com/puppetlabs/rspec-system"

data/spec/spec_helper_system.rb

@@ -1,10 +1,17 @@
 require 'rspec-system/spec_helper'
 
+# A localized module for storing project specific helpers
 module LocalHelpers
+  # Return the project root
+  #
+  # @return [Pathname] root directory of project
   def proj_root
     Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), '..')))
   end
 
+  # Return the fixture directory
+  #
+  # @return [Pathname] test fixture directory
   def fixture_root
     proj_root + 'spec' + 'fixtures'
   end
@@ -16,11 +23,4 @@ RSpec.configure do |c|
   c.before :suite do
     shell 'echo foobar > /tmp/setupblock'
   end
-
-  # NOTE: this is deprecated, but we do this for legacy testing purposes
-  # with the next major release we should remove this capability, and remove
-  # the test. Do not use this in your own tests any more!
-  c.system_setup_block = proc do
-    shell 'echo foobar > /tmp/setupblockold'
-  end
 end

data/spec/system/rcp_spec.rb

@@ -1,29 +1,30 @@
 require 'spec_helper_system'
 
 describe "rcp:" do
-  it 'check rcp works' do
+  it 'check rcp works with block matchers' do
     rcp(
       :sp => fixture_root + 'example_dir',
-      :dp => '/tmp/example_destination'
-    )
+      :dp => '/tmp/example_destination1'
+    ) do |r|
+      r.success.should be_true
+    end
 
-    shell 'cat /tmp/example_destination/example_file' do |r|
+    shell 'cat /tmp/example_destination1/example_file' do |r|
       r.exit_code.should be_zero
       r.stdout.should =~ /Test content 1234/
     end
   end
 
-  context 'legacy tests' do
-    it 'check system_rcp works' do
-      system_rcp(
-        :sp => fixture_root + 'example_dir',
-        :dp => '/tmp/example_destination'
-      )
+  it 'check rcp works outside a block' do
+    r = rcp(
+      :sp => fixture_root + 'example_dir',
+      :dp => '/tmp/example_destination2'
+    )
+    r.success.should be_true
 
-      shell 'cat /tmp/example_destination/example_file' do |r|
-        r.exit_code.should be_zero
-        r.stdout.should =~ /Test content 1234/
-      end
+    shell 'cat /tmp/example_destination2/example_file' do |r|
+      r.exit_code.should be_zero
+      r.stdout.should =~ /Test content 1234/
     end
   end
 end

data/spec/system/shell_spec.rb

@@ -14,6 +14,12 @@ describe "shell:" do
     end
   end
 
+  it 'ensure it can be used outside a block' do
+    shell 'echo foobar > /tmp/foobarbaz'
+    r = shell 'cat /tmp/foobarbaz'
+    r.stdout.should =~ /foobar/
+  end
+
   it "cat /etc/hosts - test results using hash method" do
     shell "cat /etc/hosts" do |r|
       r[:exit_code].should be_zero
@@ -74,6 +80,39 @@ describe "shell:" do
     r.exit_code.should be_zero
   end
 
+  describe 'use in subject' do
+    context shell 'cat /etc/hosts' do
+      its(:stdout) { should =~ /localhost/ }
+      its(:exit_code) { should be_zero }
+      its(:stderr) { should be_empty }
+    end
+  end
+
+  context 'should not be lazy in a before :each block' do
+    before :each do
+      shell('echo foobarbaz > /tmp/eachblock')
+    end
+    context shell 'cat /tmp/eachblock' do
+      its(:stdout) { should =~ /foobarbaz/ }
+    end
+  end
+
+  context 'should not be lazy in a before inside its own context' do
+    context shell 'cat /tmp/eachblock2' do
+      before :each do
+        shell('echo foobarbaz > /tmp/eachblock2')
+      end
+      its(:stdout) { should =~ /foobarbaz/ }
+    end
+  end
+
+  it 'should be able to make shell lazy' do
+    shell(:c => 'echo foobarbaz > /tmp/forcelazy', :lazy => true)
+    shell 'cat /tmp/forcelazy' do |r|
+      r.stdout.should be_empty
+    end
+  end
+
   context 'legacy tests' do
     it 'cat /etc/hosts - test results using hash method' do
       shell 'cat /etc/hosts' do |r|
@@ -81,18 +120,22 @@ describe "shell:" do
         r[:stdout].should =~ /localhost/
       end
     end
+  end
+end
 
-    it 'cat /etc/hosts - using system_run' do
-      system_run 'cat /etc/hosts' do |r|
-        r.exit_code.should be_zero
-        r.stdout.should =~ /localhost/
-      end
-    end
+# Test as a top-level subject
+describe shell('cat /etc/hosts') do
+  its(:stdout) { should =~ /localhost/ }
+  its(:stderr) { should be_empty }
+  its(:exit_code) { should be_zero }
+end
 
-    it 'cat /tmp/setupblockold to ensure the system_setup_block still works' do
-      shell 'cat /tmp/setupblockold' do |r|
-        r.stdout.should =~ /foobar/
-      end
-    end
-  end
+# Test as an explicit subject, this is a bad example but put here for complete-
+# ness. The problem is that the subject will get called each time, so its not
+# recommended to use it ths way.
+describe 'cat /etc/hosts' do
+  subject { shell('cat /etc/hosts') }
+  its(:stdout) { should =~ /localhost/ }
+  its(:stderr) { should be_empty }
+  its(:exit_code) { should be_zero }
 end

data/spec/unit/helper_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe 'RSpecSystem::Helper' do
+  let(:node) { mock() }
+
+  before :each do
+    # Always stub default_node
+    RSpecSystem::Helper.any_instance.stubs(:default_node).returns(node)
+  end
+
+  context '#initialize' do
+    it 'should be instantiatable' do
+      RSpecSystem::Helper.any_instance.expects(:result_data).returns({})
+      RSpecSystem::Helper.new({}, self)
+    end
+
+    it 'called as a block, should execute block and return itself' do
+      RSpecSystem::Helper.any_instance.expects(:result_data)
+      block_exec = nil
+      RSpecSystem::Helper.new({}, self) do |r|
+        r.class.should == RSpecSystem::Helper
+        block_exec = true
+      end
+      block_exec.should be_true
+    end
+  end
+
+  context '#refresh' do
+    it 'should only be called once even if data requested again' do
+      RSpecSystem::Helper.any_instance.expects(:execute).once.returns({:test => true})
+      r = RSpecSystem::Helper.new({}, self)
+      r[:test].should be_true
+      r[:test].should be_true
+    end
+
+    it 'should call execute again' do
+      RSpecSystem::Helper.any_instance.expects(:execute).once
+      r = RSpecSystem::Helper.new({}, self)
+      r.expects(:execute).once
+      r.refresh
+    end
+  end
+
+  context '#[]' do
+    it 'should retrieve result data as a hash element' do
+      rd = RSpecSystem::Result.new(:test => true)
+      RSpecSystem::Helper.any_instance.expects(:result_data).twice.returns(rd)
+      r = RSpecSystem::Helper.new({}, self)
+      r[:test].should be_true
+    end
+  end
+
+  context '#result_data' do
+    it 'no initial result data request if lazy' do
+      RSpecSystem::Helper.any_instance.expects(:result_data).never
+      RSpecSystem::Helper.new({:lazy => true}, self)
+    end
+
+    it 'when lazy, will call result_data on first data request' do
+      RSpecSystem::Helper.any_instance.expects(:result_data).never
+      r = RSpecSystem::Helper.new({:lazy => true}, self)
+      r.expects(:result_data).returns(RSpecSystem::Result.new(:test => true))
+      r[:test].should be_true
+    end
+  end
+
+  context '#to_hash' do
+    it 'should call result_data.to_hash' do
+      rd = mock()
+      rd.expects(:to_hash).once.returns({:test => true})
+      RSpecSystem::Helper.any_instance.stubs(:result_data).returns(rd)
+      r = RSpecSystem::Helper.new({}, self)
+      r.to_hash.should == {:test => true}
+    end
+  end
+end

data/spec/unit/result_spec.rb

@@ -10,4 +10,12 @@ describe RSpecSystem::Result do
     result = subject.class.new(:foo => 'bar')
     result[:foo].should == 'bar'
   end
+
+  it 'should allow you to retreive the full hash' do
+    result = subject.class.new(:foo => 'bar', :baz => 'bam')
+    result.to_hash.should == {
+      :foo => 'bar',
+      :baz => 'bam',
+    }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -150,7 +150,11 @@ files:
 - examples/spec/system/test3_spec.rb
 - lib/rspec-system.rb
 - lib/rspec-system/formatter.rb
+- lib/rspec-system/helper.rb
 - lib/rspec-system/helpers.rb
+- lib/rspec-system/helpers/rcp.rb
+- lib/rspec-system/helpers/shell.rb
+- lib/rspec-system/internal_helpers.rb
 - lib/rspec-system/log.rb
 - lib/rspec-system/node.rb
 - lib/rspec-system/node_set.rb
@@ -173,6 +177,7 @@ files:
 - spec/spec_helper_system.rb
 - spec/system/rcp_spec.rb
 - spec/system/shell_spec.rb
+- spec/unit/helper_spec.rb
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
 - spec/unit/result_spec.rb
@@ -205,6 +210,7 @@ summary: System testing with rspec
 test_files:
 - spec/system/rcp_spec.rb
 - spec/system/shell_spec.rb
+- spec/unit/helper_spec.rb
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
 - spec/unit/result_spec.rb