rspec-system 1.2.0 → 1.2.1

data/lib/rspec-system.rb

@@ -3,6 +3,7 @@ require 'rspec'
 # Root module namespace for +rspec-system+
 module RSpecSystem; end
 
+require 'rspec-system/util'
 require 'rspec-system/log'
 require 'rspec-system/helpers'
 require 'rspec-system/node_set'

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

@@ -6,6 +6,7 @@ module RSpecSystem
   # A NodeSet implementation for Vagrant.
   class NodeSet::Vagrant < RSpecSystem::NodeSet::Base
     include RSpecSystem::Log
+    include RSpecSystem::Util
 
     ENV_TYPE = 'vagrant'
 
@@ -68,7 +69,7 @@ module RSpecSystem
       ssh_channels = RSpec.configuration.ssh_channels
       puts "-----------------"
       puts "#{dest}$ #{cmd}"
-      result = ssh_exec!(ssh_channels[dest], "cd /tmp && sudo sh -c '#{cmd}'")
+      result = ssh_exec!(ssh_channels[dest], "cd /tmp && sudo sh -c #{shellescape(cmd)}")
       puts "-----------------"
       result
     end
@@ -122,7 +123,7 @@ module RSpecSystem
       log.info "[Vagrant#create_vagrantfile] Creating vagrant file here: #{@vagrant_path}"
       FileUtils.mkdir_p(@vagrant_path)
       File.open(File.expand_path(File.join(@vagrant_path, "Vagrantfile")), 'w') do |f|
-        f.write('Vagrant::Config.run do |c|')
+        f.write("Vagrant::Config.run do |c|\n")
         nodes.each do |k,v|
           log.debug "Filling in content for #{k}"
 

data/lib/rspec-system/util.rb

@@ -0,0 +1,26 @@
+# A set of utilities that can be used as a mixin.
+module RSpecSystem::Util
+  # This is the shellescape method from shellwords from ruby-2.0.0
+  #
+  # @param str [String] string to escape
+  # @return [String] returns escaped string
+  def shellescape(str)
+    str = str.to_s
+
+    # An empty argument will be skipped, so return empty quotes.
+    return "''" if str.empty?
+
+    str = str.dup
+
+    # Treat multibyte characters as is.  It is caller's responsibility
+    # to encode the string in the right encoding for the shell
+    # environment.
+    str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
+
+    # A LF cannot be escaped with a backslash because a backslash + LF
+    # combo is regarded as line continuation and simply ignored.
+    str.gsub!(/\n/, "'\n'")
+
+    return str
+  end
+end

data/rspec-system.gemspec

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

data/spec/system/system_run_spec.rb

@@ -17,13 +17,13 @@ describe "system_run:" do
 
   it 'piping should be preserved' do
     system_run('rm -f /tmp/foo')
-    system_run('echo "foo" > /tmp/foo') do |r|
+    system_run('echo "foo bar baz" > /tmp/foo') do |r|
       r.stderr.should == ''
       r.exit_code.should == 0
     end
 
     system_run('cat /tmp/foo') do |r|
-      r.stdout.should =~ /foo/
+      r.stdout.should =~ /foo bar baz/
       r.exit_code.should == 0
     end
     system_run('rm -f /tmp/foo')
@@ -31,15 +31,40 @@ describe "system_run:" do
 
   it 'escape single quotes properly' do
     system_run('rm -f /tmp/foo')
-    system_run("echo 'foo' > /tmp/foo") do |r|
+    system_run("echo 'foo bar baz' > /tmp/foo") do |r|
       r.stderr.should == ''
       r.exit_code.should == 0
     end
 
     system_run('cat /tmp/foo') do |r|
-      r.stdout.should =~ /foo/
+      r.stdout.should =~ /foo bar baz/
       r.exit_code.should == 0
     end
     system_run('rm -f /tmp/foo')
   end
+
+  it 'escape all quotes properly' do
+    system_run('rm -f ~vagrant/foo')
+    system_run("su - vagrant -c 'echo \"foo bar baz\" > ~/foo'") do |r|
+      r.stderr.should == ''
+      r.exit_code.should == 0
+    end
+
+    system_run('cat ~vagrant/foo') do |r|
+      r.stdout.should =~ /foo bar baz/
+      r.exit_code.should == 0
+    end
+    system_run('rm -f ~vagrant/foo')
+  end
+
+  it 'a string of commands should succeed' do
+    r = system_run(<<-EOS.gsub(/^ {6}/, ''))
+      rm /tmp/foo
+      echo 'foo bar baz' > /tmp/foo
+      cat /tmp/foo
+      rm /tmp/foo
+    EOS
+    r.stdout.should =~ /foo bar baz/
+    r.exit_code.should == 0
+  end
 end

data/spec/unit/utils_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'rspec-system/util'
+
+describe RSpecSystem::Util do
+  let(:cls) do
+    cls = Object.new
+    cls.extend(RSpecSystem::Util)
+  end
+
+  describe '#shellescape' do
+    it 'should escape strings' do
+      cls.shellescape('echo "foo" > /tmp/baz').should == 'echo\ \\"foo\\"\ \>\ /tmp/baz'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -144,6 +144,7 @@ files:
 - lib/rspec-system/rake_task.rb
 - lib/rspec-system/result.rb
 - lib/rspec-system/spec_helper.rb
+- lib/rspec-system/util.rb
 - resources/kwalify-schemas/nodeset_schema.yml
 - resources/kwalify-schemas/prefabs_schema.yml
 - resources/prefabs.yml
@@ -158,6 +159,7 @@ files:
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
 - spec/unit/result_spec.rb
+- spec/unit/utils_spec.rb
 homepage: https://github.com/puppetlabs/rspec-system
 licenses: []
 post_install_message: 
@@ -189,3 +191,4 @@ test_files:
 - spec/unit/kwalify-schemas/nodeset_schema_spec.rb
 - spec/unit/kwalify-schemas/prefabs_schema_spec.rb
 - spec/unit/result_spec.rb
+- spec/unit/utils_spec.rb