net-sftp 0.5.0

data/test/protocol/03/tc_impl.rb

@@ -0,0 +1,48 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../../lib"
+$:.unshift File.join( File.dirname( __FILE__ ), ".." )
+
+require '02/tc_impl.rb'
+require 'net/sftp/protocol/03/impl'
+
+class TC_03_Impl < TC_02_Impl
+
+  def impl_class
+    Net::SFTP::Protocol::V_03::Impl
+  end
+
+  operation :readlink
+
+  operation :symlink
+
+  def test_do_status_with_callback
+    buffer = Net::SSH::Util::ReaderBuffer.new( "\0\0\0\1\0\0\0\2" +
+      "\0\0\0\1a\0\0\0\1b" )
+    called = false
+    @impl.on_status do |d,i,c,a,b|
+      called = true
+      assert_equal 1, i
+      assert_equal 2, c
+      assert_equal "a", a
+      assert_equal "b", b
+    end
+    @impl.do_status nil, buffer
+    assert called
+  end
+
+end

data/test/protocol/03/tc_packet_assistant.rb

@@ -0,0 +1,34 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../../lib"
+$:.unshift File.join( File.dirname( __FILE__ ), ".." )
+
+require '02/tc_packet_assistant'
+require 'net/sftp/protocol/03/packet-assistant'
+
+class TC_03_PacketAssistant < TC_02_PacketAssistant
+
+  def packet_assistant_class
+    Net::SFTP::Protocol::V_03::PacketAssistant
+  end
+
+  packet :readlink, [ "a path" ], "\0\0\0\6a path"
+
+  packet :symlink, [ "from path", "to path" ],
+    "\0\0\0\11from path\0\0\0\7to path"
+
+end

data/test/protocol/04/tc_attributes.rb

@@ -0,0 +1,174 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../../lib"
+
+require 'test/unit'
+require 'net/sftp/protocol/04/attributes'
+
+require 'net/ssh'
+require 'net/ssh/util/buffer'
+
+class TC_04_Attributes < Test::Unit::TestCase
+
+  class Buffers
+    def writer
+      Net::SSH::Util::WriterBuffer.new
+    end
+    def reader( text )
+      Net::SSH::Util::ReaderBuffer.new( text )
+    end
+  end
+
+  def setup
+    @factory = Net::SFTP::Protocol::V_04::Attributes.init( Buffers.new )
+  end
+
+  def test_empty
+    empty = @factory.empty
+    assert_equal 1, empty.type
+    assert_nil empty.size
+    assert_nil empty.owner
+    assert_nil empty.group
+    assert_nil empty.permissions
+    assert_nil empty.atime
+    assert_nil empty.atime_nseconds
+    assert_nil empty.ctime
+    assert_nil empty.ctime_nseconds
+    assert_nil empty.mtime
+    assert_nil empty.mtime_nseconds
+    assert_nil empty.acl
+    assert_nil empty.extended
+    assert_equal "\0\0\0\0\1", empty.to_s
+  end
+
+  def test_from_buffer_empty
+    buffer = @factory.buffers.reader( "\0\0\0\0\2" )
+    attrs = @factory.from_buffer( buffer )
+    assert_equal 2, attrs.type
+    assert_nil attrs.size
+    assert_nil attrs.owner
+    assert_nil attrs.group
+    assert_nil attrs.permissions
+    assert_nil attrs.atime
+    assert_nil attrs.atime_nseconds
+    assert_nil attrs.ctime
+    assert_nil attrs.ctime_nseconds
+    assert_nil attrs.mtime
+    assert_nil attrs.mtime_nseconds
+    assert_nil attrs.acl
+    assert_nil attrs.extended
+    assert_equal "\0\0\0\0\2", attrs.to_s
+  end
+
+  ACL = Net::SFTP::Protocol::V_04::Attributes::ACL
+  ATTRIBUTES = 
+    [ [ 0x00000001, "\1\2\3\4\5\6\7\10", :size, 0x0102030405060708 ],
+      [ 0x00000080, "\0\0\0\1a\0\0\0\1b", :owner, "a" ],
+      [ 0x00000080, "\0\0\0\1a\0\0\0\1b", :group, "b" ],
+      [ 0x00000004, "\21\22\23\24", :permissions, 0x11121314 ],
+      [ 0x00000138,
+        "\1\1\1\1\1\1\1\1\0\1\2\3" +
+        "\2\2\2\2\2\2\2\2\4\5\6\7" +
+        "\3\3\3\3\3\3\3\3\2\4\6\10", :atime_nseconds, 0x00010203 ],
+      [ 0x00000008, "\1\2\3\4\1\2\3\4", :atime, 0x0102030401020304 ],
+      [ 0x00000010, "\4\3\4\3\4\3\4\3", :ctime, 0x0403040304030403 ],
+      [ 0x00000020, "\4\3\2\1\4\3\2\1", :mtime, 0x0403020104030201 ],
+      [ 0x00000040, "\0\0\0\46\0\0\0\2\0\0\0\1\0\0\0\2\0\0\0\3\0\0\0\1a" +
+        "\0\0\0\4\0\0\0\5\0\0\0\6\0\0\0\1b", :acl,
+        [ ACL.new( 1, 2, 3, "a" ), ACL.new( 4, 5, 6, "b" ) ] ],
+      [ 0x80000000,
+        "\0\0\0\4" +
+        "\0\0\0\01a\0\0\0\01b" +
+        "\0\0\0\01c\0\0\0\01d" +
+        "\0\0\0\01e\0\0\0\01f" +
+        "\0\0\0\01g\0\0\0\01h",
+        :extended,
+        { "a" => "b", "c" => "d", "e" => "f", "g" => "h" } ] ]
+
+  # find all possible combinations of the elements of ATTRIBUTES
+  # (i.e., 'n' choose k, for k in [1..ATTRIBUTES.length]).
+  def self.choose( from, k )
+    result = []
+    ( from.length - k + 1 ).times do |i|
+      if i+1 < from.length && k > 1
+        choose( from[i+1..-1], k-1 ).each do |chosen|
+          result << [ from[i], *chosen ]
+        end
+      else
+        result << [ from[i] ]
+      end
+    end
+    result
+  end
+
+  method_id = 0
+  ATTRIBUTES.length.times do |k|
+    choose( ATTRIBUTES, k+1 ).each do |attrs|
+      vars = attrs.map { |a| a[2] }.join( "_" )
+      define_method( "test_attributes_#{vars}_%03d" % method_id ) do
+        flags = 0
+        buffer = "\1"
+        attrs.each do |a|
+          if ( flags & a[0] ) == 0
+            flags |= a[0]
+            buffer += a[1]
+          end
+        end
+        buffer = [ flags, buffer ].pack( "NA*" )
+        input = @factory.buffers.reader( buffer )
+        obj = @factory.from_buffer( input )
+        assert_equal 1, obj.type, vars
+        flags = 0
+        attrs.each do |a|
+          if ( flags & a[0] ) == 0
+            assert_equal a[3], obj.__send__( a[2] ), a[2]
+            flags |= a[0]
+          end
+        end
+        assert_equal buffer, obj.to_s, vars
+      end
+      method_id += 1
+    end
+  end
+
+  require 'etc'
+  [
+    [ { :type => 3 }, :type, 3 ],
+    [ { :size => 1000 }, :size, 1000, :permissions ],
+    [ { :owner => ENV['USER'] }, :owner, ENV['USER'] ],
+    [ { :group => 'root' }, :group, 'root' ],
+    [ { :uid => Etc.getpwnam(ENV['USER']).uid }, :owner, ENV['USER'] ],
+    [ { :gid => Etc.getgrnam('root').gid }, :group, 'root' ],
+    [ { :permissions => 0600 }, :permissions, 0600 ],
+    [ { :atime => 1 }, :atime, 1 ],
+    [ { :atime_nseconds => 2 }, :atime_nseconds, 2 ],
+    [ { :ctime => 1 }, :ctime, 1 ],
+    [ { :ctime_nseconds => 2 }, :ctime_nseconds, 2 ],
+    [ { :mtime => 1 }, :mtime, 1 ],
+    [ { :mtime_nseconds => 2 }, :mtime_nseconds, 2 ],
+    [ { :acl => [ ACL.new(1,2,3,4), ACL.new(5,6,7,8) ] },
+          :acl, [ ACL.new(1,2,3,4), ACL.new(5,6,7,8) ] ],
+    [ { :extended => { "foo" => "bar" } }, :extended, { "foo" => "bar" } ]
+  ].each do |fixture|
+    define_method( "test_from_hash_#{fixture[1]}" ) do
+      attrs = @factory.from_hash( fixture[0] )
+      assert_equal fixture[2], attrs.__send__( fixture[1] )
+      assert_nil attrs.__send__( fixture[3] || :size )
+    end
+  end
+
+end

data/test/protocol/04/tc_impl.rb

@@ -0,0 +1,102 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../../lib"
+$:.unshift File.join( File.dirname( __FILE__ ), ".." )
+
+require 'net/sftp/protocol/04/impl'
+require '03/tc_impl'
+
+class TC_04_Impl < TC_03_Impl
+
+  def impl_class
+    Net::SFTP::Protocol::V_04::Impl
+  end
+
+  unless defined?( IO_FLAGS_V4 )
+    IO_FLAGS_V4 = [ IO::RDONLY, IO::WRONLY, IO::RDWR, IO::APPEND ]
+    OTHER_FLAGS_V4 = [ 0, IO::CREAT, IO::TRUNC, IO::EXCL ]
+    FLAG_MAP_V4 = { IO::RDONLY => 2, IO::WRONLY => 1, IO::RDWR => 3,
+      IO::APPEND => 11, IO::CREAT => 3, IO::TRUNC => 4 }
+    ACCESS_MAP_V4 = { IO::RDONLY => 0x81, IO::WRONLY => 0x102,
+      IO::RDWR => 0x183, IO::APPEND => 0x106 }
+
+    IO_FLAGS_V4.each do |flag|
+      OTHER_FLAGS_V4.each do |oflag|
+        [ nil, 0400 ].each do |mode|
+          define_method( "test_open_#{flag}_#{oflag}_#{mode||"nil"}" ) do
+            return if oflag == IO::EXCL
+            @assistant.mock_handle( :open ) { |*a| [ a[0], a[1..-1] ] }
+            args = [ 14, "a path", flag | oflag ]
+            args << mode if mode
+            assert_equal 14, @impl.open( *args )
+            assert_equal 1, @assistant.mock_count( :open )
+            assert_equal( ( mode || 0660 ), @permissions )
+            sftp_flag = FLAG_MAP_V4[flag] |
+              ( oflag == 0 ? 0 : FLAG_MAP_V4[oflag] )
+            access_flag = ACCESS_MAP_V4[flag]
+            assert_equal Net::SFTP::Protocol::Constants::FXP_OPEN,
+              @sent_data.first[0]
+            assert_equal [ "a path", access_flag, sftp_flag ],
+              @sent_data.first[1][0,3]
+          end
+        end
+      end
+    end
+  end
+
+  def test_stat_flags
+    @assistant.mock_handle( :stat ) { |*a| [ a[0], a[1..-1] ] }
+    id = @impl.stat( 14, :a, :b )
+    assert_equal 14, id
+    assert_equal 1, @assistant.mock_count( :stat )
+    assert_equal 1, @driver.mock_count( :send_data )
+    assert_equal [
+      [ Net::SFTP::Protocol::Constants::FXP_STAT, [ :a, :b ]] ], @sent_data
+  end
+
+  def test_lstat_flags
+    @assistant.mock_handle( :lstat ) { |*a| [ a[0], a[1..-1] ] }
+    id = @impl.lstat( 14, :a, :b )
+    assert_equal 14, id
+    assert_equal 1, @assistant.mock_count( :lstat )
+    assert_equal 1, @driver.mock_count( :send_data )
+    assert_equal [
+      [ Net::SFTP::Protocol::Constants::FXP_LSTAT, [ :a, :b ]] ], @sent_data
+  end
+
+  def test_fstat_flags
+    @assistant.mock_handle( :fstat ) { |*a| [ a[0], a[1..-1] ] }
+    id = @impl.fstat( 14, :a, :b )
+    assert_equal 14, id
+    assert_equal 1, @assistant.mock_count( :fstat )
+    assert_equal 1, @driver.mock_count( :send_data )
+    assert_equal [
+      [ Net::SFTP::Protocol::Constants::FXP_FSTAT, [ :a, :b ]] ], @sent_data
+  end
+
+  def test_rename_flags
+    @assistant.mock_handle( :rename ) { |*a| [ a[0], a[1..-1] ] }
+    id = @impl.rename( 14, :a, :b, :c )
+    assert_equal 14, id
+    assert_equal 1, @assistant.mock_count( :rename )
+    assert_equal 1, @driver.mock_count( :send_data )
+    assert_equal [
+      [ Net::SFTP::Protocol::Constants::FXP_RENAME, [ :a, :b, :c ]] ],
+      @sent_data
+  end
+
+end

data/test/protocol/04/tc_packet_assistant.rb

@@ -0,0 +1,41 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../../lib"
+$:.unshift File.join( File.dirname( __FILE__ ), ".." )
+
+require '03/tc_packet_assistant'
+require 'net/sftp/protocol/04/packet-assistant'
+
+class TC_04_PacketAssistant < TC_03_PacketAssistant
+
+  def packet_assistant_class
+    Net::SFTP::Protocol::V_04::PacketAssistant
+  end
+
+  packet :open, [ "a path", 1, 2, "attrs" ],
+    "\0\0\0\6a path\0\0\0\1\0\0\0\2attrs"
+
+  packet :rename, [ "old name", "new name", 1 ],
+    "\0\0\0\10old name\0\0\0\10new name\0\0\0\1"
+
+  packet :stat, [ "a path", 1 ], "\0\0\0\6a path\0\0\0\1"
+
+  packet :lstat, [ "a path", 1 ], "\0\0\0\6a path\0\0\0\1"
+
+  packet :fstat, [ "handle", 1 ], "\0\0\0\6handle\0\0\0\1"
+
+end

data/test/protocol/tc_driver.rb

@@ -0,0 +1,219 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+$:.unshift "../../lib"
+
+require 'test/unit'
+require 'net/sftp/protocol/driver'
+require 'net/ssh/util/buffer'
+require 'flexmock'
+
+class TC_Protocol_Driver < Test::Unit::TestCase
+
+  class Buffers
+    def writer
+      Net::SSH::Util::WriterBuffer.new
+    end
+    def reader( text )
+      Net::SSH::Util::ReaderBuffer.new( text )
+    end
+  end
+
+  def reader( text )
+    Net::SSH::Util::ReaderBuffer.new( text )
+  end
+
+  def force_state( state )
+    @driver.instance_eval { @state = state }
+  end
+
+  def setup
+    @channel = FlexMock.new
+    @channel.mock_handle( :close )
+    @channel.mock_handle( :subsystem )
+    @channel.mock_handle( :on_success )
+    @channel.mock_handle( :on_data )
+    @channel.mock_handle( :send_data )
+
+    @connection = FlexMock.new
+    @connection.mock_handle( :open_channel ) { @channel }
+
+    @log = FlexMock.new
+    @log.mock_handle( :debug? )
+    @log.mock_handle( :debug )
+    @log.mock_handle( :info? )
+    @log.mock_handle( :info )
+
+    @dispatchers = FlexMock.new
+
+    @dispatcher = FlexMock.new
+
+    @dispatchers.mock_handle( :[] ) do |v,e|
+      @version = v
+      @extensions = e
+      @dispatcher
+    end
+
+    @driver = Net::SFTP::Protocol::Driver.new( @connection, Buffers.new, 5,
+      @dispatchers, @log )
+  end
+
+  def test_initial_state
+    assert_equal :unconfirmed, @driver.state
+  end
+
+  def test_close
+    @driver.close
+    assert_equal 1, @channel.mock_count( :close )
+    assert_equal :closed, @driver.state
+  end
+
+  def test_next_request_id
+    assert_equal 0, @driver.next_request_id
+    assert_equal 1, @driver.next_request_id
+    assert_equal 2, @driver.next_request_id
+  end
+
+  def test_do_confirm_bad_state
+    force_state :bogus
+    assert_raise( Net::SFTP::Bug ) { @driver.do_confirm @channel }
+  end
+
+  def test_do_confirm
+    force_state :unconfirmed
+    @channel.mock_handle( :subsystem ) { |a| assert_equal "sftp", a }
+    @driver.do_confirm @channel
+    assert_equal 1, @channel.mock_count( :subsystem )
+    assert_equal 1, @channel.mock_count( :on_success )
+    assert_equal 1, @channel.mock_count( :on_data )
+    assert_equal :init, @driver.state
+  end
+
+  def test_do_success_bad_state
+    force_state :bogus
+    assert_raise( Net::SFTP::Bug ) { @driver.do_success @channel }
+  end
+
+  def test_do_success
+    force_state :init
+    packet = nil
+    @channel.mock_handle( :send_data ) { |p| packet = p }
+    @driver.do_success @channel
+    assert_equal 1, @channel.mock_count( :send_data )
+    assert_equal "\0\0\0\5\1\0\0\0\5", packet.to_s
+  end
+
+  def test_version_bad_state
+    force_state :bogus
+    assert_raise( Net::SFTP::Bug ) { @driver.do_version nil }
+  end
+
+  def test_version_server_higher
+    force_state :version
+    @driver.do_version reader( "\0\0\0\7" )
+    assert_equal 5, @version
+    assert_equal Hash.new, @extensions
+    assert_equal :open, @driver.state
+  end
+
+  def test_version_server_lower
+    force_state :version
+    @driver.do_version reader( "\0\0\0\3" )
+    assert_equal 3, @version
+    assert_equal Hash.new, @extensions
+    assert_equal :open, @driver.state
+  end
+
+  def test_version_extensions
+    force_state :version
+    @driver.do_version reader( "\0\0\0\3\0\0\0\1a\0\0\0\1b\0\0\0\1c\0\0\0\1d" )
+    assert_equal( {"a"=>"b","c"=>"d"}, @extensions )
+  end
+
+  def test_version_with_on_open
+    force_state :version
+    called = false
+    @driver.on_open { called = true }
+    @driver.do_version reader( "\0\0\0\3" )
+    assert called
+  end
+
+  def test_do_data_version
+    force_state :version
+    @driver.do_data( nil, "\0\0\0\5\2\0\0\0\3" )
+    assert_equal 1, @dispatchers.mock_count( :[] )
+  end
+
+  def test_do_dispatch
+    # define the dispatcher
+    force_state :version
+    @driver.do_version reader( "\0\0\0\3" )
+
+    channel = type = content = 0
+    @dispatcher.mock_handle( :dispatch ) { |c,t,n|
+      channel, type, content = c,t,n }
+    @driver.do_data( nil, "\0\0\0\5\7\0\0\0\0" )
+    assert_equal 1, @dispatcher.mock_count(:dispatch)
+    assert_nil channel
+    assert_equal 7, type
+    assert_equal "\0\0\0\0", content.to_s
+  end
+
+  def test_do_dispatch_multipass
+    # define the dispatcher
+    force_state :version
+    @driver.do_version reader( "\0\0\0\3" )
+
+    channel = type = content = 0
+    @dispatcher.mock_handle( :dispatch ) { |c,t,n|
+      channel, type, content = c,t,n }
+    @driver.do_data( nil, "\0\0\0\5\7\0\0" )
+
+    assert_equal 0, @dispatcher.mock_count(:dispatch)
+    assert_equal 0, channel
+    assert_equal 0, type
+    assert_equal 0, content
+
+    @driver.do_data( nil, "\0\0" )
+
+    assert_equal 1, @dispatcher.mock_count(:dispatch)
+    assert_nil channel
+    assert_equal 7, type
+    assert_equal "\0\0\0\0", content.to_s
+  end
+
+  def test_method_missing_found
+    force_state :version
+    @driver.do_version reader( "\0\0\0\3" )
+
+    def @dispatcher.respond_to?(sym)
+      super || sym == :foo
+    end
+
+    @dispatcher.mock_handle( :foo )
+    assert @driver.respond_to?( :foo )
+
+    @driver.foo
+
+    assert_equal 1, @dispatcher.mock_count( :foo )
+  end
+
+  def test_method_missing_not_found
+    assert !@driver.respond_to?( :foo )
+    assert_raise( NoMethodError ) { @driver.foo }
+  end
+
+end