sshkit 0.0.10 → 0.0.11

data/.travis.yml

@@ -1,3 +1,4 @@
+before_install: echo 'yes' | gem uninstall ffi -a -I || true
 language: ruby
 rvm:
   - 1.9.3

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 This file is written in reverse chronological order, newer releases will
 appear at the top.
 
+## 0.0.11
+
+ * Implementing confuguration objects on the backends (WIP, undocumented)
+ * Implement `SSHKit.config.default_env`, a hash which can be modified and
+   will act as a global `with`.
+ * Fixed #9 (with(a: 'b', c: 'c') being parsed as `A=bC=d`. Now properly space
+   separated.
+ * Fixed #10 (overly aggressive shell escaping), one can now do:
+   `with(path: 'foo:$PATH') without the $ being escaped too early.
+
 ## 0.0.10
 
 * Include more attributes in `Command#to_hash`.

data/EXAMPLES.md

@@ -8,6 +8,13 @@
       end
     end
 
+## Run with default environemntal variables
+
+    SSHKit.config.default_env = { path: '/usr/local/libexec/bin:$PATH' }
+    on hosts do |host|
+      puts capture(:env)
+    end
+
 ## Run a command in a different directory
 
     on hosts do |host|

data/README.md

@@ -194,10 +194,10 @@ should be printed.
   not, perhaps a family of similarly named bang methods should be the ones to
   raise. (Perhaps `test()` should be a way to `execute()` without raising, and
   `execute()` and friends should always raise)~~
-* It would be nice to be able to say `SSHKit.config.formatter = :pretty` and
+* ~~It would be nice to be able to say `SSHKit.config.formatter = :pretty` and
   have that method setter do the legwork of updating `SSHKit.config.output` to
   be an instance of the correct formatter class wrapping the existing output
-  stream.
+  stream.~~
 * No closing of connections, the abstract backend class should include a
   cleanup method which is empty but can be overriden by
 * No conncetion pooling, the `connection` method of the NetSSH backend could
@@ -207,3 +207,7 @@ should be printed.
 * Wrap all commands in a known shell, that is that `execute('uptime')` should
   be converted into `sh -c 'uptime'` to ensure that we have a consistent shell
   experience.
+* There's no suitable host parser that accepts `Host.new('user@ip:port')`, it
+  will decode a `user@hostname:port`, but IP addresses don't work.
+* If Net::SSH raises `IOError` (as it does when authentication fails) this
+  needs to be caught, and re-raised as some kind of ConnectionFailed error.

data/lib/sshkit.rb

@@ -23,6 +23,10 @@ module SSHKit
     @@config ||= Configuration.new
   end
 
+  def self.reset_configuration!
+    @@config = nil
+  end
+
 end
 
 require_relative 'sshkit/all'

data/lib/sshkit/backends/netssh.rb

@@ -5,6 +5,10 @@ module SSHKit
 
     class Netssh < Printer
 
+      class Configuration
+        attr_accessor :connection_timeout, :pty
+      end
+
       include SSHKit::CommandHelper
 
       def run
@@ -29,6 +33,14 @@ module SSHKit
         _execute(*args).stdout.strip
       end
 
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+
       private
 
       def _execute(*args)
@@ -36,6 +48,7 @@ module SSHKit
           output << cmd
           cmd.started = true
           ssh.open_channel do |chan|
+            chan.request_pty if config.pty
             chan.exec cmd.to_s do |ch, success|
               chan.on_data do |ch, data|
                 cmd.stdout += data

data/lib/sshkit/command.rb

@@ -124,14 +124,19 @@ module SSHKit
         if options[:in]
           cs << sprintf("cd %s && ", options[:in])
         end
+        unless SSHKit.config.default_env.empty?
+          if options[:env].is_a? Hash
+            options[:env] = SSHKit.config.default_env.merge(options[:env])
+          end
+        end
         if options[:env]
           cs << '( '
           options[:env].each do |k,v|
             cs << k.to_s.upcase
             cs << "="
-            cs << v.to_s.shellescape
+            cs << v.to_s
+            cs << ' '
           end
-          cs << ' '
         end
         if options[:user]
           cs << "sudo su #{options[:user]} -c "

data/lib/sshkit/configuration.rb

@@ -2,12 +2,23 @@ module SSHKit
 
   class Configuration
 
-    attr_writer :command_map
-    attr_accessor :output, :backend
+    attr_writer :output, :backend, :default_env, :command_map
 
-    def initialize
-      @output  = SSHKit::Formatter::Pretty.new($stdout)
-      @backend = SSHKit::Backend::Netssh
+    def output
+      @output ||= format=(:pretty)
+    end
+
+    def default_env
+      @default_env ||= {}
+    end
+
+    def backend
+      @backend ||= SSHKit::Backend::Netssh
+    end
+
+    def format=(format)
+      formatter = SSHKit::Formatter.const_get(format.capitalize)
+      self.output = formatter.new($stdout)
     end
 
     def command_map

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/test/unit/backends/test_netssh.rb

@@ -3,11 +3,19 @@ require 'helper'
 module SSHKit
   module Backend
     class TestNetssh < UnitTest
+
       def backend
-        Netssh.new(Host.new('example.com'), Proc.new)
+        @backend ||= Netssh.new(Host.new('example.com'))
       end
-      def test_net_ssh_configuration_timeout
-        skip "No configuration on the Netssh class yet"
+
+      def test_net_ssh_configuration_options
+        backend.configure do |ssh|
+          ssh.pty = true
+          ssh.connection_timeout = 30
+        end
+
+        assert_equal 30, backend.config.connection_timeout
+        assert_equal true, backend.config.pty
       end
     end
   end

data/test/unit/test_command.rb

@@ -4,6 +4,10 @@ require 'sshkit'
 module SSHKit
   class TestCommand < UnitTest
 
+    def setup
+      SSHKit.reset_configuration!
+    end
+
     def test_maps_a_command
       c = Command.new('example')
       assert_equal '/usr/bin/env example', String(c)
@@ -26,10 +30,36 @@ module SSHKit
     end
 
     def test_including_the_env
+      SSHKit.config = nil
       c = Command.new(:rails, 'server', env: {rails_env: :production})
       assert_equal "( RAILS_ENV=production /usr/bin/env rails server )", String(c)
     end
 
+    def test_including_the_env_with_multiple_keys
+      SSHKit.config = nil
+      c = Command.new(:rails, 'server', env: {rails_env: :production, foo: 'bar'})
+      assert_equal "( RAILS_ENV=production FOO=bar /usr/bin/env rails server )", String(c)
+    end
+
+    def test_including_the_env_doesnt_addressively_escape
+      SSHKit.config = nil
+      c = Command.new(:rails, 'server', env: {path: '/example:$PATH'})
+      assert_equal "( PATH=/example:$PATH /usr/bin/env rails server )", String(c)
+    end
+
+    def test_global_env
+      SSHKit.config = nil
+      SSHKit.config.default_env = { default: 'env' }
+      c = Command.new(:rails, 'server', env: {})
+      assert_equal "( DEFAULT=env /usr/bin/env rails server )", String(c)
+    end
+
+    def test_default_env_is_overwritten_with_locally_defined
+      SSHKit.config.default_env = { foo: 'bar', over: 'under' }
+      c = Command.new(:rails, 'server', env: { over: 'write'})
+      assert_equal "( FOO=bar OVER=write /usr/bin/env rails server )", String(c)
+    end
+
     def test_working_in_a_given_directory
       c = Command.new(:ls, '-l', in: "/opt/sites")
       assert_equal "cd /opt/sites && /usr/bin/env ls -l", String(c)

data/test/unit/test_configuration.rb

@@ -7,12 +7,16 @@ module SSHKit
     def setup
       SSHKit.config = nil
       SSHKit.config.command_map.clear
+      SSHKit.config.output = SSHKit::Formatter::Pretty.new($stdout)
     end
 
     def test_output
       assert SSHKit.config.output.is_a? SSHKit::Formatter::Pretty
       assert SSHKit.config.output = $stderr
-      assert_equal $stderr, SSHKit.config.output
+    end
+
+    def test_default_env
+      assert SSHKit.config.default_env
     end
 
     def test_backend
@@ -30,6 +34,10 @@ module SSHKit
       assert_equal "/opt/sites/example/current/bin ruby", SSHKit.config.command_map[:ruby]
     end
 
+    def test_setting_formatter
+      assert SSHKit.config.format = :dot
+      assert SSHKit.config.output.is_a? SSHKit::Formatter::Dot
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-18 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh