fabric 0.2.0

data/spec/classes/map_spec.rb

@@ -0,0 +1,212 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Map do
+  before(:each) do
+    Fabric.options[:map_root] = File.join(File.dirname(__FILE__), '..')
+    @map = Map.create
+  end
+  
+  describe "when created" do
+    it "should be valid when created" do
+      @map.should be_a Map
+    end
+    
+    it "should have a blank collection attribute for roles" do
+      @map.roles.should == []
+    end
+
+    it "should have a blank collection attribute for users" do
+      @map.users.should == []  
+    end
+
+    it "should default the key repository to 'keys'" do
+      @map.key_repository.should == 'keys'
+    end
+  end
+  
+  describe "when read" do
+    it "should return true" do
+      @map.read!.should be_true
+    end
+  end
+  
+  describe "'draw' called with a block" do
+    it "should return the map" do
+
+      map = Map.draw do |map|
+        1
+      end
+      
+      map.should be_a Map
+    end    
+  end
+  
+  describe "when passed a non-existent directory as key repository" do
+    it "should raise a LoadError" do
+      lambda { @map.key_repository('blah') }.should raise_error LoadError
+    end
+  end
+    
+  describe "with a mock key repository" do
+    it "should update the key repository without raising an error" do    
+      lambda { @map.key_repository('support/mock_key_repo') }.should_not raise_error LoadError
+    end
+
+    it "should know the full path of the repository" do
+      @map.key_repository 'support/mock_key_repo'
+      @map.expanded_key_repository_path.should == File.join(File.dirname(__FILE__), '..','support', 'mock_key_repo')
+    end
+  end    
+    
+  describe "when given a role" do
+    it "should add that role to the role list" do
+      @map.role 'test'
+      @map.roles.first(:name => 'test').should be_a Role
+    end
+    
+    describe "with host(s)" do
+      it "should add a server object when passed one host" do
+        @map.role 'test', '127.0.0.1'
+        @map.roles.first(:name =>'test').servers.first.should be_a Server        
+      end
+      
+      it "should add multiple server objects when passed multiple hosts" do
+        hosts = []
+        (rand(4) + 1).times { hosts << '127.0.0.1' }
+
+        @map.role 'test', *hosts
+        
+        servers = @map.roles.first(:name => 'test').servers
+        servers.count.should == hosts.count        
+        servers.each do |server|
+          server.should be_a Server
+        end               
+      end
+    end    
+  end
+  
+  describe "with user(s)" do
+    it "should add user to the user list" do
+      @map.user 'test'
+      @map.users.first(:name => 'test').should be_a User
+    end
+    
+    describe "with a user with an ssh key in the mock key repository" do
+      before(:each) do
+        @map.key_repository 'support/mock_key_repo'
+        @key_file = File.join(@map.expanded_key_repository_path, 'fabric_test_user.pub') 
+
+        File.open(@key_file, 'w+') do |f|
+          f.write('test key')
+        end
+      end
+      
+      after(:each) do
+        File.delete(@key_file)
+      end
+      
+      it "should add the user's ssh key from the key repository" do
+        @map.user 'fabric_test_user'
+        @map.users.first(:name => 'fabric_test_user').keys.first.public_key.should == 'test key'
+      end
+    end
+
+    it "should add multiple users to the user list" do
+      users = []
+      (rand(4) + 1).times { |i| users << "user_#{i}" }
+      
+      @map.user *users
+      
+      @map.users.count.should == users.count
+      @map.users.all.each do |user|
+        user.should be_a User
+      end
+    end
+  end
+  
+  describe "when given a grant" do
+    before(:each) do
+      @map.role 'test', '127.0.0.1'
+      @map.user 'test_user'
+    end
+    
+    it "should add the map's users to the role" do
+      @map.roles.first(:name => 'test').users.count.should == 0
+      @map.grant 'test_user', 'test'  
+      @map.roles.first(:name => 'test').users.count.should == 1
+    end
+    
+    describe "for multiple users" do
+      before(:each) do
+        @map.user 'another test'
+      end
+      
+      it "should add multiple users to the role" do
+        @map.grant ['test_user', 'another test'], 'test'
+        @map.roles.first(:name => 'test').users.count.should == 2
+      end
+
+      it "should add all the users to the role when passed :all" do
+        @map.grant :all, 'test'
+        @map.roles.first(:name => 'test').users.count.should == 2
+      end
+    end
+    
+    describe "for all roles" do
+      before(:each) do
+        @map.role 'test again', '127.0.0.1'
+      end
+      
+      it "should add the user to multiple roles" do
+        @map.grant 'test_user', ['test', 'test again']
+        @map.roles.each do |role|
+          role.users.count.should == 1
+        end        
+      end
+      
+      it "should add the user to all the roles when passed :all" do
+        @map.grant 'test_user', :all
+        @map.roles.each do |role|
+          role.users.count.should == 1
+        end
+      end
+    end
+    
+    it "should raise a Object Not Found if an invalid user identifier is passed" do
+      lambda { @map.grant 'fake_user', 'test' }.should raise_error(DataMapper::ObjectNotFoundError)
+    end
+    
+    it "should raise a Object Not Found if an invalid role identifier is passed" do
+      lambda { @map.grant 'user', 'fake_test' }.should raise_error(DataMapper::ObjectNotFoundError)
+    end
+  end
+  
+  describe "with a namespace" do
+    it "should be an instance of Map when created" do
+      namespace = @map.namespace
+      namespace.should be_a Map
+    end
+
+    it "should know its parent when created" do
+      namespace = @map.namespace
+      namespace.parent.should == @map
+    end
+    
+    describe "with users" do
+      before(:each) do
+        @map.users.create(:name => 'test')
+        @namespace = @map.namespace
+      end
+
+      it "should inherit its parents users" do
+        @namespace.users.should == @map.users
+      end
+
+      it "should add users without adding them to the parent" do
+        @namespace.users.create(:name => 'test two')
+        @namespace.users.length.should == 2
+        @map.users.length.should == 1
+      end
+    end
+  end
+end

data/spec/classes/role_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Role do
+end

data/spec/classes/server_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Server do
+  before(:each) do
+    @server = Server.create(:host => TEST_SERVER)
+  end
+  
+  it "should be valid when created" do
+    @server.should be_a Server
+  end
+  
+  describe "'create_group' method" do
+    before(:each) do
+      @group = Group.new(:name => TEST_GROUP)
+    end
+    
+    after(:each) do
+      @server.execute_command("sudo /usr/sbin/groupdel #{TEST_GROUP}")
+    end
+
+    it "should create a group" do
+      @server.create_group(@group)
+
+      @server.execute_command("cat /etc/group | grep #{TEST_GROUP}")     # Not the strongest test - grep not ideal for this    
+      @server.output.should_not == ''
+    end
+  end
+  
+  describe "running plesk" do
+    before(:each) do
+      # mock a plesk server
+      @server.execute_command("sudo mkdir /usr/local/psa")      
+    end
+    
+    after(:each) do
+      # how can we tear this down safely?
+      @server.execute_command("sudo rm -rf /usr/local/psa")      
+    end
+
+    it "should know it is a plesk server" do
+      @server.is_running_plesk?.should be_true
+    end
+  end
+  
+  describe "not running plesk" do
+    it "should know it is not a plesk server" do
+      @server.is_running_plesk?.should be_false
+    end    
+  end
+  
+  describe "with accounts" do
+    before(:each) do
+      @role = Role.create(:name => 'test')
+      @role.servers << @server
+      @role.users.create(:name => TEST_USER)
+    end
+
+    it "should have an account object for each of its role's users" do
+      @server.accounts.first.user.should == @role.users.first
+    end
+
+    it "should check if an account exists" do    
+      # Runner has to exist for the login to have worked
+      runner = User.new(:name => TEST_RUNNER)
+      
+      @server.account_exists_for?(runner).should be_true
+      @server.account_exists_for?(@role.users.first).should be_false
+    end  
+    
+    it "should identify account that require adding" do
+      @server.accounts_to_add.should == Array(@role.users.first)    
+    end
+    
+  end
+  
+  describe "with an account that should be deleted" do
+    before(:each) do
+      @role = Role.create(:name => 'test')
+      @role.servers << @server
+      
+      # We'll add the test user too; just to check it doesn't get deleted
+      @role.users.create(:name => TEST_USER)
+      @server.accounts.first.add_user
+
+      @doomed_user = User.create(:name => TEST_DOOMED_USER)
+      @server.execute_command("sudo /usr/sbin/useradd -m #{@doomed_user.name}")
+    end
+    
+    after(:each) do
+      @server.execute_command("sudo /usr/sbin/userdel --remove #{TEST_USER}")
+      @server.execute_command("sudo /usr/sbin/userdel --remove #{TEST_DOOMED_USER}")
+    end
+
+    it "should identify accounts that require removing" do
+      @server.accounts_to_remove.should == Array(@doomed_user)
+    end
+    
+    it "should delete the account" do
+      @server.account_exists_for?(@doomed_user).should be_true
+      @server.delete_account_for(@doomed_user)
+      @server.account_exists_for?(@doomed_user).should be_false  
+    end    
+  end
+end

data/spec/classes/user_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe User do
+  before :each do
+    @user = User.new(:name => 'bob')
+  end
+  
+  it "should merge multiple keys into the authorized_keys file" do
+    user = User.create
+    key1 = 'this is'
+    key2 = ' a key.'
+    
+    user.keys.create(:public_key => key1)
+    user.keys.create(:public_key => key2)
+    
+    user.authorized_keys_file.should == key1 + key2
+  end
+  
+  it "should raise an error if the authorized_keys_file is blank" do
+    lambda { @user.authorized_keys_file }.should raise_error
+  end
+  
+  it "can generate the user's home directory path" do
+    @user.home_directory_path.should == '/home/bob/'
+  end
+  
+  it "can generate the path to the user's .ssh directory" do
+    @user.ssh_config_directory_path.should == '/home/bob/.ssh/'
+  end
+  
+  it "can generate the path to the user's authorized_keys file" do
+    @user.authorized_keys_file_path.should == '/home/bob/.ssh/authorized_keys'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format specdoc
+--loadby mtime
+--reverse
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '..', 'vendor','gems','environment')
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'fabric'
+require 'fabric-test'
+require 'database_cleaner'
+
+TEST_SERVER = Fabric::Test.settings['server']
+TEST_RUNNER = Fabric::Test.settings['runner']
+TEST_USER = Fabric::Test.settings['user']
+TEST_DOOMED_USER = Fabric::Test.settings['doomed_user']
+TEST_GROUP = Fabric::Test.settings['group']
+
+Spec::Runner.configure do |config|
+  config.before(:suite) do 
+    DatabaseCleaner.strategy = :transaction
+  end 
+
+  config.before(:each) do 
+    DatabaseCleaner.start 
+  end 
+
+  config.after(:each) do 
+    DatabaseCleaner.clean 
+  end
+end

data/tasks/features.rake

@@ -0,0 +1,15 @@
+namespace :test do
+  begin
+    require 'cucumber/rake/task'
+    Cucumber::Rake::Task.new(:features)
+
+    task :features => :check_dependencies
+  rescue LoadError
+    task :features do
+      abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+    end
+  end
+end
+
+desc 'synonym for test:features'
+task 'features' => 'test:features'

data/tasks/jeweler.rake

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fabric"
+    gem.summary = %Q{Fabric is a small ruby app to perform tasks on servers via SSH.}
+    gem.description = %Q{Fabric is a small ruby app to perform tasks on servers via SSH. Built around net/ssh and taking heavy inspiration from Capistrano, it allows you to create policies for server management and perform sysadmin tasks without the need for a process/daemon/dependency or even ruby being installed on the remote server.}
+    gem.email = "sam.phillips@setfiremedia.com"
+    gem.homepage = "http://github.com/setfire/fabric"
+    gem.authors = ["Sam Phillips"]
+    gem.add_development_dependency "cucumber", ">= 0.3.104"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/tasks/rdoc.rake

@@ -0,0 +1,9 @@
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fabric #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/tasks/spec.rake

@@ -0,0 +1,15 @@
+require 'spec'
+require 'spec/rake/spectask'
+
+namespace 'test' do
+  Spec::Rake::SpecTask.new('spec') do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--options', "\"spec/spec.opts\""]
+    t.ruby_opts = ['-Ilib']
+    t.rcov = false
+  end
+end
+
+desc 'synonym for test:spec'
+task 'spec' => 'test:spec'
+