zool 0.1.0

data/spec/zool/key_file_writer_spec.rb

@@ -0,0 +1,82 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Zool
+  describe KeyfileWriter do
+    context "dumping keys to files" do
+      before :each do
+        @writer = KeyfileWriter.new
+      end
+
+      context "#write" do
+        context "with no filename provided" do
+          before :each do
+            sorted_keys = [
+              key_fixtures[:pascal],
+              key_fixtures[:pascal_private],
+              key_fixtures[:pascal_laptop],
+              key_fixtures[:bob],
+              key_fixtures[:upcase],
+            ]
+            sorted_keys.each do |key|
+              @writer.write key
+            end
+          end
+
+          it "should replace special characters with underscores in filename" do
+            it_should_generate_keyfile 'bob_schneider.pub'
+            it_should_generate_keyfile 'pascal_friederich.pub'
+          end
+          
+          it "should not fail if keyfile name is not parsable" do
+            key_without_host = "ssh-dsa asdfkasdlfjasdlfkjsdf="
+            @writer.write key_without_host
+            it_should_generate_keyfile '1__not_parsable.pub'
+          end
+          
+          it "should not fail if the name in the keyfile is unusual" do
+            key_with_only_username = "ssh-dsa asdfasdfasdfkjkj= Peter"
+            @writer.write key_with_only_username
+            it_should_generate_keyfile "peter.pub"
+          end
+
+          it "should write the ssh key in the appropriate keyfile" do
+            File.read('keys/bob_schneider.pub').chomp.should == key_fixtures[:bob]
+            File.read('keys/pascal_friederich.pub').chomp.should == key_fixtures[:pascal]
+          end
+
+          it "should turn the filenames to underscores" do
+            it_should_generate_keyfile 'upcase_van.pub'
+          end
+
+          it "should number dublicate keynames" do
+            it_should_generate_keyfile 'pascal_friederich_2.pub'
+            it_should_generate_keyfile 'pascal_friederich_3.pub'
+          end
+        end
+        
+        context "with a filename provided" do
+          it "should write the ssh key to the file named as given (with .pub added to the name)" do
+            @writer.write('a key', 'customname')
+            it_should_generate_keyfile('customname.pub')
+          end
+        end
+      end
+      
+      context "#write_keys" do
+        it "should write every key" do
+          @writer.should_receive(:write).exactly(3).times
+          keys = [
+                  key_fixtures[:pascal],
+                  key_fixtures[:pascal_private],
+                  key_fixtures[:pascal_laptop]
+                 ]
+          @writer.write_keys(keys)
+        end
+      end
+    end
+  end
+end
+
+def it_should_generate_keyfile(keyfile)
+  Dir['keys/*.pub'].map {|path| path.split('/').last }.should include keyfile
+end

data/spec/zool/server_pool_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Zool
+  describe ServerPool do
+    context "parsing from a hosts file" do
+      context "with a user argument and/or password" do
+        before :each do
+          hostsfile = <<-HOSTS
+          12.21.4.1 servername
+          HOSTS
+          @server = ServerPool.from_hostfile(hostsfile, :user => 'peter', :password => 'peters1234').servers.first
+        end
+        
+        it "should pass the user argument to the servers" do
+          @server.user.should == 'peter'
+        end
+        
+        it "should pass the password argument to the servers" do
+          @server.send(:instance_variable_get, :@options)[:password].should == 'peters1234'
+        end
+      end
+
+      context "when given a String" do
+        it "should return a Serverpool object with the servers from the hosts file" do
+          hostsfile = StringIO.new <<-HOSTS
+            12.21.4.1       servername
+            12.21.4.2       servername2
+            12.21.4.3       servername3
+            12.21.4.4       servername4
+          HOSTS
+          pool = ServerPool.from_hostfile(hostsfile)
+          pool.servers.map {|server| server.hostname }.should == ['12.21.4.1', '12.21.4.2', '12.21.4.3', '12.21.4.4']
+        end
+
+        it "should remove duplicates from the list of servers" do
+          hostsfile = StringIO.new <<-HOSTS
+            12.21.4.1       servername1
+            12.21.4.2       servername2
+            12.21.4.2       fancy_alias
+          HOSTS
+          pool = ServerPool.from_hostfile(hostsfile)
+          pool.servers.map {|server| server.hostname }.should == ['12.21.4.1', '12.21.4.2']
+        end
+        
+        it "should remove localhost and networks from the list of servers" do
+          hostfile = StringIO.new <<-HOSTS
+            12.34.45.56     validserver
+            localhost       localhost
+            127.0.0.1       localhost
+            255.255.255.255 network
+            ::1             localhost
+          HOSTS
+          pool = ServerPool.from_hostfile(hostfile)
+          pool.servers.map {|server| server.hostname }.should == ['12.34.45.56']
+        end
+
+        it "should ignore malformed lines" do
+          hostsfile = StringIO.new <<-HOSTS
+            # asdfasdfasdf  comment
+            19023912u0194h  odd_line
+            12.21.4.1       servername1
+
+            10.257.2.1      invalid_ip
+            12.21.4.2       servername2
+            myhost.de
+          HOSTS
+          pool = ServerPool.from_hostfile(hostsfile)
+          pool.servers.map {|server| server.hostname }.should == ['12.21.4.1', '12.21.4.2', 'myhost.de']
+        end
+      end
+    end
+    before :each do
+      @pool = ServerPool.new
+    end
+
+    it "should only take Server objects" do
+      lambda { @pool << Object.new }.should raise_error TypeError
+      lambda { @pool.add Object.new }.should raise_error TypeError
+    end
+
+    it "should delegate methods to the server objects" do
+      server = mock('server')
+      server.should_receive(:keys)
+      server.should_receive(:fetch_keys)
+      server.should_receive(:upload_keys)
+      @pool.push server
+
+      @pool.keys
+      @pool.fetch_keys
+      @pool.upload_keys
+    end
+
+    context "delegating methods to the servers" do
+      it "should aggregated values as an hash" do
+        server1 = stub
+        server1_keys = ['first key', 'second key']
+        server1.stub!(:keys).and_return(server1_keys)
+
+        server2 = stub
+        server2_keys = ['third key', 'forth key']
+        server2.stub!(:keys).and_return(server2_keys)
+
+        @pool.push server1
+        @pool.push server2
+
+        @pool.keys.should == server1_keys + server2_keys
+      end      
+    end
+
+    context "dumping the servers keys to files" do
+      it "should write a keyfile for every key" do
+        FileUtils.rm_r 'keys' # cleanup old keyfiles
+        @pool.stub!(:keys).and_return(key_fixtures.values.join("\n"))
+        @pool.dump_keyfiles
+        Dir['keys/*'].should have(key_fixtures.size).keys
+      end
+    end
+
+    context "adding a key to the serverpool" do
+      it "should add the key to every server in the pool" do
+        new_key = 'a key'
+        keys = mock('keys')
+        server1 = mock('server1', :keys => keys)
+        server2 = mock('server2', :keys => keys)
+        @pool.push server1
+        @pool.push server2
+
+        keys.should_receive(:<<).twice.with(new_key)        
+        @pool.keys << new_key
+      end
+    end
+  end
+end

data/spec/zool/server_spec.rb

@@ -0,0 +1,178 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'ruby-debug'
+Debugger.start
+
+module Zool
+  describe Server do
+    before :each do
+      @server = Server.new("somehost")
+    end
+    
+    it "should have a getter for the user attribute" do
+      @server.user.should == @server.send(:instance_variable_get, :@options)[:user]
+    end
+    
+    context "fetching a servers keys" do
+      it "should use a password if provided" do
+        server = Server.new('somehost', :user => 'root', :password => 'a password')
+        Net::SCP.should_receive(:download!).with(anything, anything, anything, anything, :ssh => {:password => 'a password'})
+        server.keys
+      end
+
+      it "should use the default server location" do
+        Server.new('somehost').keyfile_location.should          == '~/.ssh/authorized_keys'
+        Server.new('somehost', :user => 'peter').keyfile_location.should == '~/.ssh/authorized_keys'
+      end
+      
+      context "with a custom keyfile location set" do
+        it "should use the custom keyfile location" do
+          @server = Server.new('somehost')
+          custom_keyfile_location = '/some/custom/path'
+          @server.keyfile_location = custom_keyfile_location
+          Net::SCP.should_receive(:download!).with(anything, anything, custom_keyfile_location, anything, anything)
+
+          @server.fetch_keys          
+        end
+      end
+      
+      context "when the keyfile is not presetn" do
+        it "should return an empty list of keys" do
+          Net::SCP.should_receive(:download!).and_raise(Net::SCP::Error)
+          @server.keys.should be_empty
+        end
+      end
+
+      it "should load the authorized_keys file from the server" do
+        @server = Server.new('somehost')
+        Net::SCP.should_receive(:download!).with(anything, anything, @server.keyfile_location, anything, anything)
+
+        @server.fetch_keys
+      end
+
+      it "should make the keys available through a keys array" do
+        @server.stub!(:load_remote_file).and_return("#{key_fixtures[:pascal]}\n#{key_fixtures[:bob]}")
+        @server.keys.should == [key_fixtures[:pascal], key_fixtures[:bob]]
+      end
+
+      it "should remove unneccasarry whitespace from the output" do
+        @server = Server.new('somehost')
+        @server.stub!(:load_remote_file).and_return("    #{key_fixtures[:pascal]}   ")
+        @server.keys.should == [key_fixtures[:pascal]]
+        @server.keys.should have(1).key
+      end
+
+      it "should remove blank lines" do
+        @server = Server.new('somehost')
+        @server.stub!(:load_remote_file).and_return("    #{key_fixtures[:pascal]}   \n    ")
+        @server.keys.should == [key_fixtures[:pascal]]
+        @server.keys.should have(1).key
+      end
+
+      it "should remove duplicate keys from the list" do
+        @server = Server.new('somehost')
+        @server.stub!(:load_remote_file).and_return("#{key_fixtures[:pascal]}\n#{key_fixtures[:pascal]}")
+        @server.keys.should have(1).key
+        @server.keys.should == [key_fixtures[:pascal]]
+      end
+      
+      context "requesting the keys several times" do
+        it "should not fetch the keys again" do
+          @server = Server.new('somehost')
+          @server.should_receive(:load_remote_file).once.and_return("n#{key_fixtures[:pascal]}")
+          @server.keys
+          @server.keys
+        end
+      end
+      
+      context "fetching the keys again after they have already been fetched" do
+        it "should return the new list of keys" do
+          @server = Server.new('somehost')
+          @server.should_receive(:load_remote_file).ordered.and_return("#{key_fixtures[:pascal]}")
+          @server.should_receive(:load_remote_file).ordered.and_return("#{key_fixtures[:bob]}")
+          @server.keys
+          @server.keys.should == [key_fixtures[:pascal]]
+          @server.fetch_keys
+          @server.keys.should == [key_fixtures[:bob]]
+        end
+      end
+    end
+
+    context "dumping the keys to files" do
+      it "should write a keyfile for every key" do
+        FileUtils.rm_r 'keys' # cleanup old keyfiles
+        @server.stub!(:load_remote_file).and_return(key_fixtures.values.join("\n"))
+        @server.dump_keyfiles
+        Dir['keys/*'].should have(key_fixtures.size).keys
+      end
+    end
+    
+    context "setting a servers keys" do
+      before :each do
+        @server = Server.new('somehost')
+        @server.stub!(:load_remote_file).and_return("")
+      end
+
+      context "by replacing all of them" do
+        it "should take a array of keys" do
+          @server.keys = [key_fixtures[:pascal], key_fixtures[:bob]]
+          @server.keys.should == [key_fixtures[:pascal], key_fixtures[:bob]]
+        end
+
+        it "should not fetch the servers existing keys" do
+          @server.should_not_receive(:load_remote_file)
+          @server.keys = [key_fixtures[:pascal]]
+        end
+      end
+
+      context "by adding keys to the existing keys" do
+        it "should fetch the servers current keys if not done before" do
+          @server.should_receive(:load_remote_file)
+          @server.keys << "asdf"
+        end        
+      end
+
+      context "and uploading them" do
+        before :each do
+          @server.keys = [key_fixtures[:pascal], key_fixtures[:bob]]
+          @backup_keys = 'original keys'
+          @server.stub!(:load_remote_file).and_return(@backup_keys)
+
+          Net::SCP.stub(:download!)
+        end
+
+        it "should write a authorized_keys file with all the keys" do          
+          channel_stub = stub('ssh channel stub', :null_object => true)
+          Net::SSH.stub!(:start).and_return(channel_stub)
+          Net::SCP.stub!(:upload!) # the backup
+          channel_stub.stub(:scp).and_return(channel_stub)
+
+          channel_stub.should_receive(:upload!).with(stringbuffer_with(@server.keys.join("\n")), @server.keyfile_location).ordered
+          @server.upload_keys
+        end
+
+        it "should backup the existing authorized_keys file" do
+          @server.should_receive(:load_remote_file).and_return(@backup_keys)
+          Net::SSH.stub!(:start).and_return(stub('ssh channel stub', :null_object => true))
+          
+          Net::SCP.should_receive(:upload!).with('somehost', 'root', stringbuffer_with(@backup_keys), /authorized_keys_\d+$/, anything)
+          @server.upload_keys
+        end
+
+        context "with an exception during backup of the original keys" do
+          before :each do
+            Net::SCP.stub!(:download!).and_raise(Exception)
+          end
+
+          it "should not upload the new keys" do
+            Net::SCP.should_not_receive(:upload!)
+            lambda { @server.upload_keys }.should raise_error
+          end
+        end
+        
+        context "providing a fallback if something goes wrong" do
+          
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification 
+name: zool
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pascal Friederich
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 +01:00
+default_executable: zool
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-scp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.17
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-scp
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.17
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: polyglot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: columnize
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: linecache
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.43"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug-base
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+description: Zool allows you to manage authorized_keys files on servers. It comes with a command-line client 'zool'. The configuration can be done in a pyconfig/gitosis like configuration file. See README.md for further details
+email: paukul@gmail.com
+executables: 
+- zool
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- Rakefile
+- Readme.md
+- bin/zool
+- lib/py_config_parser/py_config_parser.tt
+- lib/zool.rb
+- lib/zool/configuration.rb
+- lib/zool/key_file_writer.rb
+- lib/zool/server.rb
+- lib/zool/server_pool.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/paukul/zool
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library and command-line client to manage authorized_keys files
+test_files: 
+- spec/py_config_parser_spec.rb
+- spec/spec_helper.rb
+- spec/zool/configuration_spec.rb
+- spec/zool/key_file_writer_spec.rb
+- spec/zool/server_pool_spec.rb
+- spec/zool/server_spec.rb
+- spec/zool.rb
+- features/config_parser.feature
+- features/fetching_ssh_keys.feature
+- features/step_definitions/ssh_keys_steps.rb
+- features/store_ssh_keys.feature
+- features/support/env.rb