drush-deploy 1.0.0.alpha1

data/lib/drush_deploy/database.rb

@@ -0,0 +1,260 @@
+require 'capistrano'
+require 'drush_deploy/error'
+require 'drush_deploy/configuration'
+require 'yaml'
+require 'php_serialize'
+
+module DrushDeploy
+  class Database
+    class Error < DrushDeploy::Error; end
+
+
+    STANDARD_KEYS = %w(driver database username password host port prefix collation).map &:to_sym
+    MANAGE_KEYS   = %w(driver database username password host port prefix 
+                       admin_username admin_password).map &:to_sym
+  
+    def initialize(config)
+      @config = config
+      @seen_paths = {}
+    end
+
+    def method_missing(sym, *args, &block)
+      if @config.respond_to?(sym)
+        @config.send(sym, *args, &block)
+      else
+        super
+      end
+    end
+
+    def configure
+      databases_path.find do |val|
+        set :databases, load_path( val, databases )
+        MANAGE_KEYS.all? {|k| databases.key? k}
+      end
+    end
+
+    def load_path(path,databases = {})
+      unless @seen_paths[path]
+        logger.info "Trying to load database setting from #{path.inspect}"
+        if path !~ /^[\/~]/
+          path = latest_release+"/"+path
+        end
+        if path =~ /.php$/
+          @seen_paths[path] = load_php_path path
+        elsif path =~ /.yml$/
+          @seen_paths[path] = load_yml_path path
+        else
+          throw Error.new "Unknown file type: #{path}"
+        end
+      end
+      DrushDeploy::Database.deep_merge(@seen_paths[path],databases)
+    end
+
+    def load_php_path(path)
+      prefix = ''
+      if path.sub!(/^~/,'')
+        prefix = "getenv('HOME')." 
+      end
+
+      script = <<-END.gsub(/^ */,'')
+        <?php
+        $filename = #{prefix}'#{path}';
+        if( file_exists($filename) ) {
+          require_once($filename);
+          if( isset($databases) ) {
+            print serialize($databases);
+          }
+        } 
+      END
+      put script, '/tmp/load_db_credentials.php', :once => true
+      resp = capture "#{drush_bin} php-script /tmp/load_db_credentials.php"
+      
+      settings = {}
+      unless resp.empty?
+        resp = DrushDeploy::Configuration.unserialize_php(resp)
+        if resp != []
+          settings = resp
+        end
+      end
+      settings
+    end
+
+    def load_yml_path(path)
+      prefix = ''
+      if path.sub!(/^~/,'')
+        prefix = '"$HOME"'
+      end
+
+      yaml =  capture("[ ! -e #{prefix}'#{path}' ] || cat #{prefix}'#{path}'")
+      if yaml.empty?
+        {}
+      else
+        credentials = YAML.load yaml
+        DrushDeploy::Configuration.normalize_value(credentials)
+      end
+    end
+
+    def update_settings(settings,template = 'sites/default/default.settings.php')
+      if template !~ /^[\/~]/
+        template = latest_release+"/"+template
+      end
+      prefix = ''
+      if template.sub!(/^~/,'')
+        prefix = "getenv('HOME')." 
+      end
+      script = <<-END.gsub(/^ */,'')
+        <?php
+        define('DRUPAL_ROOT', '#{latest_release}');
+        define('MAINTENANCE_MODE', 'install');
+
+        $template = #{prefix}'#{template}';
+        $default = DRUPAL_ROOT.'/sites/default/default.settings.php';
+        $backup = '/tmp/default_settings_backup.php';
+
+        $databases = unserialize('#{PHP.serialize(settings)}');
+        $settings["databases"] = array( 'comment' => 'Generated by drush-deploy',
+                                        'value' => $databases );
+
+        require_once(DRUPAL_ROOT.'/includes/bootstrap.inc');
+        require_once(DRUPAL_ROOT.'/includes/install.inc');
+
+        $backed_up = false;
+        if ($template != $default && file_exists($default)) {
+          rename($default,$backup);
+          $backed_up = true;
+        }
+        rename($template,$default);
+        drupal_rewrite_settings($settings);
+        if ($backed_up) {
+          rename($backup,$default);
+        }
+      END
+      put script, '/tmp/update_settings.php'
+      run "cd '#{latest_release}' && #{drush_bin} php-script /tmp/update_settings.php"
+    end
+
+    def updatedb
+      run "cd '#{latest_release}' && #{drush_bin} updatedb", :once => true
+    end
+
+    def config(*args)
+      options = (args.size>0 && args.last.is_a?(Hash)) ? args.pop : {}
+      site_name = args[0] || :default
+      db_name = args[1] || :default
+      conf = databases[site_name][db_name].dup
+      if options[:admin] && conf[:admin_username]
+        conf[:username] = conf[:admin_username]
+        conf[:password] = conf[:admin_password]
+      end
+      conf.merge options
+    end
+
+    def remote_sql(sql,options={})
+      url = options[:config] ? DrushDeploy::Database.url(options[:config]) : nil
+      tmp = capture('mktemp').strip
+      put(sql,tmp)
+      cmd = %Q{cd '#{current_path}' && #{drush_bin} sql-cli #{url ? "--db-url='#{url}'" : ''} < '#{tmp}'}
+      if options[:capture]
+        capture(cmd)
+      else
+        run cmd, :once => true
+      end
+    end
+
+    def db_versions
+      conf = config(:admin => true)
+      logger.info "Getting list of databases versions"
+      sql = %q{SELECT SCHEMA_NAME FROM information_schema.SCHEMATA
+               WHERE SCHEMA_NAME REGEXP '%{database}_[0-9]+';} % conf
+      remote_sql(sql, :config => conf, :capture => true).split(/\n/)[1..-1].sort.reverse
+    end
+
+    def db_exists?(db = nil)
+      conf = config(:admin => true)
+      conf[:database] = db if db
+      logger.info "Checking existence of #{conf[:database]}"
+      sql = %q{SELECT COUNT(*) FROM information_schema.SCHEMATA WHERE SCHEMA_NAME = '%{database}';} % conf
+      conf[:database] = 'information_schema'
+      remote_sql(sql, :config => conf, :capture => true).split(/\n/)[1].to_i != 0
+    end
+
+    def db_tables(db = nil)
+      conf = config(:admin => true)
+      conf[:database] = db if db
+      logger.info "Fetching table list of #{conf[:database]}"
+      db_tables_query = %q{SELECT table_name FROM information_schema.tables
+                           WHERE table_schema = '%{database}'
+                             AND table_type = 'BASE TABLE'};
+      sql = db_tables_query % conf
+      conf[:database] = 'information_schema'
+      remote_sql(sql, :config => conf, :capture => true).split(/\n/)[1..-1] || []
+    end
+
+    def copy_database(from,to)
+      logger.info "Copying database #{from} to #{to}"
+      tables = db_tables
+      conf = config(:database => from, :admin => true)
+
+      remote_sql("CREATE DATABASE #{to};", :config => conf)
+      sql = ''
+      tables.each do |table|
+        sql += <<-END 
+          CREATE TABLE #{to}.#{table} LIKE #{from}.#{table};
+          INSERT INTO #{to}.#{table} SELECT * FROM #{from}.#{table};
+        END
+      end
+      remote_sql(sql, :config => conf)
+    end
+
+    def rename_database(from,to)
+      logger.info "Renaming database #{from} to #{to}"
+      conf = config(:database => from, :admin => true)
+      sql = ''
+      if conf[:driver] == :mysql
+        sql += "CREATE DATABASE `#{to}`;"
+        db_tables(from).each do |table|
+          sql += "RENAME TABLE `#{from}`.`#{table}` TO `#{to}`.`#{table}`;"
+        end
+        sql += "DROP DATABASE `#{from}`;"
+      else
+        sql += "ALTER TABLE #{from} RENAME TO #{to};"
+      end
+      remote_sql(sql, :config => conf)
+    end
+
+    def drop_database(db)
+      logger.info "Dropping database #{db}"
+      conf = config(:database => db, :admin => true)
+      remote_sql("DROP DATABASE #{db};", :config => conf)
+    end
+
+    # Should split these out
+    def self.deep_update(h1,h2)
+      h1.inject({}) do |h,(k,v)|
+        if Hash === v && Hash === h2[k]
+          h[k] = deep_update(v,h2[k])
+        else
+          h[k] = h2.key?(k) ? h2[k] : v
+        end
+        h
+      end
+    end
+
+    def self.deep_merge(h1,h2)
+      merger = proc { |key,v1,v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+      h1.merge(h2, &merger)
+    end
+
+    def self.each_db(databases)
+      databases.each do |site_name,site|
+        site.each do |db_name,db|
+          yield db,site_name,db_name
+        end
+      end
+    end
+
+    def self.url(db)
+      "#{db[:driver]}://#{db[:username]}:#{db[:password]}@#{db[:host]}:#{db[:port]}/#{db[:database]}"
+    end
+  end
+end

data/lib/drush_deploy/error.rb

@@ -0,0 +1,3 @@
+module DrushDeploy
+  class Error < Exception; end
+end

data/lib/drush_deploy/paths.rb

@@ -0,0 +1,19 @@
+module DrushDeploy
+  module Paths
+    def self.root(path = '')
+      File.expand_path('../../../' + path,__FILE__)
+    end
+
+    def self.bin(path = '')
+      root('bin/' + path)
+    end
+
+    def self.lib(path = '')
+      root('lib/' + path)
+    end
+
+    def self.recipe(path)
+      root('lib/drush_deploy/recipes/' + path + '.rb')
+    end
+  end
+end

data/lib/drush_deploy/recipes/all.rb

@@ -0,0 +1,8 @@
+require 'drush_deploy/paths'
+
+load DrushDeploy::Paths.recipe("setup")
+
+load DrushDeploy::Paths.recipe("general")
+load DrushDeploy::Paths.recipe("deploy")
+load DrushDeploy::Paths.recipe("drupal")
+load DrushDeploy::Paths.recipe("db")

data/lib/drush_deploy/recipes/bootstrap.rb

@@ -0,0 +1,2 @@
+# Needed for some reason
+require 'drush_deploy'

data/lib/drush_deploy/recipes/db.rb

@@ -0,0 +1,106 @@
+require 'drush_deploy/database'
+
+drupal_db = DrushDeploy::Database.new(self)
+
+after "deploy", "db:drupal:update_settings"
+after "deploy", "db:version:create"
+before "deploy:rollback", "db:version:rollback"
+
+before "db:version:create", "db:drupal:configure"
+before "db:version:rollback", "db:drupal:configure"
+before "db:version:cleanup", "db:drupal:configure"
+
+if update_modules
+  after "deploy", "db:drupal:update"
+end
+after "deploy:cleanup", "db:version:cleanup"
+
+namespace :db do
+  namespace :drupal do
+    desc "Run update scripts for Drupal"
+    task :update, :roles => :web do
+      drupal_db.updatedb
+    end
+
+    desc "Determine database settings"
+    task :configure do
+      unless configured
+        drupal_db.configure
+
+        unless databases.nil? || databases.is_a?(Hash)
+          throw DrushDeploy::Error.new "Invalid value for databases: #{databases.inspect}"
+        end
+
+        # Set some defaults
+        DrushDeploy::Database.each_db(databases) do |db|
+          if db[:driver]
+            db[:driver] = db[:driver].to_sym
+          else
+            db[:driver] = db[:port] == database_ports[:pgsql] ? :pgsql : :mysql
+          end
+          db[:host] ||= 'localhost'
+          db[:port] ||= database_ports[db[:driver]]
+          db[:prefix] ||= ''
+          db[:collation] ||= 'utf8_general_ci'
+        end
+        set :configured, true
+
+        logger.important "Using database settings #{databases.inspect}"
+      end
+    end
+
+    desc "Update settings.php with database settings"
+    task :update_settings do
+      configure unless configured
+      settings = databases.inject({}) do |h,(k,site)|
+        h[k] = site.inject({}) do |h,(k,db)|
+          h[k] = db.keep_if { |k,v| DrushDeploy::Database::STANDARD_KEYS.include? k }
+          h
+        end
+        h
+      end
+      drupal_db.update_settings(settings)
+    end
+  end
+
+  namespace :version do
+    desc "Create a versioned backup of the database"
+    task :create, :roles => :web do
+      if releases.size > 1
+        current = drupal_db.config[:database]
+        backup = "#{current}_#{releases[-2]}"
+        unless drupal_db.db_exists? backup
+          on_rollback do
+            drupal_db.drop_database backup
+          end
+          drupal_db.copy_database(current,backup)
+        end
+      end
+    end
+
+    desc "Rollback to a previous version of the database"
+    task :rollback, :roles => :web do
+      unless releases.size > 1
+        throw DrushDeploy::Error.new "No previous versions to rollback to"
+      end
+      current = drupal_db.config[:database]
+      release = releases.last
+      source = "#{current}_#{releases[-2]}"
+      backup = "#{current}_backup"
+      if drupal_db.db_exists? source
+        drupal_db.rename_database(current,backup)
+        drupal_db.rename_database(source,current)
+        drupal_db.drop_database(backup)
+      end
+    end
+
+    desc "Cleanup old versions of the database"
+    task :cleanup, :roles => :web do
+      # Subtract one because the latest release won't be counted
+      count = fetch(:keep_releases, 5).to_i - 1
+      drupal_db.db_versions.drop(count).each do |db|
+        drupal_db.drop_database(db)
+      end
+    end
+  end
+end

data/lib/drush_deploy/recipes/deploy.rb

@@ -0,0 +1,28 @@
+after "deploy", "deploy:cleanup"
+
+# --------------------------------------------
+# Overloaded Methods
+# --------------------------------------------
+namespace :deploy do
+  desc "Setup shared application directories and permissions after initial setup"
+  task :setup_shared do
+    # remove Capistrano specific directories
+    run "rm -Rf #{shared_path}/log"
+    run "rm -Rf #{shared_path}/pids"
+    run "rm -Rf #{shared_path}/system"
+
+    run "[[ -e '#{shared_path}/default/files' ]] || mkdir -p #{shared_path}/default/files"
+  end
+
+  namespace :web do
+    desc "Disable the application and show a message screen"
+    task :disable, :roles => :web do
+      run "#{drush_bin} -r #{latest_release} vset --yes site_offline 1"
+    end
+
+    desc "Enable the application and remove the message screen"
+    task :enable, :roles => :web do
+      run "#{drush_bin} -r #{latest_release} vdel --yes site_offline"
+    end
+  end
+end

data/lib/drush_deploy/recipes/drupal.rb

@@ -0,0 +1,89 @@
+require 'drush_deploy/database'
+
+before "deploy", "drupal:setup_build"
+before "deploy", "drupal:check_permissions"
+after "deploy:symlink", "drupal:symlink"
+after "deploy", "drupal:clearcache"
+before "drupal:install_profile", "db:drupal:configure"
+
+namespace :drupal do
+  desc "Symlink shared directories"
+  task :symlink, :roles => :web do
+    run "ln -nfs #{shared_path}/default/files #{latest_release}/sites/default/files"
+  end
+ 
+  desc "Clear all Drupal cache"
+  task :clearcache, :roles => :web do
+    run "#{drush_bin} -r #{current_path} cache-clear all"
+  end
+
+  desc "Protect system files"
+  task :protect, :roles => :web do
+    run "chmod 644 #{latest_release}/sites/default/settings.php"
+  end
+
+  desc "Install profile from command line"
+  task :install_profile, :roles => :web do
+      script= <<-END
+        cd '#{latest_release}'
+        for p in `ls profiles`
+        do
+          echo "$(sed -n 's/name[ \t]*=[ \t]*//p' profiles/$p/$p.info) ($p)"
+        done
+      END
+      put script, '/tmp/select_profile.sh'
+      profiles = capture('bash /tmp/select_profile.sh').split(/\n/)
+
+      profile = Capistrano::CLI.ui.choose(*profiles) {|m| m.header = "Choose installation profile"}
+      machine_name = profile.match(/.*\((.*)\)$/)[1]
+      site_name = Capistrano::CLI.ui.ask("Site name?")
+      site_email = Capistrano::CLI.ui.ask("Site email?")
+      admin_email = Capistrano::CLI.ui.ask("Admin email?")
+      admin_user = Capistrano::CLI.ui.ask("Admin username?")
+      admin_password = Capistrano::CLI.password_prompt("Admin password?")
+      arguments = Capistrano::CLI.password_prompt("Additional profile settings (key=value)?")
+      dbconf = databases[:default][:default]
+      db_url = DrushDeploy::Database.url(dbconf)
+
+      run "cd '#{latest_release}' && #{drush_bin} site-install --yes --db-url='#{db_url}'"\
+          " --account-mail='#{admin_email}' --account-name='#{admin_user}' --account-pass='#{admin_password}'"\
+          " --site-name='#{site_name}' --site-mail='#{site_email}' "\
+          "#{dbconf[:admin_username] ? "--db-su='#{dbconf[:admin_username]}'" : ''} #{dbconf[:admin_password] ? "--db-su-pw='#{dbconf[:admin_password]}'" : ''}"\
+          "#{machine_name} #{arguments}", :once => true
+  end
+
+  task :setup_build, :roles => :web do
+    if ENV['MAKE']
+      set :make, ENV['MAKE'] =~ /^(0|no?)$/i
+    end
+    if ENV['MAKEFILE']
+      set :makefile, ENV['MAKEFILE']
+    end
+
+    build_cmd = "drush make '#{makefile}' ."
+
+    if make.nil?
+      build_cmd = "[ -f index.php ] || { [ -f '#{makefile}' ] && #{build_cmd}; }"
+    end
+    if make != false
+      set :build_script, build_cmd
+    end
+  end
+
+  desc "Check and fix if any permissions are set incorrectly."
+  task :check_permissions, :roles => :web do
+    if ! defined? www_user or www_user.nil?
+      user = capture(%q{ps -eo user,comm,pid,ppid | awk '$2 ~ /^apache.*|^httpd$/ && $1 != U && $3 != P {P=$4; U=$1} END { print U }'}).strip
+      if user
+        set :www_user, user
+        logger.important "Guessing that #{user} is the www_user, if this is wrong please set www_user manually in config"
+      else
+        logger.important "Not setting permissions: Unable to determine www_user, please set manually in config"
+      end
+    end
+    if ! defined? www_user or www_user.nil?
+      run "setfacl -Rdm u:#{www_user}:rwx #{shared_path}/default/files && setfacl -Rm u:#{www_user}:rwx #{shared_path}/default/files"
+    end
+  end
+
+end

data/lib/drush_deploy/recipes/general.rb

@@ -0,0 +1,5 @@
+
+desc "Show list of valid targets"
+task :targets do
+  drush_cap.targets.each {|t| puts t}
+end

data/lib/drush_deploy/recipes/setup.rb

@@ -0,0 +1,31 @@
+require 'drush_deploy/capistrano'
+
+set :deploy_via, :copy
+set :scm, :none
+set :repository, "."
+set :drush_bin, "drush"
+set :make, nil
+set :makefile, 'distro.make'
+
+set :drush, ENV['DRUSH'] if ENV['DRUSH']
+set :scm, ENV['SCM'] if ENV['SCM']
+set :repository, ENV['REPO'] if ENV['REPO']
+set :target, ENV['TARGET'] if ENV['TARGET']
+set :source, ENV['SOURCE'] if ENV['SOURCE']
+
+set :databases_path, [ '~/.drush/database.php', '~/.drush/database.yml', 
+                       '/etc/drush/database.php','/etc/drush/database.yml',
+                       'sites/default/default.settings.php', 'sites/default/settings.php']
+set :databases, {}
+
+set :database_ports, { :pgsql => 5432, :mysql => 3306 }
+
+set :configured, false
+
+set :update_modules, true
+
+set :drush_cap, DrushDeploy::Capistrano.new
+
+if exists? :target
+  target.split(/ *, */).each {|t| drush_cap.load_target t }
+end

data/lib/drush_deploy.rb

@@ -0,0 +1,4 @@
+require 'railsless-deploy'
+require 'drush_deploy/paths'
+
+Capistrano::Configuration.instance(:must_exist).load DrushDeploy::Paths.recipe('all')

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: drush-deploy
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha1
+  prerelease: 6
+platform: ruby
+authors:
+- Matt Edlefsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: &24649140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24649140
+- !ruby/object:Gem::Dependency
+  name: railsless-deploy
+  requirement: &24648400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *24648400
+- !ruby/object:Gem::Dependency
+  name: php_serialize
+  requirement: &24647760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *24647760
+description: Utilizes capistrano to allow for doing intellegent deployments of drupal
+  projects.
+email: matt@xforty.com
+executables:
+- drush-deploy
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- LICENSE.txt
+- LICENSE_GPL.txt
+- LICENSE_MPL.txt
+- README.md
+- bin/drush-deploy
+- drush-deploy.gemspec
+- lib/drush_deploy.rb
+- lib/drush_deploy/capistrano.rb
+- lib/drush_deploy/configuration.rb
+- lib/drush_deploy/database.rb
+- lib/drush_deploy/error.rb
+- lib/drush_deploy/paths.rb
+- lib/drush_deploy/recipes/all.rb
+- lib/drush_deploy/recipes/bootstrap.rb
+- lib/drush_deploy/recipes/db.rb
+- lib/drush_deploy/recipes/deploy.rb
+- lib/drush_deploy/recipes/drupal.rb
+- lib/drush_deploy/recipes/general.rb
+- lib/drush_deploy/recipes/setup.rb
+homepage: https://github.com/xforty/drush-deploy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Deployment strategy for Drupal using Drush
+test_files: []