rspec-system 2.2.1 → 2.3.0

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+2.3.0
+=====
+
+Rework the look and feel to make it pretty and add color
+
+This feature release is primarily a look and feel update that improves the visual look of
+how tests run. It changes the way `shell` and `rcp` output looks and includes
+more color where applicable.
+
+The output now uses the formatters output methods, in a mildly hackish way so
+that colors can be disabled centrally and also so if users switch to a different
+format the output is silenced. This is useful for cases where you want to run
+the progress formatter without all the extra noise for example.
+
+The dividers are now a little better, showing you the begin and end of blocks
+in a better way now, so it is slightly easier to see before/after runs
+without them bleeding into the test parts.
+
+As an aside I've also migrated the scp methodology from vsphere to vagrant so
+we are using the same channel to transfer files as well as for sending commands
+which should in theory be a perf boost, but as yet I've seen little evidence.
+
+#### Detailed Changes
+
+* Rework the look and feel to make it pretty and add color (Ken Barber)
+
+-------------------------------
+
 2.2.1
 =====
 

data/lib/rspec-system/formatter.rb

@@ -24,7 +24,7 @@ module RSpecSystem
     def start(count)
       @max_tests = count
       super(count)
-      output << "=================================================================\n\n"
+      output << "\n"
       output << bold("Commencing rspec-system tests\n")
       output << bold("Total Test Count: ") << color(count, :cyan) << "\n\n"
     end
@@ -35,7 +35,7 @@ module RSpecSystem
     # @return [void]
     def example_started(example)
       super(example)
-      output << "=================================================================\n\n"
+      output << "\n=begin===========================================================\n\n"
       output << bold("Running test: ") << "#{next_index} of #{@max_tests}" << "\n"
       output << bold("Description:\n  ") << color(example.full_description, :magenta) << "\n\n"
     end
@@ -47,6 +47,7 @@ module RSpecSystem
     def example_passed(example)
       super(example)
       output << "\n" << bold('Result: ') << success_color('passed') << "\n\n"
+      output << "=end=============================================================\n\n"
     end
 
     # Display output when an example is pending
@@ -58,6 +59,7 @@ module RSpecSystem
       msg = example.execution_result[:pending_message]
       output << "\n" << bold('Result: ') << pending_color('pending') << "\n"
       output << bold("Reason: ") << "#{msg}\n\n"
+      output << "=end=============================================================\n\n"
     end
 
     # Display output when an example has failed
@@ -69,6 +71,7 @@ module RSpecSystem
       msg = example.execution_result[:exception]
       output << "\n" << bold('Result: ') << failure_color('failed') << "\n"
       output << bold("Reason:\n") << "#{msg}\n\n"
+      output << "=end=============================================================\n\n"
     end
 
     # Obtains next index value so we can keep a count of what test we are upto

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

@@ -37,7 +37,6 @@ module RSpecSystem::Helpers
       sp = opts[:sp]
       dp = opts[:dp]
 
-      log.info("rcp from #{sp} to #{d.name}:#{dp} executed")
       result = ns.rcp(opts)
       { :success => result }
     end

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

@@ -31,6 +31,10 @@ module RSpecSystem::Helpers
 
     # Gathers new results by executing the resource action
     def execute
+      dest = opts[:n].name
+      cmd = opts[:c]
+
+      output << bold(color("#{dest}$", :green)) << " #{cmd}\n"
       rspec_system_node_set.run(opts)
     end
   end

data/lib/rspec-system/internal_helpers.rb

@@ -67,20 +67,20 @@ module RSpecSystem::InternalHelpers
   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
-
+    output << "=begin===========================================================\n"
+    output << "\n"
+    output << bold("Starting nodes") << "\n"
+    output << "\n"
+    output << bold("Setname:") << "             #{ns.setname}\n"
+    output << bold("Configuration:") << "       #{ns.config.pretty_inspect}"
+    output << bold("Virtual Environment:") << " #{ns.env_type}\n"
+    output << bold("Default node:") << "        #{ns.default_node.name}\n"
+    output << bold("Destroy node:") << "        #{ns.destroy}\n"
+    output << "\n"
     ns.setup
-
-    puts
-    puts "Finished starting nodes"
-    puts "================================================================="
+    output << "\n"
+    output << "=end=============================================================\n"
+    output << "\n"
     nil
   end
 
@@ -88,11 +88,14 @@ module RSpecSystem::InternalHelpers
   #
   # @return [void]
   def stop_nodes
-    puts 'Stopping nodes'
-    puts
+    output << "\n"
+    output << "=begin===========================================================\n"
+    output << "\n"
+    output << bold("Stopping nodes\n")
+    output << "\n"
     rspec_system_node_set.teardown
-    puts 'Finished stopping nodes'
-    puts "================================================================="
+    output << "\n"
+    output << "=end=============================================================\n"
     nil
   end
 end

data/lib/rspec-system/log.rb

@@ -2,16 +2,80 @@ require 'logger'
 
 # This log overlay module, provides access to the +log+ method.
 module RSpecSystem::Log
+  class Logger
+    attr_accessor :io
+
+    def initialize(io)
+      @io = io
+    end
+
+    def debug(text)
+      io << bold(color('Debug: ', :blue)) << text << "\n"
+    end
+
+    def info(text)
+      io << bold('Info: ') << text << "\n"
+    end
+
+    def warn(text)
+      io << 'Warn: ' << text << "\n"
+    end
+
+    def fatal(text)
+      io << 'Fatal: ' << text << "\n"
+    end
+
+    def unknown(text)
+      io << 'Unknown: ' << text << "\n"
+    end
+
+    def error(text)
+      io << 'Error: ' << text << "\n"
+    end
+  end
+
   # Return the default Logger object.
   #
   # @return [Logger] default logger object
   def log
     return @logger if @logger
-    @logger = ::Logger.new(STDOUT)
-    @logger.progname = 'rspec-system'
-    @logger.formatter = Proc.new do |s, t, p, m|
-      "#{s}: #{m}\n"
-    end
+    @logger = Logger.new(output)
     @logger
   end
+
+  def formatter
+    RSpec.configuration.formatters.each do |f|
+      if f.is_a? RSpecSystem::Formatter then
+        return f
+      end
+    end
+  end
+
+  class NullStream
+     def <<(o); self; end
+  end
+
+  def output
+    begin
+      formatter.output
+    rescue NameError
+      NullStream.new
+    end
+  end
+
+  def bold(text)
+    begin
+      formatter.send(:bold, text)
+    rescue NameError
+      ""
+    end
+  end
+
+  def color(text, color)
+    begin
+      formatter.send(:color, text, color)
+    rescue NameError
+      ""
+    end
+  end
 end

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

@@ -127,25 +127,25 @@ module RSpecSystem
           end
           channel.on_data do |ch,data|
             d = data
-            print d
+            output << d
             r[:stdout]+=d
           end
 
           channel.on_extended_data do |ch,type,data|
             d = data
-            print d
+            output << d
             r[:stderr]+=d
           end
 
           channel.on_request("exit-status") do |ch,data|
             c = data.read_long
-            puts "Exit code: #{c}"
+            output << bold("Exit code:") << " #{c}\n"
             r[:exit_code] = c
           end
 
           channel.on_request("exit-signal") do |ch, data|
             s = data.read_string
-            puts "Exit signal: #{s}"
+            output << bold("Exit signal:") << " #{s}\n"
             r[:exit_signal] = s
           end
         end

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

@@ -19,29 +19,30 @@ module RSpecSystem
     def initialize(setname, config, custom_prefabs_path, options)
       super
       @vagrant_path = File.expand_path(File.join(RSpec.configuration.system_tmp, 'vagrant_projects', setname))
+
+      RSpec.configuration.rspec_storage[:nodes] ||= {}
     end
 
     # Setup the NodeSet by starting all nodes.
     #
     # @return [void]
     def setup
-      log.info "[Vagrant#setup] Begin setting up vagrant"
-
       create_vagrantfile()
 
       teardown()
 
-      log.info "[Vagrant#setup] Running 'vagrant up'"
+      output << bold(color("localhost$", :green)) << " vagrant up\n"
       vagrant("up")
 
       # Establish ssh connectivity
-      ssh_channels = {}
       nodes.each do |k,v|
-        log.info "[Vagrant#setup] establishing Net::SSH channel with #{k}"
+        output << bold(color("localhost$", :green)) << " ssh #{k}\n"
         chan = Net::SSH.start(k, 'vagrant', :config => ssh_config)
-        ssh_channels[k] = chan
+
+        RSpec.configuration.rspec_storage[:nodes][k] = {
+          :ssh => chan,
+        }
       end
-      RSpec.configuration.ssh_channels = ssh_channels
 
       nil
     end
@@ -50,16 +51,18 @@ module RSpecSystem
     #
     # @return [void]
     def teardown
-      log.info "[Vagrant#teardown] closing all ssh channels"
-      RSpec.configuration.ssh_channels.each do |k,v|
-        v.close unless v.closed?
+      nodes.each do |k,v|
+        storage = RSpec.configuration.rspec_storage[:nodes][k]
+
+        next if storage.nil?
+
+        ssh = storage[:ssh]
+        ssh.close unless ssh.closed?
       end
 
       if destroy
-        log.info "[Vagrant#teardown] Running 'vagrant destroy'"
+        output << bold(color("localhost$", :green)) << " vagrant destroy --force\n"
         vagrant("destroy --force")
-      else
-        log.info "[Vagrant#teardown] Skipping 'vagrant destroy'"
       end
       nil
     end
@@ -72,12 +75,8 @@ module RSpecSystem
       dest = opts[:n].name
       cmd = opts[:c]
 
-      ssh_channels = RSpec.configuration.ssh_channels
-      puts "-----------------"
-      puts "#{dest}$ #{cmd}"
-      result = ssh_exec!(ssh_channels[dest], "cd /tmp && sudo sh -c #{shellescape(cmd)}")
-      puts "-----------------"
-      result
+      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
+      ssh_exec!(ssh, "cd /tmp && sudo sh -c #{shellescape(cmd)}")
     end
 
     # Transfer files to a host in the NodeSet.
@@ -88,8 +87,6 @@ module RSpecSystem
     #   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.
     def rcp(opts)
-      #log.debug("[Vagrant@rcp] called with #{opts.inspect}")
-
       dest = opts[:d].name
       source = opts[:sp]
       dest_path = opts[:dp]
@@ -98,23 +95,13 @@ module RSpecSystem
       tmpdest = tmppath
 
       # Do the copy and print out results for debugging
-      cmd = "scp -r -F '#{ssh_config}' '#{source}' #{dest}:#{tmpdest}"
-      puts "------------------"
-      puts "localhost$ #{cmd}"
-      r = systemu cmd
-
-      result = {
-        :exit_code => r[0].exitstatus,
-        :stdout => r[1],
-        :stderr => r[2]
-      }
-
-      print "#{result[:stdout]}"
-      print "#{result[:stderr]}"
-      puts "Exit code: #{result[:exit_code]}"
+      cmd = "scp -r '#{source}' #{dest}:#{tmpdest}"
+      output << bold(color("localhost$", :green)) << " #{cmd}\n"
+      ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
+      ssh.scp.upload! source.to_s, tmpdest.to_s, :recursive => true
 
       # Now we move the file into their final destination
-      result = run(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}")
+      result = shell(:n => opts[:d], :c => "mv #{tmpdest} #{dest_path}")
       if result[:exit_code] == 0
         return true
       else
@@ -126,13 +113,11 @@ module RSpecSystem
     #
     # @api private
     def create_vagrantfile
-      log.info "[Vagrant#create_vagrantfile] Creating vagrant file here: #{@vagrant_path}"
+      output << bold(color("localhost$", :green)) << " cd #{@vagrant_path}\n"
       FileUtils.mkdir_p(@vagrant_path)
       File.open(File.expand_path(File.join(@vagrant_path, "Vagrantfile")), 'w') do |f|
         f.write('Vagrant.configure("2") do |c|' + "\n")
         nodes.each do |k,v|
-          log.debug "Filling in content for #{k}"
-
           ps = v.provider_specifics['vagrant']
 
           node_config = "  c.vm.define '#{k}' do |v|\n"
@@ -148,7 +133,6 @@ module RSpecSystem
         end
         f.write("end\n")
       end
-      log.debug "[Vagrant#create_vagrantfile] Finished creating vagrant file"
       nil
     end
 
@@ -167,7 +151,6 @@ module RSpecSystem
       self.nodes.each do |k,v|
         Dir.chdir(@vagrant_path) do
           result = systemu("vagrant ssh-config #{k} >> #{ssh_config_path}")
-          puts result.inspect
         end
       end
       ssh_config_path

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

@@ -37,8 +37,6 @@ module RSpecSystem
     #
     # @return [void]
     def setup
-      log.info "[Vsphere#setup] Setup begins"
-
       dest_dir = ENV['RSPEC_VSPHERE_DEST_DIR']
       template_dir = ENV['RSPEC_VSPHERE_TEMPLATE_DIR']
 
@@ -56,7 +54,7 @@ module RSpecSystem
       vm_folder = dc.vmFolder
       vm_newfolder = vm_folder.find(dest_dir)
 
-      log.info "[Vsphere#setup] launching instances one by one"
+      log.info "Launching VSphere instances one by one"
       nodes.each do |k,v|
         ps = v.provider_specifics['vsphere']
 
@@ -66,7 +64,7 @@ module RSpecSystem
 
         raise "No template specified for this prefab" if template.nil?
 
-        log.info "[Vsphere#setup] launching instance #{k} with template #{template}"
+        log.info "Launching VSphere instance #{k} with template #{template}"
 
         vm = vm_folder.find(ENV['RSPEC_VSPHERE_TEMPLATE_DIR']).find(template)
 
@@ -74,7 +72,7 @@ module RSpecSystem
 
         vm_name = "rspec-system-#{k}-#{random_string(10)}"
 
-        log.info "[Vsphere#setup] Cloning new vm #{vm_name} in folder #{dest_dir}"
+        log.info "Cloning new VSphere vm #{vm_name} in folder #{dest_dir}"
 
         vm.CloneVM_Task(
           :folder => vm_newfolder,
@@ -82,7 +80,7 @@ module RSpecSystem
           :spec => spec
         ).wait_for_completion
 
-        log.info "[Vsphere#setup] Cloning complete"
+        log.info "Cloning complete"
 
         newvm = vm_newfolder.find(vm_name)
         guest_info = newvm.guest
@@ -90,20 +88,20 @@ module RSpecSystem
         timeout(60) do
           while(newvm.guest.guestState != 'running') do
             sleep 2
-            puts "#{k}> Waiting for vm to run ..."
+            log.info "#{k}> Waiting for vm to run ..."
           end
         end
 
         timeout(60) do
           while(newvm.guest.ipAddress == nil) do
             sleep 2
-            puts "#{k}> Waiting for ip address ..."
+            log.info "#{k}> Waiting for ip address ..."
           end
         end
 
         ipaddress = newvm.guest.ipAddress
 
-        log.info "[Vsphere#setup] establishing Net::SSH channel with #{k}"
+        output << bold(color("localhost$", :green)) << " ssh #{k}"
         chan = Net::SSH.start(ipaddress, 'vagrant', :password => 'vagrant')
 
         RSpec.configuration.rspec_storage[:nodes][k] = {
@@ -111,11 +109,8 @@ module RSpecSystem
           :ssh => chan,
           :vm => newvm
         }
-        log.info "[Vsphere#setup] Node launched: #{k}"
       end
 
-      log.info("[Vsphere#setup] setup complete")
-
       nil
     end
 
@@ -127,25 +122,23 @@ module RSpecSystem
         storage = RSpec.configuration.rspec_storage[:nodes][k]
 
         if storage.nil?
-          log.info "[Vsphere#teardown] No entry for node #{k}, no teardown necessary"
+          log.info "No entry for node #{k}, no teardown necessary"
           next
         end
 
-        log.info "[Vsphere#teardown] closing ssh channel to #{k}"
         ssh = storage[:ssh]
         ssh.close unless ssh.closed?
 
         if destroy
-          log.info "[Vsphere#teardown] destroy instance #{k}"
+          log.info "Destroying instance #{k}"
           vm = storage[:vm]
           if vm == nil
-            puts "No vm object"
+            log.error "No vm object for #{k}"
             next
           end
           vm.PowerOffVM_Task.wait_for_completion
           vm.Destroy_Task.wait_for_completion
         else
-          log.info "[Vsphere#teardown] Skipping destroy instance #{k}"
           next
         end
       end
@@ -162,11 +155,7 @@ module RSpecSystem
       cmd = opts[:c]
 
       ssh = RSpec.configuration.rspec_storage[:nodes][dest][:ssh]
-      puts "-----------------"
-      puts "#{dest}$ #{cmd}"
-      result = ssh_exec!(ssh, "cd /tmp && sudo sh -c '#{cmd}'")
-      puts "-----------------"
-      result
+      ssh_exec!(ssh, "cd /tmp && sudo sh -c '#{cmd}'")
     end
 
     # Transfer files to a host in the NodeSet.
@@ -177,8 +166,6 @@ module RSpecSystem
     #   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.
     def rcp(opts)
-      #log.debug("[Vagrant@rcp] called with #{opts.inspect}")
-
       dest = opts[:d].name
       source = opts[:sp]
       dest_path = opts[:dp]

data/lib/rspec-system/spec_helper.rb

@@ -29,20 +29,19 @@ RSpec.configure do |c|
     begin
       start_nodes
     rescue => ex
-      puts ex.inspect + " in"
-      puts ex.backtrace.join("\n  ")
+      output << ex.inspect + " in\n"
+      output << ex.backtrace.join("\n  ") << "\n"
       exit(1)
     end
   end
 
   c.after :suite do
-    puts "================================================================="
     # After Suite exceptions get captured it seems
     begin
       stop_nodes
     rescue => ex
-      puts ex.inspect + " in"
-      puts ex.backtrace.join("\n  ")
+      output << ex.inspect + " in\n"
+      output << ex.backtrace.join("\n  ") << "\n"
     end
   end
 end

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "2.2.1"
+  s.version     = "2.3.0"
   s.authors     = ["Ken Barber"]
   s.email       = ["info@puppetlabs.com"]
   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.2.1
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -217,4 +217,3 @@ test_files:
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
 - spec/unit/result_spec.rb
 - spec/unit/utils_spec.rb
-has_rdoc: