Class: Net::SSH::Test::Script

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

### Methods

gets gets_channel_close gets_channel_data gets_channel_eof gets_channel_request new next opens_channel process sends sends_channel_close sends_channel_data sends_channel_eof sends_channel_request

### Attributes

events | [R] | The list of scripted events. These will be Net::SSH::Test::LocalPacket and Net::SSH::Test::RemotePacket instances.

### Public Class methods

new()

Create a new, empty script.

### Public Instance methods

gets(type, *args)

A convenience method for adding an arbitrary remote packet to the events list.

gets_channel_close(channel)

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.

gets_channel_data(channel, data)

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.

gets_channel_eof(channel)

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.

gets_channel_request(channel, request, reply, data)

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.

next(mode=:shift)

By default, removes the next event in the list and returns it. However, this can also be used to non-destructively peek at the next event in the list, by passing :first as the argument.

      # remove the next event and return it
      event = script.next

      # peek at the next event
      event = script.next(:first)

opens_channel(confirm=true)

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.

process(packet)

Compare the given packet against the next event in the list. If there is no next event, an exception will be raised. This is called by Net::SSH::Test::Extensions::PacketStream#test_enqueue_packet.

sends(type, *args, &block)

A convenience method for adding an arbitrary local packet to the events list.

sends_channel_close(channel)

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.

sends_channel_data(channel, data)

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.

sends_channel_eof(channel)

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.

sends_channel_request(channel, request, reply, data, success=true)

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.

[Validate]