Ssh transport for network device management

It is an adapatation of net-ssh-telnet, so that net-ssh conforms to
a saner interface for consumer.

Signed-off-by: Brice Figureau <brice-puppet@daysofwonder.com>

1 files changed, 212 insertions, 0 deletions

diff --git a/spec/unit/util/network_device/transport/ssh_spec.rb b/spec/unit/util/network_device/transport/ssh_spec.rb
new file mode 100644
index 000000000..ddf685628
--- /dev/null
+++ b/spec/unit/util/network_device/transport/ssh_spec.rb
@@ -0,0 +1,212 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../../../../spec_helper'
+
+require 'puppet/util/network_device/transport/ssh'
+
+describe Puppet::Util::NetworkDevice::Transport::Ssh do
+  confine "Missing net/ssh" => Puppet.features.ssh?
+
+  before(:each) do
+    @transport = Puppet::Util::NetworkDevice::Transport::Ssh.new()
+  end
+
+  it "should handle login through the transport" do
+    @transport.should be_handles_login
+  end
+
+  it "should connect to the given host and port" do
+    Net::SSH.expects(:start).with { |host, user, args| host == "localhost" && args[:port] == 22 }.returns stub_everything
+    @transport.host = "localhost"
+    @transport.port = 22
+
+    @transport.connect
+  end
+
+  it "should connect using the given username and password" do
+    Net::SSH.expects(:start).with { |host, user, args| user == "user" && args[:password] == "pass" }.returns stub_everything
+    @transport.user = "user"
+    @transport.password = "pass"
+
+    @transport.connect
+  end
+
+  describe "when connected" do
+    before(:each) do
+      @ssh = stub_everything 'ssh'
+      @channel = stub_everything 'channel'
+      Net::SSH.stubs(:start).returns @ssh
+      @ssh.stubs(:open_channel).yields(@channel)
+      @transport.stubs(:expect)
+    end
+
+    it "should open a channel" do
+      @ssh.expects(:open_channel)
+
+      @transport.connect
+    end
+
+    it "should request a pty" do
+      @channel.expects(:request_pty)
+
+      @transport.connect
+    end
+
+    it "should create a shell channel" do
+      @channel.expects(:send_channel_request).with("shell")
+      @transport.connect
+    end
+
+    it "should raise an error if shell channel creation fails" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, false)
+      lambda { @transport.connect }.should raise_error
+    end
+
+    it "should register an on_data and on_extended_data callback" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, true)
+      @channel.expects(:on_data)
+      @channel.expects(:on_extended_data)
+      @transport.connect
+    end
+
+    it "should accumulate data to the buffer on data" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, true)
+      @channel.expects(:on_data).yields(@channel, "data")
+
+      @transport.connect
+      @transport.buf.should == "data"
+    end
+
+    it "should accumulate data to the buffer on extended data" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, true)
+      @channel.expects(:on_extended_data).yields(@channel, 1, "data")
+
+      @transport.connect
+      @transport.buf.should == "data"
+    end
+
+    it "should mark eof on close" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, true)
+      @channel.expects(:on_close).yields(@channel)
+
+      @transport.connect
+      @transport.should be_eof
+    end
+
+    it "should expect output to conform to the default prompt" do
+      @channel.expects(:send_channel_request).with("shell").yields(@channel, true)
+      @transport.expects(:default_prompt).returns("prompt")
+      @transport.expects(:expect).with("prompt")
+      @transport.connect
+    end
+
+    it "should start the ssh loop" do
+      @ssh.expects(:loop)
+      @transport.connect
+    end
+  end
+
+  describe "when closing" do
+    before(:each) do
+      @ssh = stub_everything 'ssh'
+      @channel = stub_everything 'channel'
+      Net::SSH.stubs(:start).returns @ssh
+      @ssh.stubs(:open_channel).yields(@channel)
+      @channel.stubs(:send_channel_request).with("shell").yields(@channel, true)
+      @transport.stubs(:expect)
+      @transport.connect
+    end
+
+    it "should close the channel" do
+      @channel.expects(:close)
+      @transport.close
+    end
+
+    it "should close the ssh session" do
+      @ssh.expects(:close)
+      @transport.close
+    end
+  end
+
+  describe "when sending commands" do
+    before(:each) do
+      @ssh = stub_everything 'ssh'
+      @channel = stub_everything 'channel'
+      Net::SSH.stubs(:start).returns @ssh
+      @ssh.stubs(:open_channel).yields(@channel)
+      @channel.stubs(:send_channel_request).with("shell").yields(@channel, true)
+      @transport.stubs(:expect)
+      @transport.connect
+    end
+
+    it "should send data to the ssh channel" do
+      @channel.expects(:send_data).with("data\n")
+      @transport.command("data")
+    end
+
+    it "should expect the default prompt afterward" do
+      @transport.expects(:default_prompt).returns("prompt")
+      @transport.expects(:expect).with("prompt")
+      @transport.command("data")
+    end
+
+    it "should expect the given prompt" do
+      @transport.expects(:expect).with("myprompt")
+      @transport.command("data", :prompt => "myprompt")
+    end
+
+    it "should yield the buffer output to given block" do
+      @transport.expects(:expect).yields("output")
+      @transport.command("data") do |out|
+        out.should == "output"
+      end
+    end
+
+    it "should return buffer output" do
+      @transport.expects(:expect).returns("output")
+      @transport.command("data").should == "output"
+    end
+  end
+
+  describe "when expecting output" do
+    before(:each) do
+      @connection = stub_everything 'connection'
+      @socket = stub_everything 'socket'
+      transport = stub 'transport', :socket => @socket
+      @ssh = stub_everything 'ssh', :transport => transport
+      @channel = stub_everything 'channel', :connection => @connection
+      @transport.ssh = @ssh
+      @transport.channel = @channel
+    end
+
+    it "should process the ssh event loop" do
+      IO.stubs(:select)
+      @transport.buf = "output"
+      @transport.expects(:process_ssh)
+      @transport.expect(/output/)
+    end
+
+    it "should return the output" do
+      IO.stubs(:select)
+      @transport.buf = "output"
+      @transport.stubs(:process_ssh)
+      @transport.expect(/output/).should == "output"
+    end
+
+    it "should return the output" do
+      IO.stubs(:select)
+      @transport.buf = "output"
+      @transport.stubs(:process_ssh)
+      @transport.expect(/output/).should == "output"
+    end
+
+    describe "when processing the ssh loop" do
+      it "should advance one tick in the ssh event loop and exit on eof" do
+        @transport.buf = ''
+        @connection.expects(:process).then.raises(EOFError)
+        @transport.process_ssh
+      end
+    end
+  end
+
+end
\ No newline at end of file