require 'custodian/protocoltest/tcp'

#
#  The SSH-protocol test.
#
#  This object is instantiated if the parser sees a line such as:
#
###
### foo.vm.bytemark.co.uk must run ssh on 22 otherwise 'ssh fail'.
###
#
#  The specification of the port is optional.
#
module Custodian
  module ProtocolTest

    class SSHTest < TCPTest


      #
      # The line from which we were constructed.
      #
      attr_reader :line


      #
      # The host to test against.
      #
      attr_reader :host


      #
      # The port to connect to.
      #
      attr_reader :port



      #
      # Constructor
      #
      # Ensure we received a port to run the test against.
      #
      def initialize( line )

        #
        # Save the line
        #
        @line = line

        #
        # Save the host
        #
        @host  = line.split( /\s+/)[0]

        #
        # Save the port
        #
        if ( line =~ /on\s+([0-9]+)/ )
          @port = $1.dup
        else
          @port = 22
        end
      end




      #
      # Helper for development.
      #
      def to_s
        "ssh-test of #{@host}:#{@port}."
      end




      #
      # Convert this class to JSON such that it may be
      # serialized.
      #
      def to_json
        hash = { :line => @line }
        hash.to_json
      end




      #
      # Run the TCP-protocol test.
      #
      def run_test

        # reset the error, in case we were previously executed.
        @error = nil

        run_test_internal( @host, @port, "SSH" )
      end




      #
      # If the test fails then report the error.
      #
      def error
        @error
      end




      register_test_type "ssh"




    end
  end
end