rspec-system 1.6.0 → 1.7.0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+1.7.0
+=====
+
+This change adjusts the temporary path for vagrant projects to use a directory in your project `.rspec_system`. This way while debugging issues on your VM you do not need to scroll back to find the vagrant project, simply look in the local `.rspec_system`.
+
+Now if you want to adjust this base directory to something else, you can use the directory RSPEC_SYSTEM_TMP.
+
+#### Detailed Changes
+
+* Change the tmp path for the vagrant_projects directory to be under projects root directory (Trey Dock)
+
+-------------------------------
+
 1.6.0
 =====
 

data/README.md

@@ -22,6 +22,8 @@ Then installing with:
 
     bundle install --path vendor
 
+If your using git, add `.rspec_system` to your project's `.gitignore` file.  This is the default location for files created by rspec-system.
+
 ### Writing tests
 
 Start by creating a helper file in `spec/spec_helper_system.rb` containing something like the following:
@@ -165,6 +167,7 @@ Instead of switches, we use a number of environment variables to modify the beha
 * *RSPEC_VIRTUAL_ENV* - set this to `vagrant` if you wish, for now `vagrant` is the default so this is optional.
 * *RSPEC_SET* - the set to use when running tests (defaults to the `default_set` setting in the projects `.nodeset.yml` file). This string must align with the entries under `sets` in your `.nodeset.yml`.
 * *RSPEC_DESTROY* - set this to `no` if you do not want the VM to be destroyed before or after a test completes.  May be useful during initial testing of rspec tests to allow inspection of the VM.
+* *RSPEC_SYSTEM_TMP* - Sets the path to create vagrant_projects directory containing each Nodeset's Vagrantfile.  Default is the directory `.rspec_system` in your projects root.
 
 So if you wanted to run an alternate nodeset you could use:
 
@@ -172,6 +175,10 @@ So if you wanted to run an alternate nodeset you could use:
 
 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.
 
+To set the location of the Nodeset's Vagrantfile to `/tmp/vagrant_projects/centos-64-x64` you could use:
+
+    RSPEC_SET=centos-64-x64 RSPEC_SYSTEM_TMP=/tmp rake spec:system
+
 #### VSphere Provider
 
 *Note:* this provider requires some templates to be created in a globally accessable folder somewhere in your VSphere system, in the near future the site: <http://puppet-vagrant-boxes.puppetlabs.com> should provide you with deployable OVF files for this purpose, and I'll provide you with better docs on how to load these ;-). Look at prefabs.yml for the names of the templates that we expect.

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

@@ -10,7 +10,11 @@ module RSpecSystem
     attr_reader :nodes
     attr_reader :destroy
 
+    # @!group Abstract Methods
+
     # Create new NodeSet, populating necessary data structures.
+    #
+    # @abstract override for providing global storage and setup-level code
     def initialize(setname, config, custom_prefabs_path, options)
       @setname = setname
       @config = config
@@ -24,25 +28,44 @@ module RSpecSystem
     end
 
     # Setup the NodeSet by starting all nodes.
+    #
+    # @return [void]
+    # @abstract Override this method and provide your own node launching code
     def setup
       raise "Unimplemented method #setup"
     end
 
     # Shutdown the NodeSet by shutting down or pausing all nodes.
+    #
+    # @return [void]
+    # @abstract Override this method and provide your own node teardown code
     def teardown
       raise "Unimplemented method #teardown"
     end
 
     # Run a command on a host in the NodeSet.
+    #
+    # @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)
       raise "Unimplemented method #run"
     end
 
     # Copy a file to the host in the NodeSet.
+    #
+    # @param opts [Hash] options
+    # @option opts [RSpecHelper::Node] :d destination node
+    # @option opts [String] :sp source path
+    # @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)
       raise "Unimplemented method #rcp"
     end
 
+    # @!group Common Methods
+
     # Return environment type
     def env_type
       self.class::ENV_TYPE

data/lib/rspec-system/spec_helper.rb

@@ -27,6 +27,12 @@ RSpec.configure do |c|
   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')
@@ -89,7 +95,7 @@ RSpec.configure do |c|
   end
 
   # Default the system_tmp dir to something random
-  c.system_tmp = Dir.mktmpdir
+  c.system_tmp = rspec_system_tmp
 
   c.before :suite do
     # Before Suite exceptions get captured it seems

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "1.6.0"
+  s.version     = "1.7.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: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec