Contents

module Utils
  module LitaPuppet
    # Utility methods for doing things over SSH
    module SSH
      # Only really used for the over_ssh method to determine success or failure
      def calculate_result(output, exception)
        result = {}
        if exception
          result[:exception] = exception
        else
          result[:exit_status] = output.exit_status
          result[:stdout] = output.stdout
          result[:stderr] = output.stderr
        end
        result
      end

      # Intelligently do some things over SSH
      def over_ssh(opts = {})
        raise 'MissingSSHHost' unless opts[:host]
        raise 'MissingSSHUser' unless opts[:user]
        opts[:timeout] ||= 300 # default to a 5 minute timeout

        remote = Rye::Box.new(
          opts[:host],
          user: opts[:user],
          auth_methods: ['publickey'],
          password_prompt: false,
          error: STDOUT # send STDERR to STDOUT for things that actually print
        )

        exception = nil

        # Getting serious about not crashing Lita...
        output = begin
          # pass our host back to the user to work with
          Timeout.timeout(opts[:timeout]) { yield remote }
        rescue Rye::Err, StandardError => e
          exception = e
        ensure
          remote.disconnect
        end

        remote = nil # Try to force the destruction of the Rye box
        calculate_result(output, exception)
      end

      # Provides a super simple way to just run a single command over ssh
      def simple_ssh_command(host, user, command, timeout = 300)
        over_ssh(host: host, user: user, timeout: timeout) do |server|
          server.cd '/tmp'
          # Need to use sudo
          server.enable_sudo
          # scary...
          server.disable_safe_mode

          server.execute command
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
lita-puppet-2.1.3	lib/utils/lita_puppet/ssh.rb