capitate 0.1.9 → 0.2.1

data/lib/capitate/plugins/templates.rb

@@ -1,22 +1,16 @@
 module Capitate::Plugins::Templates
   
-  # Get the absolute base templates path.
-  def gem_templates_root
-    File.expand_path(File.dirname(__FILE__) + "/../../templates")
-  end
-  
-  # Get full template path from relative path.
+  # Load template. If extension is erb will be evaluated with binding.
   #
-  # Something like <tt>monit/monit.cnf => /usr/lib/..../capitate/lib/templates/monit/monit.cnf</tt>.
+  # You can add to the list of places we search for templates by setting:
   #
-  # ==== Options 
-  # +template_path+:: Relative path
+  #    set :templates_dirs, [ "path/to/templates1", "/path/to/templates2" ]
   #
-  def gem_template_path(template_path)
-    File.join(gem_templates_root, template_path)
-  end
-  
-  # Load template. If extension is erb will be evaluated with binding.
+  # It looks for the template from:
+  # * the <tt>:templates_dirs</tt> setting (if set)
+  # * the current directory
+  # * the <tt>:project_root</tt> setting (if set)
+  # * the gem templates path  
   # 
   # ==== Options
   # +path+:: If starts with '/', absolute path, otherwise relative path to templates dir
@@ -27,21 +21,16 @@ module Capitate::Plugins::Templates
   #   put template.load("memcached/memcached.monitrc.erb"), "/tmp/memcached.monitrc"
   #
   def load(path, override_binding = nil)
-    template_paths = [ path, gem_template_path(path) ]
     
-    template_paths = template_paths.select { |file| File.exist?(file) }
+    template_dirs_found = template_dirs.select { |dir| File.exist?("#{dir}/#{path}") }
     
-    if template_paths.empty?
-      raise <<-EOS 
-      
-      
-      Template not found: #{path}
-      
-      EOS
+    # Not found anywhere, throw error
+    if template_dirs_found.empty?
+      raise "\n\nTemplate not found: #{path}\n\n"
     end
     
     # Use first
-    template_path = template_paths.first
+    template_path = template_dirs_found.first + "/#{path}"
     
     template_data = IO.read(template_path)
     
@@ -51,21 +40,6 @@ module Capitate::Plugins::Templates
     end
     template_data
   end
-  
-  # Load template from project.
-  # If extension is erb will be evaluated with binding.
-  # 
-  # ==== Options
-  # +path+:: If starts with '/', absolute path, otherwise relative path to templates dir
-  # +override_binding+:: Binding to override, otherwise uses current (task) binding
-  #
-  # ==== Examples
-  #   template.project("config/templates/sphinx.conf.erb")
-  #   put template.project("config/templates/sphinx.conf.erb"), "#{shared_path}/config/sphinx.conf"
-  #
-  def project(path, override_binding = nil)
-    load(project_root + "/" + path, override_binding || binding)
-  end
     
   # Write template at (relative path) with binding to LOCAL destination path.
   #
@@ -77,7 +51,7 @@ module Capitate::Plugins::Templates
   # +verbose+:: Verbose output
   #
   # ==== Examples
-  #   template.write("config/templates/sphinx.conf.erb", binding, "config/sphinx.conf")
+  #   template.write("config/templates/sphinx.conf.erb", "config/sphinx.conf")
   #  
   def write(template_path, dest_path, override_binding = nil, overwrite = false, verbose = true)    
     # This is gnarly!
@@ -93,6 +67,37 @@ module Capitate::Plugins::Templates
     File.open(dest_path, "w") { |file| file.puts(load(template_path, override_binding)) }
   end
     
+    
+protected
+
+  # Load all possible places for templates
+  def template_dirs
+    @template_dir ||= begin
+      template_dirs = []      
+      template_dirs += fetch(:templates_dirs) if exists?(:templates_dirs)      
+      template_dirs << [ "." ]
+      template_dirs << project_root if exists?(:project_root)
+      template_dirs << gem_templates_root
+      template_dirs
+    end
+  end
+
+  # Get the absolute base templates path.
+  def gem_templates_root
+    File.expand_path(File.dirname(__FILE__) + "/../../templates")
+  end
+  
+  # Get full template path from relative path.
+  #
+  # Something like <tt>monit/monit.cnf => /usr/lib/..../capitate/lib/templates/monit/monit.cnf</tt>.
+  #
+  # ==== Options 
+  # +template_path+:: Relative path
+  #
+  def gem_template_path(template_path)
+    File.join(gem_templates_root, template_path)
+  end
+  
 end
 
 Capistrano.plugin :template, Capitate::Plugins::Templates

data/lib/capitate/plugins/yum.rb

@@ -10,12 +10,8 @@ module Capitate::Plugins::Yum
   #   yum.update
   #   yum.update([ "aspell" ])
   #
-  # Also can use package plugin with package.type = :yum, and then:
-  #   package.update
-  #   package.update([ "aspell" ])
-  #
   def update(packages = [])
-    sudo "yum -y update #{packages.join(" ")}"
+    run_via "yum -y update #{packages.join(" ")}"
   end
     
   # Remove via yum.
@@ -27,12 +23,8 @@ module Capitate::Plugins::Yum
   #   yum.remove
   #   yum.remove([ "aspell" ])
   #
-  # Also can use package plugin with package.type = :yum, and then:
-  #   package.remove
-  #   package.remove([ "aspell" ])
-  #  
   def remove(packages)
-    sudo "yum -y remove #{packages.join(" ")}"    
+    run_via "yum -y remove #{packages.join(" ")}"    
   end
   
   # Install via yum.
@@ -44,10 +36,6 @@ module Capitate::Plugins::Yum
   # ==== Examples
   #   yum.install
   #   yum.install([ "aspell" ])
-  #
-  # Also can use package plugin with package.type = :yum, and then:
-  #   package.install
-  #   package.install([ "aspell" ])
   #    
   def install(packages, update_existing = true)    
     
@@ -58,16 +46,21 @@ module Capitate::Plugins::Yum
       
       installed_packages = []
       
-      sudo "yum -d 0 list installed #{packages.join(" ")}" do |channel, stream, data|
-        installed_packages += data.split("\n")[1..-1].collect { |line| line.split(".").first }
+      run_via "yum -d 0 list installed #{packages.join(" ")}" do |channel, stream, data|
+        lines = data.split("\n")[1..-1]
+        if lines.blank?
+          logger.info "Invalid yum output: #{data}"
+        else
+          installed_packages += lines.collect { |line| line.split(".").first }
+        end
       end      
     
       packages -= installed_packages
     
-      sudo "yum -y update #{installed_packages.join(" ")}" unless installed_packages.blank?
+      run_via "yum -y update #{installed_packages.join(" ")}" unless installed_packages.blank?
     end
     
-    sudo "yum -y install #{packages.join(" ")}" unless packages.blank?
+    run_via "yum -y install #{packages.join(" ")}" unless packages.blank?
   end
   
   # Clean yum.
@@ -75,11 +68,8 @@ module Capitate::Plugins::Yum
   # ==== Examples
   #   yum.clean
   #
-  # Also can use package plugin with package.type = :yum, and then:
-  #   package.clean
-  #
   def clean
-    sudo "yum -y clean all"
+    run_via "yum -y clean all"
   end
   
 end

data/lib/capitate/task_node.rb

@@ -56,6 +56,12 @@ class Capitate::TaskNode
     nodes.sort_by(&:name)
   end
   
+  # Get tasks (sorted).
+  #
+  def sorted_tasks
+    tasks.sort_by(&:fully_qualified_name) # { |t| t.name.to_s }
+  end
+  
   # Iterate over ALL "child" nodes, depth first.
   # Yields |node, level|.
   #
@@ -87,7 +93,9 @@ class Capitate::TaskNode
     name == "top" ? nil : name
   end
   
-  # Write doc for node (recursively)
+  # Write textile documentation for node (recursively).
+  #
+  # Uses task desc attribute for task details.
   #
   # ==== Options
   # +dir+:: Dir to write to
@@ -126,22 +134,33 @@ class Capitate::TaskNode
       #
       # Namespace
       #
-      unless sorted_nodes.empty?
-        file.puts "h2. Namespaces\n\n"
+      unless nodes.empty?
+        file.puts "\n\nh2. Namespaces\n\n"
         each_node do |snode, level|
-          li_level = (0..level).collect { "*" }.join
-          file.puts %{#{li_level} "#{snode.full_name(":")}":#{snode.full_name}.html \n}                  
+          #li_level = (0..level).collect { "*" }.join
+          if snode.tasks.length > 0
+            file.puts %{* "#{snode.full_name(":")}":#{snode.full_name}.html (#{snode.tasks.length}) \n}                  
+          end
         end        
       end
       
       #
       # Tasks
+      # 
+      unless tasks.empty?
+        file.puts "\n\nh2. Tasks\n\n"
+        sorted_tasks.each do |task|
+          file.puts %{* "#{task.fully_qualified_name}":##{task.fully_qualified_name} \n}                  
+        end        
+      end
+      
+      #
+      # Task details
       #
       unless tasks.empty?
-        file.puts "\n\n"
-        file.puts "h2. Tasks\n\n"        
-        tasks.each do |task|
-          file.puts "h3. #{task.fully_qualified_name}\n\n"
+        file.puts "\n\nh2. Task documentation\n\n"        
+        sorted_tasks.each do |task|
+          file.puts "h3(##{task.fully_qualified_name}). #{task.fully_qualified_name}\n\n"
           file.puts "#{unindent(task.desc)}\n\n\n\n"
         end
       end

data/lib/capitate/version.rb

@@ -1,8 +1,8 @@
 module Capitate #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 9
+    MINOR = 2
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/capitate.rb

@@ -15,21 +15,20 @@ end
 
 require 'capitate/plugins/base'
 require 'capitate/plugins/gem'
-require 'capitate/plugins/package'
-require 'capitate/plugins/profiles'
 require 'capitate/plugins/script'
+require 'capitate/plugins/prompt'
 require 'capitate/plugins/templates'
-require 'capitate/plugins/wget'
-require 'capitate/plugins/yum'
-
 require 'capitate/plugins/upload'
+require 'capitate/plugins/yum'
 
 require "capitate/cap_ext/connections"
 require "capitate/cap_ext/extension_proxy"
 require "capitate/cap_ext/variables"
+require "capitate/cap_ext/run_via"
         
 class Capistrano::Configuration   
   include Capitate::CapExt::Variables
+  include Capitate::CapExt::RunVia
 end
 
 require 'capitate/task_node'

data/lib/deployment/deploy.rb

@@ -0,0 +1,42 @@
+#
+# Settings for project
+#
+
+set :application, "sick"
+set :user, "sick"
+set :groups, "admin"
+
+set :deploy_to, "/var/www/apps/sick"
+set :web_host, "192.168.1.111"
+set :db_host, "192.168.1.111"
+set :db_user, "sick"
+set :db_pass, prompt.password("DB Password: ")
+set :db_name, "sick"
+set :repository, "http://svn.ducktyper.com/scratch/testapp/trunk"
+set :mongrel_port, 12000
+set :mongrel_size, 3
+set :domain_name, "localhost"
+set :mysql_admin_password, prompt.password('Mysql admin password: ')
+
+set :deploy_via, :copy
+set :copy_strategy, :export
+
+role :web, "192.168.1.111"
+role :db, "192.168.1.111", :primary => true
+
+
+# Callbacks 
+before "deploy:setup", "centos:add_user"
+
+after "deploy:setup", "mysql:setup", "rails:setup", "mongrel_cluster:centos:setup",
+  "nginx:setup_mongrel", "sphinx:centos:setup"
+  
+after "sphinx:centos:setup", "sphinx:setup_monit"
+after "mongrel_cluster:centos:setup", "mongrel_cluster:setup_monit"
+
+after "nginx:setup_mongrels", "nginx:centos:restart"
+
+after "deploy:update_code", "rails:update_code", "sphinx:update_code"
+
+# Auto cleanup after deploy
+after "deploy", "deploy:cleanup"

data/lib/deployment/install-centos-rubyweb.rb

@@ -0,0 +1,131 @@
+#
+# This is an EXAMPLE deployment script based on some recipes in Capitate.
+#
+
+#
+# For installing apps on the thoughpolice centos 5.1 image
+#
+task :install do
+  
+  # Set templates dir to this here gem
+  set :templates_dirs, [ File.dirname(__FILE__) + "/../templates" ]
+  
+  set :user, "root"
+  set :run_method, :run
+  
+  # Can use cap HOSTS=192.168.1.111 install
+  # Otherwise prompt for the service
+  role :install, prompt.ask("Server: ") if find_servers_for_task(current_task).blank?
+  
+  # Setup for web  
+  # * Add admin group
+  # * Change inittab to runlevel 3
+  # * Create web apps directory
+  # * Add admin group to suders ALL=(ALL)   ALL
+  script.run_all <<-CMDS  
+    egrep "^admin" /etc/group || /usr/sbin/groupadd admin 
+    sed -i -e 's/^id:5:initdefault:/id:3:initdefault:/g' /etc/inittab
+    mkdir -p /var/www/apps
+    egrep "^%admin" /etc/sudoers || echo "%admin  ALL=(ALL)   ALL" > /etc/sudoers
+  CMDS
+    
+  # Package installs
+  yum.remove [ "openoffice.org-*", "ImageMagick" ]
+  yum.update
+  yum.install [ "gcc", "kernel-devel", "libevent-devel", "libxml2-devel", "openssl", "openssl-devel",
+     "aspell", "aspell-devel", "aspell-en", "aspell-es" ]
+  
+  #
+  # App installs
+  #
+  
+  ruby.centos.install
+  # Fix ruby install openssl
+  script.sh("ruby/fix_openssl.sh")
+  
+  nginx.centos.install
+  mysql.centos.install
+  sphinx.centos.install
+  monit.centos.install
+  imagemagick.centos.install
+  memcached.centos.install
+  
+  #
+  # Install monit hooks
+  #
+  nginx.install_monit
+  mysql.install_monit
+  
+  # Gem installs
+  gems.install([ "rake", "mysql -- --with-mysql-include=/usr/include/mysql --with-mysql-lib=/usr/lib/mysql --with-mysql-config", 
+    "raspell", "rmagick", "mongrel", "mongrel_cluster","json" ])
+  
+  # Cleanup
+  yum.clean
+end
+
+
+# For mysql:install
+set :mysql_pid_path, "/var/run/mysqld/mysqld.pid"
+set :db_port, 3306
+
+# For sphinx:install
+set :sphinx_prefix, "/usr/local/sphinx"
+
+
+#
+# Install options
+#
+
+# Ruby install
+set :ruby_build_options, {
+  :url => "http://capigen.s3.amazonaws.com/ruby-1.8.6-p110.tar.gz",
+  :build_dest => "/usr/src",
+  :configure_options => "--prefix=/usr",       
+  :clean => false
+}
+
+set :rubygems_build_options, { 
+  :url => "http://rubyforge.org/frs/download.php/29548/rubygems-1.0.1.tgz"
+}
+
+# Memcached install
+set :memcached_pid_path, "/var/run/memcached.pid"
+set :memcached_memory, 64
+set :memcached_port, 11211
+set :memcached_build_options, {
+  :url => "http://www.danga.com/memcached/dist/memcached-1.2.4.tar.gz",
+  :configure_options => "--prefix=/usr/local"
+}
+
+# Monit install
+set :monit_conf_dir, "/etc/monit"
+set :monit_port, 2812
+set :monit_build_options, { 
+  :url => "http://www.tildeslash.com/monit/dist/monit-4.10.1.tar.gz" 
+}
+
+# Nginx install
+set :nginx_bin_path, "/sbin/nginx"
+set :nginx_conf_path, "/etc/nginx/nginx.conf"
+set :nginx_pid_path, "/var/run/nginx.pid"
+set :nginx_prefix_path, "/var/nginx"
+set :nginx_build_options, {
+  :url => "http://sysoev.ru/nginx/nginx-0.5.35.tar.gz",
+  :configure_options => "--sbin-path=#{nginx_bin_path} --conf-path=#{nginx_conf_path} \
+--pid-path=#{nginx_pid_path} --error-log-path=/var/log/nginx_master_error.log --lock-path=/var/lock/nginx \
+--prefix=#{nginx_prefix_path} --with-md5=auto/lib/md5 --with-sha1=auto/lib/sha1 --with-http_ssl_module"
+}
+
+# Sphinx install 
+set :sphinx_build_options, {
+  :url => "http://www.sphinxsearch.com/downloads/sphinx-0.9.7.tar.gz",
+  :configure_options => "--with-mysql-includes=/usr/include/mysql --with-mysql-libs=/usr/lib/mysql \
+--prefix=#{sphinx_prefix}"
+}
+
+# Imagemagick install
+set :imagemagick_build_options, {
+  :url => "ftp://ftp.imagemagick.org/pub/ImageMagick/ImageMagick.tar.gz",
+  :unpack_dir => "ImageMagick-*"
+}

data/lib/recipes/centos/centos.rb

@@ -1,34 +1,43 @@
 # Custom tasks for centos OS profiles
 namespace :centos do
-    
-  desc "Setup centos for web"
-  task :setup_for_web do
-    put template.load("centos/sudoers"), "/tmp/sudoers"
-    script.sh("centos/setup_for_web.sh")
-  end  
-    
-  desc "Cleanup"
-  task :cleanup do
-    yum.clean
-    # TODO: Add cleanup tasks here
-  end
-  
+
   # Add user for an application
-  desc "Add user (adds to admin group)"
-  task :add_user_for_app do
+  desc <<-DESC
+  Add user and set user password for application. Adds user to specified groups. 
+  
+  *user*: User to add.\n
+  @set :user, "app_user"@
+  *groups*: Groups for user to be in. _Defaults to none_\n
+  @set :groups, "admin,foo"@\n
+  *home*: Home directory for user. _Defaults to <tt>:deploy_to</tt> setting_\n
+  @set :home, "/var/www/apps/app_name"@\n
+  *home_readable*: Whether home permissions are readable by all. Needed if using deploy dir as home. _Defaults to true_\n
+  @set :home_readable, true@\n
+  DESC
+  task :add_user do
     
     # Settings
-    user = fetch(:user)
-    fetch_or_default(:install_user, "root")
+    fetch(:user)
+    fetch_or_default(:groups, nil)
+    fetch_or_default(:home, deploy_to)
+    fetch_or_default(:home_readable, true)
+    
+    # Need to be root because we don't have any other users at this point
+    install_user = "root"
     
     with_user(install_user) do
+      
+      adduser_options = []
+      adduser_options << "-d #{home}" unless home.blank?
+      adduser_options << "-G #{groups}" unless groups.blank?
     
-      sudo "id sick || /usr/sbin/adduser -d #{deploy_to} -G admin #{user}"
-      sudo "chmod a+rx #{deploy_to}"
+      run "id sick || /usr/sbin/adduser #{adduser_options.join(" ")} #{user}"
+            
+      run "chmod a+rx #{home}" if home_readable
   
-      new_password = Capistrano::CLI.password_prompt("Password for user (#{user}): ")
+      new_password = prompt.password("Password for user (#{user}): ", true)
   
-      sudo "passwd #{user}" do |channel, stream, data|
+      run "passwd #{user}" do |channel, stream, data|
         logger.info data
     
         if data =~ /password:/i

data/lib/recipes/centos/imagemagick.rb

@@ -1,19 +1,20 @@
 namespace :imagemagick do 
   namespace :centos do
   
-    desc "Install imagemagick"
+    desc <<-DESC
+    Install imagemagick.\n    
+    *imagemagick_build_options*: Imagemagick build options.
+    DESC
     task :install do
       
+      # Settings 
+      fetch(:imagemagick_build_options)
+      
       # Install dependencies
       yum.install([ "libjpeg-devel", "libpng-devel", "glib2-devel", "fontconfig-devel", "zlib-devel", 
         "libwmf-devel", "freetype-devel", "libtiff-devel" ])
-    
-      imagemagick_options = {
-        :url => "ftp://ftp.imagemagick.org/pub/ImageMagick/ImageMagick.tar.gz",
-        :unpack_dir => "ImageMagick-*"
-      }
-    
-      script.make_install("imagemagick", imagemagick_options)
+        
+      script.make_install("imagemagick", imagemagick_build_options)
     end
   
   end

data/lib/recipes/centos/memcached.rb

@@ -5,18 +5,13 @@ namespace :memcached do
     desc <<-DESC
     Install memcached.
     
-    memcached_memory: Memcached memory (in MB).
-    
-      set :memcached_memory, 64
-
-    memcached_pid_path: Path to memcached pid file. Defaults to /var/run/memcached.pid
-    
-      set :memcached_pid_path, "/var/run/memcached.pid"
-
-    memcached_port: Memcached port. Defaults to 11211.
-    
-      set :memcached_port, 11211
-      
+    *memcached_build_options*: Memcached build options.\n
+    *memcached_memory*: Memcached memory (in MB).\n    
+    @set :memcached_memory, 64@\n
+    *memcached_pid_path*: Path to memcached pid file. Defaults to /var/run/memcached.pid\n    
+    @set :memcached_pid_path, "/var/run/memcached.pid"@\n
+    *memcached_port*: Memcached port. Defaults to 11211.\n    
+    @set :memcached_port, 11211@\n      
     DESC
     task :install do
 
@@ -24,20 +19,15 @@ namespace :memcached do
       fetch_or_default(:memcached_pid_path, "/var/run/memcached.pid")
       fetch_or_default(:memcached_port, 11211)
       fetch(:memcached_memory)      
-
-      # Build options
-      memcached_options = {
-        :url => "http://www.danga.com/memcached/dist/memcached-1.2.4.tar.gz",
-        :configure_options => "--prefix=/usr/local"
-      }
+      fetch(:memcached_build_options)
 
       # Build
-      script.make_install("memcached", memcached_options)
+      script.make_install("memcached", memcached_build_options)
 
       # Install initscript, service
       put template.load("memcached/memcached.initd.centos.erb"), "/tmp/memcached.initd"
-      sudo "install -o root /tmp/memcached.initd /etc/init.d/memcached && rm -f /tmp/memcached.initd"
-      sudo "/sbin/chkconfig --level 345 memcached on"
+      run_via "install -o root /tmp/memcached.initd /etc/init.d/memcached && rm -f /tmp/memcached.initd"
+      run_via "/sbin/chkconfig --level 345 memcached on"
 
     end
     

data/lib/recipes/centos/mongrel_cluster.rb

@@ -5,15 +5,11 @@ namespace :mongrel_cluster do
     desc <<-DESC
     Create mongrel cluster.
     
-    mongrel_size: Number of mongrels.
-    
-      set :mongrel_size, 3
-
-    mongrel_port: Starting port for mongrels. If there are 3 mongrels with port 9000, then instances will be at 
-      9000, 9001, and 9002
-      
-      set :mongrel_port, 9000      
-      
+    *mongrel_size*: Number of mongrels.\n    
+    @set :mongrel_size, 3@\n
+    *mongrel_port*: Starting port for mongrels. If there are 3 mongrels with port 9000, 
+    then instances will be at 9000, 9001, and 9002\n      
+    @set :mongrel_port, 9000@\n      
     DESC
     task :setup do 
 
@@ -29,8 +25,8 @@ namespace :mongrel_cluster do
 
       pid_path = "#{shared_path}/pids"
 
-      put template.load("mongrel/mongrel_cluster.initd.erb", binding), "/tmp/mongrel_cluster_#{application}.initd"    
-      put template.load("mongrel/mongrel_cluster.yml.erb", binding), "#{mongrel_config_path}/mongrel_cluster.yml"
+      put template.load("mongrel/mongrel_cluster.initd.erb"), "/tmp/mongrel_cluster_#{application}.initd"    
+      put template.load("mongrel/mongrel_cluster.yml.erb"), "#{mongrel_config_path}/mongrel_cluster.yml"
 
       # Setup the mongrel_cluster init script
       sudo "install -o root /tmp/mongrel_cluster_#{application}.initd /etc/init.d/mongrel_cluster_#{application}"