runssh 0.1.0

data/spec/runsshlib/cli_spec.rb

@@ -0,0 +1,334 @@
+#
+# 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 'lib/runsshlib'
+require 'spec_helper'
+require 'stringio'
+
+describe "The CLI interface" do
+  # a shortcut to verify the help for print command
+  def match_print
+    @buffer.should match(/Print host configuration/)
+  end
+
+  before(:each) do
+    @buffer = ""
+    $stdout = StringIO.open(@buffer, 'w')
+    $stderr = StringIO.open(@buffer, 'w')
+  end
+
+  describe "when initialized" do
+    it "should display help when run with no arguments" do
+      expect { RunSSHLib::CLI.new([]) }.to exit_normaly
+      @buffer.should match(/Available commands:/)
+    end
+
+    it "should display help when called with help as the only parameter" do
+      expect { RunSSHLib::CLI.new(['help']) }.to exit_normaly
+      @buffer.should match(/Available commands:/)
+    end
+
+    it "should correctly process the -f argument" do
+      cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print test))
+      global_options = cli.instance_variable_get :@global_options
+      global_options[:config_file].should eql("#{TMP_FILE}")
+      cli.instance_variable_get(:@c).
+          instance_variable_get(:@config_file).
+          should eql("#{TMP_FILE}")
+    end
+
+    it "should display version when asked for" do
+      expect { RunSSHLib::CLI.new(['-v'])}.to exit_normaly
+      @buffer.should include(RunSSHLib::Version::STRING)
+    end
+
+    it "should correctly process the `help command` scheme" do
+      expect do
+        RunSSHLib::CLI.new(%w(help print ?))
+      end.to exit_normaly
+      match_print
+    end
+
+    it "should correctly parse the `?` for completion" do
+      cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print ?))
+      cli.instance_variable_get(:@completion_requested).should be_true
+    end
+
+    it "should raise an error when invoked with invalid command" do
+      expect do
+        RunSSHLib::CLI.new(%W(-f #{TMP_FILE} wrong))
+      end.to exit_abnormaly
+      @buffer.should match(/invalid command/)
+    end
+  end
+
+  describe "main help" do
+    it "should include a description of all subcommands" do
+      expect { RunSSHLib::CLI.new([]) }.to exit_normaly
+      RunSSHLib::CLI::COMMAND.each do |subcmd|
+        @buffer.should include("* #{subcmd}")
+      end
+    end
+  end
+
+  describe "when run" do
+    before(:all) do
+      import_fixtures
+    end
+
+    it "should parse display completions and exit if requested" do
+      cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print ?))
+      cli.should_not_receive(:run_print)
+      cli.instance_variable_get(:@c).should_receive(:list_groups).with([])
+      cli.run
+    end
+
+    describe "with subcommand" do
+      describe "shell" do
+        before(:each) do
+          @shell_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} shell))
+        end
+
+        it "should require a path" do
+          expect { @shell_cli.run }.to exit_abnormaly
+          @buffer.should include("not host definition")
+        end
+
+        it "should execute the run_shell method" do
+          @shell_cli.should_receive(:run_shell)
+          @shell_cli.run
+        end
+
+        it "should parse 's' as shell" do
+          @shell_cli.send(:extract_subcommand, %w(s root)).should eql('shell')
+        end
+
+        it "should have all required arguments" do
+          options = @shell_cli.instance_variable_get :@options
+          options.should have_key(:login)
+        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))
+          cli.run
+        end
+      end
+
+      describe "add" do
+        before(:each) do
+          @add_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} add -n host one two))
+        end
+
+        it "should parse 'a' as add" do
+          @add_cli.send(:extract_subcommand, ['a']).should eql('add')
+        end
+
+        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)
+        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'))
+          @add_cli.run
+        end
+      end
+
+      describe "del" do
+        before(:each) do
+          @d_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} del))
+          @d_cli.instance_variable_get(:@c).stub(:delete_path)
+        end
+
+        it "should parse 'd' as del" do
+          @d_cli.send(:extract_subcommand, ['d']).should eql('del')
+        end
+
+        it "should verify the deletion" do
+          @d_cli.should_receive(:verify_yn).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)
+          @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)
+          @d_cli.instance_variable_get(:@c).should_not_receive(:delete_path)
+          @d_cli.run
+          @buffer.should match(/cancel/)
+        end
+
+        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)
+          cli.instance_variable_get(:@c).should_receive(:delete_path).
+                                         with([:one, :two, :three])
+          cli.run
+        end
+      end
+
+      describe "update" do
+        before(:each) do
+          @update_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} update -n newhost root))
+        end
+
+        it "should parse 'u' as update" do
+          @update_cli.send(:extract_subcommand, ['u']).should eql('update')
+        end
+
+        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)
+        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'))
+          @update_cli.run
+        end
+      end
+
+      describe "print" do
+        before(:each) do
+          @p_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} print cust2 dc internal somehost))
+        end
+
+        it "should parse 'p' as print" do
+          @p_cli.send(:extract_subcommand, ['p']).should eql('print')
+        end
+
+        it "should print correctly host definition with user" do
+          @p_cli.run
+          @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
+
+      describe "import" do
+        before(:each) do
+          @i_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} import -i inputfile))
+          @i_cli.instance_variable_get(:@c).stub(:import)
+        end
+
+        it "should parse 'i' as import" do
+          @i_cli.send(:extract_subcommand, ['i']).should eql('import')
+        end
+
+        it "should have the right arguments" do
+          options = @i_cli.instance_variable_get :@options
+          options.include?(:input_file)
+        end
+
+        it "should verify the import with the user" do
+          @i_cli.should_receive(:verify_yn).with(/OVERWRITES/)
+          @i_cli.run
+        end
+
+        it "should run import upon confirmation" do
+          @i_cli.should_receive(:verify_yn).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)
+          @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)
+          @i_cli.instance_variable_get(:@c).should_receive(:import).
+                                            with('inputfile')
+          @i_cli.run
+        end
+      end
+
+      describe "export" do
+        before(:each) do
+          @e_cli = RunSSHLib::CLI.new(%W(-f #{TMP_FILE} export -o somefile))
+        end
+
+        it "should parse 'e' as export" do
+          @e_cli.send(:extract_subcommand, ['e']).should eql('export')
+        end
+
+        it "should run export with the right parameters" do
+          @e_cli.instance_variable_get(:@c).should_receive(:export).
+                                            with('somefile')
+          @e_cli.run
+        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
+    cleanup_tmp_file
+  end
+end

data/spec/runsshlib/config_file_spec.rb

@@ -0,0 +1,275 @@
+#
+# 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 'lib/runsshlib'
+require 'tmpdir'
+require 'spec_helper'
+
+describe "RunSSH Configuration class" do
+
+  def read_config
+    File.open(@temp_file) { |io| Marshal.load(io) }
+  end
+
+  def initial_data
+    @c = RunSSHLib::ConfigFile.new(@temp_file)
+    @c.add_host_def([:one, :two, :three], :www,
+                   RunSSHLib::HostDef.new('www.example.com', 'me'))
+  end
+
+  before(:all) do
+    @temp_file = File.join(Dir.tmpdir, 'tempfile')
+    @temp_file_bak = @temp_file + '.bak'
+    @h1 = RunSSHLib::HostDef.new('a.b.c')
+    @h2 = RunSSHLib::HostDef.new('b.b.c', 'meme')
+    @tmp_yml = File.join(Dir.tmpdir, 'tempyml')
+  end
+
+  it "should save a new empty configuration if none exists" do
+    RunSSHLib::ConfigFile.new(@temp_file)
+    read_config.should == {}
+  end
+
+  it "should create a backup while saving" do
+    c = RunSSHLib::ConfigFile.new(@temp_file)
+    c.send(:save)
+    # the 2 files should match
+    File.read(@temp_file).should == File.read(@temp_file_bak)
+  end
+
+  it "should overwrite existing backup if one already exists" do
+    # create a new file and a copy of it
+    c = RunSSHLib::ConfigFile.new(@temp_file)
+    c.send(:save)
+    # sanity
+    File.read(@temp_file).should == File.read(@temp_file_bak)
+    b = RunSSHLib::ConfigFile.new(@temp_file)
+    b.add_host_def([:one, :two, :three], :www, @h1)
+    File.read(@temp_file).should_not == File.read(@temp_file_bak)
+
+  end
+
+  describe "when adding host" do
+    it "should not overwrite existing paths with host definition" do
+      initial_data
+      lambda {@c.add_host_def([:one, :two], :three, @h1)}.
+              should raise_exception(RunSSHLib::ConfigError, /path already exist/)
+    end
+
+    it "should not overwrite existing hosts with path" do
+      initial_data
+      lambda {@c.add_host_def([:one, :two, :three, :www], :host, @h1)}.
+              should raise_exception(RunSSHLib::ConfigError,
+                                     /Cannot override host definition with path/)
+    end
+
+    it "should not overwrite existing hosts" do
+      initial_data
+      lambda {@c.add_host_def([:one, :two, :three], :www, @h1)}.
+              should raise_exception(RunSSHLib::ConfigError, /path already exist/)
+    end
+
+    it "should fail if invalid host definition" do
+      initial_data
+      lambda { @c.add_host_def([], :host, :error) }.
+              should raise_error(RunSSHLib::ConfigError, /Invalid host definition/)
+    end
+
+    it "should correctly merge different paths" do
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.add_host_def([:one, :two], :h1, @h1)
+      c.add_host_def([:three, :four], :h2, @h2)
+      d = RunSSHLib::ConfigFile.new(@temp_file)
+      d.get_host([:one, :two, :h1]).should == @h1
+      d.get_host([:three, :four, :h2]).should == @h2
+    end
+
+    it "should correctly merge paths with common path" do
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.add_host_def([:one, :two], :h1, @h1)
+      c.add_host_def([:one, :three], :h2, @h2)
+      d = RunSSHLib::ConfigFile.new(@temp_file)
+      d.get_host([:one, :two, :h1]).should == @h1
+      d.get_host([:one, :three, :h2]).should == @h2
+    end
+
+    it "should correctly merge hosts under same path" do
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.add_host_def([:one, :two], :h1, @h1)
+      c.add_host_def([:one, :two], :h2, @h2)
+      d = RunSSHLib::ConfigFile.new(@temp_file)
+      d.get_host([:one, :two, :h1]).should == @h1
+      d.get_host([:one, :two, :h2]).should == @h2
+    end
+  end
+
+  describe "when updating host" do
+    it "should refuse to *update* non-existing host" do
+      initial_data
+      lambda { @c.update_host_def([:one, :two, :host], @h1) }.
+              should raise_error(RunSSHLib::ConfigError,
+                                 /Host definition doesn't exist/)
+      lambda { @c.update_host_def([:wrong, :path], @h1) }.
+              should raise_error(RunSSHLib::ConfigError, /Invalid path!/)
+
+    end
+
+    it "should refuse to accept invalid host definition" do
+      initial_data
+      lambda { @c.update_host_def([:one, :two, :three, :www], :wrong) }.
+              should raise_error(RunSSHLib::ConfigError, /Invalid/)
+    end
+
+    it "should NOT replace path with host definition" do
+      initial_data
+      lambda { @c.update_host_def([:one, :two, :three], @h2) }.
+              should raise_error(RunSSHLib::ConfigError, /Cannot overwrite/)
+
+    end
+
+    it "should correctly update and save host definition" do
+      initial_data
+      @c.update_host_def([:one, :two, :three, :www], @h2)
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.get_host([:one, :two, :three, :www]).should == @h2
+    end
+
+    it "should handle invalid paths correctly" do
+      initial_data
+      lambda { @c.update_host_def([:two, :three, :four], @h2) }.
+              should raise_error(RunSSHLib::ConfigError, /Invalid/)
+    end
+  end
+
+  describe "when deleting host" do
+    before(:each) do
+      initial_data
+    end
+
+    it "should raise error if path is invalid" do
+      lambda { @c.delete_path([:one, :three]) }.
+              should raise_error(RunSSHLib::ConfigError, /invalid path/i)
+      lambda { @c.delete_path([:non, :existing]) }.
+              should raise_error(RunSSHLib::ConfigError, /invalid path/i)
+      lambda { @c.delete_path([]) }.
+              should raise_error(RunSSHLib::ConfigError, /invalid path/i)
+    end
+
+    it "should refuse to delete non-empty groups" do
+      lambda { @c.delete_path([:one, :two]) }.
+              should raise_error(RunSSHLib::ConfigError,
+                                 /Supplied path is non-empty group/)
+    end
+
+    it "should delete host definitions" do
+      @c.add_host_def([:another, :path], :host, @h2)
+      @c.delete_path([:another, :path, :host])
+      b = RunSSHLib::ConfigFile.new(@temp_file)
+      b.list_groups([:another, :path]).should == []
+    end
+
+    it "should delete empty groups" do
+      @c.add_host_def([:another, :path], :host, @h2)
+      @c.delete_path([:another, :path, :host])
+      # I should be able to delete the empty path
+      @c.delete_path([:another, :path])
+      b = RunSSHLib::ConfigFile.new(@temp_file)
+      b.list_groups([:another]).should == []
+    end
+  end
+
+  describe "when quering for host" do
+    it "should raise error if requested host is path" do
+      initial_data
+      lambda { @c.get_host([:one, :two]) }.
+              should raise_error(RunSSHLib::ConfigError,
+                                 /is a group, not host definition/)
+    end
+
+    it "should raise error if requested host doesn't exist" do
+      initial_data
+      lambda { @c.get_host([:one, :two, :three, :www2]) }.
+              should raise_error(RunSSHLib::ConfigError, /oesn't exist!/)
+    end
+
+    it "should raise the correct error even if the path is completely invalid" do
+      initial_data
+      lambda { @c.get_host([:dummy, :two, :three, :www]) }.
+              should raise_error(RunSSHLib::ConfigError, /oesn't exist!/)
+    end
+
+    it "should return the correct host when the path is right" do
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.add_host_def([:customer, :dc], :host1, @h1)
+      b = RunSSHLib::ConfigFile.new(@temp_file)
+      b.get_host([:customer, :dc, :host1]).should == @h1
+    end
+  end
+
+  describe "when listing subgroups" do
+    before(:each) do
+      initial_data
+    end
+
+    it "should raise error if path is invalid" do
+      lambda { @c.list_groups([:one, :three, :four]) }.
+              should raise_error(RunSSHLib::ConfigError, /invalid path/i)
+      lambda { @c.list_groups([:two, :three, :four]) }.
+              should raise_error(RunSSHLib::ConfigError, /invalid path/i)
+    end
+
+    it "should return [] if path points to host definition" do
+      @c.list_groups([:one, :two, :three, :www]).should == []
+    end
+
+    it "should return [] for group without subgroups" do
+      @c.add_host_def([:another, :path], :host, @h2)
+      @c.delete_path([:another, :path, :host])
+      @c.list_groups([:another, :path]).should == []
+    end
+
+    it "should return valid subgroups if there are any" do
+      @c.add_host_def([:one, :two, :four], :host, @h2)
+      @c.add_host_def([:one, :two, :three], :host, @h1)
+      @c.list_groups([:one, :two]).should include(:three, :four)
+      @c.list_groups([:one, :two, :three]).should include(:host, :www)
+    end
+  end
+
+  it "should correctly export and import YAML files" do
+    yml = File.join(File.dirname(__FILE__), '../fixtures', 'runssh.yml')
+    c = RunSSHLib::ConfigFile.new(@temp_file)
+    c.import(yml)
+    c.export(@tmp_yml)
+    require 'yaml'
+    YAML.load_file(@tmp_yml).should == YAML.load_file(yml)
+  end
+
+  after(:each) do
+    if File.exists? @temp_file
+      File.delete(@temp_file)
+    end
+    if File.exists? @temp_file_bak
+      File.delete(@temp_file_bak)
+    end
+    if File.exists? @tmp_yml
+      File.delete(@tmp_yml)
+    end
+  end
+
+end

data/spec/runsshlib/ssh_backend_spec.rb

@@ -0,0 +1,68 @@
+#
+# 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 'lib/runsshlib'
+require 'spec_helper'
+
+describe "SshBackend implementation" do
+  describe "when initializing" do
+    before(:all) do
+      @h = RunSSHLib::HostDef.new('a.example.com', 'me')
+      @o = {:login => 'you'}
+    end
+
+    it "should override user in host definition with `overrides`" do
+      s = RunSSHLib::SshBackend.new(@h, @o)
+      s.instance_variable_get(:@host).should == 'a.example.com'
+      s.instance_variable_get(:@user).should == 'you'
+    end
+
+    it "should accept host definitions if no overrides" do
+      s = RunSSHLib::SshBackend.new(@h, {})
+      s.instance_variable_get(:@host).should == 'a.example.com'
+      s.instance_variable_get(:@user).should == 'me'
+    end
+  end
+
+  describe "shell" do
+    before(:each) do
+      @hd1 = RunSSHLib::HostDef.new('a.example.com')
+      @hd2 = RunSSHLib::HostDef.new('b.example.com', 'user')
+    end
+
+    it "should handle null user correctly" do
+      ssh = RunSSHLib::SshBackend.new(@hd1, {})
+      ssh.should_receive(:exec).with(/^ssh\s+a.example.com$/).and_return(nil)
+      ssh.shell
+    end
+
+    it "should handle existing user correctly" do
+      ssh = RunSSHLib::SshBackend.new(@hd2, {})
+      ssh.should_receive(:exec).with(/^ssh\s+-l\s+user\s+b.example.com$/).
+          and_return(nil)
+      ssh.shell
+    end
+
+    it "should use the overriding user instead of configured one" do
+      ssh = RunSSHLib::SshBackend.new(@hd2, {:login => 'another', })
+      ssh.should_receive(:exec).with(/^ssh\s+-l\s+another\s+b.example.com$/).
+          and_return(nil)
+      ssh.shell
+    end
+  end
+end