runssh 0.1.1 → 0.2.0

data/lib/runsshlib/version.rb

@@ -0,0 +1,27 @@
+#
+# 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
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    BUILD = 0
+
+    STRING = [MAJOR, MINOR, BUILD].compact.join('.')
+  end
+end

data/lib/runsshlib.rb

@@ -19,6 +19,9 @@
 require 'runsshlib/cli'
 require 'runsshlib/config_file'
 require 'runsshlib/ssh_backend'
+require 'runsshlib/ssh_host_def'
+require 'runsshlib/version'
+require 'highline'
 
 # Main RunSSHLib module.
 module RunSSHLib
@@ -31,14 +34,10 @@ module RunSSHLib
   # Indicates invalid command
   class InvalidSubCommandError < StandardError; end
 
+  # Indicates older config version.
+  # message should contain only the older config version!
+  class OlderConfigVersionError < StandardError; end
+
   # A placeholder for host definitions
   HostDef = Struct.new(:name, :login)
-
-  module Version
-    MAJOR = 0
-    MINOR = 1
-    BUILD = 1
-
-    STRING = [MAJOR, MINOR, BUILD].compact.join('.')
-  end
 end

data/runssh.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "runsshlib/version"
+
+spec = Gem::Specification.new do |s|
+  s.name     = 'runssh'
+  s.version  = RunSSHLib::Version::STRING
+  s.platform = Gem::Platform::RUBY
+  s.author   = 'Haim Ashkenazi'
+  s.email    = 'haim@babysnakes.org'
+  s.homepage = 'http://github.com/babysnakes/runssh'
+
+  s.summary     = "CLI utility to bookmark multiple ssh connections with hierarchy."
+  s.description = <<EOF
+Runssh is a command line utility to help bookmark many
+ssh connections in heirarchial groups.
+EOF
+
+  s.required_ruby_version = '>= 1.8.7'
+  s.add_dependency('trollop', '~> 1.16.2')
+  s.add_dependency('highline', '~> 1.6.1')
+  s.add_development_dependency('rspec', "~> 2.1.0")
+  s.add_development_dependency('rcov', '~> 0.9.9')
+  s.add_development_dependency('autotest', '~> 4.4.4')
+  s.add_development_dependency('autotest-fsevent', '~> 0.2.3')
+  s.add_development_dependency('autotest-growl', '~> 0.2.6')
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ['README.rdoc']
+  s.rdoc_options      << '--main' << 'README.rdoc'
+  s.rdoc_options      << '-c' << 'UTF-8'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   << 'runssh'
+  s.require_paths = ['lib']
+end

data/spec/fixtures/runssh.yml

@@ -1,19 +1,24 @@
---- 
-: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
+---
+VERSION: 1.0
+:cust1:
+  :dc1:
+    :host1: !ruby/object:RunSSHLib::SshHostDef
+      definition:
+        :login: user1
+        :host_name: a.host.com
+    :host2: !ruby/object:RunSSHLib::SshHostDef
+      definition:
+        :login: user1
+        :host_name: b.host.com
+  :dc2:
+    :host1: !ruby/object:RunSSHLib::SshHostDef
+      definition:
+        :login: user3
+        :host_name: c.host.com
+:cust2:
+  :dc:
+    :internal:
+      :somehost: !ruby/object:RunSSHLib::SshHostDef
+        definition:
+          :login: otheruser
+          :host_name: a.example.com

data/spec/fixtures/runssh_v_none.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

data/spec/runsshlib/cli_spec.rb

@@ -15,9 +15,10 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-require 'lib/runsshlib'
 require 'spec_helper'
+require 'runsshlib'
 require 'stringio'
+require 'yaml'
 
 describe "The CLI interface" do
   # a shortcut to verify the help for print command
@@ -74,6 +75,36 @@ describe "The CLI interface" do
       end.to exit_abnormaly
       @buffer.should match(/invalid command/)
     end
+
+    it "should display right message upon older configuration error" do
+      dump_config Hash.new
+      expect do
+        cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print ?))
+      end.to exit_abnormaly
+      @buffer.should match(/--update-config/)
+      @buffer.should match(/.none/)
+    end
+
+    describe "with --update_config" do
+      let(:config_v_none) do
+        YAML.load_file(File.join(File.dirname(__FILE__), '..',
+                                 'fixtures', 'runssh_v_none.yml'))
+      end
+
+      it "should accept --update-config as argument" do
+        cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+      end
+
+      it "should not fail upon initialization if config is of older version" do
+        dump_config config_v_none
+        cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+      end
+
+      it "should not initialize @config object after initialization" do
+        cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+        cli.instance_variable_get(:@c).should be_nil
+      end
+    end
   end
 
   describe "main help" do
@@ -97,8 +128,43 @@ describe "The CLI interface" do
       cli.run
     end
 
+    it "should run run_update_config when called with --update-config" do
+      @cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+      @cli.should_receive(:run_update_config)
+      @cli.run
+    end
+
+    context "update_config" do
+      let(:cf) { double('ConfigFile') }
+
+      it "should initialize ConfigFile with old_version=true and run update_config" do
+        cf.should_receive(:update_config)
+        RunSSHLib::ConfigFile.should_receive(:new).with(TMP_FILE, true).
+                              and_return(cf)
+        @cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+        @cli.run
+      end
+
+      it "should inform the user of success and backup file" do
+        backup_path = "/path/to/backup_file"
+        cf.should_receive(:update_config).and_return(backup_path)
+        RunSSHLib::ConfigFile.should_receive(:new).and_return(cf)
+        @cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+        @cli.run
+        @buffer.should include(backup_path)
+      end
+
+      it "should inform the user if no backup was required" do
+        cf.should_receive(:update_config).and_return(nil)
+        RunSSHLib::ConfigFile.should_receive(:new).and_return(cf)
+        @cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} --update-config))
+        @cli.run
+        @buffer.should include("No update was performed")
+      end
+    end
+
     describe "with subcommand" do
-      describe "shell" do
+      context "shell" do
         before(:each) do
           @shell_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} shell))
         end
@@ -121,15 +187,39 @@ describe "The CLI interface" do
           options = @shell_cli.instance_variable_get :@options
           options.should have_key(:login)
         end
+        
+        it "should not overwrite nil arguments with saved ones when merging" do
+          import_fixtures
+          RunSSHLib::SshBackend.should_receive(:shell).
+                                with(hash_including(
+                                     :host_name => "a.example.com",
+                                     :login => "otheruser")).
+                                and_return(nil)
+          cli = RunSSHLib::CLI.new(
+                %W(-f #{TMP_FILE} shell cust2 dc internal somehost))
+          cli.run
+        end
+
+        it "should correctly call SshBackend.shell with merged definition" do
+          import_fixtures
+          RunSSHLib::SshBackend.should_receive(:shell).
+                                with(hash_including(:host_name => "a.example.com",
+                                                    :login => "someuser")).
+                                and_return(nil)
+          cli = RunSSHLib::CLI.new(
+                %W(-f #{TMP_FILE} shell -l someuser cust2 dc internal somehost))
+          cli.run
+        end
 
-        it "should correctly initialize SshBackend" do
-          somehost = RunSSHLib::HostDef.new('a.example.com', 'otheruser')
-          mock_ssh_backend = double('SshBackend')
-          mock_ssh_backend.should_receive(:shell)
-          RunSSHLib::SshBackend.should_receive(:new).
-                                with(somehost, {:login=>nil, :help=>false}).
-                                and_return(mock_ssh_backend)
-          cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} shell cust2 dc internal somehost))
+        it "should correctly parse remote command (indicated by --)" do
+          import_fixtures
+          RunSSHLib::SshBackend.should_receive(:shell).
+                                with(hash_including(:remote_cmd => "ls -l /tmp")).
+                                and_return(nil)
+          cli = RunSSHLib::CLI.new(
+                %W(-f #{TMP_FILE} shell -l someuser cust2 dc internal somehost 
+                   -- ls -l /tmp)
+          )
           cli.run
         end
       end
@@ -146,12 +236,14 @@ describe "The CLI interface" do
         it "should have all required arguments" do
           options = @add_cli.instance_variable_get :@options
           options.should have_key(:host_name)
-          options.should have_key(:user)
+          options.should have_key(:login)
         end
 
         it "should invoke the add_host_def" do
           @add_cli.instance_variable_get(:@c).should_receive(:add_host_def).
-                   with([:one], :two, RunSSHLib::HostDef.new('host'))
+                   with([:one], :two, RunSSHLib::SshHostDef.new({
+                     :host_name => 'host',:login => nil
+                   }))
           @add_cli.run
         end
       end
@@ -160,6 +252,9 @@ describe "The CLI interface" do
         before(:each) do
           @d_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} del))
           @d_cli.instance_variable_get(:@c).stub(:delete_path)
+          @hl = double('HighLine')
+          HighLine.stub(:new) {@hl}
+          @hl.stub(:agree)
         end
 
         it "should parse 'd' as del" do
@@ -167,18 +262,18 @@ describe "The CLI interface" do
         end
 
         it "should verify the deletion" do
-          @d_cli.should_receive(:verify_yn).with(/Are you sure/)
+          @hl.should_receive(:agree).with(/Are you sure/)
           @d_cli.run
         end
 
         it "should perform the deletion upon confirmation" do
-          @d_cli.should_receive(:verify_yn).and_return(true)
+          @hl.should_receive(:agree).and_return(true)
           @d_cli.instance_variable_get(:@c).should_receive(:delete_path)
           @d_cli.run
         end
 
         it "should cancel the deletion if not confirmed" do
-          @d_cli.should_receive(:verify_yn).and_return(false)
+          @hl.should_receive(:agree).and_return(false)
           @d_cli.instance_variable_get(:@c).should_not_receive(:delete_path)
           @d_cli.run
           @buffer.should match(/cancel/)
@@ -186,7 +281,7 @@ describe "The CLI interface" do
 
         it "should pass the right path to delete_path" do
           cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} del one two three))
-          cli.stub(:verify_yn).and_return(true)
+          @hl.should_receive(:agree).and_return(true)
           cli.instance_variable_get(:@c).should_receive(:delete_path).
                                          with([:one, :two, :three])
           cli.run
@@ -205,19 +300,22 @@ describe "The CLI interface" do
         it "should have all required argumants" do
           options = @update_cli.instance_variable_get :@options
           options.should have_key(:host_name)
-          options.should have_key(:user)
+          options.should have_key(:login)
         end
 
         it "should invoke update_host_def" do
           config = @update_cli.instance_variable_get :@c
           config.should_receive(:update_host_def).
-                 with([:root], RunSSHLib::HostDef.new('newhost'))
+                 with([:root], RunSSHLib::SshHostDef.new({
+                   :host_name => "newhost", :login => nil
+                 }))
           @update_cli.run
         end
       end
 
       describe "print" do
         before(:each) do
+          import_fixtures
           @p_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print cust2 dc internal somehost))
         end
 
@@ -225,19 +323,10 @@ describe "The CLI interface" do
           @p_cli.send(:extract_subcommand, ['p']).should eql('print')
         end
 
-        it "should print correctly host definition with user" do
+        it "should print correctly host definition" do
           @p_cli.run
+          @buffer.should match(/Host definition for: somehost/)
           @buffer.should match(/host: a.example.com/)
-          @buffer.should match(/user: otheruser/)
-        end
-
-        it "should print correctly host definition without user" do
-          c = RunSSHLib::ConfigFile.new("#{TMP_FILE}")
-          c.add_host_def([:three, :four], :five, RunSSHLib::HostDef.new('anewhost'))
-          cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print three four five))
-          cli.run
-          @buffer.should match(/host: anewhost/)
-          @buffer.should match(/user: current user/)
         end
       end
 
@@ -245,6 +334,9 @@ describe "The CLI interface" do
         before(:each) do
           @i_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} import -i inputfile))
           @i_cli.instance_variable_get(:@c).stub(:import)
+          @hl = double('HighLine')
+          HighLine.stub(:new) {@hl}
+          @hl.stub(:agree)
         end
 
         it "should parse 'i' as import" do
@@ -257,25 +349,25 @@ describe "The CLI interface" do
         end
 
         it "should verify the import with the user" do
-          @i_cli.should_receive(:verify_yn).with(/OVERWRITES/)
+          @hl.should_receive(:agree).with(/OVERWRITES/)
           @i_cli.run
         end
 
         it "should run import upon confirmation" do
-          @i_cli.should_receive(:verify_yn).and_return(true)
+          @hl.should_receive(:agree).and_return(true)
           @i_cli.instance_variable_get(:@c).should_receive(:import)
           @i_cli.run
         end
 
         it "should cancel if not confirmed" do
-          @i_cli.should_receive(:verify_yn).and_return(false)
+          @hl.should_receive(:agree).and_return(false)
           @i_cli.instance_variable_get(:@c).should_not_receive(:import)
           @i_cli.run
           @buffer.should match(/cancel/)
         end
 
         it "should pass the right argument to import" do
-          @i_cli.should_receive(:verify_yn).and_return(true)
+          @hl.should_receive(:agree).and_return(true)
           @i_cli.instance_variable_get(:@c).should_receive(:import).
                                             with('inputfile')
           @i_cli.run
@@ -298,37 +390,9 @@ describe "The CLI interface" do
         end
       end
     end
-
-    describe "verify_yn" do
-      before(:each) do
-        @verify_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print))
-      end
-
-      it "should parse 'y' as true" do
-        stdin = "y\n"
-        $stdin = StringIO.open(stdin, 'r')
-        @verify_cli.send(:verify_yn, 'question').should be_true
-      end
-
-      it "should parse all other as false" do
-        tests = ["n", "\n", "Y\n", "maybe", "\n"]
-        tests.each do |test_phrase|
-          stdin = test_phrase
-          $stdin = StringIO.open(stdin, 'r')
-          @verify_cli.send(:verify_yn, 'question').should be_false
-        end
-      end
-
-      it "should add postfix to the question" do
-        stdin = "n"
-        $stdin = StringIO.open(stdin, 'r')
-        @verify_cli.send(:verify_yn, 'are you sure')
-        @buffer.should eql('are you sure (y/n)? ')
-      end
-    end
   end
 
-  after(:all) do
+  after(:each) do
     cleanup_tmp_file
   end
 end