rspec-system 2.0.0 → 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+2.1.0
+=====
+
+This is a small feature release, that includes the ability for custom prefabs to be 'merged' with the inbuilt ones. This is a convenience, so that one can override the box definitions without having to also provide new Fact details (for example).
+
+#### Detailed Changes
+
+* Bundle exec should be used (Hunter Haugen)
+* Align bundler instructions based on @hunner previous patch (Ken Barber)
+* Perform deep merge of custom prefabs (Dominic Cleal)
+* Fix yard doc error for Helpers (Ken Barber)
+
+-------------------------------
+
 2.0.0
 =====
 
@@ -44,7 +58,13 @@ As part of this release, we have also removed some prior deprecations:
 
 Before upgrading, we suggest you upgrade to 1.7.0, paying heed to any deprecation warnings before upgrading to 2.0.0.
 
-#### Detail Changes
+#### Detailed Changes
+
+* Fix yarddoc for rcp (Ken Barber)
+* Remove deprecations in prep for 2 (Ken Barber)
+* More sugar through lazy helper object (Ken Barber)
+* Fix 2 yard errors (Ken Barber)
+* Minor improvements to tests and apidocs (Ken Barber)
 
 -------------------------------
 

data/README.md

@@ -20,9 +20,9 @@ However it is usually recommended to include it in your `Gemfile` and let bundle
 
 Then installing with:
 
-    bundle install --path vendor
+    bundle install --path vendor/bundle
 
-If your using git, add `.rspec_system` to your project's `.gitignore` file.  This is the default location for files created by rspec-system.
+If you're using git, add `.rspec_system` to your project's `.gitignore` file.  This is the default location for files created by rspec-system.
 
 ### Writing tests
 
@@ -92,7 +92,7 @@ The file must adhere to the Kwalify schema supplied in `resources/kwalify-schema
 * `sets`: Each set contains a series of nodes, and is given a unique name. You can create sets with only 1 node if you like.
 * `sets -> [setname] -> nodes`: Node definitions for a set. Each node needs a unique name so you can address each one individualy if you like.
 * `sets -> [setname] -> nodes -> [name] -> prefab`: This relates to the prefabricated node template you wish to use. Currently this is the only way to launch a node. Look in `resources/prefabs.yml` for more details.
-* `default_set`: this is the default set to run if none are provided with `rake spec:system`. This should be the most common platform normally.
+* `default_set`: this is the default set to run if none are provided with `bundle exec rake spec:system`. This should be the most common platform normally.
 
 ### Prefabs
 
@@ -162,7 +162,7 @@ Make sure you have already installed:
 
 Once these are ready, you can Run the system tests with:
 
-    rake spec:system
+    bundle exec rake spec:system
 
 The VM's should be downloaded from the internet, started and tests should run.
 
@@ -175,7 +175,7 @@ Instead of switches, we use a number of environment variables to modify the beha
 
 So if you wanted to run an alternate nodeset you could use:
 
-    RSPEC_SET=fedora18 rake spec:system
+    RSPEC_SET=fedora18 bundle exec rake spec:system
 
 In Jenkins you should be able to use RSPEC\_SET in a test matrix, thus obtaining quite a nice integration and visual display of nodesets in Jenkins.
 
@@ -203,7 +203,7 @@ This provider has a lot more options for setup, in the form of environment varia
 
 Set these variables, and run the usual rake command:
 
-    rake spec:system
+    bundle exec rake spec:system
 
 In Jenkins, set the authentication variables above using environment variable injection. I recommend using the private environment variables feature for user & pass however so these do not get displayed in the console output. As with the vagrant provider however, turn RSPEC\_SET into a test matrix, containing all the sets you want to test against.
 
@@ -269,10 +269,9 @@ The setup for a job is basically:
         set +e
     
         [[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"
-        rvm use ruby-2.0.0@some_unique_name_here --create
-    
-        bundle update
-        rake spec:system
+        rvm use ruby-2.0.0
+        bundle install --path vendor/bundle
+        bundle exec rake spec:system
 
 I went quite complex and had Github pull request integration working with this, and quite a few other nice features. If you need help setting it up get in touch.
 
@@ -297,7 +296,7 @@ The setup for a job is basically:
         set +e
         [[ -s "$HOME/.rvm/scripts/rvm" ]] && source "$HOME/.rvm/scripts/rvm"
         rvm use ruby-2.0.0
-        bundle install --vendor
+        bundle install --path vendor/bundle
         bundle exec rake spec:system
 
 Basically the results were quite nice, as apposed to the 'vagrant' provider I was able to achieve running parallel jobs using my matrix setup.

data/lib/rspec-system/helpers.rb

@@ -57,8 +57,6 @@ require 'rspec-system/helpers/rcp'
 module RSpecSystem::Helpers
   # @!group Actions
 
-  # @!macro shell_method
-
   # Runs a shell command on a test host.
   #
   # When invoked as a block a result hash is yielded to the block as a
@@ -73,9 +71,7 @@ module RSpecSystem::Helpers
   # node provider, however this abstraction should mean you shouldn't need
   # to worry about that.
   #
-  # @api public
-  # @api public
-  # @overload $0(options)
+  # @overload shell(options)
   #   @param options [Hash] options for command execution
   #   @option options [String] :command command to execute. Mandatory.
   #   @option options [String] :c alias for :command
@@ -83,7 +79,7 @@ module RSpecSystem::Helpers
   #     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)
+  # @overload shell(command)
   #   @param command [String] command to execute
   # @yield [result] yields result when called as a block
   # @yieldparam result [RSpecSystem::Helpers::Shell] result of run

data/lib/rspec-system/prefab.rb

@@ -1,6 +1,8 @@
 module RSpecSystem
   # This object represents a prefab definition from the prefabs.yml file
   class Prefab
+    extend RSpecSystem::Util
+
     attr_reader :name
     attr_reader :description
     attr_reader :facts
@@ -15,7 +17,7 @@ module RSpecSystem
       end
 
       prefabs = YAML.load_file(File.join(File.dirname(__FILE__), '..', '..', 'resources', 'prefabs.yml'))
-      prefabs.merge!(custom_prefabs)
+      deep_merge!(prefabs, custom_prefabs)
       raise "No such prefab" unless pf = prefabs[name]
 
       RSpecSystem::Prefab.new(

data/lib/rspec-system/rake_task.rb

@@ -1,10 +1,5 @@
 # Include this file to create the spec:* rake tasks
 
-require 'rubygems'
-require "bundler/setup"
-
-Bundler.require :default, :test
-
 require 'rspec/core/rake_task'
 require 'rspec-system/formatter'
 

data/lib/rspec-system/util.rb

@@ -23,4 +23,17 @@ module RSpecSystem::Util
 
     return str
   end
+
+  # This is based on the Hash#deep_merge! method from activesupport
+  #
+  # @param dest_hash [Hash] hash to save merged values into
+  # @param other_hash [Hash] hash to merge values from
+  # @return [Hash] dest_hash
+  def deep_merge!(dest_hash, other_hash)
+    other_hash.each_pair do |k,v|
+      tv = dest_hash[k]
+      dest_hash[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge!(tv.dup, v) : v
+    end
+    dest_hash
+  end
 end

data/rspec-system.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-10 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec