runssh 0.1.0

data/lib/runsshlib/cli.rb

@@ -0,0 +1,287 @@
+#
+# Copyright (C) 2010 Haim Ashkenazi
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+require 'trollop'
+
+module RunSSHLib
+  class CLI
+
+    COMMAND = %w(shell add del update print import export)
+
+    # Initialize new CLI instance and parse the supplied
+    # arguments.
+    def initialize(args)
+      args.unshift '-h' if args.empty?
+      args.unshift '-h' if args == ['help']
+      @global_options = parse_args(args)
+
+      # workaround to enable 'help COMMAND' functionality.
+      if args.first == 'help'; args.shift; args << '-h'; end
+      # indicate path completion request
+      @completion_requested = args.delete('?')
+
+      @cmd = extract_subcommand(args)
+      @options = parse_subcommand(@cmd, args)
+      @c = init_config
+      # path in ConfigFile uses symbols and not strings
+      @path = args.map { |e| e.to_sym }
+    rescue ConfigError, InvalidSubCommandError, Errno::ENOENT => e
+      Trollop.die e.message
+    end
+
+    # run
+    def run
+      # did the user request completions? if not run the approproate command.
+      if @completion_requested
+        puts @c.list_groups(@path)
+      else
+        command_name = 'run_' + @cmd
+        m = method(command_name.to_sym)
+        m.call(@path)
+      end
+    rescue ConfigError => e
+      Trollop.die e.message
+    end
+
+    private
+
+    # Parses main arguments. Returns the output of Trollop::options
+    def parse_args(args)
+      Trollop::options(args) do
+        # TODO: This should be generated automatically somehow!!
+        banner <<-EOS
+Usage: runssh [global_options] COMMAND [options] <path>
+
+A utility to bookmark multiple ssh connections in heirarchial order.
+
+COMMAND : One of the commands mentioned below. It's possible to
+          type only part of the command as long as it's not ambiguous.
+<path>  : A space separated list of names (e.g, one two three)
+          For available completions append " ?" to the end of path.
+
+Available commands:
+  * shell  : Open ssh shell on remote host
+  * add    : Add host definition
+  * del    : Delete host definition
+  * update : Update host definition
+  * print  : Print host definition
+  * import : Import configuration
+  * export : Export configuration
+
+For help on commands run:
+  runssh help COMMAND
+
+Global options:
+EOS
+        opt :config_file, "alternate config file",
+            :type => :string, :short => :f
+        version "RunSSH version #{Version::STRING}"
+        stop_on_unknown
+      end
+    end
+
+    # Etracts the subcommand from args. Throws InvalidSubCommandError if
+    # invalid or ambigious subcommand
+    def extract_subcommand(args)
+      cmd = args.shift
+      if COMMAND.include? cmd
+        cmd
+      else
+        cmdopts = COMMAND.select { |item| item =~ /^#{cmd}/ }
+        raise InvalidSubCommandError, 'invalid command' unless
+              cmdopts.length == 1
+        cmdopts.first
+      end
+    rescue RegexpError
+      raise InvalidSubCommandError, 'invalid command'
+    end
+
+    # handles argument parsing for all subcomand. It doesn't contain
+    # any logic, nor does it handle errors. It just parses the
+    # arguments and put the result into @options.
+    def parse_subcommand(cmd, args)
+      case cmd
+      when 'shell'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] shell [options] <path>
+
+Connect to the specified host using ssh.
+
+<path> : See main help for description of path.
+
+Options:
+EOS
+          opt :login, "override the login in the configuration",
+              :type => :string
+        end
+      when 'add'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] add [options] <path>
+
+Add a new host definition at the supplied <path>. <path> must not exit!
+
+<path> : See main help for description of path.
+
+Options:
+EOS
+          opt :host_name, 'The name or address of the host (e.g, host.example.com)',
+              :short => :n, :type => :string, :required => true
+          opt :user, 'The user to connect as (optional)',
+              :short => :u, :type => :string
+        end
+      when 'update'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] update [options] <path>
+
+Update host definition specified by <path> with new settings. The host
+definition is completely replaced by the new definition (e.g, You can
+not specify only new host and expect the user to remain the old one).
+
+<path> : See main help for description of path.
+
+Options:
+EOS
+          opt :host_name, 'The name or address of the host (e.g, host.example.com)',
+              :short => :n, :type => :string, :required => true
+          opt :user, 'The user to connect as (optional)',
+              :short => :u, :type => :string
+        end
+      when 'del'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] del [options] <path>
+
+Delete host definitions or `empty` groups (e.g, groups that contained
+only one host definition which was deleted). You'll be prompted for
+verification.
+
+<path> : See main help for description of path.
+
+Options:
+EOS
+          opt :yes, 'Delete without verification'
+        end
+      when 'print'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] print [options] <path>
+
+Print host configuration to the console.
+
+<path> : See main help for description of path.
+
+Options:
+EOS
+        end
+      when 'import'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage: runssh [global_options] import [options]
+
+Imports a new configuration.
+CAREFULL: This completely overrides the current configuration!
+
+Options:
+EOS
+          opt :input_file, 'The yaml file to import from',
+              :type => :string, :required => true
+        end
+      when 'export'
+        Trollop::options(args) do
+          banner <<-EOS
+Usage runssh [global_options] export [options]
+
+Exports the configuration to a YAML file.
+
+Options
+EOS
+          opt :output_file, 'The output file',
+              :type => :string, :required => true
+        end
+      end
+    end
+
+    def init_config
+      config = @global_options[:config_file] ?
+               @global_options[:config_file] : DEFAULT_CONFIG
+      ConfigFile.new(config)
+    end
+
+    def run_shell(path)
+      host = @c.get_host(path)
+      s = SshBackend.new(host, @options)
+      s.shell
+    end
+
+    def run_add(path)
+      # extract the host definition name
+      host = path.pop
+      @c.add_host_def(path, host,
+                      HostDef.new(@options[:host_name], @options[:user]))
+    end
+
+    def run_update(path)
+      @c.update_host_def(path,
+                HostDef.new(@options[:host_name], @options[:user]))
+    end
+
+    def run_del(path)
+      question = "Are you sure you want to delete \"" + path.join(':') + "\""
+      if verify_yn(question)
+        @c.delete_path(path)
+      else
+        puts 'canceled'
+      end
+    end
+
+    def run_print(path)
+      host = @c.get_host(path)
+      output = "Host definition for: #{path.last}",
+               "    * host: #{host.name}",
+               "    * user: #{host.login ? host.login : 'current user'}"
+      puts output
+    end
+
+    # we don't use path here, it's just for easier invocation.
+    def run_import(path)
+      question = "Importing a file OVERWRITES existing configuration. " +
+                 "Are you sure"
+      if verify_yn(question)
+        @c.import(@options[:input_file])
+      else
+        puts 'canceled'
+      end
+    end
+
+    # we don't use path here, it's just for easier invocation
+    def run_export(path)
+      @c.export(@options[:output_file])
+    end
+
+    # Verifies a presented question. If response is 'y' it returns
+    # true, else false.
+    #
+    # The supplied question should not include the (y/n)? postfix.
+    def verify_yn question
+      print question, " (y/n)? "
+      gets.chomp == 'y'
+    end
+  end
+end

data/lib/runsshlib/config_file.rb

@@ -0,0 +1,167 @@
+#
+# Copyright (C) 2010 Haim Ashkenazi
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module RunSSHLib
+
+  # Handles configuration file for the application.
+  #
+  # The configuration consists of nested hashes which keys either
+  # points to another hash or to host definition.
+  #
+  # The configuration file should use Marshal to save/load
+  # configuration, but should also be able to import/export
+  # to/from yaml file.
+  class ConfigFile
+
+    # Initialize new ConfigFile. Uses supplied config_file or the default
+    # '~/.runssh'. If file doesn't exist, it issues a warning and creates
+    # a new empty one.
+    def initialize(config_file)
+      @config_file = config_file
+      if File.exists? config_file
+        File.open(config_file) { |io| @config = Marshal.load(io) }
+      else
+        # warn "Config file not found. It must be the first time you run this app..."
+        @config = Hash.new
+        save
+      end
+    end
+
+    # Add host definition to config file.
+    #
+    # path:: An array of symbols that represent the path
+    #        for the host. e.g, [:client, :datacenter1].
+    # name:: The name of the host definition as symbol.
+    # host_def:: A HostDef instance.
+    def add_host_def(path, name, host_def)
+      # sanity
+      raise ConfigError.new('Invalid host definition') unless host_def.instance_of? HostDef
+
+      k = path.inject(@config) do |hsh, key|
+        if hsh.include? key
+          if hsh[key].instance_of? HostDef
+            raise ConfigError.new('Cannot override host definition with path!')
+          end
+          hsh[key]
+        else
+          hsh[key] = {}
+        end
+      end
+
+      raise ConfigError.new('path already exist!') if k.include? name
+
+      k[name] = host_def
+      save
+    end
+
+    # Update host definition (host_def) at the specified path.
+    # Raises ConfigError if doesn't already exist!
+    def update_host_def(path, host_def)
+      # sanity
+      raise ConfigError.new('Invalid host definition!') if not
+            host_def.instance_of? HostDef
+
+      # we need to separate the host name from the path
+      # in order to get the key of the host definition.
+      host = path.pop
+      groups = retrieve_path(path, "Invalid path!")
+      raise ConfigError, 'Invalid path!' unless groups
+      if groups.include? host
+        raise ConfigError.new("Cannot overwrite group with host definition") unless
+              groups[host].instance_of? HostDef
+        groups[host] = host_def
+      else
+        raise ConfigError.new("Host definition doesn't exist!")
+      end
+      save
+    end
+
+    # Returns the host definition in the specified path.
+    # path:: is an array of symbols which translates to nested hash keys.
+    # Raises:: ConfigError if not found or if path points to a group.
+    def get_host(path)
+      host = retrieve_path(path,
+             %Q{host definition (#{path.join(' => ')}) doesn't exist!})
+      if not host
+        raise ConfigError.new(%Q{host definition (#{path.join(' => ')}) doesn't exist!})
+      elsif host.instance_of? Hash
+        raise ConfigError.new(%Q("#{path.join(' => ')}" is a group, not host definition!))
+      end
+
+      host
+    end
+
+    # List all available sub groups inside path.
+    def list_groups(path)
+      value = retrieve_path(path, 'Invalid path!')
+      if value.instance_of? Hash
+        value.keys
+      else
+        []
+      end
+    end
+
+    # This will delete any path if it's a host definition
+    # or an empty group.
+    def delete_path(path)
+      # we need access to the delete key, not just the value
+      mykey = path.pop
+      value = retrieve_path(path, 'Invalid path!')
+      raise ConfigError.new('Invalid path!') unless value
+
+      if value[mykey].instance_of? HostDef or value[mykey] == {}
+        value.delete(mykey)
+      elsif not value[mykey]
+        raise ConfigError.new('Invalid path!')
+      else
+        raise ConfigError.new('Supplied path is non-empty group!')
+      end
+
+      save
+    end
+
+    # Export config as YAML to the supplied file.
+    def import(file)
+      require 'yaml'
+      @config = YAML.load_file(file)
+      save
+    end
+
+    # Import config from YAML from the specified file.
+    def export(file)
+      require 'yaml'
+      File.open(file, 'w') { |out| YAML.dump(@config, out) }
+    end
+
+    private
+
+    def save
+      require 'ftools'
+      # create backup (File.copy always seems to overwrite existing file)
+      File.copy(@config_file, @config_file + '.bak') if File.exists? @config_file
+      File.open(@config_file, 'w') { |out| Marshal.dump(@config, out) }
+    end
+
+    def retrieve_path(path, error)
+      host = path.inject(@config) do |hsh, ky|
+        raise ConfigError.new(error) unless hsh
+        hsh[ky]
+      end
+    end
+  end
+end

data/lib/runsshlib/ssh_backend.rb

@@ -0,0 +1,36 @@
+#
+# Copyright (C) 2010 Haim Ashkenazi
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module RunSSHLib
+
+  # A class to handle ssh operations.
+  class SshBackend
+    # New backend with host/login details.
+    def initialize(host_def, overrides)
+      @host = host_def.name
+      @user = overrides[:login] ? overrides[:login] : host_def.login
+    end
+
+    # run shell on remote host.
+    def shell
+      command = "ssh #{@user ? %Q(-l #{@user}) : ''} #{@host}"
+      exec command
+    end
+
+  end
+end

data/lib/runsshlib.rb

@@ -0,0 +1,44 @@
+#
+# Copyright (C) 2010 Haim Ashkenazi
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+require 'runsshlib/cli'
+require 'runsshlib/config_file'
+require 'runsshlib/ssh_backend'
+
+# Main RunSSHLib module.
+module RunSSHLib
+
+  DEFAULT_CONFIG = File.expand_path('~/.runssh')
+
+  # Indicates configuration error
+  class ConfigError < StandardError; end
+
+  # Indicates invalid command
+  class InvalidSubCommandError < StandardError; end
+
+  # A placeholder for host definitions
+  HostDef = Struct.new(:name, :login)
+
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    BUILD = 0
+
+    STRING = [MAJOR, MINOR, BUILD].compact.join('.')
+  end
+end

data/spec/fixtures/runssh.yml

@@ -0,0 +1,19 @@
+--- 
+:cust1: 
+  :dc1: 
+    :host2: !ruby/struct:RunSSHLib::HostDef 
+      name: b.host.com
+      login: user1
+    :host1: !ruby/struct:RunSSHLib::HostDef 
+      name: a.host.com
+      login: user1
+  :dc2: 
+    :host1: !ruby/struct:RunSSHLib::HostDef 
+      name: c.host.com
+      login: user3
+:cust2: 
+  :dc: 
+    :internal: 
+      :somehost: !ruby/struct:RunSSHLib::HostDef 
+        name: a.example.com
+        login: otheruser