sshkit-sudo 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5d6298a3efbd2224bec41000feb3bc4700a0506
-  data.tar.gz: 17be3a66b0d57e0588c07358d6ec6a23bf402d5a
+  metadata.gz: 584ff1236a17ccb0e7a8d86879c20507500d27cc
+  data.tar.gz: 6ff19bcecb8f204277a21447d1a6723252b68a7e
 SHA512:
-  metadata.gz: 7e49ef8108a412566391395ddc4fa48bf080bc643c5cad8bab12197741ba043f7e648dc564f51c7dcecdef4a05b064fc77b074c08648b08d03444cfc6e4843c2
-  data.tar.gz: e6eef7349a71a7c2c83208a2b25dda19b94d4aa13ebbcbd7b8aaeda692cdd13440ae2ff8f1e243385bcc9e89113aaa418ce0bd0d74a4f0e1e8d90185eae39855
+  metadata.gz: 94eb893a96ad4aa5e66f776629e24e50d2ce02e4940ff4dddbf7eec0bd139110d0f2368e014aa9aff6ddf246b217112669bad7bcb04a98683a5d35b9d43572ff
+  data.tar.gz: af0359eb6962017f05967396c10f844a03e5fde4abd0a56ae12f721cf70e554d004dbf78c8ef03006ea820459c5e17d6c77ad09864df2395833f2aefd0379dc4

data/README.md

@@ -75,6 +75,50 @@ namespace :prov do
 end
 ```
 
+### Configuration
+Available in sshkit-sudo 0.1.0 and later.
+
+#### Same password across servers
+If you are using a same password across all servers, you can skip inputting the password for the second server or after
+by using `use_same_password!` method in your `deploy.rb` as follows:
+```ruby
+class SSHKit::Sudo::InteractionHandler
+  use_same_password!
+end
+```
+
+#### Password prompt and wrong password matchers
+You can set your own matchers in your `deploy.rb` as follows:
+```ruby
+class SSHKit::Sudo::InteractionHandler
+  password_prompt_regexp /[Pp]assword.*:/
+  wrong_password_regexp /Sorry.*\stry\sagain/
+end
+```
+
+#### Making your own handler
+You can write your own handler in your `deploy.rb` as follows:
+```ruby
+class SSHKit::Sudo::InteractionHandler
+  def on_data(command, stream_name, data, channel)
+    if data =~ wrong_password
+      SSHKit::Sudo.password_cache[password_cache_key(command.host)] = nil
+    end
+    if data =~ password_prompt
+      key = password_cache_key(command.host)
+      pass = SSHKit::Sudo.password_cache[key]
+      unless pass
+        print data
+        pass = $stdin.noecho(&:gets)
+        puts ''
+        SSHKit::Sudo.password_cache[key] = pass
+      end
+      channel.send_data(pass)
+    end
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/sshkit-sudo/fork )

data/lib/sshkit/sudo.rb

@@ -1,8 +1,8 @@
 require "sshkit/sudo/version"
 require 'sshkit'
-require "sshkit/sudo/backends_ext/printer"
-require "sshkit/sudo/backends_ext/netssh"
-require "sshkit/sudo/backends_ext/local"
+require 'sshkit/sudo/interaction_handler'
+require 'sshkit/sudo/backends/abstract'
+require 'sshkit/sudo/backends/netssh'
 
 module SSHKit
   module Sudo
@@ -10,4 +10,7 @@ module SSHKit
       @password_cache ||= {}
     end
   end
+
+  Backend::Abstract.send(:include, ::SSHKit::Sudo::Backend::Abstract)
+  Backend::Netssh.send(:include, ::SSHKit::Sudo::Backend::Netssh)
 end

data/lib/sshkit/sudo/backends/abstract.rb

@@ -0,0 +1,26 @@
+module SSHKit
+  module Sudo
+    module Backend
+      module Abstract
+        def sudo(*args)
+          execute!(:sudo, *args)
+        end
+
+        def execute!(*args)
+          options = args.extract_options!
+          options[:interaction_handler] ||= SSHKit::Sudo::InteractionHandler.new
+          create_command_and_execute!(args, options).success?
+        end
+
+        private
+        def execute_command!(*args)
+          execute_command(*args)
+        end
+
+        def create_command_and_execute!(args, options)
+          command(args, options).tap { |cmd| execute_command!(cmd) }
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/sudo/backends/netssh.rb

@@ -0,0 +1,57 @@
+module SSHKit
+  module Sudo
+    module Backend
+      module Netssh
+        private
+        def execute_command!(cmd)
+          output.log_command_start(cmd)
+          cmd.started = true
+          exit_status = nil
+          with_ssh do |ssh|
+            ssh.open_channel do |chan|
+              chan.request_pty
+              chan.exec cmd.to_command do |_ch, _success|
+                chan.on_data do |ch, data|
+                  cmd.on_stdout(ch, data)
+                  output.log_command_data(cmd, :stdout, data)
+                end
+                chan.on_extended_data do |ch, _type, data|
+                  cmd.on_stderr(ch, data)
+                  output.log_command_data(cmd, :stderr, data)
+                end
+                chan.on_request("exit-status") do |_ch, data|
+                  exit_status = data.read_long
+                end
+                #chan.on_request("exit-signal") do |ch, data|
+                #  # TODO: This gets called if the program is killed by a signal
+                #  # might also be a worthwhile thing to report
+                #  exit_signal = data.read_string.to_i
+                #  warn ">>> " + exit_signal.inspect
+                #  output.log_command_killed(cmd, exit_signal)
+                #end
+                chan.on_open_failed do |_ch|
+                  # TODO: What do do here?
+                  # I think we should raise something
+                end
+                chan.on_process do |_ch|
+                  # TODO: I don't know if this is useful
+                end
+                chan.on_eof do |_ch|
+                  # TODO: chan sends EOF before the exit status has been
+                  # writtend
+                end
+              end
+              chan.wait
+            end
+            ssh.loop
+          end
+          # Set exit_status and log the result upon completion
+          if exit_status
+            cmd.exit_status = exit_status
+            output.log_command_exit(cmd)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sshkit/sudo/interaction_handler.rb

@@ -0,0 +1,61 @@
+module SSHKit
+  module Sudo
+    class DefaultInteractionHandler
+      def wrong_password; self.class.wrong_password; end
+      def password_prompt; self.class.password_prompt; end
+
+      def on_data(command, stream_name, data, channel)
+        if data =~ wrong_password
+          puts data if defined?(Airbrussh) and
+                       Airbrussh.configuration.command_output != :stdout and
+                       data !~ password_prompt
+          SSHKit::Sudo.password_cache[password_cache_key(command.host)] = nil
+        end
+        if data =~ password_prompt
+          key = password_cache_key(command.host)
+          pass = SSHKit::Sudo.password_cache[key]
+          unless pass
+            print data
+            pass = $stdin.noecho(&:gets)
+            puts ''
+            SSHKit::Sudo.password_cache[key] = pass
+          end
+          channel.send_data(pass)
+        end
+      end
+
+      def password_cache_key(host)
+        "#{host.user}@#{host.hostname}"
+      end
+
+      class << self
+        def wrong_password
+          @wrong_password ||= /Sorry.*\stry\sagain/
+        end
+
+        def password_prompt
+          @password_prompt ||= /[Pp]assword.*:/
+        end
+
+        def wrong_password_regexp(regexp)
+          @wrong_password = regexp
+        end
+
+        def password_prompt_regexp(regexp)
+          @password_prompt = regexp
+        end
+
+        def use_same_password!
+          class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def password_cache_key(host)
+            '0'
+          end
+          METHOD
+        end
+      end
+    end
+
+    class InteractionHandler < DefaultInteractionHandler
+    end
+  end
+end

data/lib/sshkit/sudo/version.rb

@@ -1,5 +1,5 @@
 module SSHKit
   module Sudo
-    VERSION = "0.0.5"
+    VERSION = "0.1.0"
   end
 end

data/sshkit-sudo.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 1.9.3"
 
-  spec.add_dependency "sshkit", "< 1.8"
+  spec.add_dependency "sshkit", "~> 1.8"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit-sudo
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Kentaro Imai
@@ -14,14 +14,14 @@ dependencies:
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
@@ -65,9 +65,9 @@ files:
 - README.md
 - Rakefile
 - lib/sshkit/sudo.rb
-- lib/sshkit/sudo/backends_ext/local.rb
-- lib/sshkit/sudo/backends_ext/netssh.rb
-- lib/sshkit/sudo/backends_ext/printer.rb
+- lib/sshkit/sudo/backends/abstract.rb
+- lib/sshkit/sudo/backends/netssh.rb
+- lib/sshkit/sudo/interaction_handler.rb
 - lib/sshkit/sudo/version.rb
 - sshkit-sudo.gemspec
 homepage: ''

data/lib/sshkit/sudo/backends_ext/local.rb

@@ -1,11 +0,0 @@
-module SSHKit
-  module Backend
-    class Local < Printer
-      def sudo(*args)
-        _execute(:sudo, *args).success?
-      end
-
-      alias execute! execute
-    end
-  end
-end

data/lib/sshkit/sudo/backends_ext/netssh.rb

@@ -1,88 +0,0 @@
-require 'io/console'
-
-module SSHKit
-  module Backend
-
-    class Netssh < Printer
-      def sudo(*args)
-        _execute!(:sudo, *args).success?
-      end
-
-      def execute!(*args)
-        _execute!(*args).success?
-      end
-
-      private
-
-      def _execute!(*args)
-        command(*args).tap do |cmd|
-          output << cmd
-          cmd.started = true
-          exit_status = nil
-          with_ssh do |ssh|
-            ssh.open_channel do |chan|
-              chan.request_pty
-              chan.exec cmd.to_command do |ch, success|
-                chan.on_data do |ch, data|
-                  cmd.stdout = data
-                  cmd.full_stdout += data
-                  output << cmd
-                  if data =~ /Sorry.*\stry\sagain/
-                    SSHKit::Sudo.password_cache[password_cache_key(cmd.host)] = nil
-                  end
-                  if data =~ /[Pp]assword.*:/
-                    key = password_cache_key(cmd.host)
-                    pass = SSHKit::Sudo.password_cache[key]
-                    unless pass
-                      pass = $stdin.noecho(&:gets)
-                      SSHKit::Sudo.password_cache[key] = pass
-                    end
-                    ch.send_data(pass)
-                  end
-                end
-                chan.on_extended_data do |ch, type, data|
-                  cmd.stderr = data
-                  cmd.full_stderr += data
-                  output << cmd
-                end
-                chan.on_request("exit-status") do |ch, data|
-                  exit_status = data.read_long
-                end
-                #chan.on_request("exit-signal") do |ch, data|
-                #  # TODO: This gets called if the program is killed by a signal
-                #  # might also be a worthwhile thing to report
-                #  exit_signal = data.read_string.to_i
-                #  warn ">>> " + exit_signal.inspect
-                #  output << cmd
-                #end
-                chan.on_open_failed do |ch|
-                  # TODO: What do do here?
-                  # I think we should raise something
-                end
-                chan.on_process do |ch|
-                  # TODO: I don't know if this is useful
-                end
-                chan.on_eof do |ch|
-                  # TODO: chan sends EOF before the exit status has been
-                  # writtend
-                end
-              end
-              chan.wait
-            end
-            ssh.loop
-          end
-          # Set exit_status and log the result upon completion
-          if exit_status
-            cmd.exit_status = exit_status
-            output << cmd
-          end
-        end
-      end
-
-      def password_cache_key(host)
-        "#{host.user}@#{host.hostname}"
-      end
-    end
-  end
-
-end

data/lib/sshkit/sudo/backends_ext/printer.rb

@@ -1,13 +0,0 @@
-module SSHKit
-  module Backend
-    class Printer < Abstract
-      def sudo(*args)
-        command(:sudo, *args).tap do |cmd|
-          output << cmd
-        end
-      end
-
-      alias execute! execute
-    end
-  end
-end