rspec-system 0.3.1 → 0.3.2

data/Rakefile

@@ -6,6 +6,10 @@ Bundler.require :default
 require 'rspec/core/rake_task'
 require 'rspec-system/rake_task'
 
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/unit/**/*_spec.rb"
+end
+
 task :default do
   sh %{rake -T}
 end

data/lib/rspec-system/helpers.rb

@@ -70,12 +70,13 @@ module RSpecSystem::Helpers
 
   # Runs a shell command on a test host.
   #
-  # When invoked as a block the status,stdout and stderr are yielded to the
-  # block as parameters. If not these three variables are returned to the
-  # caller.
+  # When invoked as a block a result hash is yielded to the block as a
+  # parameter. Alternatively the result hash it is returned to the caller.
   #
   # If you have only provided 1 node in your nodeset, or you have specified a
-  # a default you can avoid entering the name of the node if you wish.
+  # a default you can avoid entering the name of the node if you wish. The
+  # method for simplicity can accept a string instead of an options hash
+  # and it knows to default everything else.
   #
   # The underlying implementation is actually performed by the particular
   # node provider, however this abstraction should mean you shouldn't need
@@ -119,7 +120,9 @@ module RSpecSystem::Helpers
     result = ns.run(options)
     log.info("system_run results:\n" +
       "-----------------------\n" +
-      result.pretty_inspect +
+      "exit_code: #{result[:exit_code]}\n" +
+      "stdout:\n #{result[:stdout]}\n" +
+      "stderr:\n #{result[:stderr]}\n" +
       "-----------------------\n")
 
     if block_given?
@@ -152,13 +155,14 @@ module RSpecSystem::Helpers
   # @option options [RSpecSystem::Node] :s alias for source_node
   # @return [Bool] returns true if successful
   def system_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 => rspec_system_node_set.default_node,
-      :d => rspec_system_node_set.default_node,
+      :destination_node => ns.default_node,
+      :d => ns.default_node,
       :source_node => nil,
       :s => nil,
     }.merge(options)
@@ -168,17 +172,7 @@ module RSpecSystem::Helpers
     dp = options[:dp]
 
     log.info("system_rcp from #{sp} to #{d.name}:#{dp} executed")
-    results = rspec_system_node_set.rcp(options)
-    log.info("rcp results:\n" +
-      "-----------------------\n" +
-      results.pretty_inspect +
-      "-----------------------\n")
-
-    if results[:exit_code] == 1
-      return true
-    else
-      return false
-    end
+    ns.rcp(options)
   end
 
   # @!group Queries

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

@@ -8,32 +8,43 @@ module RSpecSystem
 
     ENV_TYPE = 'vagrant'
 
+    # Creates a new instance of RSpecSystem::NodeSet::Vagrant
+    #
+    # @param setname [String] name of the set to instantiate
+    # @param config [Hash] nodeset configuration hash
     def initialize(setname, config)
       super
       @vagrant_path = File.expand_path(File.join(RSpec.configuration.system_tmp, 'vagrant_projects', setname))
     end
 
     # Setup the NodeSet by starting all nodes.
+    #
+    # @return [void]
     def setup
       log.info "[Vagrant#setup] Begin setting up vagrant"
-      create_vagrantfile
 
-      log.info "[Vagrant#setup] Running 'vagrant destroy'"
-      vagrant("destroy --force")
+      create_vagrantfile()
+
+      teardown()
 
       log.info "[Vagrant#setup] Running 'vagrant up'"
       vagrant("up")
+      nil
     end
 
     # Shutdown the NodeSet by shutting down or pausing all nodes.
+    #
+    # @return [void]
     def teardown
       log.info "[Vagrant#teardown] Running 'vagrant destroy'"
       vagrant("destroy --force")
+      nil
     end
 
     # Run a command on a host in the NodeSet.
     #
     # @param opts [Hash] options
+    # @return [Hash] a hash containing :exit_code, :stdout and :stderr
     def run(opts)
       #log.debug("[Vagrant#run] called with #{opts.inspect}")
 
@@ -58,11 +69,10 @@ module RSpecSystem
     # Transfer files to a host in the NodeSet.
     #
     # @param opts [Hash] options
+    # @return [Boolean] returns true if command succeeded, false otherwise
     # @todo This is damn ugly, because we ssh in as vagrant, we copy to a temp
     #   path then move it later. Its slow and brittle and we need a better
     #   solution. Its also very Linux-centrix in its use of temp dirs.
-    # @todo Need to return more interesting information, not just the systemu
-    #   results. This will require a formalisation of this API.
     def rcp(opts)
       #log.debug("[Vagrant@rcp] called with #{opts.inspect}")
 
@@ -86,13 +96,26 @@ module RSpecSystem
         :stderr => r[2]
       }
 
-      log.info("system_run results:\n" +
+      log.info("scp results:\n" +
         "-----------------------\n" +
-        result.pretty_inspect +
+        "exit_code: #{result[:exit_code]}\n" +
+        "stdout:\n #{result[:stdout]}\n" +
+        "stderr:\n #{result[:stderr]}\n" +
         "-----------------------\n")
 
       # Now we move the file into their final destination
-      run(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}")
+      result = run(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}")
+      log.info("move results:\n" +
+        "-----------------------\n" +
+        "exit_code: #{result[:exit_code]}\n" +
+        "stdout:\n #{result[:stdout]}\n" +
+        "stderr:\n #{result[:stderr]}\n" +
+        "-----------------------\n")
+      if result[:exit_code] == 0
+        return true
+      else
+        return false
+      end
     end
 
     # Create the Vagrantfile for the NodeSet.
@@ -105,16 +128,21 @@ module RSpecSystem
         f.write('Vagrant::Config.run do |c|')
         nodes.each do |k,v|
           log.debug "Filling in content for #{k}"
+
+          ps = v.provider_specifics['vagrant']
+
           f.write(<<-EOS)
-  c.vm.define '#{k}' do |vmconf|
-    vmconf.vm.host_name = "#{k}"
-#{template_node(v.provider_specifics['vagrant'])}
+  c.vm.define '#{k}' do |v|
+    v.vm.host_name = '#{k}'
+    v.vm.box = '#{ps['box']}'
+    v.vm.box_url = '#{ps['box_url']}'
   end
           EOS
         end
         f.write('end')
       end
       log.debug "[Vagrant#create_vagrantfile] Finished creating vagrant file"
+      nil
     end
 
     # Here we get vagrant to drop the ssh_config its using so we can monopolize
@@ -122,6 +150,7 @@ module RSpecSystem
     # since its indexed based on our own node names its quite ideal.
     #
     # @api private
+    # @return [String] path to ssh_config file
     def ssh_config
       ssh_config_path = File.expand_path(File.join(@vagrant_path, "ssh_config"))
       begin
@@ -137,17 +166,6 @@ module RSpecSystem
       ssh_config_path
     end
 
-    # Provide Vagrantfile templates from node definition.
-    #
-    # @api private
-    # @param settings [Hash] provider specific settings for vagrant
-    def template_node(settings)
-      template = <<-EOS
-    vmconf.vm.box = '#{settings['box']}'
-    vmconf.vm.box_url = '#{settings['box_url']}'
-      EOS
-    end
-
     # Execute vagrant command in vagrant_path
     #
     # @api private

data/rspec-system.gemspec

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

data/spec/spec_helper.rb

@@ -13,12 +13,18 @@ Pathname.glob("#{dir}/shared_behaviours/**/*.rb") do |behaviour|
   require behaviour.relative_path_from(Pathname.new(dir))
 end
 
+def root_path
+  Pathname.new(File.expand_path(File.join(__FILE__, '..', '..')))
+end
+
 def fixture_path
-  Pathname.new(File.expand_path(File.join(__FILE__, '..', 'fixtures')))
+  root_path + 'spec' + 'fixtures'
 end
+
 def resources_path
-  Pathname.new(File.expand_path(File.join(__FILE__, '..', '..', 'resources')))
+  root_path + 'resources'
 end
+
 def schema_path
   resources_path + 'kwalify-schemas'
 end

data/spec/unit/kwalify-schemas/nodeset_schema_spec.rb

@@ -25,4 +25,15 @@ describe 'nodeset_schema' do
       errors.should == []
     end
   end
+
+  it "my own .nodeset.yml should validate" do
+    ydoc = parser.parse_file(root_path + '.nodeset.yml')
+    errors = parser.errors
+    if errors && !errors.empty?
+      errors.each do |e|
+        puts "line=#{e.linenum}, path=#{e.path}, mesg=#{e.message}"
+      end
+    end
+    errors.should == []
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec