alcapon 0.1.0

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Arnaud Lafon, http://github.com/alafon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# AlCapON : Enable Capistrano for your eZ Publish installations
+
+AlCapON is a simple recipe for Capistrano, the well-known deployment toolbox. It helps you dealing with simple task such as pushing your code to your webserver(s), clearing cache, etc.
+
+IMPORTANT: this package is currently under development, please consider testing it on a preproduction environment before going further. Please also read the "Known bugs" section carefully.
+
+## Requirements, installation & co
+
+Please see [alafon.github.com/alcapon](http://alafon.github.com/alcapon)

data/bin/capezit

@@ -0,0 +1,201 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+
+alcapon_path  = 'extension/alcapon'
+FileUtils.mkdir_p(File.join(alcapon_path,'config/deploy'))
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory to capifony, e.g. `#{File.basename($0)} .'"
+elsif !File.exists?(ARGV.first)
+  abort "`#{ARGV.first}' does not exist."
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory to capify."
+end
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    set :alcapon_path, \"#{alcapon_path}\"
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    Dir['vendor/gems/*/recipes/*.rb','vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+
+    load Gem.find_files('capez.rb').last.to_s
+
+    set :stage_dir, '#{alcapon_path}/config/deploy'
+    Dir['#{alcapon_path}/config/*.rb'].each { |recipe| load(recipe) }
+  FILE
+
+  "#{alcapon_path}/config/deploy.rb" => unindent(<<-FILE),
+    # Comment this if you don't want to use a multistage setup
+    set :stages, %w(devel production )
+    set :default_stage, "devel"
+    require 'capistrano/ext/multistage'
+
+    set :application, "myapp"
+    set :repository,  "git@github.com:username/myapp.git"
+
+    set :deploy_to, "/var/www/\#{application}"
+    # The user connecting your server through ssh
+    set :user, "deploy"
+
+    # The default branch used (can be overridden on multistage setup)
+    set :branch, "master"
+
+    # Need if you want to deploy somewhere where sudo is needed
+    default_run_options[:pty] = true
+
+    # Use this to use your ssh keys
+    # (you might need to run ssh-add /path/to/your/deploy_key before)
+    ssh_options[:forward_agent] = true
+    # Or if you want to use a specific key
+    #ssh_options[:keys] = %w(/home/username/.ssh/id_rsa)
+
+    # Or: `accurev`, `bzr`, `cvs`, `darcs`, `git`, `mercurial`, `perforce`, `subversion` or `none`
+    set :scm, :git
+
+    # Comment this if you don't use submodules
+    set :git_enable_submodules, 1
+
+    # Prevents you from cloning the whole rep. each deploy but your remote servers
+    # must be able to get connected to your scm server
+    set :deploy_via, :remote_cache
+
+    # Your Primary HTTP server
+    # (Use config/deploy/*.rb files instead if you need a multisage setup)
+    role :web, "domain.com", :primary => true
+    # Another HTTP server, for instanced when using a clustered mode
+    #role :web, "server2"
+
+    #role :db,  "your primary db-server here", :primary => true # This is where Rails migrations will run
+    #role :db,  "your slave db-server here"
+  FILE
+
+  "#{alcapon_path}/config/ezpublish.rb" => unindent(<<-FILE),
+    # This file contains eZ Publish adjustable variables depending on your custom setup
+
+    # Your webserver user and group, used to chmod directories just after deploy:setup
+    set :webserver_user, "apache"
+    set :webserver_group, "apache"
+
+    # If true, will always turn your webserver offline
+    # Requires a specific rewrite rule (see documentation)
+    set :always_turnoff, false
+
+    # Array taking all the values given by php bin/php/ezcache.php --list-tags
+    #
+    # If you want to clear all caches use :
+    #set :cache_list, "all"
+    set :cache_list, [ "template", "ini", "content" ]
+
+    # If true, adds '--purge' to the ezcache.php command
+    # Be careful with that one, some versions are known to completely delete
+    # your var directory (2012.5 for instance)
+    set :cache_purge, false
+
+    # Siteaccess list, needed for setup & shared directory sync
+    #set :siteaccess_list, [ "ezflow_site" ]
+
+    # Set this to tell Capistrano with which host you want to sync your local storage dir
+    #set :shared_host, "domain.com"
+
+    # Which autoloads to generate. By default, regenerates extensions and
+    # kernel-override autoloads
+    # Possible values : see bin/php/ezpgenerateautoloads.php --help
+    set :autoload_list, [ "extension", "kernel-override" ]
+
+    # TODO : use yml files to manage database credentials securely
+    # See http://www.simonecarletti.com/blog/2009/06/capistrano-and-database-yml/
+    set :database_uname, "dbuname"
+    set :database_passd, "dbpasswd"
+    set :database_name, "dbname"
+
+    # Not implemented
+    set :ezpublish_separated_core, false
+    set :ezpublish_base, "community"
+    set :ezpublish_version, "2012.5"
+
+    # Check-list (used by cap setup:check)
+    depend :remote, :command, "php"
+    depend :remote, :match, "php -r \\"echo(version_compare(PHP_VERSION,'5.2.14')?'ok':'ko');\\"", "ok"
+    depend :remote, :match, "php -m | grep curl", "curl"
+
+    # TODO
+    #Check : PHP memory_limit >= 128
+    #Check : PHP date.imezone = "something"
+    #Check : eZ Components (must be bundled if eZ Publish >= 20??.? since there's a patch for Archive)
+    #Check : If deploy_via remote_cache => check of the remote servers have access to the scm
+  FILE
+
+  "#{alcapon_path}/config/deploy/devel.rb" => unindent(<<-FILE),
+    # There you can override default settings for this specific environment
+
+    set :branch, "dev"
+    #role :web, "myapp.devserv", :primary => true           # Your Primary HTTP server
+
+    # If you need sudo commands to be run with -u sudouser
+    #set :admin_runner, "sudouser"
+
+    # This is used for permissions related tasks
+    #set :webserver_user, "www-data"
+    #set :webserver_group, "www-data"
+  FILE
+
+  "#{alcapon_path}/config/deploy/production.rb" => unindent(<<-FILE)
+    # There you can override default settings for this specific environment
+
+    set :branch, "master"
+    #role :web, "domain.com", :primary => true           # Your Primary HTTP server
+
+    # If you need sudo commands to be run with -u sudouser
+    #set :admin_runner, "sudouser"
+
+    # This is used for permissions related tasks
+    #set :webserver_user, "apache"
+    #set :webserver_group, "apache"
+  FILE
+  }
+
+base = ARGV.shift
+
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] '#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] '#{file.downcase}' exists, which could conflict with `#{file}'"
+  else
+    unless File.exists?(File.dirname(file))
+      puts "[add] making directory '#{File.dirname(file)}'"
+      FileUtils.mkdir(File.dirname(file))
+    end
+    puts "[add] writing '#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
+  end
+end
+
+puts "[done] Your eZ Publish project is now controlled by AlCapON !"

data/lib/capez.rb

@@ -0,0 +1,219 @@
+load_paths.push File.expand_path('../', __FILE__)
+load 'db.rb'
+
+# This will simply do chmod g+w on all dir
+# See task :setup
+set :group_writable, true
+
+after "deploy:setup", :roles => :web do
+  capez.var.init_shared
+end
+
+after "deploy:update", :roles => :web do
+  # We don't need to clear the cache anymore but a warmup might be needed
+  #capez.cache.clear
+end
+
+before "deploy", :roles => :web do
+  capez.dev.local_check
+  deploy.web.disable
+end
+
+after "deploy", :roles => :web do
+  deploy.web.enable
+end
+
+namespace :deploy do
+
+  desc <<-DESC
+    Finalize the update by creating symlink var -> shared/var
+  DESC
+  task :finalize_update do
+    capez.var.link
+    capez.autoloads.generate
+  end
+
+  namespace :web do
+    desc <<-DESC
+      Puts a html file somewhere in the documentroot
+      This file is displayed by a RewriteRule if it exists
+    DESC
+    task :disable do
+    end
+
+    desc <<-DESC
+      Remove the html file so that the application is reachable
+    DESC
+    task :enable do
+    end
+  end
+  # End of namespace :deploy:web
+
+end
+
+namespace :capez do
+
+  namespace :cache do
+    desc <<-DESC
+      Clear caches the way it is configured in ezpublish.rb
+    DESC
+    # Caches are just cleared for the primary server
+    # Multiple server platform are supposed to use a cluster configuration (eZDFS/eZDBFS)
+    # and cache management is done via expiry.php which is managed by the cluster API
+    task :clear, :roles => :web, :only => { :primary => true } do
+      on_rollback do
+        clear
+      end
+      cache_list.each { |cache_tag| capture "cd #{current_path} && sudo -u #{webserver_user} php bin/php/ezcache.php --clear-tag=#{cache_tag}#{' --purge' if cache_purge}" }
+    end
+  end
+
+  namespace :var do
+    desc <<-DESC
+      Creates the needed folder within your remote(s) var directories
+    DESC
+    task :init_shared, :roles => :web do
+      run( "mkdir -p #{shared_path}/var/storage" )
+      siteaccess_list.each{ |siteaccess_identifier|
+        run( "mkdir -p #{shared_path}/var/#{siteaccess_identifier}/storage" )
+      }
+
+      fix_permissions( "#{shared_path}/var", webserver_user, webserver_group )
+    end
+
+    desc <<-DESC
+      Link .../shared/var into ../releases/[latest_release]/var
+    DESC
+    task :link, :roles => :web do
+      run( "mkdir #{latest_release}/var" )
+      siteaccess_list.each{ |siteaccess_identifier|
+        run( "mkdir #{latest_release}/var/#{siteaccess_identifier}" )
+      }
+
+      fix_permissions( "#{latest_release}/var", webserver_user, webserver_group )
+
+      try_sudo( "ln -s #{shared_path}/var/storage #{latest_release}/var/storage", :as => webserver_user )
+      siteaccess_list.each{ |siteaccess_identifier|
+        try_sudo( "ln -s #{shared_path}/var/#{siteaccess_identifier}/storage #{latest_release}/var/#{siteaccess_identifier}/storage", :as => webserver_user )
+      }
+    end
+
+    desc <<-DESC
+      Sync your var directory with a remote one
+    DESC
+    task :sync, :roles => :web, :only => { :primary => true } do
+      confirmation = Capistrano::CLI.ui.ask "You're about to sync your local var/ directory with a remote one (current stage = #{stage}). Are you sure (y/N) ?"
+      abort "Aborted" unless confirmation.downcase == 'y'
+
+      shared_host = fetch( :shared_host, nil )
+      abort "Please set 'shared_host'" if shared_host == nil
+
+      # TODO : make it configurable
+      exclude_string = ""
+      exclude_paths = [ "/cache", "/log", "/*/cache", "/*/log", "/autoload" ]
+      exclude_paths.each{ |item|
+        exclude_string << "--exclude '#{item}' "
+      }
+
+      run_locally( "rsync -az #{exclude_string} #{user}@#{shared_host}:#{shared_path}/var/* var/" )
+    end
+
+  end
+  # End of namespace :capez:var
+
+  # TODO : cache management must be aware of cluster setup  namespace :autoloads do
+  namespace :autoloads do
+    desc <<-DESC
+      Generates autoloads (extensions and kernel overrides)
+    DESC
+    task :generate do
+      on_rollback do
+        generate
+      end
+      autoload_list.each { |autoload|
+        capture( "cd #{latest_release} && sudo -u #{webserver_user} php bin/php/ezpgenerateautoloads.php --#{autoload}" )
+      }
+    end
+  end
+  # End of namespace :capez:autoloads
+
+  # Should be transformed in a simple function (not aimed to be called as a Cap task...)
+  namespace :dev do
+    desc <<-DESC
+      Checks if there are local changes or not (only with Git)
+      Considers that your main git repo is at the top of your eZ Publish install
+      If changes are detected, then ask the user to continue or not
+    DESC
+    task :local_check do
+      if "#{scm}" != "git" then
+        abort "Feature only available with git"
+      end
+
+      ezroot_path = fetch( :ezpublish_path, false )
+      abort "Please set a correct path to your eZ Publish root (:ezpublish_path) or add 'set :ezpublish_path, File.expand_path( File.dirname( __FILE__ ) )' in your Capfile" unless ezroot_path != false and File.exists?(ezroot_path)
+
+      git_status = git_status_result( ezroot_path )
+
+      ask_to_abort = false
+      puts "Checking your local git..."
+      if git_status['has_local_changes']
+        ask_to_abort = true
+        puts "You have local changes"
+      end
+      if git_status['has_new_files']
+        ask_to_abort = true
+        puts "You have new files"
+      end
+
+      if ask_to_abort
+        user_abort = Capistrano::CLI.ui.ask "Abort ? y/n (n)"
+        abort "Deployment aborted to commit/add local changes" unless user_abort == "n" or user_abort == ""
+      end
+
+      if git_status['tracked_branch_status'] == 'ahead'
+        puts "You have #{git_status['tracked_branch_commits']} commits that need to be pushed"
+        push_before = Capistrano::CLI.ui.ask "Push them before deployment ? y/n (y)"
+        if push_before == "" or push_before == "y"
+          system "git push"
+        end
+      end
+    end
+  end
+
+  def git_status_result(path)
+    result = Hash.new
+    result['has_local_changes'] = false
+    result['has_new_files'] = false
+    result['tracked_branch'] = nil
+    result['tracked_branch_status'] = nil
+    result['tracked_branch_commits'] = 0
+    cmd_result = `cd #{path} && git status 2> /dev/null`
+    result['raw_result'] = cmd_result
+    cmd_result_array = cmd_result.split( /\n/ );
+    cmd_result_array.each { |value|
+      case value
+        when /# Changes not staged for commit:/
+          result['has_local_changes'] = true
+        when /# Untracked files:/
+          result['has_new_files'] = true
+        when /# On branch (.*)$/
+          result['branch'] = $1
+        when /# Your branch is (.*) of '(.*)' by (.*) commits?/
+          result['tracked_branch_status'] = $1
+          result['tracked_branch'] = $2
+          result['tracked_branch_commits'] = $3
+      end
+      }
+      return result
+  end
+
+  def fix_permissions(path,userid,groupid)
+      # If admin_runner is not null then make sure that the command is not run with -u admin_runner
+      if fetch( :admin_runner, nil ) != nil
+        run( "sudo chown -R #{userid}:#{groupid} #{path}" )
+      else
+        try_sudo( "chown -R #{userid}:#{groupid} #{path}" )
+      end
+  end
+
+end

data/lib/db.rb

@@ -0,0 +1,67 @@
+namespace :db do
+  desc <<-DESC
+    Loads one of the backup made with the db:export:remote task
+  DESC
+  task :import_to_local do
+    confirmation = Capistrano::CLI.ui.ask "You are about to replace your local database by a remote backup (selected stage = #{stage}). Are you sure ? y/n (n)"
+    if confirmation == "n" or confirmation == ""
+      abort "Aborted"
+    end
+    backup_dir = File.join( get_backup_dir, "#{stage}" )
+    backup_list = `ls #{backup_dir}`
+    backup_files = backup_list.split( /\n/ );
+    files = Hash.new
+    i = 1
+    backup_files.each { |value|
+      puts "#{i}: #{value}"
+      files[i] = value
+      i += 1
+    }
+    file_to_import = Capistrano::CLI.ui.ask "Which one ?"
+    if files.has_key?( file_to_import.to_i )
+      filename = File.join( backup_dir, files[file_to_import.to_i] )
+      system( "gunzip < #{filename} | mysql -u#{database_uname} -p#{database_passd} #{database_name} ")
+    else
+      abort "Bad index"
+    end
+  end
+
+  # Should use :db as :roles
+  desc <<-DESC
+    Creates a backup from a remote database server
+  DESC
+  task :backup, :roles => :db do
+    filename = generate_backup_name
+    file = File.join( "/tmp", filename )
+      on_rollback do
+        run "rm #{file}"
+      end
+    run "mysqldump -u#{database_uname} -p#{database_passd} #{database_name} | gzip > #{file}"
+    backup_dir_for_this_stage = File.join( get_backup_dir, "#{stage}" )
+    create_backup_dir( backup_dir_for_this_stage )
+    get file, File.join( backup_dir_for_this_stage, filename )
+    run "rm #{file}"
+  end
+
+  desc <<-DESC
+    Create a backup from your local instance
+  DESC
+  task :backup_local do
+    backup_dir = File.join( get_backup_dir, 'local' )
+    create_backup_dir( backup_dir )
+    filename = File.join( backup_dir, generate_backup_name )
+    system("mysqldump -u#{database_uname} -p#{database_passd} #{database_name} | gzip -9 > #{filename}")
+  end
+
+  def generate_backup_name
+    return "#{Time.now.strftime '%Y-%m%d-%H%M%S'}.sql.gz"
+  end
+
+  def create_backup_dir( path )
+    FileUtils.mkdir_p( path )
+  end
+
+  def get_backup_dir
+    return "extension/alcapon/backups/database"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: alcapon
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Arnaud Lafon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 12
+        - 0
+        version: 2.12.0
+  type: :runtime
+  version_requirements: *id001
+description: Capistrano is a utility and framework for executing commands in parallel on multiple remote machines, via SSH. This package gives you some tools to deploy your eZ Publish projects.
+email: alcapon@arnaudlafon.com
+executables: 
+- capezit
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/capezit
+- lib/capez.rb
+- lib/db.rb
+- README.md
+- LICENSE.md
+homepage: http://alafon.github.com/alcapon
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Enable Capistrano for your eZ Publish projects
+test_files: []
+