capistrano-didi 0.4.0 → 0.4.1

data/CHANGELOG.txt

@@ -0,0 +1,29 @@
+## 0.4.1 22 May 2012
+
+* fix compatibility with capistrano 2.12.0
+* you need to uninstall capistrano-ext (included in 2.12.0)
+* cleanup sample stage config in didify
+* fixed cleanup and dbbackup tasks in multisite config
+* minor code and docs cleanup
+
+## 0.4.0 / May 3 2012
+
+* added multisite support (see wiki)
+* added manage:pull_dump
+* extra config options (no_disable:true, local_database:nil, backup_database:true)
+
+## 0.3.2 / Mar 23 2012
+
+* added config option: enable_robots, default to false 
+* added config option: drush_path, on remote server 
+* added default php settings in settings.php file
+* put site in maintenance mode during deploy
+
+## 0.3.1 / Jan 4 2012
+
+* added tests:unit_all + bugfixes
+
+## 0.3.0 / Nov 24 2011
+
+* fix symlinks on rollback
+* added manage:dbdump_previous task

data/Gemfile

@@ -7,10 +7,9 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "railsless-deploy", ">= 1.0.2"
-  gem "capistrano-ext", ">= 1.2.1"
-  gem "capistrano", ">= 2.9.0"
+  gem "capistrano", ">= 2.12.0"
   gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.1.3"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -1,16 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    capistrano (2.9.0)
+    capistrano (2.12.0)
       highline
       net-scp (>= 1.0.0)
       net-sftp (>= 2.0.0)
       net-ssh (>= 2.0.14)
       net-ssh-gateway (>= 1.1.0)
-    capistrano-ext (1.2.1)
-      capistrano (>= 1.0.0)
     git (1.2.5)
-    highline (1.6.2)
+    highline (1.6.12)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -19,21 +17,24 @@ GEM
       net-ssh (>= 1.99.1)
     net-sftp (2.0.5)
       net-ssh (>= 2.0.9)
-    net-ssh (2.2.1)
+    net-ssh (2.3.0)
     net-ssh-gateway (1.1.0)
       net-ssh (>= 1.99.1)
     railsless-deploy (1.0.2)
     rake (0.9.2.2)
-    rcov (0.9.11)
-    shoulda (2.11.3)
+    rcov (1.0.0)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  capistrano (>= 2.9.0)
-  capistrano-ext (>= 1.2.1)
+  bundler (~> 1.1.3)
+  capistrano (>= 2.12.0)
   jeweler (~> 1.6.4)
   railsless-deploy (>= 1.0.2)
   rcov

data/README.rdoc

@@ -1,6 +1,15 @@
 = didi
 
-Description goes here.
+Didi is an collection of capistrano recipes that enable automated deployment and continuous integration of drupal websites. Once you have configured different hosting environments you can use the "didi" command to interact with them.
+
+== What can didi do you for?
+
+* update a hosting environment of your choice with the latest code
+* perform drush commands for maintenance
+* revert features via drush after code updates
+* restore a remote database to your local development machine
+* setup a drupal website from scratch on a new webserver
+* run simpletests with Jenkins
 
 == Contributing to didi
  
@@ -14,29 +23,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2011 Koen Van Winckel. See LICENSE.txt for
-further details.
-
-
-
-= TODO
-
-* set :site, "apache vhost here" => not clear what this is
-* set :sitesubdir, "default" => use :site here ?
-* create default + multisite with :site
-* sensible default: adminpass => default is admin admin
-* server app, web, db => hide this db depends on settings.php so specified else where
-* set :scm, "subversion" => document options => with svn url needs to be location of cap file
-* set :baseline => should not be mandatory
-* set :sitemail => should not be mandatory
-* stages => reserverd names (eg. test)
-* set :deploy_to => needs to be absolute (+what with trailing slash?)
-* requirements: drush
-* deploy:check => uitbreiden met control of repostioryu (svn / git) bereikbaar is) see "depend"
-* deploy:check => ook mysql connectie controleren
-* svn: problem with acceptance voor certificate
-* scm_username, scm_password 
-* drush:si => ook feature revert all doen
-* apache vhost opgeven en gesymlinked word
-* railslessdeploy: run_locally
-* robots.txt disallow all
+Copyright (c) Koen Van Winckel. See LICENSE.txt for further details.

data/Rakefile

@@ -21,9 +21,8 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{didi is a collection of recipes for capistrano that allow drupal to be deployed, tested and used in a CI environment}
   gem.email = "koenvw@gmail.com"
   gem.authors = ["Koen Van Winckel"]
-  gem.add_dependency "capistrano", ">= 2.9.0"
+  gem.add_dependency "capistrano", ">= 2.12.0"
   gem.add_dependency "railsless-deploy", ">= 1.0.2"
-  gem.add_dependency "capistrano-ext", ">= 1.2.1"
   gem.post_install_message = '=> "didify" and "didi" commands installed. Try them out!'
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/bin/didify

@@ -38,35 +38,35 @@ end
 files = {
   "Capfile" => unindent(<<-FILE),
     require 'railsless-deploy'          # gem install railsless-deploy
-    require 'capistrano/ext/multistage' # gem install capistrano-ext
     require 'didi/recipes/didi.rb'      # gem install capistrano-didi 
     load 'config/deploy'
+    require 'capistrano/ext/multistage' # gem install capistrano
   FILE
 
   "config/deploy.rb" => 'set :default_stage, "staging"
 set :stages, %w(staging production)
-set :application, "set your application name here"
-set :repository,  "set your repository location here"
+set :application, "your_application_name"
+set :repository,  "your_repository_location_here"
 set :drupal_path, "drupal" # change this to your drupal folder
 ',
-  "config/deploy/staging.rb" => 'set :user, "set your shell user here"
-server "set your server hostname here", :app, :web, :db, :primary => true
+  "config/deploy/staging.rb" => 'set :user, "ssh_user_name"
+server "server.example.com", :app, :web, :db, :primary => true
 
-set :deploy_to, "the path on the remote server"
+set :deploy_to, "the_path_on_the_remote_server"
 set :branch, "master"
 
 set :db_type, "mysql"
-set :db_name, "set database name"
-set :db_username, "set database user name"
-set :db_password, "set database password"
+set :db_name, "database_name"
+set :db_username, "database_user_name"
+set :db_password, "database_password"
 
 set :profile, "minimal"
-set :site, "apache vhost here"
-set :sitemail, "drupal site email address"
-set :adminpass, "drupal admin pass"
-set :sitesubdir, "default"
+set :domain, "default"
+set :site, "apache_vhost"
+set :sitemail, "drupal_site_email_address"
+set :adminpass, "drupal_admin_pass"
 
-set :baseline, "drupal feature to activate after fresh install"
+set :baseline, "drupal_feature_to_activate_after_fresh_install"
 '}
 
 base = ARGV.shift

data/capistrano-didi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano-didi"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Koen Van Winckel"]
-  s.date = "2012-05-03"
+  s.date = "2012-05-22"
   s.description = "didi is a collection of recipes for capistrano that allow drupal to be deployed, tested and used in a CI environment"
   s.email = "koenvw@gmail.com"
   s.executables = ["didify", "didi"]
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGELOG.txt",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -44,38 +45,32 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-      s.add_development_dependency(%q<capistrano-ext>, [">= 1.2.1"])
-      s.add_development_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_development_dependency(%q<capistrano>, [">= 2.12.0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.12.0"])
       s.add_runtime_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-      s.add_runtime_dependency(%q<capistrano-ext>, [">= 1.2.1"])
     else
       s.add_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-      s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
-      s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_dependency(%q<capistrano>, [">= 2.12.0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+      s.add_dependency(%q<capistrano>, [">= 2.12.0"])
       s.add_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-      s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
     end
   else
     s.add_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-    s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
-    s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+    s.add_dependency(%q<capistrano>, [">= 2.12.0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<capistrano>, [">= 2.9.0"])
+    s.add_dependency(%q<capistrano>, [">= 2.12.0"])
     s.add_dependency(%q<railsless-deploy>, [">= 1.0.2"])
-    s.add_dependency(%q<capistrano-ext>, [">= 1.2.1"])
   end
 end
 

data/lib/didi/recipes/didi.rb

@@ -15,7 +15,6 @@ _cset(:profile)         { abort "Please specify the Drupal install profile (:pro
 _cset(:site)            { abort "Please specify the Drupal site (:site)." }
 _cset(:sitemail)        { abort "Please specify the Drupal site mail (:sitemail)." }
 _cset(:adminpass)       { abort "Please specify the Drupal admin password (:adminpass)." }
-_cset(:sitesubdir)      { abort "Please specify the Drupal site subdir (:sitesubdir)." } # FIXME: files folder needs to be symlinked ??
 _cset(:baseline)        { abort "Please specify the Baseline feature (:baseline)." }
 
 
@@ -78,7 +77,7 @@ depend :remote, :command, "#{drush_path}drush"
 namespace :deploy do
 
   desc <<-DESC
-    Deploys your Drupal site. It supposes that the Setup task was already executed.
+    Deploys your Drupal site, runs drush:update. It supposes that the Setup task was already executed.
     This overrides the default Capistrano Deploy task to handle database operations and backups,
     all of them via Drush.
   DESC
@@ -93,17 +92,16 @@ namespace :deploy do
   task :cold do
     transaction do
       setup
-      update_code
-      symlink
+      update
     end
   end
   after "deploy:cold", "drush:si"
 
   desc "Deploys latest code and rebuild the database"
   task :rebuild do
-    update_code
-    symlink
+    update
     manage.dbdump_previous
+    cleanup
   end
   after "deploy:rebuild", "drush:si"
 
@@ -119,12 +117,12 @@ namespace :deploy do
 
     run <<-CMD
       mkdir -p #{dirs.join(' ')}
-      #{try_sudo} chown #{user}:#{srv_usr} #{shared_files.to_a.join(' ')} &&
-      #{try_sudo} chmod g+w #{shared_files.to_a.join(' ')}
+      #{try_sudo} chown #{user}:#{srv_usr} #{shared_files.join(' ')} &&
+      #{try_sudo} chmod g+w #{shared_files.join(' ')}
     CMD
 
     #create drupal config file
-    domain.to_a.each_with_index do |d, i|
+    domain.each_with_index do |d, i|
       configuration = drupal_settings(drupal_version, d)
       put configuration, shared_settings[i]
     end
@@ -133,8 +131,12 @@ namespace :deploy do
 
   desc "[internal] Rebuild files and settings symlinks"
   task :finalize_update, :except => { :no_release => true } do
+    # Specifies an on_rollback hook for the currently executing task. If this
+    # or any subsequent task then fails, and a transaction is active, this
+    # hook will be executed.
     on_rollback do
       if previous_release
+        #FIXME: won't work on mulitsite config
         run "ln -nfs #{shared_files} #{previous_release_files} && ln -nfs #{shared_settings} #{previous_release_settings}"
       else
         logger.important "no previous release to rollback to, rollback of drupal shared data skipped."
@@ -143,7 +145,7 @@ namespace :deploy do
 
 
     release_domain.each do |rd|
-      run "if [ ! -d #{rd} ]; then mkdir #{rd}; fi" # in case the default is not versioned
+      run "if [ ! -d #{rd} ]; then mkdir #{rd}; fi" # in case the default folder is not versioned
     end
 
     shared_files.each_with_index do |sf, i|
@@ -177,21 +179,29 @@ namespace :deploy do
       logger.info "keeping #{count} of #{releases.length} deployed releases"
       old_releases = (releases - releases.last(count))
       directories = old_releases.map { |release| File.join(releases_path, release) }.join(" ")
-      databases = old_releases.map { |release| File.join(dbbackups_path, "#{release}.sql") }.join(" ")
-
+      databases = dbbackups_path.product(old_releases.map { |release| "#{release}.sql"} ).map { |p| File.join(p)}.join(" ") if backup_database
       run "rm -rf #{directories} #{databases}"
     end
   end
 
   namespace :rollback do
 
+    desc <<-DESC
+    go back to the previous release (code and database)
+    DESC
+    task :default do
+      revision
+      #db_rollback if domain.to_a.size == 1 # FIXME: not supported in multisite configuration, does not work
+      cleanup
+    end
+
     desc <<-DESC
       [internal] Removes the most recently deployed release.
       This is called by the rollback sequence, and should rarely
       (if ever) need to be called directly.
     DESC
     task :cleanup, :except => { :no_release => true } do
-      # chmod 777 #{release_settings} #{release_files} &&
+      # FIXME: this doesn't cleanup dbbackups
       run "if [ `readlink #{current_path}` != #{current_release} ]; then rm -rf #{current_release}; fi"
     end
 
@@ -203,9 +213,13 @@ namespace :deploy do
         run <<-CMD
           rm #{current_path};
           ln -s #{previous_release} #{current_path};
-          ln -nfs #{shared_files} #{previous_release_files};
-          ln -nfs #{shared_settings} #{previous_release_settings}
         CMD
+        shared_files.each_with_index do |sf, i|
+          run <<-CMD
+            ln -nfs #{sf} #{previous_release_files[i]} &&
+            ln -nfs #{shared_settings[i]} #{previous_release_settings[i]}
+          CMD
+        end
       else
         abort "could not rollback the code because there is no prior release"
       end
@@ -217,6 +231,7 @@ namespace :deploy do
     database and import the backup. This task should NEVER be called standalone.
     DESC
     task :db_rollback, :except => { :no_release => true } do
+      #FIXME: does not work
       if previous_release
         logger.info "Dumping current database and importing previous one (If one is found)."
         previous_db = File.join(dbbackups_path, "#{releases[-2]}.sql")
@@ -227,15 +242,17 @@ namespace :deploy do
       end
     end
 
-    desc <<-DESC
-    go back to the previous release (code and database)
-    DESC
-    task :default do
-      revision
-      db_rollback
-      cleanup
+  end
+  
+  namespace :web do
+    desc "Makes the application web-accessible again."
+    task :enable do
+      drush.ensite
+    end
+    desc "Present a maintenance page to visitors."
+    task :disable do
+      drush.dissite
     end
-
   end
 
 end
@@ -275,13 +292,13 @@ namespace :drush do
     end
     cc
   end
-  desc "[internal]  Enable the simpletest feature"
+  desc "[internal] Enable the simpletest feature"
   task :enst do
     run "cd #{current_path}/#{drupal_path} && #{drush_path}drush pm-enable simpletest -y"
     cc
   end
 
-  desc "Disable maintenance mode, enabling the site"
+  desc "[internal] Disable maintenance mode, enabling the site"
   task :ensite do
     if drupal_version == 6
       run "cd #{current_path}/#{drupal_path} && #{drush_path}drush vset --always-set site_offline 0"
@@ -292,7 +309,7 @@ namespace :drush do
     end
   end
 
-  desc "Enable maintenance mode, disabling the site"
+  desc "[internal] Enable maintenance mode, disabling the site"
   task :dissite do
     if drupal_version == 6
       run "cd #{current_path}/#{drupal_path} && #{drush_path}drush vset --always-set site_offline 1"
@@ -399,7 +416,9 @@ namespace :manage do
   task :dbdump_previous do
     #Backup the previous release's database
     if previous_release && backup_database
-      run "cd #{current_path}/#{drupal_path} && #{drush_path}drush sql-dump > #{ File.join(dbbackups_path, "#{releases[-2]}.sql") }"
+      domain.each_with_index do |d,i|
+        run "cd #{current_path}/#{drupal_path} && #{drush_path}drush" + (d == 'default' ? '' : " -l #{d}") + " sql-dump > #{ File.join(dbbackups_path[i], "#{releases[-2]}.sql") }"
+      end
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capistrano-didi
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Koen Van Winckel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-03 00:00:00 Z
+date: 2012-05-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -39,34 +39,18 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
-  version_requirements: *id002
-  name: capistrano-ext
-  prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
+        hash: 63
         segments: 
         - 2
-        - 9
+        - 12
         - 0
-        version: 2.9.0
-  version_requirements: *id003
+        version: 2.12.0
+  version_requirements: *id002
   name: capistrano
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,28 +59,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id004
+  version_requirements: *id003
   name: shoulda
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 21
         segments: 
         - 1
-        - 0
-        - 0
-        version: 1.0.0
-  version_requirements: *id005
+        - 1
+        - 3
+        version: 1.1.3
+  version_requirements: *id004
   name: bundler
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -107,12 +91,12 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id006
+  version_requirements: *id005
   name: jeweler
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -121,28 +105,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
+  version_requirements: *id006
   name: rcov
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency 
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
+        hash: 63
         segments: 
         - 2
-        - 9
+        - 12
         - 0
-        version: 2.9.0
-  version_requirements: *id008
+        version: 2.12.0
+  version_requirements: *id007
   name: capistrano
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency 
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -153,26 +137,10 @@ dependencies:
         - 0
         - 2
         version: 1.0.2
-  version_requirements: *id009
+  version_requirements: *id008
   name: railsless-deploy
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
-  version_requirements: *id010
-  name: capistrano-ext
-  prerelease: false
-  type: :runtime
 description: didi is a collection of recipes for capistrano that allow drupal to be deployed, tested and used in a CI environment
 email: koenvw@gmail.com
 executables: 
@@ -185,6 +153,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- CHANGELOG.txt
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt