alcapon 0.2.0 → 0.3.0

data/README.md

@@ -1,8 +1,30 @@
 # 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.
+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.
+IMPORTANT: this package is currently under development, please consider testing
+it on a preproduction environment before going further. Please also do read the
+"Known bugs" section carefully.
+
+## Changelog
+
+### 0.3.x
+
+ - added the possibility to trigger rename and in-file replace operations
+   during the deployment (see the generated file
+   config/deploy/production.rb after running the capezit command)
+
+ - major changes in permissions management for the var/ folders. Previous
+   versions tried to manage different cases by using sudo commands but I'm
+   convinced that it is not the right place to do that. Permissions have to be
+   handled by sysadmin, not Capistrano.
+   This will be improved, maybe simplified again, in next versions.
+   In consequence, you might experienced some issues, but please, let me know.
+
+ - usage of siteaccess_list in ezpublish.rb is deprecated as of 0.3.0. Please
+   use storage_directories instead (see issue #2)
 
 ## Requirements, installation & co
 

data/bin/capezit

@@ -69,6 +69,14 @@ files = {
     # Need if you want to deploy somewhere where sudo is needed
     default_run_options[:pty] = true
 
+    # Set debug level to IMPORTANT only
+    # Comment if you want to get more debug outputs
+    logger.level = Logger::IMPORTANT
+
+    # Override default feature (not needed for eZ Publish)
+    # If turned on, you will get a warning during deployment but it should not be aborted
+    set :normalize_asset_timestamps, false
+
     # 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
@@ -99,8 +107,9 @@ files = {
     # 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"
+    # By default, this is the user as the one used to connect via SSH
+    set :webserver_user, :user
+    set :webserver_group, :user
 
     # If true, will always turn your webserver offline
     # Requires a specific rewrite rule (see documentation)
@@ -117,15 +126,22 @@ files = {
     # your var directory (2012.5 for instance)
     set :cache_purge, false
 
-    # Siteaccess list, needed for setup & shared directory sync
-    #set :siteaccess_list, [ "ezflow_site" ]
+    # A list of var directories which will handle siteaccess's specific assets, such as
+    # the storage
+    #set :storage_directories, [ "ezflow_site" ]
 
     # Set this to tell Capistrano with which host you want to sync your local storage dir
     #set :shared_host, "domain.com"
 
+    # Changes the group of shared_children items (by default, webserver_group is used)
+    # If not set, permissions remain unchanged
+    #set :shared_children_group, "#{webserver_group}"
+
     # Which autoloads to generate. By default, regenerates extensions and
     # kernel-override autoloads
     # Possible values : see bin/php/ezpgenerateautoloads.php --help
+    # Feature can be disabled by using :
+    #set :autoload_list, []
     set :autoload_list, [ "extension", "kernel-override" ]
 
     # TODO : use yml files to manage database credentials securely
@@ -161,8 +177,8 @@ files = {
     #set :admin_runner, "sudouser"
 
     # This is used for permissions related tasks
-    #set :webserver_user, "www-data"
-    #set :webserver_group, "www-data"
+    #set :webserver_user, :user
+    #set :webserver_group, :user
   FILE
 
   "#{alcapon_path}/config/deploy/production.rb" => unindent(<<-FILE)
@@ -175,8 +191,18 @@ files = {
     #set :admin_runner, "sudouser"
 
     # This is used for permissions related tasks
-    #set :webserver_user, "apache"
-    #set :webserver_group, "apache"
+    #set :webserver_user, :user
+    #set :webserver_group, :user
+
+    #set :file_changes, {
+    #    'settings/override/site.ini.append.dist' => {
+    #        'rename' => 'settings/override/site.ini.append.php',
+    #        'replace' => {
+    #            '@tokens_database_host@' => 'prod-dbs',
+    #        },
+    #    }
+    #}
+
   FILE
   }
 

data/lib/capez.rb

@@ -1,16 +1,60 @@
 load_paths.push File.expand_path('../', __FILE__)
 load 'db.rb'
+require 'colored'
 
 # This will simply do chmod g+w on all dir
 # See task :setup
 set :group_writable, true
 
+# triggered after all recipes have loaded
+on :load do
+  if( fetch( :siteaccess_list, nil ) != nil )
+    abort "The usage of siteaccess_list in ezpublish.rb is deprecated as of 0.3.0.\nPlease use storage_directories instead".red
+  end
+end
+
+before "deploy:setup" do
+  print_dotted( "--> Creating default directories" )
+end
+
 after "deploy:setup", :roles => :web do
+  puts( " OK".green )
+  print_dotted( "--> Fixing permissions on deployment directory" )
+  try_sudo( "chown -R #{user} #{deploy_to}" ) # if not code checkout cannot be done :/
+  puts( " OK".green )
   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
+before "deploy:update_code" do
+  puts( "\n*** Building release ***" )
+  puts( "Started at " + Time.now.utc.strftime("%H:%M:%S") )
+  print_dotted( "--> Updating code", :sol => true )
+end
+
+after "deploy:update_code" do
+  puts( "\n*** Release ready ***".green )
+  puts( "Finished at " + Time.now.utc.strftime("%H:%M:%S") )
+end
+
+before "deploy:finalize_update" do
+  puts( " OK".green )
+  # Needed if you want to create extra shared directories under var/ with
+  # set :shared_children, [ "var/something",
+  #                         "var/something_else" ]
+  # Note that :shared_children creates a folder within shared which name is
+  # the last path element (ie: something or something_else) => that's why
+  # we cannot use it to create siteaccess storages (var/siteaccess/storage)
+  run( "mkdir #{latest_release}/var" )
+end
+
+after "deploy:finalize_update" do
+  if fetch( :shared_children_group, false )
+    shared_children.map { |d| run( "chgrp -R #{shared_children_group} #{shared_path}/#{d.split('/').last}") }
+  end
+  capez.var.init_release
+  capez.var.link
+  capez.settings.deploy
+  capez.autoloads.generate
   #capez.cache.clear
 end
 
@@ -23,15 +67,16 @@ after "deploy", :roles => :web do
   deploy.web.enable
 end
 
-namespace :deploy do
+before "deploy:create_symlink" do
+  print_dotted( "--> Going live (symlink)", :sol => true )
+end
 
-  desc <<-DESC
-    Finalize the update by creating symlink var -> shared/var
-  DESC
-  task :finalize_update do
-    capez.var.link
-    capez.autoloads.generate
-  end
+after "deploy:create_symlink" do
+  puts( " OK".green )
+end
+
+# Default behavior overrides
+namespace :deploy do
 
   namespace :web do
     desc <<-DESC
@@ -61,6 +106,116 @@ end
 
 
 namespace :capez do
+  namespace :settings do
+
+    def make_file_changes( options={} )
+
+      default_options = { :locally => false }
+      options = default_options.merge( options )
+
+      puts( "\n--> File operations" )
+
+      unless !(file_changes = get_file_changes) then
+
+        path = options[:locally] ? "" : "#{latest_release}/"
+
+        changes = 0
+        renames = 0
+        errors = []
+        messages = []
+
+        print_dotted( "execution", :eol_msg => (options[:locally] ? "local" : "distant" ), :eol => true, :max_length => 25 )
+        print_dotted( "files count", :eol_msg => "#{file_changes.count}", :eol => true, :max_length => 25 )
+
+        # process each files
+        print( "progress " )
+        file_changes.each { |filename,operations|
+
+          print( "." )
+
+          target_filename = filename
+          renamed = false
+
+          # rename operation is caught and executed at first
+          if operations.has_key?("rename")
+            if( target_filename != operations['rename'] )
+              target_filename = operations['rename']
+              cmd = "if [ -f #{path}#{filename} ]; then cp #{path}#{filename} #{path}#{target_filename}; fi;"
+              options[:locally] ? run_locally( "#{cmd}" ) : run( "#{cmd}" )
+              renames += 1
+            else
+              target_filename = operations['rename']
+              errors += ["target and original name are the same (#{target_filename})"]
+            end
+          end
+
+          operations.each { |operation,value|
+            case operation
+              when 'rename'
+              when 'replace'
+
+                if( value.count > 0 )
+
+                  # download file if necessary
+                  if options[:locally]
+                    tmp_filename = target_filename
+                  else
+                    tmp_filename = target_filename+".tmp"
+                    get "#{path}#{target_filename}", tmp_filename
+                  end
+
+                  text = File.read(tmp_filename)
+                  value.each { |search,replace|
+                    changes += 1
+                    text = text.gsub( "#{search}", "#{replace}" )
+                  }
+                  File.open(tmp_filename, "w") {|file| file.write(text) }
+
+                  # upload and remove temporary file
+                  if !options[:locally]
+                    run( "if [ -f #{target_filename} ]; then rm #{target_filename}; fi;" )
+                    upload( tmp_filename, "#{path}#{target_filename}" )
+                    run_locally( "rm #{tmp_filename}" )
+                  end
+                end
+              else
+                errors += ( "operation '#{operation}' supported" )
+            end
+          }
+        }
+        puts " done".green
+
+        # stats
+        print_dotted( "files renamed", :eol_msg => "#{renames}", :eol => true, :max_length => 25 )
+        print_dotted( "changes count", :eol_msg => "#{changes}", :eol => true, :max_length => 25 )
+        print_dotted( "changes avg / file", :max_length => 25, :eol_msg => ( file_changes.count > 0 ? "#{changes/file_changes.count}" : "" ), :eol => true )
+        messages.each { |msg| puts( "#{msg}") }
+        puts( "errors : ".red ) unless errors.count == 0
+        errors.each { |msg| puts( "- #{msg}".red ) }
+      else
+        puts( "No file changes needs to be applied. Please set :file_changes".blue )
+      end
+    end
+
+    desc <<-DESC
+      Makes some file level operations if needed (rename, replace)
+    DESC
+    task :deploy, :roles => :web do
+      make_file_changes
+    end
+
+    desc <<-DESC
+      [local] Makes some file level operations if needed (rename, replace)
+    DESC
+    task :deploy_locally, :roles => :web do
+      make_file_changes( :locally => true )
+    end
+
+    def get_file_changes
+      return fetch( :file_changes, false )
+    end
+
+  end
 
   namespace :cache do
     desc <<-DESC
@@ -70,10 +225,12 @@ namespace :capez do
     # 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}" }
+      puts( "\n--> Clearing caches #{'with --purge'.red if cache_purge}" )
+      cache_list.each { |cache_tag|
+        print_dotted( "#{cache_tag}" )
+        capture "cd #{current_path} && sudo -u #{webserver_user} php bin/php/ezcache.php --clear-tag=#{cache_tag}#{' --purge' if cache_purge}"
+        puts( " OK".green )
+      }
     end
   end
 
@@ -82,29 +239,65 @@ namespace :capez do
       Creates the needed folder within your remote(s) var directories
     DESC
     task :init_shared, :roles => :web do
+      puts( "--> Creating eZ Publish var directories" )
+      print_dotted( "var " )
+      run( "mkdir -p #{shared_path}/var" )
+      puts( " OK".green )
+
+      print_dotted( "var/storage" )
       run( "mkdir -p #{shared_path}/var/storage" )
-      siteaccess_list.each{ |siteaccess_identifier|
-        run( "mkdir -p #{shared_path}/var/#{siteaccess_identifier}/storage" )
+      puts( " OK".green )
+
+      storage_directories.each{ |sd|
+        print_dotted( "var/#{sd}/storage" )
+        run( "mkdir -p #{shared_path}/var/#{sd}/storage" )
+        puts( " OK".green )
+      }
+      run( "chmod -R g+w #{shared_path}/var")
+      run( "chown -R #{fetch(:webserver_group,:user)} #{shared_path}/var")
+    end
+
+
+
+    desc <<-DESC
+      [internal] Creates release directories
+    DESC
+    task :init_release, :roles => :web do
+      puts( "\n--> Release directories" )
+
+      # creates a storage dir for elements specified by :storage_directories
+      storage_directories.each{ |sd|
+        print_dotted( "var/#{sd}/storage" )
+        run( "mkdir #{latest_release}/var/#{sd}" )
+        puts( " OK".green )
       }
 
-      fix_permissions( "#{shared_path}/var", webserver_user, webserver_group )
+      # makes sure the webserver can write into var/
+      run( "chmod -R g+w #{latest_release}/var")
+      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/var")
+      # needed even if we just want to run 'bin/php/ezpgenerateautoloads.php' with --extension
+      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{latest_release}/autoload")
     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}" )
-      }
+      puts( "\n--> Symlinks" )
 
-      fix_permissions( "#{latest_release}/var", webserver_user, webserver_group )
+      print_dotted( "var/storage" )
+      run( "ln -s #{shared_path}/var/storage #{latest_release}/var/storage" )
+      puts( " OK".green )
 
-      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 )
+      storage_directories.each{ |sd|
+        print_dotted( "var/#{sd}/storage" )
+        run( "ln -s #{shared_path}/var/#{sd}/storage #{latest_release}/var/#{sd}/storage", :as => webserver_user )
+        #run( "chmod -h g+w #{latest_release}/var/#{sd}/storage")
+        puts( " OK".green )
       }
+
+      run( "chmod -R g+w #{latest_release}/var")
+      run( "chown -R #{fetch(:webserver_user,:user)}:#{fetch(:webserver_group,:user)} #{shared_path}/var")
     end
 
     desc <<-DESC
@@ -159,12 +352,17 @@ namespace :capez do
       Generates autoloads (extensions and kernel overrides)
     DESC
     task :generate do
-      on_rollback do
-        generate
+      if autoload_list.count == 0
+        print_dotted( "--> eZ Publish autoloads (disabled)", :sol => true )
+        puts( " OK".green )
+      else
+        puts( "\n--> eZ Publish autoloads " )
+        autoload_list.each { |autoload|
+          print_dotted( "#{autoload}" )
+          capture( "cd #{latest_release} && sudo -u #{webserver_user} php bin/php/ezpgenerateautoloads.php --#{autoload}" )
+          puts( " OK".green )
+        }
       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
@@ -172,7 +370,7 @@ namespace :capez do
   # 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)
+      Checks changes on your local installation
       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
@@ -184,26 +382,26 @@ namespace :capez do
       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)
 
+      puts( "\n--> Local installation check with git status" )
       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"
+        puts( "    - You have local changes" )
       end
       if git_status['has_new_files']
         ask_to_abort = true
-        puts "You have new files"
+        puts( "    - You have untracked files (not under git control)" )
       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 == ""
+        user_abort = Capistrano::CLI.ui.ask "    Abort ? y/n (n)"
+        abort "Deployment aborted to commit/add local changes".red 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"
+        print "    - 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"
@@ -248,4 +446,29 @@ namespace :capez do
       end
   end
 
+
+end
+
+def print_dotted( message, options={} )
+  defaults_options = { :eol => false,
+                       :sol => false,
+                       :max_length => 40,
+                       :eol_msg => false }
+
+  options = defaults_options.merge( options )
+  message = "#{message} " + "." * [0,options[:max_length]-message.length-1].max
+
+  if options[:sol]
+    message = "\n#{message}"
+  end
+
+  if options[:eol_msg]
+    message += " #{options[:eol_msg]}"
+  end
+
+  if options[:eol]
+    puts message
+  else
+    print message
+  end
 end

data/lib/ext/spinner.rb

@@ -0,0 +1,26 @@
+# spinner stuff
+# inspired from http://jondavidjohn.com/blog/2012/04/cleaning-up-capistrano-deployment-output
+@spinner_running = false
+@chars = ['|', '/', '-', '\\']
+@spinner = Thread.new do
+  loop do
+    unless @spinner_running
+      Thread.stop
+    end
+    print @chars[0]
+    sleep(0.1)
+    print "\b"
+    @chars.push @chars.shift
+  end
+end
+
+def start_spinner
+  @spinner_running = true
+  @spinner.wakeup
+end
+
+# stops the spinner and backspaces over last displayed character
+def stop_spinner
+  @spinner_running = false
+  print "\b"
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Arnaud Lafon
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-18 00:00:00 +02:00
+date: 2012-11-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,19 @@ dependencies:
         version: 2.12.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: colored
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
 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: 
@@ -43,6 +56,7 @@ files:
 - bin/capezit
 - lib/capez.rb
 - lib/db.rb
+- lib/ext/spinner.rb
 - README.md
 - LICENSE.md
 has_rdoc: true