cap-drupal-multisite 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 905a61b9d5ae508f30e561c3c23968b299048d64
+  data.tar.gz: 1719cfe0fe3146406de663471d4e00249cbee6ca
+SHA512:
+  metadata.gz: e3766410982381499a649e57c7f1cb9a2fb88407ce762677e737112eb1f446c99c3fab9b74c46528070db181db6817f626a3f30a242154eda59fa4ee13d187b0
+  data.tar.gz: 585a08c349149f5c8ab993197a78ffaa372a432d45c8afe83718bdc0a819a618023f0b0b7cce750725930710dd084188df59ffb1ebeec93618e75040111b6b9a

data/README.md

@@ -0,0 +1,97 @@
+cap-drupal-multisite
+====================
+
+Various capistrano tasks to deploy and maintain drupal sites.
+
+It currently only works with Drupal 7.x and Capistrano 3.x.
+
+Features:
+* Specify and upload settings.php file for each site and stage.
+* Automatically symlinking `files` and `private` directory for each site.
+* Integration of some basic Drush tasks.
+* Synchronize assets and database.
+
+
+Installation
+------------
+
+Add it as gem to `Gemfile`:
+
+    source 'https://rubygems.org'
+    group :development do
+        gem "capistrano", '~> 3.3.5'
+        gem "capistrano-ext"
+        gem 'cap-drupal-multisite'
+    end
+
+Install using 'bundle':
+
+    bundle install
+
+
+Configuration
+-------------
+
+Add the following line to your `Capfile`:
+
+    require 'capistrano-drupal-multisite'
+    
+Add the following configuration to your `config/deploy.rb`:
+
+    # Path to drupal installation inside the release directory
+    set :drupal_path, "public"
+    # List of all sites in the sites directory
+    set :drupal_sites, %w{default site2}
+    # Group owner of the assets files
+    set :drupal_group, "www-data"
+
+You have to specify an own settings.php file for each site and each stage like:
+
+    config/<stage>/settings.<site>.php
+
+You also have to specify an own sites.php for each stage like:
+
+    config/<stage>/sites.php
+
+
+Usage
+-----
+
+Add to following additional optional deploy hooks to your `config/deploy.rb`:
+
+    namespace :deploy do
+        after :publishing, "drupal:cache_clear"     # clears all caches
+        after :publishing, "drupal:updatedb"        # updates all databases
+        after :publishing, "drupal:feature_revert"  # reverts all features
+    end
+
+Display a list of all available tasks:
+
+    bundle exec cap -T
+    cap drupal:assets:download         # Download assets from <remote>:shared_path to <local>:files/ and <local>:private/ for each site
+    cap drupal:assets:upload           # Upload assets from <local>:files/ and <local>:private/ to <remote>:shared_path for each site
+    cap drupal:cache_clear             # Clear all caches
+    cap drupal:db:download             # Download database dumps from <remote>:release_path to <local>:db/
+    cap drupal:db:dump                 # Dump database for each site to <remote>:release_path
+    cap drupal:db:restore              # Restore database for each site from dump in <remote>:release_path
+    cap drupal:db:upload               # Upload database dumps from <local>:db/ to <remote>:release_path
+    cap drupal:feature_revert          # Revert all features
+    cap drupal:symlink                 # Symlink shared directories
+    cap drupal:updatedb                # Apply any database updates required
+    cap drupal:upload_settings         # Upload settings
+
+
+Bugs & Feedback
+---------------
+
+I'm not a Ruby developer so if you have any feedback or found a bug please contact me.
+
+
+Credits
+-------
+
+Most of the code is inspired by other projects like:
+
+* [antistatique/capdrupal](https://github.com/antistatique/capdrupal)
+* [mathieue/cap-drupal](https://github.com/mathieue/cap-drupal)
+* [sgruhier/capistrano-db-tasks](https://github.com/sgruhier/capistrano-db-tasks)

data/cap-drupal-multisite.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name        = "cap-drupal-multisite"
+  spec.version     = "0.3.2"
+  spec.authors     = ["Insiders Online"]
+  spec.email       = ["beheer@insiders.nl"]
+  spec.homepage    = "https://github.com/insiders/cap-drupal-multisite"
+  spec.summary     = "[OUTDATED] A collection of capistrano tasks for deploying drupal sites"
+  spec.description = spec.summary
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.3.5"
+  spec.add_dependency "sshkit", ">= 1.4.0"
+  spec.add_dependency "colorize"
+  spec.add_dependency "highline"
+end

data/lib/cap-drupal-multisite.rb

@@ -0,0 +1,2 @@
+require "capistrano"
+require File.expand_path("#{File.dirname(__FILE__)}/cap-drupal-multisite/drupal")

data/lib/cap-drupal-multisite/drupal.rb

@@ -0,0 +1,172 @@
+# Load default values
+namespace :load do
+  task :defaults do
+    set :drush, "drush"
+    set :drupal_path, "public"
+    set :drupal_sites, %w{default}
+    set :drupal_group, "www-data"
+    set :drupal_rsync_exclude, "--exclude=/languages --exclude=/styles --exclude=/js --exclude=/css"
+  end
+end
+
+# Specific Drupal tasks
+namespace :drupal do
+
+  desc "Symlink shared directories"
+  task :symlink do
+    on roles(:all) do
+      fetch(:drupal_sites).each do |site|
+        execute "mkdir", "-p #{shared_path}/#{site}/files #{shared_path}/#{site}/private #{release_path}/#{fetch(:drupal_path)}/sites/#{site}"
+        execute "chmod", "2775 #{shared_path}/#{site}/files #{shared_path}/#{site}/private"
+        execute "chgrp", "#{fetch(:drupal_group)} #{shared_path}/#{site}/files #{shared_path}/#{site}/private"
+        execute "ln", "-nfs #{shared_path}/#{site}/files #{release_path}/#{fetch(:drupal_path)}/sites/#{site}/files"
+        execute "ln", "-nfs #{shared_path}/#{site}/private #{release_path}/#{fetch(:drupal_path)}/sites/#{site}/private"
+        #execute :drush, "-l #{site} -r #{release_path}/#{fetch(:drupal_path)} vset --yes file_directory_path sites/#{site}/files"
+      end
+    end
+  end
+
+  desc "Upload settings"
+  task :upload_settings do
+    on roles(:all) do
+      fetch(:drupal_sites).each do |site|
+        upload! "config/#{fetch(:stage)}/settings.#{site}.php", "#{release_path}/#{fetch(:drupal_path)}/sites/#{site}/settings.php"
+      end
+      upload! "config/#{fetch(:stage)}/sites.php", "#{release_path}/#{fetch(:drupal_path)}/sites/sites.php"
+    end
+  end
+
+  desc "Apply any database updates required"
+  task :updatedb do
+    on roles(:all) do
+      fetch(:drupal_sites).each do |site|
+        execute :drush, "-l #{site} -r #{release_path}/#{fetch(:drupal_path)} -y updatedb"
+      end
+    end
+  end
+
+  desc "Revert all features"
+  task :feature_revert do
+    on roles(:all) do
+      fetch(:drupal_sites).each do |site|
+        execute :drush, "-l #{site} -r #{release_path}/#{fetch(:drupal_path)} -y features-revert-all"
+      end
+    end
+  end
+
+  desc 'Clear all caches'
+  task :cache_clear do
+    on roles(:all) do
+      within "#{release_path}/#{fetch(:drupal_path)}" do
+        fetch(:drupal_sites).each do |site|
+          execute :drush, "-l #{site} -r #{release_path}/#{fetch(:drupal_path)} -y cache-clear all"
+        end
+      end
+    end
+  end
+
+  namespace :db do
+
+    desc 'Dump database for each site to <remote>:release_path'
+    task :dump do 
+      on roles(:all) do
+        fetch(:drupal_sites).each do |site|
+          execute :drush, "-l #{site} -r #{release_path}/#{fetch(:drupal_path)} sql-dump | gzip > #{release_path}/#{site}.sql.gz"
+        end
+      end
+    end
+
+    desc 'Restore database for each site from dump in <remote>:release_path'
+    task :restore do
+      set :confirmed, proc {
+        puts <<-WARN
+
+          ========================================================================
+                WARNING: You're about to overwrite production database
+          ========================================================================
+
+        WARN
+        ask :answer, "Are you sure you want to continue? Type 'yes'"
+        if fetch(:answer)== 'yes' then true else false end
+      }.call
+      unless fetch(:confirmed)
+        puts "\nCancelled!"
+        exit
+      end
+      on roles(:all) do
+        fetch(:drupal_sites).each do |site|
+          if test("[ -f #{release_path}/#{site}.sql.gz ]")
+            execute "zcat #{release_path}/#{site}.sql.gz | `drush -l #{site} -r #{release_path}/#{fetch(:drupal_path)} sql-connect`"
+          else
+            raise "Database dump for #{site} is not available"
+          end
+        end
+      end
+    end
+
+    desc 'Download database dumps from <remote>:release_path to <local>:db/'
+    task :download do 
+      on roles(:all) do
+        fetch(:drupal_sites).each do |site|
+          download! "#{release_path}/#{site}.sql.gz", "db/"
+        end
+      end
+    end
+
+    desc 'Upload database dumps from <local>:db/ to <remote>:release_path'
+    task :upload do
+      on roles(:all) do
+        fetch(:drupal_sites).each do |site|
+          upload! "db/#{site}.sql.gz", "#{release_path}/#{site}.sql.gz"
+        end
+      end
+    end
+  end
+
+  namespace :assets do
+
+    desc 'Download assets from <remote>:shared_path to <local>:files/ and <local>:private/ for each site'
+    task :download do 
+      on roles(:all) do |server|
+        fetch(:drupal_sites).each do |site|
+          puts "Downloading files of #{site} from #{server}"
+          system("sshpass -p#{server.password} rsync -rut --del -L -K #{fetch(:drupal_rsync_exclude)} --rsh='ssh -p #{server.port}' #{server.user}@#{server.hostname}:#{shared_path}/#{site}/files/ sites/#{site}/files")
+          system("sshpass -p#{server.password} rsync -rut --del -L -K #{fetch(:drupal_rsync_exclude)} --rsh='ssh -p #{server.port}' #{server.user}@#{server.hostname}:#{shared_path}/#{site}/private/ sites/#{site}/private")
+        end
+      end
+    end
+
+    desc 'Upload assets from <local>:files/ and <local>:private/ to <remote>:shared_path for each site'
+    task :upload do
+      set :confirmed, proc {
+        puts <<-WARN
+
+          ========================================================================
+                WARNING: You're about to overwrite production assets
+          ========================================================================
+
+        WARN
+        ask :answer, "Are you sure you want to continue? Type 'yes'"
+        if fetch(:answer)== 'yes' then true else false end
+      }.call
+      unless fetch(:confirmed)
+        puts "\nCancelled!"
+        exit
+      end
+      on roles(:all) do |server|
+        fetch(:drupal_sites).each do |site|
+          puts "Uploading files of #{site} to #{server}"
+          system("sshpass -p#{server.password} rsync -rutv --del -L -K #{fetch(:drupal_rsync_exclude)} --rsh='ssh -p #{server.port}' sites/#{site}/files/ #{server.user}@#{server.hostname}:#{shared_path}/#{site}/files")
+          system("sshpass -p#{server.password} rsync -rutv --del -L -K #{fetch(:drupal_rsync_exclude)} --rsh='ssh -p #{server.port}' sites/#{site}/private/ #{server.user}@#{server.hostname}:#{shared_path}/#{site}/private")
+        end
+      end
+    end
+  end
+
+end
+
+# Set deploy hooks
+namespace :deploy do
+  after :updating, "drupal:symlink"
+  after :updating, "drupal:upload_settings"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: cap-drupal-multisite
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Insiders Online
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '[OUTDATED] A collection of capistrano tasks for deploying drupal sites'
+email:
+- beheer@insiders.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- cap-drupal-multisite.gemspec
+- lib/cap-drupal-multisite.rb
+- lib/cap-drupal-multisite/drupal.rb
+homepage: https://github.com/insiders/cap-drupal-multisite
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: '[OUTDATED] A collection of capistrano tasks for deploying drupal sites'
+test_files: []