capistrano-base_helper 0.0.5 → 0.0.6

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/capistrano-base_helper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "capistrano-base_helper"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Leif Ringstad"]
-  s.date = "2013-07-05"
+  s.date = "2013-07-08"
   s.description = "Helpers for capistrano recipes using runit/monit. Currently: capistrano-puma and capistrano-delayed_job"
   s.email = "leifcr@gmail.com"
   s.extra_rdoc_files = [

data/lib/capistrano/base_helper/base_helper.rb

@@ -25,7 +25,11 @@ module Capistrano
     end
 
     def user_app_env_underscore
-      "#{get_capistrano_instance.fetch(:user)}_#{get_capistrano_instance.fetch(:application)}_#{environment}"
+      "#{@@capistrano_instance.fetch(:user)}_#{@@capistrano_instance.fetch(:application)}_#{environment}"
+    end
+
+    def user_app_env_underscore_short
+      "#{@@capistrano_instance.fetch(:user)[0...1]}_#{environment[0...1]}_#{@@capistrano_instance.fetch(:application)}"
     end
 
     def user_app_env_path
@@ -93,7 +97,7 @@ module Capistrano
       @@capistrano_instance.upload temp_file, temp_file, :via => :scp
       # create any folders required,
       # move temporary file to remote file
-      @@capistrano_instance.run "#{use_sudo ? "sudo" : ""} mkdir -p #{Pathname.new(remote_file).dirname}; #{use_sudo ? "sudo" : ""} mv #{temp_file} #{remote_file}"
+      @@capistrano_instance.run "#{use_sudo ? @@capistrano_instance.sudo : ""} mkdir -p #{Pathname.new(remote_file).dirname}; #{use_sudo ? "sudo" : ""} mv #{temp_file} #{remote_file}"
       # remove temp file
       `rm #{temp_file}`
     end
@@ -115,9 +119,9 @@ module Capistrano
 
     def prepare_path(path, user, group, use_sudo = false)
       commands = []
-      commands << "#{use_sudo ? "sudo" : ""} mkdir -p #{path}"
-      commands << "#{use_sudo ? "sudo" : ""} chown #{user}:#{group} #{path} -R" 
-      commands << "#{use_sudo ? "sudo" : ""} chmod +rw #{path}"
+      commands << "#{use_sudo ? @@capistrano_instance.sudo : ""} mkdir -p #{path}"
+      commands << "#{use_sudo ? @@capistrano_instance.sudo : ""} chown #{user}:#{group} #{path} -R" 
+      commands << "#{use_sudo ? @@capistrano_instance.sudo : ""} chmod +rw #{path}"
       @@capistrano_instance.run commands.join(" &&")
     end
 

data/lib/capistrano/base_helper/monit_base.rb

@@ -1,8 +1,13 @@
-# TODO: PLACE monit files like this
-# shared_path/monit/available
-# shared_path/monit/enabled
-# shared_path/monit/application.conf <-- in this: include shared_path/monit/enabled
-# files can then belong to user instead of root, and sudo is avoided for some apps
+# Monit Base config
+# Shared config for all apps that use monit
+#
+# Monit service config locations:
+# Available services: shared_path/monit/available
+# Enabled services: shared_path/monit/enabled
+# Application "global" config: shared_path/monit/application.conf <-- in this: include shared_path/monit/enabled
+# 
+# For control of monit, sudo is required, as it always runs as root. (Unfortunately.)
+#
 
 Capistrano::Configuration.instance(true).load do
   _cset :monit_dir,            defer { File.join(shared_path, "monit") }
@@ -70,15 +75,15 @@ Capistrano::Configuration.instance(true).load do
         Capistrano::BaseHelper::generate_and_upload_config(fetch(:monit_local_monitrc), fetch(:monit_remote_monitrc), true)
 
         commands = []
-        commands << "sudo chmod 700 /etc/monit/monitrc"
-        commands << "sudo chown root:root /etc/monit/monitrc"
+        commands << "#{sudo} chmod 700 /etc/monit/monitrc"
+        commands << "#{sudo} chown root:root /etc/monit/monitrc"
         run commands.join(" && ")
         # restart monit, as main config is now updated
-        run "sudo service monit restart"
+        run "#{sudo} service monit restart"
         puts "----------------------------------------"
-        puts "Sleeping for #{(fetch(:monit_daemon_time).to_i + fetch(:monit_start_delay).to_i + 2)} seconds to wait for monit to be ready"
+        puts "Sleeping for #{(fetch(:monit_daemon_time).to_i + fetch(:monit_start_delay).to_i + 10)} seconds to wait for monit to be ready"
         puts "----------------------------------------"
-        sleep (fetch(:monit_daemon_time).to_i + fetch(:monit_start_delay).to_i + 2)
+        sleep (fetch(:monit_start_delay).to_i + 2)
       end
     end
 
@@ -87,20 +92,20 @@ Capistrano::Configuration.instance(true).load do
       real_conf   = File.join(fetch(:monit_dir), "monit.conf")
       symlink   = File.join(fetch(:monit_etc_conf_d_path), "#{Capistrano::BaseHelper.user_app_env_underscore}.conf")
       # symlink to include file
-      run("[ -h #{symlink} ] || sudo ln -sf #{real_conf} #{symlink}")
+      run("[ -h #{symlink} ] || #{sudo} ln -sf #{real_conf} #{symlink}")
     end
  
     desc "Disable monit services for application"
     task :disable, :roles => [:app, :db, :web] do
       symlink   = File.join(fetch(:monit_etc_conf_d_path), "#{Capistrano::BaseHelper.user_app_env_underscore}.conf")
-      run("[ ! -h #{symlink} ] || sudo rm -f #{symlink}")
+      run("[ ! -h #{symlink} ] || #{sudo} rm -f #{symlink}")
     end
 
     desc "Purge/remove all monit configurations for the application"
     task :purge, :roles => [:app, :db, :web] do
         symlink   = File.join(fetch(:monit_etc_conf_d_path), "#{Capistrano::BaseHelper.user_app_env_underscore}.conf")
-      run("[ ! -h #{symlink} ]   || sudo rm -f #{symlink}")
-      run("[ ! -d #{fetch(:monit_dir)} ] || sudo rm -f #{fetch(:monit_dir)}")
+      run("[ ! -h #{symlink} ]   || #{sudo} rm -f #{symlink}")
+      run("[ ! -d #{fetch(:monit_dir)} ] || #{sudo} rm -f #{fetch(:monit_dir)}")
     end
 
     desc "Monitor the application"
@@ -167,7 +172,8 @@ module Capistrano
       ##
       # Control / Command monit with given arguments
       def command_monit(command, arguments="")
-        Capistrano::BaseHelper.get_capistrano_instance.run("sudo monit #{arguments} #{command}")
+        c = Capistrano::BaseHelper.get_capistrano_instance
+        c.run("#{c.sudo} monit #{arguments} #{command}")
       end
 
     end
@@ -184,7 +190,7 @@ module Capistrano
       def command_monit(command, service_name="", arguments="")
         c = Capistrano::BaseHelper.get_capistrano_instance
         service_name = "#{c.fetch(:user)}_#{c.fetch(:application)}_#{c.fetch(:environment)}_#{c.fetch(:service)}" if service_name == ""
-        c.run("sudo monit #{arguments} #{command} #{service_name}")
+        c.run("#{c.sudo} monit #{arguments} #{command} #{service_name}")
       end
 
       ##

data/lib/capistrano/base_helper/runit_base.rb

@@ -1,3 +1,9 @@
+# Runit
+# 
+# Application config and tasks that apply to all services setup with runit for the application
+#
+# Recommendation: Everything that should run as either a service or deamon, use runit!
+
 Capistrano::Configuration.instance(true).load do
   _cset :runit_dir, defer { "#{shared_path}/runit" }
   _cset :runit_local_run,     File.join(File.expand_path(File.join(File.dirname(__FILE__),"../../../templates")), "runit",  "run.erb")
@@ -8,6 +14,9 @@ Capistrano::Configuration.instance(true).load do
   _cset :runit_remote_log_run, defer {File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}
   _cset :runit_log_user, "syslog"
   _cset :runit_log_group, "syslog"
+  _cset :runit_restart_interval, 10
+  _cset :runit_restart_count, 7
+  _cset :runit_autorestart_clear_interval, 90
 
   after "deploy:update", "runit:enable"
   after "deploy:setup", "runit:setup"
@@ -23,7 +32,7 @@ Capistrano::Configuration.instance(true).load do
 
     desc "Disable runit services for application"
     task :disable, :roles => [:app, :db, :web] do
-      Capistrano::BaseHelper.get_capistrano_instance.run("sudo sv force-stop #{user}_#{application}; true")
+      Capistrano::BaseHelper.get_capistrano_instance.run("#{sudo} sv force-stop #{user}_#{application}; true")
       Capistrano::RunitBase.app_services_disable(fetch(:application), fetch(:user))
     end
 
@@ -34,7 +43,7 @@ Capistrano::Configuration.instance(true).load do
 
     desc "Purge/remove all runit configurations for the application"
     task :purge, :roles => [:app, :db, :web] do
-      Capistrano::BaseHelper.get_capistrano_instance.run("sudo sv force-stop #{user}_#{application}; true")
+      Capistrano::BaseHelper.get_capistrano_instance.run("#{sudo} sv force-stop #{user}_#{application}; true")
       Capistrano::RunitBase.app_services_purge(fetch(:application), fetch(:user))
     end
 
@@ -77,17 +86,17 @@ module Capistrano
     def app_services_create_log_service
       c = Capistrano::BaseHelper.get_capistrano_instance
       commands = []
-      commands << "sudo mkdir -p #{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log")}"
-      commands << "sudo chown #{c.fetch(:user)}:root #{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log")}"
-      commands << "sudo mkdir -p '#{File.join("/var", "log", "service", Capistrano::BaseHelper.user_app_env_path, "runit")}'"
-      commands << "sudo chown -R #{c.fetch(:runit_log_user)}:#{c.fetch(:runit_log_group)} '#{File.join("/var", "log", "service", Capistrano::BaseHelper.user_app_env_path, "runit")}'"
+      commands << "#{c.sudo} mkdir -p #{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log")}"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root #{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log")}"
+      commands << "#{c.sudo} mkdir -p '#{File.join("/var", "log", "service", Capistrano::BaseHelper.user_app_env_path, "runit")}'"
+      commands << "#{c.sudo} chown -R #{c.fetch(:runit_log_user)}:#{c.fetch(:runit_log_group)} '#{File.join("/var", "log", "service", Capistrano::BaseHelper.user_app_env_path, "runit")}'"
 
       c.run(commands.join(" && "))
       Capistrano::BaseHelper.generate_and_upload_config( c.fetch(:runit_local_log_run), c.fetch(:runit_remote_log_run), true )
       commands = []
-      commands << "sudo chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
-      commands << "sudo chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
-      commands << "sudo chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
+      commands << "#{c.sudo} chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
+      commands << "#{c.sudo} chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "log", "run")}'"
       c.run(commands.join(" && ")) 
     end
 
@@ -96,41 +105,44 @@ module Capistrano
     def app_services_create
       # SEE http://off-the-stack.moorman.nu/posts/5-user-services-with-runit/ for info on scripts
       c = Capistrano::BaseHelper.get_capistrano_instance
-      c.run("sudo mkdir -p '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path)}'")
+      c.run("#{c.sudo} mkdir -p '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path)}'")
       
       commands = []
-      commands << "sudo chown #{c.fetch(:user)}:root /etc/sv/#{c.fetch(:user)}"
-      commands << "sudo chown #{c.fetch(:user)}:root /etc/sv/#{Capistrano::BaseHelper.user_app_env_path}"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root /etc/sv/#{c.fetch(:user)}"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root /etc/sv/#{Capistrano::BaseHelper.user_app_env_path}"
       c.run(commands.join(" && "))
       Capistrano::BaseHelper.generate_and_upload_config( Capistrano::BaseHelper::get_capistrano_instance.fetch(:runit_local_run), Capistrano::BaseHelper::get_capistrano_instance.fetch(:runit_remote_run), true )
       Capistrano::BaseHelper.generate_and_upload_config( Capistrano::BaseHelper::get_capistrano_instance.fetch(:runit_local_finish), Capistrano::BaseHelper::get_capistrano_instance.fetch(:runit_remote_finish), true )
 
       commands = []
-      commands << "sudo chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
-      commands << "sudo chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
-      commands << "sudo chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
-      commands << "sudo chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
-      commands << "sudo chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
-      commands << "sudo chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
+      commands << "#{c.sudo} chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
+      commands << "#{c.sudo} chmod u+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
+      commands << "#{c.sudo} chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
+      commands << "#{c.sudo} chmod g+x '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "run")}'"
+      commands << "#{c.sudo} chown #{c.fetch(:user)}:root '#{File.join("/etc", "sv", Capistrano::BaseHelper.user_app_env_path, "finish")}'"
       c.run(commands.join(" && "))
 
       Capistrano::RunitBase.app_services_create_log_service
     end
 
     def app_services_enable(application, user)
-      Capistrano::BaseHelper.get_capistrano_instance.run("[ -h /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment} ] || sudo ln -sf /etc/sv/#{Capistrano::BaseHelper.user_app_env_path} /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}")
+      c = Capistrano::BaseHelper.get_capistrano_instance
+      Capistrano::BaseHelper.get_capistrano_instance.run("[ -h /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment} ] || #{c.sudo} ln -sf /etc/sv/#{Capistrano::BaseHelper.user_app_env_path} /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}")
     end
 
     def app_services_disable(application, user)
-      Capistrano::BaseHelper.get_capistrano_instance.run("[ ! -h /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment} ] || sudo rm -f /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}")
+      c = Capistrano::BaseHelper.get_capistrano_instance
+      Capistrano::BaseHelper.get_capistrano_instance.run("[ ! -h /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment} ] || #{c.sudo} rm -f /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}")
     end
 
     def app_services_purge(application, user)
       # this should stop ALL services running for the given application
       # true is appended to ignore any errors failing to stop the services
+      c = Capistrano::BaseHelper.get_capistrano_instance
       commands = []
-      commands << "sudo rm -f /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}"
-      commands << "sudo rm -rf /etc/sv/#{Capistrano::BaseHelper.user_app_env_path}"
+      commands << "#{c.sudo} rm -f /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment}"
+      commands << "#{c.sudo} rm -rf /etc/sv/#{Capistrano::BaseHelper.user_app_env_path}"
       Capistrano::BaseHelper.get_capistrano_instance.run(commands.join(" && "))
     end
 
@@ -147,7 +159,8 @@ module Capistrano
     end
 
     def app_services_control(application, user, command, ignore_error = false)
-      Capistrano::BaseHelper.get_capistrano_instance.run("[ ! -h /etc/service/#{user}_#{application} ] || sudo sv #{command} #{user}_#{application}; #{"true" if ignore_error != false}")
+      c = Capistrano::BaseHelper.get_capistrano_instance
+      Capistrano::BaseHelper.get_capistrano_instance.run("[ ! -h /etc/service/#{user}_#{application}_#{Capistrano::BaseHelper.environment} ] || #{c.sudo} sv #{command} #{user}_#{application}_#{Capistrano::BaseHelper.environment}; #{"true" if ignore_error != false}")
     end
 
     # END - ALL services functions (functions that affects all services for the app)
@@ -185,9 +198,9 @@ module Capistrano
       Capistrano::BaseHelper.get_capistrano_instance.run("[ ! -h #{service_path(service_name)}/run ] || rm -f #{service_path(service_name)}/run && rm -f #{service_path(service_name)}/finish")
     end
 
-    def enable_service(service_name, symlink_finish = nil)
+    def enable_service(service_name)
       Capistrano::BaseHelper.get_capistrano_instance.run("cd #{service_path(service_name)} && [ -h ./run ] || ln -sf #{remote_run_config_path(service_name)} ./run")
-      Capistrano::BaseHelper.get_capistrano_instance.run("cd #{service_path(service_name)} && [ -h ./finish ] || ln -sf #{remote_finish_config_path(service_name)} ./finish") unless symlink_finish.nil?
+      Capistrano::BaseHelper.get_capistrano_instance.run("cd #{service_path(service_name)} && [ -h ./finish ] || ln -sf #{remote_finish_config_path(service_name)} ./finish")
     end
 
     def purge_service(service_name)
@@ -220,6 +233,10 @@ module Capistrano
         commands << "chmod u+x #{Capistrano::RunitBase.remote_run_config_path(service_name)}"
         commands << "chmod g+x #{Capistrano::RunitBase.remote_run_config_path(service_name)}"
       end
+      if Capistrano::BaseHelper::remote_file_exists?(Capistrano::RunitBase.remote_finish_config_path(service_name))
+        commands << "chmod u+x #{Capistrano::RunitBase.remote_finish_config_path(service_name)}"
+        commands << "chmod g+x #{Capistrano::RunitBase.remote_finish_config_path(service_name)}"
+      end
       if Capistrano::BaseHelper::remote_file_exists?(Capistrano::RunitBase.remote_service_log_run_path(service_name))
         commands << "chmod u+x #{Capistrano::RunitBase.remote_service_log_run_path(service_name)}"
         commands << "chmod g+x #{Capistrano::RunitBase.remote_service_log_run_path(service_name)}"
@@ -236,12 +253,13 @@ module Capistrano
     def create_and_permissions_on_path(log_path, user = nil, group = nil)
       user  = Capistrano::BaseHelper.get_capistrano_instance.fetch(:user) if user.nil?
       group = "syslog" if group.nil?
+      c = Capistrano::BaseHelper.get_capistrano_instance
       # will use sudo
       commands = []
-      commands << "sudo mkdir -p #{log_path}"
-      commands << "sudo chown -R #{user}:#{group} #{log_path}"
-      commands << "sudo chmod u+w #{log_path}"
-      commands << "sudo chmod g+w #{log_path}"
+      commands << "#{c.sudo} mkdir -p #{log_path}"
+      commands << "#{c.sudo} chown -R #{user}:#{group} #{log_path}"
+      commands << "#{c.sudo} chmod u+w #{log_path}"
+      commands << "#{c.sudo} chmod g+w #{log_path}"
       Capistrano::BaseHelper.get_capistrano_instance.run commands.join(" && ")
     end
 

data/templates/runit/finish.erb

@@ -2,5 +2,12 @@
 # <% c = Capistrano::BaseHelper::get_capistrano_instance %>
 # Finish/quit services for <%= c.fetch(:application) %> as <%= c.fetch(:user) %> in env <%= Capistrano::BaseHelper.environment %>
 #
+# Announce termination
+#
+echo "Stopping all services for <%= c.fetch(:application) %> running as <%= c.fetch(:user) %>"
+
+# Force all services to stop
 sv -w600 force-stop '<%= c.fetch(:runit_dir) %>/*'
+
+# "Exit" all services
 sv exit '<%= c.fetch(:runit_dir) %>/*'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-base_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2866187985074734245
+      hash: 1132387968025362262
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: