runssh 0.2.2 → 0.4.0

data/features/step_definitions/output_steps.rb

@@ -0,0 +1,77 @@
+#
+# 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.
+#
+
+Then /^I should get a "([^"]*)" error$/ do |error|
+  expect {
+    capture(:stderr, @input) do
+      cli = RunSSHLib::CLI.new(@args)
+      cli.run
+    end
+  }.to exit_abnormaly
+  @buf.should include(error)
+end
+
+Then /^I should be prompted with "([^"]*)"$/ do |output|
+  # I'm only interested in the output verification but I should hide the errors.
+  capture(:stderr) do
+    capture(:stdout, 'n\n') do
+      expect { RunSSHLib::CLI.new(@args).run }.to exit_abnormaly
+    end
+  end
+  @buf.should match(/#{output}/)
+end
+
+When /^I confirm the prompt$/ do
+  When %Q(I answer "yes" at the prompt)
+end
+
+When /^I answer "([^"]*)" at the prompt$/ do |input|
+  @input = input
+end
+
+Then /^It should run successfully$/ do
+  capture(:stdout, @input) do
+    RunSSHLib::CLI.new(@args).run
+  end
+end
+
+Then /^It should exit normally$/ do
+  expect {
+    capture(:stdout, @input) do
+      cli = RunSSHLib::CLI.new(@args).run
+    end
+  }.to exit_normaly
+end
+
+Then /^The output should include "([^"]*)"$/ do |output|
+  @buf.should match(/#{output}/)
+end
+
+Then /^The output should not include "([^"]*)"$/ do |output|
+  @buf.should_not match(/#{output}/)
+end
+
+Then /^It should execute "(.*)"$/ do |command|
+  capture(:stdout) {
+    RunSSHLib::CLI.new(@args).run
+  }.should match(/^#{command}\s*\n$/)
+end
+
+Then /^The output file should contain "([^"]*)"$/ do |output|
+  File.read(TMP_YML).should include(output)
+end

data/features/support/env.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.
+#
+
+require "#{File.expand_path('../../../spec/support/utils', __FILE__)}"
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require 'simplecov'
+SimpleCov.start do
+  add_group "Sources", "/lib/"
+end
+require 'cucumber/rspec/doubles'
+
+Before do |scenario|
+  stub_ssh_exec
+  @test_args = %W(-f #{TMP_FILE})
+  @input = ''
+end
+
+After do |scenario|
+  cleanup_tmp_file
+end

data/features/update_bookmarks.feature

@@ -0,0 +1,24 @@
+Feature: Updating bookmarks
+  In order to modify existing bookmarks
+  I want to run runssh update on existing bookmark. This command should fail
+  if the bookmark doesn't exist yet (to avoid errors).
+  Currently the update command COMPLETELY overwrites the existing bookmark so
+  it's not very useful (to be fixed later).
+
+  Scenario: All available options runs successfully
+    Given Bookmark "one two three" exist with:
+      | name      | value     |
+      | host-name | some.host |
+      | login     | somelogin |
+    When I run the "update" command with "one two three -n some.other.host -l otherlogin -L 8080:localhost:8080"
+    Then It should run successfully
+    And Bookmark "one two three" should contain:
+      | name         | value               |
+      | host_name    | some.other.host     |
+      | login        | otherlogin          |
+      | local_tunnel | 8080:localhost:8080 |
+
+  Scenario: Fails when updating non-existing bookmark
+    Given Empty database
+    When I run the "update" command with "one two -n somehost"
+    Then I should get a "Error: Invalid path!" error

data/lib/runsshlib/cli.rb

@@ -20,14 +20,42 @@ require 'trollop'
 module RunSSHLib
   class CLI
 
-    COMMAND = %w(shell add del update print import export)
+    COMMAND = %w(shell add del update print import export cpid)
+    MAIN_HELP = <<-EOS
+Usage: runssh [global_options] COMMAND [options] <path>
+
+A utility to bookmark multiple ssh connections in heirarchial order.
+For a better understanding of host definitions and bookmarks, Read
+the provided README.rdoc or go to http://github.com/babysnakes/runssh.
+
+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) that
+          leads to a host definition. 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
+* cpid   : Copy ssh public key to authorized_keys on remote host
+
+For help on commands run:
+runssh help COMMAND
+
+Global options:
+EOS
 
     # 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)
+      exit_with_help if args == ['help']
       return if @global_options[:update_config]
 
       # workaround to enable 'help COMMAND' functionality.
@@ -42,15 +70,9 @@ module RunSSHLib
     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
+      message = construct_update_config_message e.message
       HighLine.new.say(message)
-      abort ''
+      exit 1
     end
 
     # run
@@ -66,6 +88,8 @@ EOM
       end
     rescue ConfigError => e
       Trollop.die e.message
+    rescue AbortError => e
+      abort e.message
     end
 
     private
@@ -74,33 +98,7 @@ EOM
     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.
-For a better understanding of host definitions and bookmarks, Read
-the provided README.rdoc or go to http://github.com/babysnakes/runssh.
-
-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) that
-          leads to a host definition. 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
+        banner MAIN_HELP
         opt :config_file, "alternate config file",
             :type => :string, :short => :f
         opt :update_config, "update configuration from previous version." +
@@ -111,8 +109,8 @@ EOS
       end
     end
 
-    # Etracts the subcommand from args. Throws InvalidSubCommandError if
-    # invalid or ambigious subcommand
+    # Extracts the subcommand from args. Throws InvalidSubCommandError if
+    # invalid or ambiguous subcommand
     def extract_subcommand(args)
       cmd = args.shift
       if COMMAND.include? cmd
@@ -127,14 +125,34 @@ EOS
       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.
+    # route argument parsing for all subcommand.
     def parse_subcommand(cmd, args)
       case cmd
       when 'shell'
-        options = Trollop::options(args) do
-          banner <<-EOS
+        parse_shell args
+      when 'add', 'update'
+        parse_add_update cmd, args
+      when 'del'
+        parse_del args
+      when 'print'
+        parse_print args
+      when 'import'
+        parse_import args
+      when 'export'
+        parse_export args
+      when 'cpid'
+        parse_cpid args
+      end
+    end
+
+    def init_config
+      config = @global_options[:config_file] || DEFAULT_CONFIG
+      ConfigFile.new(config)
+    end
+
+    def parse_shell(args)
+      options = Trollop::options(args) do
+        banner <<-EOS
 Usage: runssh [global_options] shell [options] <path> [-- <remote command>]
 
 Connect to the specified host using ssh.
@@ -145,68 +163,128 @@ 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
+Remote command enables pseudo terminal (ssh -t) by default. To disable
+use -T.
 
 (Local) tunneling can be enabled with the -L options (correspond to
 ssh -L option). An abbreviated syntax could be used as the requested
 port if both ports are identical and host is localhost.
 e.g. -L 7070 is converted to -L 7070:localhost:7070
 
+In case of conflicting host key (e.g, when reinstalling a server), ssh refuses
+to connect and tells you which line has the conflicting host key. ONLY if you
+know for sure why you have a conflicting key, you can add the
+--insecure-host-key option with the conflicting line as an argument. DON'T
+DO THAT UNLESS YOU KNOW WHY THE KEY HAS CHANGED!
+
 Options:
 EOS
-          opt :login, "override the login in the configuration",
-              :type => :string
-          opt :host_name, 'override the name or address of the host',
-              :short => :n, :type => :string
-          opt :local_tunnel, "tunnel definition",
-              :short => :L, :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
+        opt :login, "Override the login in the configuration.",
+            :type => :string
+        opt :host_name, 'Override the name or address of the host.',
+            :short => :n, :type => :string
+        opt :local_tunnel, "Tunnel definition (see description above).",
+            :short => :L, :type => :string
+        opt :no_pseudo_terminal, 'Disable pseudo terminal ' \
+            '(effective only with remote command).', :short => :T
+        opt :insecure_host_key, 'delete the specified line form known hosts ' \
+            'file. EXPERIMENTAL and DANGEROUS!.', :type => :int, :short => :I
+        opt :option, 'Ssh option. Appended to saved ssh options. ' \
+            'Can be used multiple times.',
+            :short => :o, :type => :string, :multi => true
+        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
+    end
+
+    def parse_cpid(args)
+      Trollop::options(args) do
+        banner <<-EOH
+Usage: runssh [global_options] cpid [options] <path>
+
+Copy ssh public key to authorized_keys on remote host. If no id file is
+specified, It copies all the keys in your ssh-agent.
+
+Requires the `ssh-copy-id` command to be in your path.
+See manpage for ssh-copy-id for more details.
+
+<path> : See main help for description of path.
+
+Options:
+EOH
+        opt :identity_file, "Full path to identity file.",
+            :short => :i, :type => :string
+      end
+    end
+
+    def parse_add_update(cmd, args)
+      case cmd
+      when "add"
+        help = <<-EOH
 Usage: runssh [global_options] add [options] <path>
 
 Add a new host definition at the supplied <path>. <path> must not exist!
-A host definition can have a hostname (required) and a remote user
-(optional).
+A host definition must have a hostname. All other options (see below)
+are optional.
 
 <path> : See main help for description of path.
 
+(Local) tunneling can be added with the -L options (correspond to
+ssh -L option). An abbreviated syntax could be used as the requested
+port if both ports are identical and host is localhost.
+e.g. -L 7070 is converted to -L 7070:localhost:7070
+
 Options:
-EOS
-          opt :host_name, 'The name or address of the host (e.g, host.example.com)',
-              :short => :n, :type => :string, :required => true
-          opt :login, 'The user to connect as (optional)',
-              :type => :string
-        end
-      when 'update'
-        Trollop::options(args) do
-          banner <<-EOS
+EOH
+      when "update"
+        help = <<-EOH
 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).
+not specify only new host and expect the login to remain the existing one).
 
 <path> : See main help for description of path.
 
+(Local) tunneling can be added with the -L options (correspond to
+ssh -L option). An abbreviated syntax could be used as the requested
+port if both ports are identical and host is localhost.
+e.g. -L 7070 is converted to -L 7070:localhost:7070
+
 Options:
-EOS
-          opt :host_name, 'The name or address of the host (e.g, host.example.com)',
-              :short => :n, :type => :string, :required => true
-          opt :login, 'The user to connect as (optional)',
-              :type => :string
-        end
-      when 'del'
-        Trollop::options(args) do
-          banner <<-EOS
+EOH
+      end
+      options = Trollop::options(args) do
+        banner help
+        opt :host_name, 'The name or address of the host (e.g, host.example.com).',
+            :short => :n, :type => :string, :required => true
+        opt :login, 'The login to connect as.',
+            :type => :string
+        opt :local_tunnel, "Tunnel definition (see description above).",
+            :short => :L, :type => :string
+        opt :option, 'Ssh option (corresponds to ssh -o <option>). ' \
+            'Can be used multiple times.',
+            :short => :o, :multi => true, :type => :string
+        opt :no_host_key_checking, "DANGEROUS! Don't verify host key when " \
+            "connecting to this host. Shortcut for '-o UserKnownHostsFile=" \
+            "/dev/null -o StrictHostKeyChecking=no'",
+            :short => :N, :type => :boolean
+      end
+      if options[:no_host_key_checking_given]
+        options[:option] << 'UserKnownHostsFile=/dev/null' << 'StrictHostKeyChecking=no'
+      end
+      options
+    end
+
+    def parse_del(args)
+      Trollop::options(args) do
+        banner <<-EOS
 Usage: runssh [global_options] del [options] <path>
 
 Delete host definitions or `empty` groups (e.g, groups that contained
@@ -217,11 +295,13 @@ verification.
 
 Options:
 EOS
-          opt :yes, 'Delete without verification'
-        end
-      when 'print'
-        Trollop::options(args) do
-          banner <<-EOS
+        opt :yes, 'Delete without verification.'
+      end
+    end
+
+    def parse_print(args)
+      Trollop::options(args) do
+        banner <<-EOS
 Usage: runssh [global_options] print [options] <path>
 
 Print host configuration to the console.
@@ -230,52 +310,63 @@ Print host configuration to the console.
 
 Options:
 EOS
-        end
-      when 'import'
-        Trollop::options(args) do
-          banner <<-EOS
+      end
+    end
+
+    def parse_import(args)
+      Trollop::options(args) do
+        banner <<-EOS
 Usage: runssh [global_options] import [options]
 
-Imports a new configuration.
+Imports a configuration (The configuration must be in YAML format).
 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
+        opt :input_file, 'The yaml file to import from.',
+            :type => :string, :required => true
+      end
+    end
+
+    def parse_export(args)
+      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
+        opt :output_file, 'The output file.',
+            :type => :string, :required => true
       end
     end
 
-    def init_config
-      config = @global_options[:config_file] || DEFAULT_CONFIG
-      ConfigFile.new(config)
-    end
-
     def run_shell(path)
+      verify_and_delete_conflicting_host_key(@options[:insecure_host_key]) if
+          @options[:insecure_host_key_given]
+
       host = @c.get_host(path)
       # 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
+        case key
+        when :option
+          this + other
+        else
+          other ? other : this
+        end
       end
       SshBackend.shell(definition)
     end
 
+    def run_cpid(path)
+      host = @c.get_host(path)
+      SshBackend.copy_id(host.definition.merge(@options))
+    end
+
     def run_add(path)
       # extract the host definition name
       host = path.pop
@@ -288,13 +379,12 @@ EOS
     end
 
     def run_del(path)
-      question = "Are you sure you want to delete \"" + path.join(':') + "\"" +
-                 "? [yes/no] "
-      if HighLine.new.agree(question)
-        @c.delete_path(path)
-      else
-        puts 'canceled'
+      unless @options[:yes]
+        question = %Q(Are you sure you want to delete "#{path.join(':')}") +
+                   "? [yes/no] "
+        @options[:yes] = agree_or_abort(question, "Cancelled")
       end
+      @c.delete_path(path)
     end
 
     def run_print(path)
@@ -307,11 +397,8 @@ EOS
     def run_import(path)
       question = "Importing a file OVERWRITES existing configuration. " +
                  "Are you sure? [yes/no] "
-      if HighLine.new.agree(question)
-        @c.import(@options[:input_file])
-      else
-        puts 'canceled'
-      end
+      agree_or_abort(question, 'Cancelled')
+      @c.import(@options[:input_file])
     end
 
     # we don't use path here, it's just for easier invocation
@@ -321,7 +408,7 @@ EOS
 
     # extract keys relevant for definition of SshHostDef
     def extract_definition options
-      valid_definition = [:host_name, :login]
+      valid_definition = [:host_name, :login, :local_tunnel, :option]
       options.reject do |key, value|
         ! valid_definition.include?(key)
       end
@@ -344,5 +431,46 @@ EOM
         HighLine.new.say(message)
       end
     end
+
+    # help needed out of trollop::parse loop
+    def exit_with_help
+      p = Trollop::Parser.new do
+        banner MAIN_HELP
+      end
+      Trollop::with_standard_exception_handling p do
+        raise Trollop::HelpNeeded
+      end
+    end
+
+    def verify_and_delete_conflicting_host_key(line_number)
+      khu = RunSSHLib::SshBackend::KnownHostsUtils.new
+      host = IO.readlines(khu.known_hosts_file)[line_number - 1].split[0]
+      question = "Are you sure you want to delete the key for host: " \
+                 "'<%= color(\"#{host}\", :red) %>'? " \
+                 "Conflicting key could indicate compromised host! [yes/no] "
+      agree_or_abort(question, "Cancelled")
+      khu.delete_line_from_known_hosts_file line_number
+    end
+
+    # Prompts you with the supplied question and aborts with the supplied
+    # error unless confirmed the prompt.
+    def agree_or_abort(question, error_message)
+      raise(AbortError, error_message) unless HighLine.new.agree(question)
+    end
+
+    # Construct update_config message with correct config file.
+    # The current_version is the number of the existing config version.
+    def construct_update_config_message(current_version)
+      config_string = @global_options[:config_file] ?
+                      "-f #{@global_options[:config_file]}" : ''
+      message = <<-EOM
+You seem to use older configuration version. Did you upgrade runssh?
+If so, please run <%= color("runssh #{config_string} --update-config", :blue) %>
+in order to update your configuration to the current version.
+
+Your old configuration will be saved with the suffix \
+<%= color(".#{current_version}", :underline) %>
+EOM
+    end
   end
 end