Class | Net::SSH::Test::Script |
In: |
lib/net/ssh/test/script.rb
|
Parent: | Object |
Represents a sequence of scripted events that identify the behavior that a test expects. Methods named "sends_*" create events for packets being sent from the local to the remote host, and methods named "gets_*" create events for packets being received by the local from the remote host.
A reference to a script. is generally obtained in a unit test via the Net::SSH::Test#story helper method:
story do |script| channel = script.opens_channel ... end
events | [R] | The list of scripted events. These will be Net::SSH::Test::LocalPacket and Net::SSH::Test::RemotePacket instances. |
Scripts the reception of a channel close packet from the remote host by the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#gets_close.
Scripts the reception of a channel data packet from the remote host by the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#gets_data.
Scripts the reception of a channel EOF packet from the remote host by the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#gets_eof.
Scripts the reception of a channel request packet from the remote host by the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#gets_exit_status.
Scripts the opening of a channel by adding a local packet sending the channel open request, and if confirm is true (the default), also adding a remote packet confirming the new channel.
A new Net::SSH::Test::Channel instance is returned, which can be used to script additional channel operations.
Scripts the sending of a channel close packet from the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#sends_close.
Scripts the sending of a channel data packet. channel must be a Net::SSH::Test::Channel object, and data is the (string) data to expect will be sent.
This will typically be called via Net::SSH::Test::Channel#sends_data.
Scripts the sending of a channel EOF packet from the given Net::SSH::Test::Channel channel. This will typically be called via Net::SSH::Test::Channel#sends_eof.
Scripts the sending of a new channel request packet to the remote host. channel should be an instance of Net::SSH::Test::Channel. request is a string naming the request type to send, reply is a boolean indicating whether a response to this packet is required , and data is any additional request-specific data that this packet should send. success indicates whether the response (if one is required) should be success or failure.
If a reply is desired, a remote packet will also be queued, :channel_success if success is true, or :channel_failure if success is false.
This will typically be called via Net::SSH::Test::Channel#sends_exec or Net::SSH::Test::Channel#sends_subsystem.