winton-ubistrano 1.2.2

data/lib/ubistrano/helpers.rb

@@ -0,0 +1,271 @@
+require 'erb'
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  # Install
+
+  def gem_install(name, options='')
+    sudo_puts "gem install #{name} #{options} --no-rdoc --no-ri -q"
+  end
+  
+  def install_source(source)
+    path, source = unpack_source source
+    yield path
+    sudo "rm -Rf #{source}"
+  end
+  
+  def make_install(path)
+    ";cd #{path} && ./configure && make && sudo make install"
+  end
+
+  def unpack_source(source)
+    url  = sources[source]
+    name = File.basename url
+    src  = "/home/#{user}/sources"
+    base = nil
+    [ 'tar.gz', 'tgz' ].each do |ext|
+      base = name[0..((ext.length + 2) * -1)] if name.include?(ext)
+    end
+    run_each [
+      "mkdir -p #{src}",
+      "cd #{src} && wget --quiet #{url}",
+      "tar -xzvf #{src}/#{name} -C #{src}"
+    ]
+    [ "#{src}/#{base}", src ]
+  end
+
+
+  # Files
+  
+  def add_line(file, *lines)
+    lines.each do |line|
+      sudo_each "echo \"#{line}\" | sudo tee -a #{file}"
+    end
+  end
+  
+  def change_line(file, from, to)
+    sudo_each "sed -i 's/#{from}/#{to}/' #{file}"
+  end
+  
+  def remove_line(file, *lines)
+    lines.each do |line|
+      change_line file, line, ''
+    end
+  end
+
+  def get_ssh_key(key)
+    key.gsub!('.pub', '')
+    key = File.expand_path("~/.ssh/#{key}")
+    key = Dir[key + '.pub', key].first
+    if key
+      keys = File.open(key).collect { |line| line.strip.empty? ? nil : line.strip }.compact
+      keys.join("\n")
+    else
+      nil
+    end
+  end
+
+  def upload_from_erb(destination, bind=nil, options={})
+    # options[ :chown  => owner of file (default: deploy user),
+    #          :chmod  => 0644 etc
+    #          :folder => 'postfix' etc,
+    #          :name   => name of template if differs from destination ]
+    if destination.respond_to?(:uniq)
+      destination.each { |d| upload_from_erb d, bind, options }
+    else
+      template = File.basename destination
+      template = template[1..-1] if template[0..0] == '.'
+      folder   = options[:folder] ? options[:folder] + '/' : ''
+      template = File.expand_path("../../templates/#{folder}#{options[:name]||template}.erb", File.dirname(__FILE__))
+      template = File.read template
+      sudo "touch #{destination}"
+      sudo "chown #{user} #{destination}"
+      put ERB.new(template).result(bind || binding), destination
+      sudo("chown #{options[:chown]} #{destination}") if options[:chown]
+      sudo("chmod #{options[:chmod]} #{destination}") if options[:chmod]
+    end
+  end
+
+
+  # MySQL
+
+  def mysql_run(sql)
+    if sql.respond_to?(:uniq)
+      sql.each { |s| mysql_run s }
+    else
+      run "echo \"#{sql}\" | #{mysql_call}"
+    end
+  end
+
+  def mysql_call
+    @mysql_root_password = @mysql_root_password || ask("Password for mysql root:")
+    "mysql -u root --password=#{@mysql_root_password}"
+  end
+
+
+  # Questions
+
+  def ask(question, default='')
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    answer = Capistrano::CLI.ui.ask(space(question)).strip
+    answer.empty? ? default : answer
+  end
+
+  def yes(question)
+    question = "\n" + question.join("\n") if question.respond_to?(:uniq)
+    question += ' (y/n)'
+    ask(question).downcase.include? 'y'
+  end
+  
+  def space(str)
+    "\n#{'=' * 80}\n#{str}"
+  end
+
+
+  # Runners
+
+  def run_each(*args, &block)
+    cmd  = args[0]
+    sudo = args[1]
+    if cmd.respond_to?(:uniq)
+      cmd.each  { |c| run_each c, sudo, &block }
+    elsif sudo
+      puts space("sudo #{cmd}")
+      sudo(cmd) { |ch, st, data| block.call(data) if block }
+    else
+      puts space(cmd)
+      run(cmd)  { |ch, st, data| block.call(data) if block }
+    end
+  end
+
+  def sudo_each(cmds, &block)
+    run_each cmds, true, &block
+  end
+
+  def run_puts(cmds, &block)
+    run_each(cmds) { |data| puts data }
+  end
+
+  def sudo_puts(cmds, &block)
+    sudo_each(cmds) { |data| puts data }
+  end
+
+
+  # Messages
+
+  def msg(type)
+    case type
+    when :about_templates
+"Let's set up an Ubuntu server! (Tested with 8.04 LTS Hardy)
+
+With each task, Ubistrano will describe what it is doing, and wait for a yes/no."
+    when :add_user
+"Please ssh into your server (use -i only for EC2):
+  ssh root@#{host} -i ~/.ssh/id_rsa-#{application}
+
+Add your deploy user:
+  adduser #{user}
+
+Continue?"
+    when :aptitude_default
+"Do you want me to run aptitude update, upgrade, and install build-essential?
+If not, instructions for doing it manually will be displayed."
+    when :aptitude_instructions
+"Please run these manually:
+  sudo aptitude update
+  sudo aptitude upgrade
+  sudo aptitude build-essential
+
+Continue?"
+    when :create_keys
+"May I generate an rsa ssh key pair in your ~/.ssh folder?"
+    when :create_server_keys
+"May I generate an rsa ssh key pair on the server?
+The public key will be displayed for adding to your GitHub account."
+    when :ec2_finished
+"All finished! Run the following commands:
+  sudo chmod 600 ~/.ssh/id_rsa-#{application}
+  cap ubuntu"
+    when :god
+"May I install God?" 
+    when :god_apache
+"Would you like God to monitor apache?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/apache.god.erb"
+    when :god_mysql
+"Would you like God to monitor mysql?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/mysql.god.erb"
+    when :god_sshd
+"Would you like God to monitor sshd?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/sshd.god.erb"
+    when :iptables
+"May I update your server's iptables, limiting access to SSH, HTTP, HTTPS, and ping only?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/ubuntu/iptables.rules.erb"
+    when :logrotate
+"May I add a logrotate entry for this application?
+See #{File.expand_path '../../', File.dirname(__FILE__)}/templates/log/rotate.conf.erb"
+    when :mysqltuner
+"Would you like to install MySQLTuner and receive instructions for running it?"
+    when :mysqltuner_instructions
+"Please ssh to your server and run `sudo mysqltuner`.
+Continue?"
+    when :passenger
+"Please run `sudo passenger-install-apache2-module` manually.
+The apache config file is found at /etc/apache2/apache2.conf.
+Reload apache?"
+    when :run_ubuntu_install
+"Client and server configuration complete.
+
+Please run the second half of the install:
+  cap ubuntu:install
+"
+    when :secure_mysql
+"It is highly recommended you run mysql_secure_installation manually.
+See http://dev.mysql.com/doc/refman/5.1/en/mysql-secure-installation.html
+Continue?"
+    when :sinatra_install
+"Would you like to run install.rb (from your app) if it exists?"
+    when :sshd_config
+"May I update your server's sshd_config with the following settings?
+  Port #{port}
+  PermitRootLogin no
+  X11Forwarding no
+  UsePAM no
+  UseDNS no
+"
+when :ssh_config
+"May I update your server's ssh_config with the following settings?
+  StrictHostKeyChecking no
+"
+    when :ubuntu_restart
+"Its probably a good idea to restart the server now.
+OK?"
+    when :ubuntu_restart_2
+"Please wait a little while for your server to restart.
+
+Continue?"
+    when :ubuntu_finished
+"That's it! Glad you made it.
+
+Use `cap deploy:first` to set up your PHP, Rails, or Sinatra app.
+Use `cap deploy` for all subsequent deploys.
+
+"
+    when :upload_keys
+"Would you like to upload a ssh key to the deploy user's authorized_keys?"
+    when :upload_keys_2
+"Please enter a key in ~/.ssh to copy to the the deploy user's authorized_keys."
+    when :visudo
+"Please ssh into your server (use -i only for EC2):
+  ssh root@#{host} -i ~/.ssh/id_rsa-#{application}
+
+Edit your sudoers file:
+  visudo
+
+Add the following line:
+  deploy ALL=NOPASSWD: ALL
+
+Continue?"
+    end
+  end
+  
+end

data/lib/ubistrano/log.rb

@@ -0,0 +1,20 @@
+Capistrano::Configuration.instance(:must_exist).load do
+ 
+  namespace :log do
+    desc "Add logrotate entry for this application"
+    task :rotate, :roles => :app do
+      if yes(msg(:iptables))
+        upload_from_erb '/etc/rotate.conf', binding, :folder => 'log'
+        sudo_each [
+          'cp -f /etc/logrotate.conf /etc/logrotate2.conf',
+          'chmod 777 /etc/logrotate2.conf',
+          'cat /etc/rotate.conf >> /etc/logrotate2.conf',
+          'cp -f /etc/logrotate2.conf /etc/logrotate.conf',
+          'rm -f /etc/logrotate2.conf',
+          'rm -f /etc/rotate.conf'
+        ]
+      end
+    end
+  end
+  
+end

data/lib/ubistrano/mysql.rb

@@ -0,0 +1,94 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :mysql do 
+    namespace :create do
+      desc "Create database and user"
+      task :default, :roles => :db do
+        mysql.create.db
+        mysql.create.user
+      end
+      
+      desc "Create database"
+      task :db, :roles => :db do
+        mysql_run "CREATE DATABASE #{db_table}"
+      end
+    
+      desc "Create database user"
+      task :user, :roles => :db do
+        mysql_run [
+          "CREATE USER '#{db_user}'@'localhost' IDENTIFIED BY '#{db_pass}'",
+          "GRANT ALL PRIVILEGES ON *.* TO '#{db_user}'@'localhost'"
+        ]
+      end
+    end
+    
+    namespace :update do
+      desc 'Update mysql root password'
+      task :root_password, :roles => :db do
+        old_pass = ask "Current root password? (default: none)"
+        new_pass = ask "New root password? (default: none)"
+        sudo "mysqladmin -u root #{old_pass.empty? ? '' : "--password=#{old_pass} "}password #{new_pass}"
+      end
+    end
+  
+    namespace :destroy do
+      desc "Destroy database and user"
+      task :default, :roles => :db do
+        mysql.destroy.db
+        mysql.destroy.user
+      end
+      
+      desc "Destroy database"
+      task :db, :roles => :db do
+        mysql_run "DROP DATABASE #{db_table}"
+      end
+      
+      desc "Destroy database user"
+      task :user, :roles => :db do
+        mysql_run [
+          "REVOKE ALL PRIVILEGES, GRANT OPTION FROM '#{db_user}'@'localhost'",
+          "DROP USER '#{db_user}'@'localhost'"
+        ]
+      end
+    end
+    
+    namespace :backup do
+      desc "Upload local backup to remote"
+      task :local_to_server, :roles => :db do
+        from = File.expand_path("~/db_backups/#{stage}/#{application}/#{backup_name}.bz2")
+        if File.exists?(from)
+          run_each "mkdir -p #{shared_path}/db_backups"
+          upload from, "#{shared_path}/db_backups/#{backup_name}.bz2"
+        else
+          puts "Does not exist: #{from}"
+        end
+      end
+      
+      desc "Restore remote database from backup"
+      task :restore, :roles => :db do
+        run_each "bunzip2 < #{shared_path}/db_backups/#{backup_name}.bz2 | mysql -u #{db_user} --password=#{db_pass} #{db_table}"
+      end
+      
+      desc "Backup database to local"
+      task :to_local, :roles => :db do
+        to_server
+        system "mkdir -p ~/db_backups/#{stage}/#{application}"
+        get "#{shared_path}/db_backups/#{backup_name}.bz2", File.expand_path("~/db_backups/#{stage}/#{application}/#{backup_name}.bz2")
+      end
+      
+      desc "Backup database to remote"
+      task :to_server, :roles => :db do
+        run_each [
+          "mkdir -p #{shared_path}/db_backups",
+          "mysqldump --add-drop-table -u #{db_user} -p#{db_pass} #{db_table}_production | bzip2 -c > #{shared_path}/db_backups/#{backup_name}.bz2"
+        ]
+      end
+      
+      def backup_name
+        now = Time.now
+        [ now.year, now.month, now.day ].join('-') + '.sql'
+      end
+    end
+  end
+
+end

data/lib/ubistrano/rails.rb

@@ -0,0 +1,76 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :rails do
+    namespace :config do
+      desc "Creates database.yml in the shared config"
+      task :default, :roles => :app do
+        run "mkdir -p #{shared_path}/config"
+        Dir[File.expand_path('../../templates/rails/*', File.dirname(__FILE__))].each do |f|
+          upload_from_erb "#{shared_path}/config/#{File.basename(f, '.erb')}", binding, :folder => 'rails'
+        end
+      end
+      
+      desc "Set up app with app_helpers" 
+      task :app_helpers do
+        run "cd #{release_path} && script/plugin install git://github.com/winton/app_helpers.git"
+        run "cd #{release_path} && rake RAILS_ENV=production quiet=true app_helpers"
+      end
+      
+      desc "Configure attachment_fu"
+      task :attachment_fu, :roles => :app do
+        run_each [
+          "mkdir -p #{shared_path}/media",
+          "ln -sf #{shared_path}/media #{release_path}/public/media"
+        ]
+        sudo_each [
+          "mkdir -p #{release_path}/tmp/attachment_fu",
+          "chown -R #{user} #{release_path}/tmp/attachment_fu"
+        ]
+      end
+      
+      desc "Configure asset_packager" 
+      task :asset_packager do
+        run "source ~/.bash_profile && cd #{release_path} && rake RAILS_ENV=production asset:packager:build_all"
+      end
+      
+      desc "Configure rails_widget"
+      task :rails_widget, :roles => :app do
+        run "cd #{release_path} && rake RAILS_ENV=production widget:production"
+      end
+      
+      desc "Copies yml files in the shared config folder into our app config"
+      task :to_app, :roles => :app do
+        run "cp -Rf #{shared_path}/config/* #{release_path}/config"
+      end
+      
+      namespace :thinking_sphinx do
+        desc "Configures thinking_sphinx"
+        task :default, :roles => :app do
+          sudo ";cd #{release_path} && rake RAILS_ENV=production ts:config"
+        end
+        
+        desc "Stop thinking_sphinx"
+        task :stop, :roles => :app do
+          sudo ";cd #{release_path} && rake RAILS_ENV=production ts:stop"
+        end
+        
+        desc "Start thinking_sphinx"
+        task :start, :roles => :app do
+          sudo ";cd #{release_path} && rake RAILS_ENV=production ts:start"
+        end
+        
+        desc "Restart thinking_sphinx"
+        task :restart, :roles => :app do
+          rails.config.thinking_sphinx.stop
+          rails.config.thinking_sphinx.start
+        end
+      end
+    end
+    
+    desc "Intialize Git submodules"
+    task :setup_git, :roles => :app do
+      run "cd #{release_path}; git submodule init; git submodule update"
+    end
+  end
+
+end

data/lib/ubistrano/sinatra.rb

@@ -0,0 +1,25 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :sinatra do
+    desc "Runs install.rb if exists"
+    task :install do
+      if yes(msg(:sinatra_install))
+        run_puts "if [ -e #{current_path}/install.rb ]; then sudo ruby #{current_path}/install.rb; fi"
+      end
+    end
+    
+    namespace :config do
+      desc "Creates config.ru in shared config"
+      task :default do
+        run "mkdir -p #{shared_path}/config"
+        upload_from_erb "#{shared_path}/config/config.ru", binding, :folder => 'sinatra'
+      end
+      
+      desc "Copies files in the shared config folder into our app"
+      task :to_app, :roles => :app do
+        run "cp -Rf #{shared_path}/config/* #{release_path}"
+      end
+    end
+  end
+  
+end

data/lib/ubistrano/ssh.rb

@@ -0,0 +1,56 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  
+  namespace :ssh do
+    desc 'Generate ssh keys and upload to server'
+    task :default do
+      ssh.keys.create.local
+      ssh.keys.upload
+      ssh.keys.create.remote
+    end
+    
+    namespace :keys do
+      namespace :create do
+        desc "Creates an rsa ssh key pair (local)"
+        task :local do
+          system('ssh-keygen -t rsa') if yes(msg(:create_keys))
+        end
+        
+        desc "Creates an rsa ssh key pair (remote)"
+        task :remote do
+          if yes(msg(:create_server_keys))
+            pass = ask "Enter a password for this key:"
+            sudo_each [
+              "ssh-keygen -t rsa -N '#{pass}' -q -f /home/#{user}/.ssh/id_rsa",
+              "chmod 0700 /home/#{user}/.ssh",
+              "chown -R #{user} /home/#{user}/.ssh"
+            ]
+            sudo_puts "tail -1 /home/#{user}/.ssh/id_rsa.pub"
+          end
+        end
+      end
+
+      desc "Uploads local ssh public keys into remote authorized_keys"
+      task :upload do
+        if yes(msg(:upload_keys))
+          key = ask msg(:upload_keys_2)
+          key = get_ssh_key key
+          if key.nil?
+            ssh.setup if yes("No keys found. Generate ssh keys now?")
+          else
+            sudo_each [
+              "mkdir -p /home/#{user}/.ssh",
+              "touch /home/#{user}/.ssh/authorized_keys"
+            ]
+            add_line "/home/#{user}/.ssh/authorized_keys", key
+            sudo_each [
+              "chmod 0700 /home/#{user}/.ssh",
+              "chmod 0600 /home/#{user}/.ssh/authorized_keys",
+              "chown -R #{user} /home/#{user}/.ssh"
+            ]
+          end
+        end
+      end
+    end
+  end
+
+end

data/lib/ubistrano/stage.rb

@@ -0,0 +1,29 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  desc 'Set the target stage to staging'
+  task :staging do
+    set :stage, :staging
+  end
+
+  desc 'Set the target stage to test'
+  task :testing do
+    set :stage, :test
+  end
+  
+  # None of this works in a namespace
+  desc 'Set up stage-dependent properties'
+  task :setup_stage do
+    set :base_dir,  "#{ubistrano[:base_dir]}/#{stage}"
+    set :deploy_to, "#{base_dir}/#{application}"
+    set :db_table,  "#{application}#{stage == :staging ? "_#{stage}" : ''}"    
+    
+    ubistrano[stage].each do |key, value|
+      set key, value
+    end
+
+    role :app, host, :primary => true
+    role :web, host, :primary => true
+    role :db,  host, :primary => true
+  end
+  
+end