runssh 0.1.1 → 0.2.0

data/spec/runsshlib/config_file_spec.rb

@@ -16,52 +16,87 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 
-require 'lib/runsshlib'
-require 'tmpdir'
 require 'spec_helper'
+require 'runsshlib'
+require 'tmpdir'
+require 'yaml'
 
 describe "RunSSH Configuration class" do
 
-  def read_config
-    File.open(@temp_file) { |io| Marshal.load(io) }
+  def read_config from_file=@temp_file
+    File.open(from_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'))
+    host = {:host_name => 'www.example.com', :login => "me"}
+    @c.add_host_def([:one, :two, :three], :www, RunSSHLib::SshHostDef.new(host))
   end
 
   before(:all) do
-    @temp_file = File.join(Dir.tmpdir, 'tempfile')
+    cleanup_tmp_file # make sure there are no leftovers
+    @temp_file = TMP_FILE
     @temp_file_bak = @temp_file + '.bak'
-    @h1 = RunSSHLib::HostDef.new('a.b.c')
-    @h2 = RunSSHLib::HostDef.new('b.b.c', 'meme')
+    @h1 = RunSSHLib::SshHostDef.new('a.b.c')
+    @h2 = RunSSHLib::SshHostDef.new(:host_name => 'b.b.c',
+                                    :login => '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
+  describe 'when initializing' do
+    it "should save a new empty configuration if none exists" do
+      RunSSHLib::ConfigFile.new(@temp_file)
+      read_config.should == {'VERSION' => RunSSHLib::ConfigFile::Version}
+    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 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)
+    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
 
+    it "should raise OlderConfigVersionError if missing config version" do
+      # create an empty file to represent a config file without a version
+      dump_config Hash.new
+      expect {
+        RunSSHLib::ConfigFile.new(@temp_file)
+      }.to raise_error(RunSSHLib::OlderConfigVersionError, 'none')
+    end
+
+    it "should accept older/no config version of old_version=true" do
+      dump_config Hash.new
+      RunSSHLib::ConfigFile.new(TMP_FILE, true).should be_instance_of(RunSSHLib::ConfigFile)
+    end
+
+    it "should raise ConfigError if version is higher then supported" do
+      hsh = Hash.new
+      hsh['VERSION'] = 1.1
+      dump_config hsh
+      expect do
+        RunSSHLib::ConfigFile.new(@temp_file)
+      end.to raise_error(RunSSHLib::ConfigError, /newer version of runssh!/)
+      # even if old_version=true
+      expect do
+        RunSSHLib::ConfigFile.new(@temp_file, true)
+      end.to raise_error(RunSSHLib::ConfigError, /newer version of runssh!/)
+    end
+
+    it "should create new config files with the correct version" do
+      cf = RunSSHLib::ConfigFile.new(@temp_file)
+      read_config['VERSION'].should eql(RunSSHLib::ConfigFile::Version)
+    end
   end
 
   describe "when adding host" do
@@ -95,8 +130,8 @@ describe "RunSSH Configuration class" do
       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
+      d.get_host([:one, :two, :h1]).should eql(@h1)
+      d.get_host([:three, :four, :h2]).should eql(@h2)
     end
 
     it "should correctly merge paths with common path" do
@@ -249,15 +284,93 @@ describe "RunSSH Configuration class" do
       @c.list_groups([:one, :two]).should include(:three, :four)
       @c.list_groups([:one, :two, :three]).should include(:host, :www)
     end
+
+    it "should not return the VERSION as a group" do
+      @c.list_groups([]).should_not include('VERSION')
+    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)
+  describe "when importing" do
+    let(:yml) { File.join(File.dirname(__FILE__), '../fixtures', 'runssh.yml') }
+
+    it "should not accept config from different config version" do
+      y = YAML.load_file(yml)
+      y['VERSION'] = 2.0
+      File.open(@tmp_yml, 'w') { |out| YAML.dump(y, out) }
+      expect do
+        c = RunSSHLib::ConfigFile.new(@temp_file)
+        c.import(@tmp_yml)
+      end.to raise_error(RunSSHLib::ConfigError, /different version.*2.0/)
+    end
+
+    it "should correctly export and import YAML files" do
+      c = RunSSHLib::ConfigFile.new(@temp_file)
+      c.import(yml)
+      c.export(@tmp_yml)
+      YAML.load_file(@tmp_yml).should == YAML.load_file(yml)
+    end
+  end
+
+  describe "when updating configuration version" do
+    let(:config_v_none) do
+      YAML.load_file(File.join(File.dirname(__FILE__), '..',
+                               'fixtures', 'runssh_v_none.yml'))
+    end
+
+    it "'config_none_to_10' should correctly convert all old HostDef to SshHostDef" do
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      result = c.send(:config_none_to_10, config_v_none)
+      result[:cust1][:dc1][:host2].should be_instance_of(RunSSHLib::SshHostDef)
+      result[:cust1][:dc1][:host1].should be_instance_of(RunSSHLib::SshHostDef)
+      result[:cust1][:dc2][:host1].should be_instance_of(RunSSHLib::SshHostDef)
+    end
+
+    it "'update_config' should call config_none_to_10 with right parameters" do
+      dump_config(config_v_none)
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      c.should_receive(:config_none_to_10).with(config_v_none).and_return(Hash.new)
+      c.update_config
+    end
+
+    it "'update_config' should create backup with appropriate name" do
+      bf = TMP_FILE + '.none'
+      dump_config(config_v_none)
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      c.update_config
+      read_config(bf).should eql(config_v_none)
+    end
+
+    it "'update_config' should return the backup file for notifying the user" do
+      dump_config(config_v_none)
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      c.update_config.should eql(TMP_FILE + '.none')
+    end
+
+    it "'update_config' should return nil if there was no need for backup" do
+      hsh = {'VERSION' => RunSSHLib::ConfigFile::Version}
+      dump_config(hsh)
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      c.update_config.should be_nil
+    end
+
+    it "should correctly save the new configuration" do
+      dump_config(config_v_none)
+      c = RunSSHLib::ConfigFile.new(TMP_FILE, true)
+      c.update_config
+      new_config = RunSSHLib::ConfigFile.new(TMP_FILE)
+      cc = new_config.instance_variable_get(:@config)
+      cc['VERSION'].should eql(RunSSHLib::ConfigFile::Version)
+      cc[:cust1][:dc1][:host2].should be_instance_of(RunSSHLib::SshHostDef)
+      cc[:cust1][:dc1][:host1].should be_instance_of(RunSSHLib::SshHostDef)
+      cc[:cust1][:dc2][:host1].should be_instance_of(RunSSHLib::SshHostDef)
+    end
+
+    after(:each) do
+      bf = TMP_FILE + '.none'
+      if File.exists? bf
+        File.delete(bf)
+      end
+    end
   end
 
   after(:each) do
@@ -272,4 +385,4 @@ describe "RunSSH Configuration class" do
     end
   end
 
-end
+end

data/spec/runsshlib/ssh_backend_spec.rb

@@ -16,53 +16,55 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
 
-require 'lib/runsshlib'
 require 'spec_helper'
+require 'runsshlib'
 
-describe "SshBackend implementation" do
-  describe "when initializing" do
-    before(:all) do
-      @h = RunSSHLib::HostDef.new('a.example.com', 'me')
-      @o = {:login => 'you'}
+describe RunSSHLib::SshBackend do
+  context "shell" do
+    let(:test_data) do
+      {:host_name => "a",
+       :login => "user",
+       :remote_cmd => "uptime"}
     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'
+    it "should handle null user correctly" do
+      data = {:host_name => "a"}
+      RunSSHLib::SshBackend.should_receive(:exec).
+                            with(/^ssh\s+#{data[:host_name]}$/).
+                            and_return(nil)
+      RunSSHLib::SshBackend.shell(data)
     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'
+    it "should handle user correctly" do
+      data = {
+        :host_name => "a",
+        :login => "user"
+      }
+      RunSSHLib::SshBackend.should_receive(:exec).
+                            with(/^ssh\s+-l\s+#{data[:login]}\s+#{data[:host_name]}$/).
+                            and_return(nil)
+      RunSSHLib::SshBackend.shell(data)
     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
+    it "should raise error if no :host_name in definition" do
+      expect do
+        RunSSHLib::SshBackend.shell({:login => 'me'})
+      end.to raise_error(RuntimeError, /no hostname/i)
     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
+    it "should handle correctly remote commands" do
+      RunSSHLib::SshBackend.should_receive(:exec).
+                            with(/^ssh\s+-l\s+#{test_data[:login]}\s+#{test_data[:host_name]}\s+--\s+"uptime"$/).
+                            and_return(nil)
+      RunSSHLib::SshBackend.shell(test_data)
     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
+    it "should ignore empty remote commands" do
+      data = test_data.merge(:remote_cmd => "")
+      RunSSHLib::SshBackend.should_receive(:exec).
+                            with(/^ssh\s+-l\s+#{data[:login]}\s+#{data[:host_name]}$/).
+                            and_return(nil)
+      RunSSHLib::SshBackend.shell(data)
     end
   end
 end

data/spec/runsshlib/ssh_host_def_spec.rb

@@ -0,0 +1,91 @@
+#
+# 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 'spec_helper'
+require 'runsshlib'
+
+describe 'SshHostDef' do
+  context 'when initialized' do
+    let(:data) { {:host_name => 'myname'} }
+
+    it "should raise ArgumentError if not initialized with host_name" do
+      expect {
+        RunSSHLib::SshHostDef.new({:login => 'haim'})
+      }.to raise_error(ArgumentError, /Missing hostname/)
+    end
+
+    it "should initialize correctly if supplied a hostname as string" do
+      shd = RunSSHLib::SshHostDef.new('myname')
+      shd.instance_variable_get(:@definition).should eql(data)
+    end
+
+    it "should initialize correctly if supplied with a hash with :host_name" do
+      shd = RunSSHLib::SshHostDef.new(data)
+      shd.instance_variable_get(:@definition).should eql(data)
+    end
+  end
+
+  context 'when testing for equality' do
+    let(:definition) do
+      { :host_name => 'host', :login => "login" }
+    end
+
+    it "should not equal nil" do
+      RunSSHLib::SshHostDef.new(definition).should_not == nil
+    end
+
+    it "should not equal any object" do
+      class MyTest
+        attr_reader :definition
+        def initialize definition
+          @definition = definition
+        end
+      end
+
+      RunSSHLib::SshHostDef.new(definition).should_not == MyTest.new(definition)
+    end
+
+    it "should return true for == if @definition is equal" do
+      h1 = RunSSHLib::SshHostDef.new(definition)
+      h2 = RunSSHLib::SshHostDef.new('hostname')
+      RunSSHLib::SshHostDef.new(definition).should == h1
+      RunSSHLib::SshHostDef.new('hostname').should == h2
+    end
+
+    it "should return true for eql? if @definition is equal" do
+      h1 = RunSSHLib::SshHostDef.new(definition)
+      h2 = RunSSHLib::SshHostDef.new('hostname')
+      RunSSHLib::SshHostDef.new(definition).should eql(h1)
+      RunSSHLib::SshHostDef.new('hostname').should eql(h2)
+    end
+  end
+
+  context "to_print" do
+    it "should run correctly without user" do
+      h = RunSSHLib::SshHostDef.new('myhostname')
+      p h.to_print
+      h.to_print.should match(/^.*host:.*myhostname\n.*login:.*current user$/)
+    end
+
+    it "should run correctly with user" do
+      h = RunSSHLib::SshHostDef.new({
+        :host_name => 'myhostname', :login => 'me'
+      })
+      h.to_print.should match(/^.*host:.*myhostname\n.*login:.*me$/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@
 #
 require 'rspec'
 require 'tmpdir'
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 # got the idea from:
 # http://stackoverflow.com/questions/1480537/how-can-i-validate-exits-and-aborts-in-rspec
@@ -83,3 +84,7 @@ def import_fixtures
   c = RunSSHLib::ConfigFile.new(TMP_FILE)
   c.import(yml)
 end
+
+def dump_config hsh
+  File.open(TMP_FILE, 'w') { |out| Marshal.dump(hsh, out) }
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: runssh
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Haim Ashkenazi
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-31 00:00:00 +02:00
+date: 2011-01-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: highline
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,16 +44,32 @@ dependencies:
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
         - 2
-        - 0
         - 1
-        version: 2.0.1
+        - 0
+        version: 2.1.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rcov
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,7 +81,55 @@ dependencies:
         - 9
         version: 0.9.9
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 4
+        - 4
+        - 4
+        version: 4.4.4
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: autotest-fsevent
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: autotest-growl
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :development
+  version_requirements: *id007
 description: |
   Runssh is a command line utility to help bookmark many
   ssh connections in heirarchial groups.
@@ -78,19 +142,30 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .autotest
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
 - README.rdoc
-- gpl-2.0.txt
 - Rakefile
+- autotest/discover.rb
+- bin/runssh
+- bin/runssh_comp.sh
+- gpl-2.0.txt
+- lib/runsshlib.rb
 - lib/runsshlib/cli.rb
 - lib/runsshlib/config_file.rb
 - lib/runsshlib/ssh_backend.rb
-- lib/runsshlib.rb
-- bin/runssh
-- bin/runssh_comp.sh
+- lib/runsshlib/ssh_host_def.rb
+- lib/runsshlib/version.rb
+- runssh.gemspec
 - spec/fixtures/runssh.yml
+- spec/fixtures/runssh_v_none.yml
 - spec/runsshlib/cli_spec.rb
 - spec/runsshlib/config_file_spec.rb
 - spec/runsshlib/ssh_backend_spec.rb
+- spec/runsshlib/ssh_host_def_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/babysnakes/runssh
@@ -100,12 +175,14 @@ post_install_message:
 rdoc_options: 
 - --main
 - README.rdoc
+- -c
+- UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version 
       hash: 57
       segments: 
@@ -125,9 +202,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: CLI utility to bookmark multiple ssh connections with hierarchy.
-test_files: []
-
+test_files: 
+- spec/fixtures/runssh.yml
+- spec/fixtures/runssh_v_none.yml
+- spec/runsshlib/cli_spec.rb
+- spec/runsshlib/config_file_spec.rb
+- spec/runsshlib/ssh_backend_spec.rb
+- spec/runsshlib/ssh_host_def_spec.rb
+- spec/spec_helper.rb