fabric 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+vendor/gems/ruby/
+vendor/gems/bin
+vendor/gems/environment.rb
+!vendor/gems/ruby/1.8/cache
+test.yml

data/Gemfile

@@ -0,0 +1,18 @@
+bin_path "vendor/gems/bin"
+
+gem 'net-ssh', '2.0.15'
+gem 'dm-core', '0.10.2'
+gem 'data_objects', '0.10.0'
+gem 'do_sqlite3', '0.10.0'
+
+# Currently forced to bundle this, otherwise internals don't load properly
+# Alternative is to comment out 'disable_system_gems'
+gem 'cucumber', '0.6.1'
+gem 'rspec', '1.2.9'
+
+gem 'jeweler', '1.4.0', :bundle => false
+gem 'database_cleaner', '0.4.0', :bundle => false
+
+gem 'ruby-debug', :bundle => false
+
+# disable_system_gems

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sam Phillips
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,91 @@
+= fabric
+
+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.
+
+Its primary purpose at the moment is to manage user access and ssh keys across a large cluster.
+
+== Installation
+
+ gem install fabric
+
+== Usage
+
+Fabric parses a 'map' of your servers. On the simplest level, this will look something like:
+
+ Map.draw do |map|
+   map.role 'web server', '192.168.1.2'
+   map.user 'sammy'
+   map.grant 'sammy', 'web server'
+ end
+
+Let's take this apart:
+
+ Map.draw do |map|
+   # Define a role called 'web server', and pass the IP of a host that is within the role
+   map.role 'web server', '192.168.1.2'
+
+   # Define a user - we'll look for sammy.pub in the key_repository (by default, './keys')
+   map.user 'sammy'
+
+   # Give the 'sammy' user access to all servers that are within the 'web server' role
+   map.grant 'sammy', 'web server'
+ end
+
+Save this file (let's say you called it map.rb) and run it as so:
+
+ fab map.rb
+
+For a detailed output of the process and commands being run, enable narration with:
+
+ fab map.rb --narrate
+
+Or
+
+ fab map.rb -n
+
+This will then execute the map file as pure Ruby, and perform the necessary operations
+
+== More complex mapping
+
+ Map.draw do |map|
+
+   # Specify the directory to look for users' ssh keys:
+   map.key_repository 'other_key_repository'
+   
+   # Pass multiple users if you like
+   map.user 'sammy', 'joey'
+
+   map.role 'file server', '2.3.4.5'
+   map.role 'database', '1.2.3.4'
+
+   # Grant all users access to all servers
+   map.grant :all, :all
+
+   # Create a namespace - this will contain all the users defined in the parent,
+   # but any users and roles added will only exist within this block
+   map.namespace do |cool_website|
+     # pass multiple IPs to add multiple hosts to this role
+     cool_website.role 'memcached', '1.1.1.1', '2.2.2.2'
+
+     # This user will only exist within the current namespace
+     cool_website.user 'timmy'
+
+     # Add all our users, including from the parent, to the memcached server:
+     grant :all, 'memcached'
+
+   end
+ end
+
+== Normal Requirements
+
+None - this should run straight out of the box.
+
+== Testing Requirements
+
+Bundler (http://github.com/wycats/bundler) is used to manage dependencies, and has cached versions of those gems which are required for execution. For development, it expects those files listed in the Gemfile with :bundle => false to be installed into the version of gems that the gem will run under.
+
+The tests for this gem rely on being able to ssh to a target machine. This can be your development machine, but it's easier if it's a Virtual Machine (try out something from http://virtualbox.org). To run tests, first ensure you have bundled the gems with 'gem bundle', and copy the test.yml.example file to point at a machine which can be safely used to test SSH commands.
+
+Note: add the moment, the tests assume at various points a Linux, rather than an OS X, way of doing things.
+
+Copyright (c) 2009 Sam Phillips. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rake'
+
+Dir['tasks/**/*.rake'].each do |task|
+  load task
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/fab

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require File.join(File.dirname(__FILE__), '..', 'vendor','gems','environment')
+require 'fabric'
+
+exit Fabric.run!(ARGV)

data/fabric.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fabric}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Phillips"]
+  s.date = %q{2010-01-23}
+  s.default_executable = %q{fab}
+  s.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.}
+  s.email = %q{sam.phillips@setfiremedia.com}
+  s.executables = ["fab"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/fab",
+     "fabric.gemspec",
+     "features/support/env.rb",
+     "lib/extensions/narrator.rb",
+     "lib/fabric-test.rb",
+     "lib/fabric.rb",
+     "lib/fabric/account.rb",
+     "lib/fabric/capture.rb",
+     "lib/fabric/grant.rb",
+     "lib/fabric/group.rb",
+     "lib/fabric/key.rb",
+     "lib/fabric/map.rb",
+     "lib/fabric/role.rb",
+     "lib/fabric/server.rb",
+     "lib/fabric/user.rb",
+     "lib/initialisers/data_mapper.rb",
+     "spec/classes/account_spec.rb",
+     "spec/classes/capture_spec.rb",
+     "spec/classes/map_spec.rb",
+     "spec/classes/role_spec.rb",
+     "spec/classes/server_spec.rb",
+     "spec/classes/user_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/features.rake",
+     "tasks/jeweler.rake",
+     "tasks/rdoc.rake",
+     "tasks/spec.rake",
+     "tasks/test.rake",
+     "test.yml.example",
+     "vendor/gems/ruby/1.8/cache/addressable-2.1.1.gem",
+     "vendor/gems/ruby/1.8/cache/columnize-0.3.1.gem",
+     "vendor/gems/ruby/1.8/cache/data_objects-0.10.0.gem",
+     "vendor/gems/ruby/1.8/cache/dm-core-0.10.2.gem",
+     "vendor/gems/ruby/1.8/cache/do_sqlite3-0.10.0.gem",
+     "vendor/gems/ruby/1.8/cache/extlib-0.9.14.gem",
+     "vendor/gems/ruby/1.8/cache/linecache-0.43.gem",
+     "vendor/gems/ruby/1.8/cache/net-ssh-2.0.15.gem",
+     "vendor/gems/ruby/1.8/cache/ruby-debug-base-0.10.3.gem"
+  ]
+  s.homepage = %q{http://github.com/setfire/fabric}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Fabric is a small ruby app to perform tasks on servers via SSH.}
+  s.test_files = [
+    "spec/classes/account_spec.rb",
+     "spec/classes/capture_spec.rb",
+     "spec/classes/map_spec.rb",
+     "spec/classes/role_spec.rb",
+     "spec/classes/server_spec.rb",
+     "spec/classes/user_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<cucumber>, [">= 0.3.104"])
+    else
+      s.add_dependency(%q<cucumber>, [">= 0.3.104"])
+    end
+  else
+    s.add_dependency(%q<cucumber>, [">= 0.3.104"])
+  end
+end
+

data/features/support/env.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+
+require File.join(File.dirname(__FILE__), '..', '..', 'vendor','gems','environment')
+
+require 'fabric'
+require 'fabric-test'

data/lib/extensions/narrator.rb

@@ -0,0 +1,19 @@
+module Narrator
+  def narrate(text)
+    return unless Fabric.options[:narrate]    
+    narration = ''
+    
+    if self.respond_to?(:narrate_as)
+      narration << "[#{self.narrate_as}]"
+    else
+      narration << "[#{self.class.to_s.downcase}]"
+    end
+    narration << " #{text}"
+    
+    puts narration
+  end
+end
+
+class Object
+  include Narrator
+end

data/lib/fabric-test.rb

@@ -0,0 +1,10 @@
+module Fabric::Test
+  def self.settings
+    @@settings ||= self.load_settings
+  end
+  
+  protected
+  def self.load_settings
+    YAML.load_file(File.join(File.dirname(__FILE__), '..', 'test.yml'))
+  end
+end

data/lib/fabric.rb

@@ -0,0 +1,57 @@
+require 'optparse'
+require 'initialisers/data_mapper'
+
+module Fabric
+  def self.narrate_as
+    'fabric'
+  end
+
+  @@options = {}  
+  def self.options(option = nil)
+    return @@options[option] if option
+    @@options
+  end
+    
+  def self.run!(arguments)
+    OptionParser.new do |options|
+      options.banner = "Usage: fab mapfile [options]"
+      
+      @@options[:narrate] = false
+      options.on('-n', '--narrate', 'Give full narrative output') do
+        @@options[:narrate] = true
+      end
+      
+      options.on('-h', '--help', 'Show this help screen') do 
+        puts options
+        exit
+      end
+    end.parse!
+    
+    map_file = arguments.first
+
+    if map_file.nil? or not File.exists?(map_file)
+      no_map_error = <<NO_MAP_FILE
+      
+  Usage: fab mapfile [options]
+      
+  Please specify a valid map file.
+  
+NO_MAP_FILE
+      
+      puts no_map_error
+      
+      exit 1
+    end
+
+    @@options[:map_root] = File.dirname(File.expand_path(map_file))
+    narrate "Setting map_root to #{Fabric.options(:map_root)}"
+
+    require map_file
+    
+    0
+  end
+end
+
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each do |file|
+  require file
+end

data/lib/fabric/account.rb

@@ -0,0 +1,36 @@
+class Account
+  include DataMapper::Resource
+
+  property :id,   Serial
+  
+  belongs_to :user
+  belongs_to :server
+  
+  def add_user
+    self.server.execute_command("sudo /usr/sbin/useradd -m #{self.user.name}")  
+  end
+
+  def add_ssh_directory
+    self.server.execute_command("sudo mkdir #{self.user.ssh_config_directory_path}")
+    self.server.execute_command("sudo chown #{self.user.name} #{user.ssh_config_directory_path}")
+    self.server.execute_command("sudo chmod 700 #{self.user.ssh_config_directory_path}")
+  end
+  
+  def write_ssh_key
+    self.server.execute_command("sudo touch #{self.user.authorized_keys_file}")
+    self.server.execute_command("echo '#{self.user.authorized_keys_file}' | sudo tee #{self.user.authorized_keys_file_path}")
+    self.set_ssh_key_permissions
+  end
+  
+  def add_to_groups
+    self.user.groups.each do |group|
+      self.server.execute_command("sudo /usr/sbin/usermod -G#{group.name} #{self.user.name}")
+    end
+  end
+  
+  protected
+  def set_ssh_key_permissions
+    self.server.execute_command("sudo chown #{self.user.name} #{self.user.authorized_keys_file_path}")
+    self.server.execute_command("sudo chmod 600 #{self.user.authorized_keys_file_path}")    
+  end
+end

data/lib/fabric/capture.rb

@@ -0,0 +1,21 @@
+class Capture
+  include DataMapper::Resource
+  
+  property :id,       Serial
+  property :name,     String
+  property :contents, Text
+  
+  belongs_to :server, :required => false
+  
+  after :create do
+    self.clear!
+  end
+  
+  def clear!
+    self.contents = ''
+  end
+  
+  def append(data)
+    self.contents << data
+  end
+end