net-ssh 5.0.0.beta1 → 5.0.0.beta2

data/lib/net/ssh/test.rb

@@ -3,90 +3,92 @@ require 'net/ssh/connection/session'
 require 'net/ssh/test/kex'
 require 'net/ssh/test/socket'
 
-module Net; module SSH
+module Net 
+  module SSH
 
-  # This module may be used in unit tests, for when you want to test that your
-  # SSH state machines are really doing what you expect they are doing. You will
-  # typically include this module in your unit test class, and then build a
-  # "story" of expected sends and receives:
-  #
-  #   require 'minitest/autorun'
-  #   require 'net/ssh/test'
-  #
-  #   class MyTest < Minitest::Test
-  #     include Net::SSH::Test
-  #
-  #     def test_exec_via_channel_works
-  #       story do |session|
-  #         channel = session.opens_channel
-  #         channel.sends_exec "ls"
-  #         channel.gets_data "result of ls"
-  #         channel.gets_close
-  #         channel.sends_close
-  #       end
-  #
-  #       assert_scripted do
-  #         result = nil
-  #
-  #         connection.open_channel do |ch|
-  #           ch.exec("ls") do |success|
-  #             ch.on_data { |c, data| result = data }
-  #             ch.on_close { |c| c.close }
-  #           end
-  #         end
-  #
-  #         connection.loop
-  #         assert_equal "result of ls", result
-  #       end
-  #     end
-  #   end
-  #
-  # See Net::SSH::Test::Channel and Net::SSH::Test::Script for more options.
-  #
-  # Note that the Net::SSH::Test system is rather finicky yet, and can be kind
-  # of frustrating to get working. Any suggestions for improvement will be
-  # welcome!
-  module Test
-    # If a block is given, yields the script for the test socket (#socket).
-    # Otherwise, simply returns the socket's script. See Net::SSH::Test::Script.
-    def story
-      Net::SSH::Test::Extensions::IO.with_test_extension { yield socket.script if block_given? }
-      return socket.script
+    # This module may be used in unit tests, for when you want to test that your
+    # SSH state machines are really doing what you expect they are doing. You will
+    # typically include this module in your unit test class, and then build a
+    # "story" of expected sends and receives:
+    #
+    #   require 'minitest/autorun'
+    #   require 'net/ssh/test'
+    #
+    #   class MyTest < Minitest::Test
+    #     include Net::SSH::Test
+    #
+    #     def test_exec_via_channel_works
+    #       story do |session|
+    #         channel = session.opens_channel
+    #         channel.sends_exec "ls"
+    #         channel.gets_data "result of ls"
+    #         channel.gets_close
+    #         channel.sends_close
+    #       end
+    #
+    #       assert_scripted do
+    #         result = nil
+    #
+    #         connection.open_channel do |ch|
+    #           ch.exec("ls") do |success|
+    #             ch.on_data { |c, data| result = data }
+    #             ch.on_close { |c| c.close }
+    #           end
+    #         end
+    #
+    #         connection.loop
+    #         assert_equal "result of ls", result
+    #       end
+    #     end
+    #   end
+    #
+    # See Net::SSH::Test::Channel and Net::SSH::Test::Script for more options.
+    #
+    # Note that the Net::SSH::Test system is rather finicky yet, and can be kind
+    # of frustrating to get working. Any suggestions for improvement will be
+    # welcome!
+    module Test
+      # If a block is given, yields the script for the test socket (#socket).
+      # Otherwise, simply returns the socket's script. See Net::SSH::Test::Script.
+      def story
+        Net::SSH::Test::Extensions::IO.with_test_extension { yield socket.script if block_given? }
+        return socket.script
+      end
+  
+      # Returns the test socket instance to use for these tests (see
+      # Net::SSH::Test::Socket).
+      def socket(options={})
+        @socket ||= Net::SSH::Test::Socket.new
+      end
+  
+      # Returns the connection session (Net::SSH::Connection::Session) for use
+      # in these tests. It is a fully functional SSH session, operating over
+      # a mock socket (#socket).
+      def connection(options={})
+        @connection ||= Net::SSH::Connection::Session.new(transport(options), options)
+      end
+  
+      # Returns the transport session (Net::SSH::Transport::Session) for use
+      # in these tests. It is a fully functional SSH transport session, operating
+      # over a mock socket (#socket).
+      def transport(options={})
+        @transport ||= Net::SSH::Transport::Session.new(
+          options[:host] || "localhost",
+          options.merge(kex: "test", host_key: "ssh-rsa", verify_host_key: false, proxy: socket(options))
+        )
+      end
+  
+      # First asserts that a story has been described (see #story). Then yields,
+      # and then asserts that all items described in the script have been
+      # processed. Typically, this is called immediately after a story has
+      # been built, and the SSH commands being tested are then executed within
+      # the block passed to this assertion.
+      def assert_scripted
+        raise "there is no script to be processed" if socket.script.events.empty?
+        Net::SSH::Test::Extensions::IO.with_test_extension { yield }
+        assert socket.script.events.empty?, "there should not be any remaining scripted events, but there are still #{socket.script.events.length} pending"
+      end
     end
 
-    # Returns the test socket instance to use for these tests (see
-    # Net::SSH::Test::Socket).
-    def socket(options={})
-      @socket ||= Net::SSH::Test::Socket.new
-    end
-
-    # Returns the connection session (Net::SSH::Connection::Session) for use
-    # in these tests. It is a fully functional SSH session, operating over
-    # a mock socket (#socket).
-    def connection(options={})
-      @connection ||= Net::SSH::Connection::Session.new(transport(options), options)
-    end
-
-    # Returns the transport session (Net::SSH::Transport::Session) for use
-    # in these tests. It is a fully functional SSH transport session, operating
-    # over a mock socket (#socket).
-    def transport(options={})
-      @transport ||= Net::SSH::Transport::Session.new(
-        options[:host] || "localhost",
-        options.merge(kex: "test", host_key: "ssh-rsa", verify_host_key: false, proxy: socket(options))
-      )
-    end
-
-    # First asserts that a story has been described (see #story). Then yields,
-    # and then asserts that all items described in the script have been
-    # processed. Typically, this is called immediately after a story has
-    # been built, and the SSH commands being tested are then executed within
-    # the block passed to this assertion.
-    def assert_scripted
-      raise "there is no script to be processed" if socket.script.events.empty?
-      Net::SSH::Test::Extensions::IO.with_test_extension { yield }
-      assert socket.script.events.empty?, "there should not be any remaining scripted events, but there are still #{socket.script.events.length} pending"
-    end
   end
-
-end; end
+end

data/lib/net/ssh/test/channel.rb

@@ -1,145 +1,149 @@
-module Net; module SSH; module Test
+module Net 
+  module SSH 
+    module Test
+
+      # A mock channel, used for scripting actions in tests. It wraps a
+      # Net::SSH::Test::Script instance, and delegates to it for the most part.
+      # This class has little real functionality on its own, but rather acts as
+      # a convenience for scripting channel-related activity for later comparison
+      # in a unit test.
+      #
+      #   story do |session|
+      #     channel = session.opens_channel
+      #     channel.sends_exec "ls"
+      #     channel.gets_data "result of ls"
+      #     channel.gets_extended_data "some error coming from ls"
+      #     channel.gets_close
+      #     channel.sends_close
+      #   end
+      class Channel
+        # The Net::SSH::Test::Script instance employed by this mock channel.
+        attr_reader :script
+    
+        # Sets the local-id of this channel object (the id assigned by the client).
+        attr_writer :local_id
+    
+        # Sets the remote-id of this channel object (the id assigned by the mock-server).
+        attr_writer :remote_id
+    
+        # Creates a new Test::Channel instance on top of the given +script+ (which
+        # must be a Net::SSH::Test::Script instance).
+        def initialize(script)
+          @script = script
+          @local_id = @remote_id = nil
+        end
+    
+        # Returns the local (client-assigned) id for this channel, or a Proc object
+        # that will return the local-id later if the local id has not yet been set.
+        # (See Net::SSH::Test::Packet#instantiate!.)
+        def local_id
+          @local_id || Proc.new { @local_id or raise "local-id has not been set yet!" }
+        end
+    
+        # Returns the remote (server-assigned) id for this channel, or a Proc object
+        # that will return the remote-id later if the remote id has not yet been set.
+        # (See Net::SSH::Test::Packet#instantiate!.)
+        def remote_id
+          @remote_id || Proc.new { @remote_id or raise "remote-id has not been set yet!" }
+        end
+    
+        # Because adjacent calls to #gets_data will sometimes cause the data packets
+        # to be concatenated (causing expectations in tests to fail), you may
+        # need to separate those calls with calls to #inject_remote_delay! (which
+        # essentially just mimics receiving an empty data packet):
+        #
+        #   channel.gets_data "abcdefg"
+        #   channel.inject_remote_delay!
+        #   channel.gets_data "hijklmn"
+        def inject_remote_delay!
+          gets_data("")
+        end
+    
+        # Scripts the sending of an "exec" channel request packet to the mock 
+        # server. If +reply+ is true, then the server is expected to reply to the
+        # request, otherwise no response to this request will be sent. If +success+
+        # is +true+, then the request will be successful, otherwise a failure will
+        # be scripted.
+        #
+        #   channel.sends_exec "ls -l"
+        def sends_exec(command, reply=true, success=true)
+          script.sends_channel_request(self, "exec", reply, command, success)
+        end
+    
+        # Scripts the sending of a "subsystem" channel request packet to the mock
+        # server. See #sends_exec for a discussion of the meaning of the +reply+
+        # and +success+ arguments.
+        #
+        #   channel.sends_subsystem "sftp"
+        def sends_subsystem(subsystem, reply=true, success=true)
+          script.sends_channel_request(self, "subsystem", reply, subsystem, success)
+        end
+    
+        # Scripts the sending of a data packet across the channel.
+        #
+        #   channel.sends_data "foo"
+        def sends_data(data)
+          script.sends_channel_data(self, data)
+        end
+    
+        # Scripts the sending of an EOF packet across the channel.
+        #
+        #   channel.sends_eof
+        def sends_eof
+          script.sends_channel_eof(self)
+        end
+    
+        # Scripts the sending of a "channel close" packet across the channel.
+        #
+        #   channel.sends_close
+        def sends_close
+          script.sends_channel_close(self)
+        end
+    
+        # Scripts the sending of a "request pty" request packet across the channel.
+        #
+        #   channel.sends_request_pty
+        def sends_request_pty
+          script.sends_channel_request_pty(self)
+        end
+    
+        # Scripts the reception of a channel data packet from the remote end.
+        #
+        #   channel.gets_data "bar"
+        def gets_data(data)
+          script.gets_channel_data(self, data)
+        end
+    
+        # Scripts the reception of a channel extended data packet from the remote
+        # end.
+        #
+        #   channel.gets_extended_data "whoops"
+        def gets_extended_data(data)
+          script.gets_channel_extended_data(self, data)
+        end
+    
+        # Scripts the reception of an "exit-status" channel request packet.
+        #
+        #   channel.gets_exit_status(127)
+        def gets_exit_status(status=0)
+          script.gets_channel_request(self, "exit-status", false, status)
+        end
+    
+        # Scripts the reception of an EOF packet from the remote end.
+        #
+        #   channel.gets_eof
+        def gets_eof
+          script.gets_channel_eof(self)
+        end
+    
+        # Scripts the reception of a "channel close" packet from the remote end.
+        #
+        #   channel.gets_close
+        def gets_close
+          script.gets_channel_close(self)
+        end
+      end
 
-  # A mock channel, used for scripting actions in tests. It wraps a
-  # Net::SSH::Test::Script instance, and delegates to it for the most part.
-  # This class has little real functionality on its own, but rather acts as
-  # a convenience for scripting channel-related activity for later comparison
-  # in a unit test.
-  #
-  #   story do |session|
-  #     channel = session.opens_channel
-  #     channel.sends_exec "ls"
-  #     channel.gets_data "result of ls"
-  #     channel.gets_extended_data "some error coming from ls"
-  #     channel.gets_close
-  #     channel.sends_close
-  #   end
-  class Channel
-    # The Net::SSH::Test::Script instance employed by this mock channel.
-    attr_reader :script
-
-    # Sets the local-id of this channel object (the id assigned by the client).
-    attr_writer :local_id
-
-    # Sets the remote-id of this channel object (the id assigned by the mock-server).
-    attr_writer :remote_id
-
-    # Creates a new Test::Channel instance on top of the given +script+ (which
-    # must be a Net::SSH::Test::Script instance).
-    def initialize(script)
-      @script = script
-      @local_id = @remote_id = nil
-    end
-
-    # Returns the local (client-assigned) id for this channel, or a Proc object
-    # that will return the local-id later if the local id has not yet been set.
-    # (See Net::SSH::Test::Packet#instantiate!.)
-    def local_id
-      @local_id || Proc.new { @local_id or raise "local-id has not been set yet!" }
-    end
-
-    # Returns the remote (server-assigned) id for this channel, or a Proc object
-    # that will return the remote-id later if the remote id has not yet been set.
-    # (See Net::SSH::Test::Packet#instantiate!.)
-    def remote_id
-      @remote_id || Proc.new { @remote_id or raise "remote-id has not been set yet!" }
-    end
-
-    # Because adjacent calls to #gets_data will sometimes cause the data packets
-    # to be concatenated (causing expectations in tests to fail), you may
-    # need to separate those calls with calls to #inject_remote_delay! (which
-    # essentially just mimics receiving an empty data packet):
-    #
-    #   channel.gets_data "abcdefg"
-    #   channel.inject_remote_delay!
-    #   channel.gets_data "hijklmn"
-    def inject_remote_delay!
-      gets_data("")
-    end
-
-    # Scripts the sending of an "exec" channel request packet to the mock 
-    # server. If +reply+ is true, then the server is expected to reply to the
-    # request, otherwise no response to this request will be sent. If +success+
-    # is +true+, then the request will be successful, otherwise a failure will
-    # be scripted.
-    #
-    #   channel.sends_exec "ls -l"
-    def sends_exec(command, reply=true, success=true)
-      script.sends_channel_request(self, "exec", reply, command, success)
-    end
-
-    # Scripts the sending of a "subsystem" channel request packet to the mock
-    # server. See #sends_exec for a discussion of the meaning of the +reply+
-    # and +success+ arguments.
-    #
-    #   channel.sends_subsystem "sftp"
-    def sends_subsystem(subsystem, reply=true, success=true)
-      script.sends_channel_request(self, "subsystem", reply, subsystem, success)
-    end
-
-    # Scripts the sending of a data packet across the channel.
-    #
-    #   channel.sends_data "foo"
-    def sends_data(data)
-      script.sends_channel_data(self, data)
-    end
-
-    # Scripts the sending of an EOF packet across the channel.
-    #
-    #   channel.sends_eof
-    def sends_eof
-      script.sends_channel_eof(self)
-    end
-
-    # Scripts the sending of a "channel close" packet across the channel.
-    #
-    #   channel.sends_close
-    def sends_close
-      script.sends_channel_close(self)
-    end
-
-    # Scripts the sending of a "request pty" request packet across the channel.
-    #
-    #   channel.sends_request_pty
-    def sends_request_pty
-      script.sends_channel_request_pty(self)
-    end
-
-    # Scripts the reception of a channel data packet from the remote end.
-    #
-    #   channel.gets_data "bar"
-    def gets_data(data)
-      script.gets_channel_data(self, data)
-    end
-
-    # Scripts the reception of a channel extended data packet from the remote
-    # end.
-    #
-    #   channel.gets_extended_data "whoops"
-    def gets_extended_data(data)
-      script.gets_channel_extended_data(self, data)
-    end
-
-    # Scripts the reception of an "exit-status" channel request packet.
-    #
-    #   channel.gets_exit_status(127)
-    def gets_exit_status(status=0)
-      script.gets_channel_request(self, "exit-status", false, status)
-    end
-
-    # Scripts the reception of an EOF packet from the remote end.
-    #
-    #   channel.gets_eof
-    def gets_eof
-      script.gets_channel_eof(self)
-    end
-
-    # Scripts the reception of a "channel close" packet from the remote end.
-    #
-    #   channel.gets_close
-    def gets_close
-      script.gets_channel_close(self)
     end
   end
-
-end; end; end
+end