remote-session 0.0.4 → 0.0.5

data/lib/remote/session.rb

@@ -8,7 +8,9 @@ require 'base64'
 
 module Remote
   class Session
-    SUDO_PROMPT = 'sudo_prompt'
+    SUDO_PASSWORD_PROMPT = 'remote-session-sudo-prompt'
+    ROOT_COMMAND_PROMPT  = 'remote-session-prompt#'
+    ROOT_COMMAND_PROMPT_MATCH = /#{ ROOT_COMMAND_PROMPT }$/
 
     def self.open( host, options = {}, &block )
       rs = new( host, options )
@@ -47,7 +49,7 @@ module Remote
 
     def sudo( commands )
       raise "Session is closed" if @session.nil?
-      commands = [ *commands ] + [ 'exit' ]
+      commands = [ *commands ]
 
       @session.open_channel do |ch|
         ch.request_pty do |ch, success|
@@ -89,10 +91,10 @@ module Remote
     def channel_exec( ch, commands )
       ch[ :commands ] = commands
 
-      ch.exec "sudo -k -p '#{ SUDO_PROMPT }' su -" do |ch, success|
+      ch.exec "sudo -k -p '#{ SUDO_PASSWORD_PROMPT }' su -" do |ch, success|
         raise "Could not execute sudo su command" if ! success
 
-        ch.on_data( &method( :on_data ) )
+        ch.on_data &method( :handle_sudo_password_prompt )
 
         ch.on_extended_data do |ch, type, data|
           $stderr.puts data
@@ -100,11 +102,35 @@ module Remote
       end
     end
 
-    def on_data( ch, data )
-      if data =~ Regexp.new( SUDO_PROMPT )
+    def handle_sudo_password_prompt( ch, data )
+      $stdout.write data
+
+      if data =~ Regexp.new( SUDO_PASSWORD_PROMPT )
         ch.send_data "#{ @sudo_password }\n"
-        return
+        ch.on_data &method( :set_command_prompt )
       end
+    end
+
+    # Set the root command prompt to something we can
+    # recognise, and wait until that prompt comes back
+    def set_command_prompt( ch, data )
+      $stdout.write data
+
+      if data =~ ROOT_COMMAND_PROMPT_MATCH
+        # Got it, now we can switch so sending commands
+        ch[ :awaiting_prompt ] = false
+        ch.on_data &method( :on_data )
+        do_command ch, data
+      elsif ! ch[ :awaiting_prompt ]
+        # this is the first time through...
+        ch[ :awaiting_prompt ] = true
+        ch.send_data "export PS1='#{ ROOT_COMMAND_PROMPT }'"
+      # else: Waiting for new root prompt
+      end
+    end
+
+    def on_data( ch, data )
+      $stdout.write data
 
       @prompts.each_pair do | prompt, send |
         if data =~ Regexp.new( prompt )
@@ -113,15 +139,21 @@ module Remote
         end
       end
 
-      $stdout.write( data )
-
-      return if ch[ :commands ].size == 0
+      if data =~ ROOT_COMMAND_PROMPT_MATCH
+        do_command ch, data
+      end
+    end
 
-      command = ch[ :commands ].shift
-      if command.is_a?( Remote::Session::Send )
-        send_file_chunk( ch, command )
+    def do_command( ch, data )
+      if ch[ :commands ].size > 0
+        command = ch[ :commands ].shift
+        if command.is_a?( Remote::Session::Send )
+          send_file_chunk( ch, command )
+        else
+          ch.send_data "#{command}\n"
+        end
       else
-        ch.send_data "#{command}\n"
+        ch.send_data "exit\n"
       end
     end
 

data/lib/remote/session/version.rb

@@ -2,7 +2,7 @@ module Remote
   class Session
     MAJOR    = 0
     MINOR    = 0
-    REVISION = 4
+    REVISION = 5
     VERSION  = [ MAJOR, MINOR, REVISION ].map( &:to_s ).join( '.' )
   end
 end

data/spec/unit/session_spec.rb

@@ -6,19 +6,28 @@ module SpecOutputCapture
   def expect_output
     stdout = []
     @rs.stub!( :puts ) do | s |
-      stdout << "{ s }\n"
+      stdout << s + "\n"
+    end
+    $stdout.stub!( :puts ) do | s |
+      stdout << s + "\n"
     end
     $stdout.stub!( :write ) do | s |
       stdout << s
     end
     stderr = []
+    $stderr.stub!( :puts ) do | s |
+      stderr << s + "\n"
+    end
     $stderr.stub!( :write ) do | s |
       stderr << s
     end
 
     yield
 
-    [ stdout, stderr ]
+    $stdout.rspec_reset
+    $stderr.rspec_reset
+
+    { :stdout => stdout, :stderr => stderr }
   end
 
 end
@@ -179,7 +188,7 @@ describe Remote::Session do
             request_pty_block.call( @ch, true )
           end
 
-          @ch.should_receive( :exec ).with( "sudo -k -p 'sudo_prompt' su -" )
+          @ch.should_receive( :exec ).with( "sudo -k -p 'remote-session-sudo-prompt' su -" )
 
           open_channel_block.call @ch
         end
@@ -234,187 +243,182 @@ describe Remote::Session do
               @ch.stub!( :exec ) do |&block|
                 block.call( @ch, true )
               end
+              @ch.stub!( :send_data => nil )
               @ch.stub!( :on_extended_data => nil )
-              @ch.stub!( :send_data )
-              $stdout.stub!( :write => nil )
-            end
+              $stdout.stub( :write => nil )
 
-            it 'should print the command to stdout' do
+              # For each call to Channel.on_data, @@data contains the strings
+              # to send back to the block
+              @@data = [ [ 'remote-session-sudo-prompt' ],               # channel_exec call
+                         [ 'any prompt#', 'remote-session-prompt#' ],    # handle_sudo_password_prompt call
+                         [ 'remote-session-prompt#', 'remote-session-prompt#', 'remote-session-prompt#' ] ]
               @ch.stub!( :on_data ) do |&block|
-                block.call( @ch, 'the_prompt' )
+                @@data.shift.each { |response| block.call @ch, response }
               end
+            end
 
-              @ch.should_receive( :send_data ).with( "pwd\n" )
+            it 'should supply the sudo password, when prompted' do
+              @ch.should_receive( :send_data ).with( "secret\n" )
 
-              subject.sudo( 'pwd' )
+              @rs.sudo( 'pwd' )
             end
 
-            it 'should run multiple commands' do
-              @ch.stub!( :on_data ) do |&block|
-                block.call( @ch, 'the_prompt' )
-                block.call( @ch, 'the_prompt' )
-                block.call( @ch, 'the_prompt' )
-                block.call( @ch, 'the_prompt' )
+            it 'should echo the sudo prompt' do
+              output = expect_output do
+                @rs.sudo( 'pwd' )
               end
+ 
+              output[ :stdout ][ 0 ].should == 'remote-session-sudo-prompt'
+            end
 
-              sent = []
-              @ch.stub!( :send_data ) { | s | sent << s }
-
-              subject.sudo( [ 'pwd', 'cd /etc', 'ls' ] )
+            context 'after sudo prompt' do
 
-              sent.should == [ "pwd\n", "cd /etc\n", "ls\n", "exit\n" ]
-            end
+              it 'should set the root command prompt' do
+                @ch.should_receive( :send_data ).with( "export PS1='remote-session-prompt#'" )
 
-            it 'should output returning data' do
-              @ch.stub!( :on_data ) do |&block|
-                block.call( @ch, 'some_data' )
+                @rs.sudo( 'pwd' )
               end
 
-              expect_output do
-                @rs.sudo( 'pwd' )
-              end.should == [ [ 'some_data' ], [] ]
-            end
+              it 'should echo until the prompt is set' do
+                @@data[ 1 ] = [ 'prompt#', 'stuff1', 'stuff2', 'remote-session-prompt#' ]
 
-            context 'sending files' do
+                output = expect_output do
+                  @rs.sudo( 'pwd' )
+                end
 
-              before :each do
-                @sf = stub( 'Remote::Session::SendFile instance', :open => nil, :close => nil )
+                output[ :stdout ].should include 'stuff1'
+                output[ :stdout ].should include 'stuff2'
               end
 
-              it 'should copy files' do
-                @ch.stub!( :on_data ) do |&block|
-                  block.call( @ch, 'root_prompt#' )
-                  block.call( @ch, 'root_prompt#' )
-                  block.call( @ch, 'root_prompt#' )
-                end
+              context 'with special command prompt' do
 
-                @sf.should_receive( :is_a? ).with( Remote::Session::Send ).twice.and_return( true )
-                @sf.should_receive( :remote_path ).twice.and_return( '/remote/path' )
+                it 'should send the command' do
+                  @ch.should_receive( :send_data ).with( "pwd\n" )
 
-                chunk = 0
-                open = false
-                @sf.should_receive( :open ) do
-                  chunk = 1
-                  open = true
+                  subject.sudo( 'pwd' )
                 end
 
-                @sf.stub!( :open? ) do
-                  open
+                it 'should run multiple commands' do
+                  sent = []
+                  @ch.stub!( :send_data ) { | s | sent << s }
+
+                  subject.sudo( [ 'pwd', 'cd /etc', 'ls' ] )
+
+                  sent[-4..-1].should == [ "pwd\n", "cd /etc\n", "ls\n", "exit\n" ]
                 end
 
-                @sf.stub!( :eof? ) do
-                  case chunk
-                  when 0
-                    true
-                  when 1, 2
-                    false
-                  else
-                    true
+                it 'should output returning data' do
+                  @@data[ 2 ] = [ 'remote-session-prompt#', 'some_data', 'remote-session-prompt#' ]
+                  output = expect_output do
+                    @rs.sudo( 'pwd' )
                   end
-                end
 
-                data = [ nil, 'first_chunk', 'second_chunk' ]
-                @sf.should_receive( :read ).twice do
-                  d = data[ chunk ]
-                  chunk += 1
-                  d
+                  output[ :stdout ].should include 'some_data'
                 end
 
-                sent = []
-                @ch.stub!( :send_data ) { | d | sent << d }
-
-                @rs.sudo( @sf )
+                context 'sending files' do
 
-                sent.should == [
-                  "echo -n 'Zmlyc3RfY2h1bms=\n' | base64 -d > /remote/path\n",
-                  "echo -n 'c2Vjb25kX2NodW5r\n' | base64 -d >> /remote/path\n",
-                  "exit\n"
-                ]
-              end
+                  before :each do
+                    @sf = stub( 'Remote::Session::SendFile instance', :open => nil, :close => nil )
+                  end
 
-              it 'should copy empty files' do
-                @ch.stub!( :on_data ) do |&block|
-                  block.call( @ch, 'root_prompt#' )
-                  block.call( @ch, 'root_prompt#' )
-                end
+                  it 'should copy files' do
+                    @sf.should_receive( :is_a? ).with( Remote::Session::Send ).twice.and_return( true )
+                    @sf.should_receive( :remote_path ).twice.and_return( '/remote/path' )
+
+                    chunk = 0
+                    open = false
+                    @sf.should_receive( :open ) do
+                      chunk = 1
+                      open = true
+                    end
+
+                    @sf.stub!( :open? ) do
+                      open
+                    end
+
+                    @sf.stub!( :eof? ) do
+                      case chunk
+                      when 0
+                        true
+                      when 1, 2
+                        false
+                      else
+                        true
+                      end
+                    end
+
+                    data = [ nil, 'first_chunk', 'second_chunk' ]
+                    @sf.should_receive( :read ).twice do
+                      d = data[ chunk ]
+                      chunk += 1
+                      d
+                    end
+
+                    sent = []
+                    @ch.stub!( :send_data ) { | d | sent << d }
+
+                    @rs.sudo( @sf )
+
+                    sent.should include "echo -n 'Zmlyc3RfY2h1bms=\n' | base64 -d > /remote/path\n"
+                    sent.should include "echo -n 'c2Vjb25kX2NodW5r\n' | base64 -d >> /remote/path\n"
+                  end
 
-                @sf.stub!( :is_a? ).with( Remote::Session::Send ).and_return( true )
-                @sf.stub!( :open? => false )
-                @sf.stub!( :remote_path ).and_return( '/remote/path' )
-                @sf.stub!( :eof? => true )
+                  it 'should copy empty files' do
+                    @sf.stub!( :is_a? ).with( Remote::Session::Send ).and_return( true )
+                    @sf.stub!( :open? => false )
+                    @sf.stub!( :remote_path ).and_return( '/remote/path' )
+                    @sf.stub!( :eof? => true )
 
-                sent = []
-                @ch.stub!( :send_data ) { | d | sent << d }
+                    sent = []
+                    @ch.stub!( :send_data ) { | d | sent << d }
 
 
-                @rs.sudo( @sf )
+                    @rs.sudo( @sf )
 
-                sent.should == [
-                  "echo -n '' | base64 -d > /remote/path\n",
-                  "exit\n"
-                ]
-              end
-              
-            end
+                    sent.should include "echo -n '' | base64 -d > /remote/path\n"
+                  end
 
-            context 'with password prompt' do
-              before :each do
-                $stdout.stub( :write )
-                @ch.stub!( :on_data ) do |&block|
-                  block.call( @ch, 'sudo_prompt' )
-                  block.call( @ch, 'root#' )
                 end
-              end
-
-              it 'should supply the sudo password, when prompted' do
-                @ch.should_receive( :send_data ).with( "secret\n" )
 
-                @rs.sudo( 'pwd' )
-              end
+                context 'with user-supplied prompt' do
+                  it 'should send the supplied data' do
+                    @@data[ 2 ] = [ 'remote-session-prompt#', 'Supply user password:', 'remote-session-prompt#' ]
+                    @ch.should_receive( :send_data ).with( "this data\n" )
+                    @rs.prompts[ 'user password:' ] = 'this data' 
 
-              it 'should not echo the standard prompt' do
-                expect_output do
-                  @rs.sudo( 'pwd' )
-                end.should == [ [ 'root#' ], [] ]
-              end
-            end
+                    @rs.sudo( 'pwd' )
+                  end
 
-            context 'with user-supplied prompt' do
-              before :each do
-                $stdout.stub( :write )
-                @ch.stub!( :on_data ) do |&block|
-                  block.call( @ch, 'Here is my prompt:' )
-                  block.call( @ch, 'root#' )
-                end
-              end
+                  it 'should echo the prompt' do
+                    @@data[ 2 ] = [ 'remote-session-prompt#', 'Supply user password:', 'remote-session-prompt#' ]
+                    @rs.prompts[ 'user password:' ] = 'this data' 
 
-              it 'should send the supplied data' do
-                @ch.should_receive( :send_data ).with( "this data\n" )
-                @rs.prompts[ 'my prompt' ] = 'this data' 
+                    output = expect_output do
+                      @rs.sudo( 'pwd' )
+                    end
+ 
+                    output[ :stdout ].should include 'Supply user password:'
+                  end
 
-                @rs.sudo( 'pwd' )
-              end
+                end
 
-              it 'should not echo the prompt' do
-                @rs.prompts[ 'my prompt' ] = 'this data' 
+                it 'should send error data to stdout' do
+                  @ch.stub!( :on_data )
 
-                expect_output do
-                  @rs.sudo( 'pwd' )
-                end.should == [ [ 'root#' ], [] ]
-              end
+                  @ch.stub!( :on_extended_data ) do |&block|
+                    block.call @ch, 'foo', 'It failed'
+                  end
 
-            end
+                  output = expect_output do
+                    @rs.sudo( 'pwd' )
+                  end
 
-            it 'should send error data to stdout' do
-              @ch.stub!( :on_data )
+                  output[ :stderr ].should include "It failed\n"
+                end
 
-              @ch.stub!( :on_extended_data ) do |&block|
-                block.call @ch, 'foo', 'It failed' 
               end
 
-              expect_output do
-                @rs.sudo( 'pwd' )
-              end.should == [ [], [ "It failed", "\n" ] ]
             end
 
           end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: remote-session
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joe Yates
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-20 00:00:00 Z
+date: 2012-06-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false