runssh 0.1.1 → 0.2.0

data/.autotest

@@ -0,0 +1,12 @@
+require 'autotest/fsevent'
+require 'autotest/growl'
+
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}  # ignore Version Control System
+  at.add_exception %r{^./tmp}  # ignore temp files, lest autotest will run again, and again...
+  #  at.clear_mappings         # take out the default (test/test*rb)
+  at.add_mapping(%r{^lib/.*\.rb$}) {|f, _|
+    Dir['spec/**/*.rb']
+  }
+  nil
+}

data/.gitignore

@@ -0,0 +1,9 @@
+html/
+*.tmproj
+.DS_Store
+.rvmrc
+coverage/
+.rake_tasks*
+*.gem
+pkg/
+.rubyamp-config.yml

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in testme.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    runssh (0.2.0.rc.1)
+      highline (~> 1.6.1)
+      trollop (~> 1.16.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.4)
+      sys-uname
+    autotest-growl (0.2.9)
+    diff-lcs (1.1.2)
+    highline (1.6.1)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    sys-uname (0.8.5)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4.4)
+  autotest-fsevent (~> 0.2.3)
+  autotest-growl (~> 0.2.6)
+  highline (~> 1.6.1)
+  rcov (~> 0.9.9)
+  rspec (~> 2.1.0)
+  runssh!
+  trollop (~> 1.16.2)

data/README.rdoc

@@ -53,18 +53,16 @@ of bookmarks:
 
 You can decide to arrange your bookmarks by customers and/or location
 and/or internal/external addresses etc. To access a host definition you
-specify the full path to that host. In the above example to access _host2_
+specify the full path to that host. In the above example to access <i>host2</i>
 (e.g, print it's definition) run:
     runssh print customer1 location1 host2
 
 == requirements:
-(versions are specified in the gem definition in the Rakefile)
-
-Runtime:
-* Trollop
-Development:
-* rspec
-* rcov
+Dependencies (runtime and development) are specified in <i>runssh.gemspec</i>.
+When installing through gem, dependencies will be installed by default. For
+development, you need to install _bundler_ 1.0.x and run (inside the
+project directory):
+    bundle install
 
 == License
 This program is distributed under the GPL v2 license.
@@ -76,12 +74,33 @@ This program is distributed under the GPL v2 license.
 [0.1.1] Improved docs.
 
 == TODO
+* Convert to use thor as parent for RunSSHLib::CLI
 * Create a _proper_ zsh completion script.
 * Add scp capabilities
 * Add tunneling support:
   1. Configured tunneling
   2. tunneling defined on the command line.
 * Remote commands (e.g, with no login).
+* Shell via gateway (connect to a firewall and from there open shell to the host).
 * Rename (or move) host definition
 * Maybe replace invoking ssh from the command line with some library.
-* Automatic deletion of empty groups.
+* Automatic deletion of empty groups.
+
+=== Tasks for 0.2
+* Add support for autotest ✓
+* Use Highline for questions ✓
+* Migrate to new ConfigFile:
+  1. Create a new _SshHostDef_ class ✓
+  2. Add version to the config file (use "VERSION" key as string and not as
+     symbol (so it won't interfere with the paths) ✓
+  3. Create discovery of config version on initialization:
+     * If config file is un-versioned abort the application and suggest
+       running with <tt>--update-config</tt> argument. ✓
+  4. Create a update-config method for upgrading the configurations file:
+     * Inform the user of backup name. ✓
+     * Copy the original to backup. ✓
+     * Convert all _HostDef_ instances to _SshHostDef_. ✓
+     * Save configuration and inform the user. ✓
+  4. Make sure _VERSION_ is excluded form the listing of groups. ✓
+  5. Convert existing functionality with the new configuration. ✓
+* Add support for remote command. ✓

data/Rakefile

@@ -16,49 +16,21 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 
-require 'lib/runsshlib'
-require 'rubygems'
-require 'rake'
+require 'bundler'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
 require 'rspec/core/rake_task'
 
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.summary = "CLI utility to bookmark multiple ssh connections with hierarchy."
-  s.name = 'runssh'
-  s.version = RunSSHLib::Version::STRING
-  s.homepage = 'http://github.com/babysnakes/runssh'
-  s.required_ruby_version = '~> 1.8.7'
-  s.has_rdoc = true
-  s.extra_rdoc_files = ['README.rdoc']
-  s.rdoc_options << '--main' << 'README.rdoc'
-  s.author = 'Haim Ashkenazi'
-  s.email = 'haim@babysnakes.org'
-  s.add_dependency('trollop', '~> 1.16.2')
-  s.add_development_dependency('rspec', "~> 2.0.1")
-  s.add_development_dependency('rcov', '~> 0.9.9')
-  s.require_path = 'lib'
-  s.executables << 'runssh'
-  s.files = %w(README.rdoc gpl-2.0.txt Rakefile) + Dir.glob("{lib,bin,spec}/**/*")
-  s.description = <<EOF
-Runssh is a command line utility to help bookmark many
-ssh connections in heirarchial groups.
-EOF
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
+Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new do |t|
-  t.rcov = true
+  t.rcov = ENV['rcov'] == "true" ? true : false
   t.rcov_opts = %w(--exclude gems\/,spec\/)
+  t.name = :specs
   # t.warning = true # rspec produces too many warnings so it's commented.
 end
 
 Rake::RDocTask.new do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.options << "-c" << 'UTF-8'
 end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/runssh

@@ -19,10 +19,12 @@
 #
 
 require 'rubygems'
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require 'runsshlib'
 
 # verify required versions
 gem 'trollop', "1.16.2"
+gem 'highline', '1.6.1'
 
 # let's clone and reset ARGV for future use
 args = ARGV.clone

data/lib/runsshlib/cli.rb

@@ -28,12 +28,12 @@ module RunSSHLib
       args.unshift '-h' if args.empty?
       args.unshift '-h' if args == ['help']
       @global_options = parse_args(args)
+      return if @global_options[:update_config]
 
       # 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
@@ -41,12 +41,23 @@ module RunSSHLib
       @path = args.map { |e| e.to_sym }
     rescue ConfigError, InvalidSubCommandError, Errno::ENOENT => e
       Trollop.die e.message
+    rescue OlderConfigVersionError => e
+      message = <<-EOM
+You seem to use older configuration version. Did you upgrade runssh?
+If so, please run <%= color('runssh [ -f config ] --update-config', :blue) %> in order to
+update your configuration to the current version.
+
+Your old configuration will be saved with the suffix <%= color(".#{e.message}", :underline) %>
+EOM
+      HighLine.new.say(message)
+      abort ''
     end
 
     # run
     def run
-      # did the user request completions? if not run the approproate command.
-      if @completion_requested
+      if @global_options[:update_config]
+        run_update_config
+      elsif @completion_requested
         puts @c.list_groups(@path)
       else
         command_name = 'run_' + @cmd
@@ -92,6 +103,9 @@ Global options:
 EOS
         opt :config_file, "alternate config file",
             :type => :string, :short => :f
+        opt :update_config, "update configuration from previous version." +
+                            " this option should run without COMMAND",
+            :short => :U
         version "RunSSH version #{Version::STRING}"
         stop_on_unknown
       end
@@ -119,19 +133,32 @@ EOS
     def parse_subcommand(cmd, args)
       case cmd
       when 'shell'
-        Trollop::options(args) do
+        options = Trollop::options(args) do
           banner <<-EOS
-Usage: runssh [global_options] shell [options] <path>
+Usage: runssh [global_options] shell [options] <path> [-- <remote command>]
 
 Connect to the specified host using ssh.
 
 <path> : See main help for description of path.
 
+If you only want to run remote command instead of full shell, you can
+append "-- <remote command>" to the regular command. To list /tmp on a host
+bookmarked as "some host" run:
+runssh shell some host -- ls -l /tmp
+
 Options:
 EOS
           opt :login, "override the login in the configuration",
               :type => :string
+          stop_on "--"
         end
+        # handle the case of remote command (indicated by --)
+        if ind = args.index("--")
+          rmt = args.slice!(ind, args.size - ind)
+          rmt.delete_at(0) # remove --
+          options[:remote_cmd] = rmt.join(" ")
+        end
+        options
       when 'add'
         Trollop::options(args) do
           banner <<-EOS
@@ -147,8 +174,8 @@ 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
+          opt :login, 'The user to connect as (optional)',
+              :type => :string
         end
       when 'update'
         Trollop::options(args) do
@@ -165,8 +192,8 @@ 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
+          opt :login, 'The user to connect as (optional)',
+              :type => :string
         end
       when 'del'
         Trollop::options(args) do
@@ -224,32 +251,37 @@ EOS
     end
 
     def init_config
-      config = @global_options[:config_file] ?
-               @global_options[:config_file] : DEFAULT_CONFIG
+      config = @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
+      # only override if value exist
+      # TODO: this works only for some types (e.g, not boolean) but
+      # currently this is all we need. We may need to make it better
+      # later.
+      definition = host.definition.merge(@options) do |key, this, other|
+        other ? other : this
+      end
+      SshBackend.shell(definition)
     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]))
+      options = extract_definition @options
+      @c.add_host_def(path, host, SshHostDef.new(options))
     end
 
     def run_update(path)
-      @c.update_host_def(path,
-                HostDef.new(@options[:host_name], @options[:user]))
+      @c.update_host_def(path, SshHostDef.new(extract_definition @options))
     end
 
     def run_del(path)
-      question = "Are you sure you want to delete \"" + path.join(':') + "\""
-      if verify_yn(question)
+      question = "Are you sure you want to delete \"" + path.join(':') + "\"" +
+                 "? [yes/no] "
+      if HighLine.new.agree(question)
         @c.delete_path(path)
       else
         puts 'canceled'
@@ -258,17 +290,15 @@ EOS
 
     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
+      puts "Host definition for: #{path.last}"
+      puts host.to_print
     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)
+                 "Are you sure? [yes/no] "
+      if HighLine.new.agree(question)
         @c.import(@options[:input_file])
       else
         puts 'canceled'
@@ -280,13 +310,30 @@ EOS
       @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'
+    # extract keys relevant for definition of SshHostDef
+    def extract_definition options
+      valid_definition = [:host_name, :login]
+      options.reject do |key, value|
+        ! valid_definition.include?(key)
+      end
+    end
+
+    # updating configurations
+    def run_update_config
+      config = @global_options[:config_file] || DEFAULT_CONFIG
+      c = ConfigFile.new(config, true)
+      result = c.update_config
+      if result
+        message = <<-EOM
+Your config file is now updated to the approproate version.
+Your old config file is copied to <%= color("#{result}", :blue) %>.
+EOM
+        HighLine.new.say(message)
+      elsif
+        message = "Your configuration seems to be at the appropriate version!" +
+                  " No update was performed."
+        HighLine.new.say(message)
+      end
     end
   end
 end

data/lib/runsshlib/config_file.rb

@@ -27,17 +27,27 @@ module RunSSHLib
   # configuration, but should also be able to import/export
   # to/from yaml file.
   class ConfigFile
+    Version = 1.0 # Config version
 
     # 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)
+    def initialize(config_file, old_version=false)
       @config_file = config_file
       if File.exists? config_file
         File.open(config_file) { |io| @config = Marshal.load(io) }
+        if ! @config['VERSION']
+          raise OlderConfigVersionError, 'none' unless old_version
+        elsif @config['VERSION'] > Version
+          # This is for the future, to avoid reading more advanced
+          # configuration version in an old runssh version
+          error = "The configuration file is for a newer version of runssh!"
+          raise ConfigError, error
+        end
       else
         # warn "Config file not found. It must be the first time you run this app..."
         @config = Hash.new
+        @config['VERSION'] = Version
         save
       end
     end
@@ -47,14 +57,14 @@ module RunSSHLib
     # 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.
+    # host_def:: A SshHostDef instance.
     def add_host_def(path, name, host_def)
       # sanity
-      raise ConfigError.new('Invalid host definition') unless host_def.instance_of? HostDef
+      raise ConfigError.new('Invalid host definition') unless host_def.instance_of? SshHostDef
 
       k = path.inject(@config) do |hsh, key|
         if hsh.include? key
-          if hsh[key].instance_of? HostDef
+          if hsh[key].instance_of? SshHostDef
             raise ConfigError.new('Cannot override host definition with path!')
           end
           hsh[key]
@@ -74,7 +84,7 @@ module RunSSHLib
     def update_host_def(path, host_def)
       # sanity
       raise ConfigError.new('Invalid host definition!') if not
-            host_def.instance_of? HostDef
+            host_def.instance_of? SshHostDef
 
       # we need to separate the host name from the path
       # in order to get the key of the host definition.
@@ -83,7 +93,7 @@ module RunSSHLib
       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].instance_of? SshHostDef
         groups[host] = host_def
       else
         raise ConfigError.new("Host definition doesn't exist!")
@@ -110,7 +120,7 @@ module RunSSHLib
     def list_groups(path)
       value = retrieve_path(path, 'Invalid path!')
       if value.instance_of? Hash
-        value.keys
+        value.keys.reject { |i| i == 'VERSION' }
       else
         []
       end
@@ -124,7 +134,7 @@ module RunSSHLib
       value = retrieve_path(path, 'Invalid path!')
       raise ConfigError.new('Invalid path!') unless value
 
-      if value[mykey].instance_of? HostDef or value[mykey] == {}
+      if value[mykey].instance_of? SshHostDef or value[mykey] == {}
         value.delete(mykey)
       elsif not value[mykey]
         raise ConfigError.new('Invalid path!')
@@ -135,25 +145,46 @@ module RunSSHLib
       save
     end
 
-    # Export config as YAML to the supplied file.
+    # Import config from YAML from the specified file.
     def import(file)
       require 'yaml'
-      @config = YAML.load_file(file)
+      config = YAML.load_file(file)
+      raise ConfigError, "The imported file is from a different version of " +
+                 "runssh (config: #{config['VERSION']})! aborting." unless
+                        config['VERSION'] == Version
+      @config = config
       save
     end
 
-    # Import config from YAML from the specified file.
+    # Export config as YAML to the supplied file.
     def export(file)
       require 'yaml'
       File.open(file, 'w') { |out| YAML.dump(@config, out) }
     end
 
+    # Spacial case - perform update to the configuration. This should
+    # later include handling of +all+ versions of the config!
+    #
+    # Returns the name of the backup file or nil if there was no need
+    # for backup.
+    def update_config
+      return if @config['VERSION'] == Version
+      backup_file = @config_file + '.none'
+      require 'fileutils'
+      new_config = config_none_to_10(@config)
+      FileUtils.move(@config_file, backup_file)
+      @config = new_config
+      @config['VERSION'] = Version
+      save
+      backup_file
+    end
+
     private
 
     def save
-      require 'ftools'
+      require 'fileutils'
       # create backup (File.copy always seems to overwrite existing file)
-      File.copy(@config_file, @config_file + '.bak') if File.exists? @config_file
+      FileUtils.copy(@config_file, @config_file + '.bak') if File.exists? @config_file
       File.open(@config_file, 'w') { |out| Marshal.dump(@config, out) }
     end
 
@@ -163,5 +194,22 @@ module RunSSHLib
         hsh[ky]
       end
     end
+
+    # convert the config hash from version none (runssh 0.1) to version 1.0
+    # group is the hash that holds all the groups/hostdefs (@config).
+    def config_none_to_10 group
+      group.each do |key, value|
+        case
+        when value.instance_of?(RunSSHLib::HostDef)
+          hsh = Hash.new
+          hsh[:host_name] = value.name
+          hsh[:login] = value.login if value.login
+          group[key] = RunSSHLib::SshHostDef.new(hsh)
+        when value.instance_of?(Hash)
+          config_none_to_10(value)
+        end
+      end
+      group
+    end
   end
 end

data/lib/runsshlib/ssh_backend.rb

@@ -18,19 +18,24 @@
 
 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
+  # A collection of ssh procedures.
+  module SshBackend
+    module_function
 
     # run shell on remote host.
-    def shell
-      command = "ssh #{@user ? %Q(-l #{@user}) : ''} #{@host}"
+    # definition:: A Hash containing required data for
+    # making shell connection (e.g., :host_name, :login).
+    #
+    # For running remote commands add to the _definition_ hash
+    # the entire remote command as a string with a +:remote_cmd+ key.
+    def shell(definition)
+      raise "no hostname" unless definition[:host_name] # should never happen
+      command = "ssh "
+      command << "-l #{definition[:login]} " if definition[:login]
+      command << "#{definition[:host_name]}"
+      command << %( -- "#{definition[:remote_cmd]}") if
+                 (definition[:remote_cmd] && (!definition[:remote_cmd].empty?))
       exec command
     end
-
   end
 end

data/lib/runsshlib/ssh_host_def.rb

@@ -0,0 +1,49 @@
+#
+# 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
+  class SshHostDef
+    attr_reader :definition
+
+    # Initialize ssh host def with definition.
+    #
+    # [definition] A hash containing ssh options. <i>:host_name</i> is required.
+    #              Could also be a hostname (string) for quick defining SshHostDef
+    #              with only hostname.
+    def initialize(definition)
+      if definition.instance_of? String
+        definition = { :host_name => definition }
+      end
+      raise ArgumentError, "Missing hostname" unless definition[:host_name]
+      @definition = definition
+    end
+
+    # should be equal if @definition is equal
+    def ==(other)
+      return false if other.nil?
+      return false unless other.instance_of? SshHostDef
+      definition == other.definition
+    end
+    alias_method :eql?, :==
+
+    def to_print
+      out = "    * host: #{definition[:host_name]}"
+      out << "\n    * login: #{definition[:login] || 'current user'}"
+      out
+    end
+  end
+end