mina-sidekiq 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 340eecbce7bf98675a29f44bb6f973101dd8a205
-  data.tar.gz: 427b634f9fb14312e0d1fb28912fe9bf9bf3741d
+  metadata.gz: b00138ad54880e131c60c2d955511bbfbdd9d262
+  data.tar.gz: f66cdab70f47c85ac99a0a7ffaaa5d04e79e3cfb
 SHA512:
-  metadata.gz: e90a545139b3b2229fbda1817df1367f0ed48d99d438640138e7bf0c86738d00183c005f504c0ebdf8382c1fe98c85501c7b90cd5fdbb2845c57835884065338
-  data.tar.gz: 80988e5e13a94bdabcc296564d325318d2a1a23a9a11180a9c7b17bfd16e5eeebcf222c92a404fd29c93297541a035c0980dee79ba93b472aaa521ac5ca96827
+  metadata.gz: 7ce054e9deb259727dcd88232968ce6dc07d8a9cf921e3680277f3e250fa91be3fcbdb0e6146c5c957ebd8c03910e84d47eb2f18c7d48496474c3c3b5dd559e2
+  data.tar.gz: 66ef72fcfc9521ef8e4938e285b4c1384088edf353d61c8da5b14e7538eb6f53521b0cea8e0021a267a56686b9a7e74c7297e65157e7c927bd40217b0e992d64

data/.gitignore

@@ -16,3 +16,4 @@ tmp
 .yardoc
 _yardoc
 doc/
+test_env/deploy/

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+services: redis
+env: FORCE_ADD_SSH_KEY=1

data/Changelog.md

@@ -0,0 +1,14 @@
+Changelog
+=========
+
+0.2.0 2013-08-18
+----------------
+
+Breaking Changes:
+
+* to load the tasks requiring 'mina_sidekiq/tasks' is needed now
+
+Enhancements:
+
+* add sidekiq_processes to allow launching multiple sidekiq instances
+* improved checking, if old instances of sidekiq are still running

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    mina-sidekiq (0.2.0)
+      mina
+
+GEM
+  remote: http://www.rubygems.org/
+  specs:
+    mina (0.3.0)
+      open4
+      rake
+    open4 (1.3.0)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mina-sidekiq!

data/README.md

@@ -1,6 +1,8 @@
 mina-sidekiq
 ============
 
+[![Build Status](https://travis-ci.org/Mic92/mina-sidekiq.png?branch=master)](https://travis-ci.org/Mic92/mina-sidekiq)
+
 mina-sidekiq is a gem that adds tasks to aid in the deployment of [Sidekiq] (http://mperham.github.com/sidekiq/)
 using [Mina] (http://nadarei.co/mina).
 
@@ -12,14 +14,25 @@ using [Mina] (http://nadarei.co/mina).
 
 ## Example
 
-    require 'mina-sidekiq'
+## Usage example
+
+    require 'mina_sidekiq/tasks'
     ...
+    # to make logs persistent between deploys
+    set :shared_paths, ['log']
+
+    task :setup do
+      # sidekiq needs a place to store its pid file and log file
+      queue! %[mkdir -p "#{deploy_to}/shared/pids/"]
+      queue! %[mkdir -p "#{deploy_to}/shared/log/"]
+    end
 
-    task :deploy => :enviroment do
+    task :deploy do
       deploy do
         # stop accepting new workers
         invoke :'sidekiq:quiet'
         invoke :'git:clone'
+        invoke :'deploy:link_shared_paths'
         ...
 
         to :launch do
@@ -43,6 +56,7 @@ using [Mina] (http://nadarei.co/mina).
 * sidekiq\_timeout: Sets a upper limit of time a worker is allowed to finish, before it is killed.
 * sidekiq\_log: Sets the path to the log file of sidekiq
 * sidekiq\_pid: Sets the path to the pid file of a sidekiq worker
+* sidekiq_processes: Sets the number of sidekiq processes launched
 
 ## Copyright
 

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+
+desc 'Run integration tests'
+task :test do
+  Dir.chdir("#{Rake.original_dir}/test_env") do
+    if ENV['FORCE_ADD_SSH_KEY']
+      force_add_ssh_key
+    end
+
+    FileUtils.rm_rf('deploy')
+    sh 'mina setup --verbose'
+    begin
+      # fresh deploy
+      sh 'mina deploy --verbose'
+      # second deploy
+      sh 'mina deploy --verbose'
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace.inspect
+      log = "./deploy/shared/sidekiq.log"
+      if File.exists?(log)
+        puts "cat #{log}"
+        puts File.open(log).read
+      end
+    end
+  end
+end
+
+def force_add_ssh_key(&block)
+  ssh_key = File.expand_path("~/.ssh/id_rsa.pub")
+  unless File.exists?(ssh_key)
+    sh "ssh-keygen -t rsa -N '' -f ~/.ssh/id_rsa"
+  end
+  file = File.open(ssh_key)
+  pub_key = file.readline
+  file.close
+
+  authorized_keys = File.expand_path("~/.ssh/authorized_keys")
+  begin
+    File.open(authorized_keys, 'a+') do |f|
+      File.chmod(0600, authorized_keys)
+      f.puts(pub_key)
+    end
+  rescue Exception => e
+    puts e.message
+    puts e.backtrace.inspect
+  ensure
+    File.chmod(0400, authorized_keys)
+  end
+end
+
+task :default => :test

data/lib/mina_sidekiq/tasks.rb

@@ -0,0 +1,121 @@
+# # Modules: Sidekiq
+# Adds settings and tasks for managing Sidekiq workers.
+#
+# ## Usage example
+#     require 'mina_sidekiq/tasks'
+#     ...
+#     task :setup do
+#       # sidekiq needs a place to store its pid file
+#       queue! %[mkdir -p "#{deploy_to}/shared/pids/"]
+#     end
+#
+#     task :deploy do
+#       deploy do
+#         invoke :'sidekiq:quiet'
+#         invoke :'git:clone'
+#         ...
+#
+#         to :launch do
+#           ...
+#           invoke :'sidekiq:restart'
+#         end
+#       end
+#     end
+
+require 'mina/bundler'
+require 'mina/rails'
+
+# ## Settings
+# Any and all of these settings can be overriden in your `deploy.rb`.
+
+# ### sidekiq
+# Sets the path to sidekiq.
+set_default :sidekiq, lambda { "#{bundle_bin} exec sidekiq" }
+
+# ### sidekiqctl
+# Sets the path to sidekiqctl.
+set_default :sidekiqctl, lambda { "#{bundle_prefix} sidekiqctl" }
+
+# ### sidekiq_timeout
+# Sets a upper limit of time a worker is allowed to finish, before it is killed.
+set_default :sidekiq_timeout, 10
+
+# ### sidekiq_config
+# Sets the path to the configuration file of sidekiq
+set_default :sidekiq_config, "./config/sidekiq.yml"
+
+# ### sidekiq_log
+# Sets the path to the log file of sidekiq
+#
+# To disable logging set it to "/dev/null"
+set_default :sidekiq_log, lambda { "#{deploy_to}/#{current_path}/log/sidekiq.log" }
+
+# ### sidekiq_pid
+# Sets the path to the pid file of a sidekiq worker
+set_default :sidekiq_pid, lambda { "#{deploy_to}/#{shared_path}/pids/sidekiq.pid" }
+
+# ### sidekiq_processes
+# Sets the number of sidekiq processes launched
+set_default :sidekiq_processes, 1
+
+# ## Control Tasks
+namespace :sidekiq do
+  def for_each_process(&block)
+    sidekiq_processes.times do |idx|
+      pid_file = if idx == 0
+                   sidekiq_pid
+                 else
+                   "#{sidekiq_pid}-#{idx}"
+                 end
+      yield(pid_file, idx)
+    end
+  end
+
+  # ### sidekiq:quiet
+  desc "Quiet sidekiq (stop accepting new work)"
+  task :quiet do
+    queue %[echo "-----> Quiet sidekiq (stop accepting new work)"]
+    for_each_process do |pid_file, idx|
+      queue %{
+        if [ -d #{deploy_to}/#{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
+          #{echo_cmd %{cd #{deploy_to}/#{current_path} && #{sidekiqctl} quiet #{pid_file}} }
+        else
+          echo 'Sidekiq is not running'
+        fi
+      }
+    end
+  end
+
+  # ### sidekiq:stop
+  desc "Stop sidekiq"
+  task :stop do
+    queue %[echo "-----> Stop sidekiq"]
+    for_each_process do |pid_file, idx|
+      queue %[
+        if [ -d #{deploy_to}/#{current_path} ] && [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
+          #{echo_cmd %[cd #{deploy_to}/#{current_path} && #{sidekiqctl} stop #{pid_file} #{sidekiq_timeout}]}
+        else
+          echo 'Sidekiq is not running'
+        fi
+      ]
+    end
+  end
+
+  # ### sidekiq:start
+  desc "Start sidekiq"
+  task :start do
+    queue %[echo "-----> Start sidekiq"]
+    for_each_process do |pid_file, idx|
+      queue %{
+        #{echo_cmd %[cd #{deploy_to}/#{current_path}; nohup #{sidekiq} -e #{rails_env} -C #{sidekiq_config} -P #{pid_file} >> #{sidekiq_log} 2>&1 &] }
+      }
+    end
+  end
+
+  # ### sidekiq:restart
+  desc "Restart sidekiq"
+  task :restart do
+    invoke :'sidekiq:stop'
+    invoke :'sidekiq:start'
+  end
+end

data/lib/mina_sidekiq/version.rb

@@ -0,0 +1,5 @@
+module MinaSidekiq
+  def self.version
+    "0.2.0"
+  end
+end

data/lib/mina_sidekiq.rb

@@ -0,0 +1,4 @@
+require 'mina_sidekiq/version'
+
+module MinaSidekiq
+end

data/mina-sidekiq.gemspec

@@ -1,8 +1,10 @@
 # -*- encoding: utf-8 -*-
 
+require "./lib/mina_sidekiq/version.rb"
+
 Gem::Specification.new do |s|
   s.name = "mina-sidekiq"
-  s.version = File.read('VERSION')
+  s.version = MinaSidekiq.version
   s.authors = ["Joerg Thalheim"]
   s.email = ["joerg@higgsboson.tk"]
   s.homepage = "http://github.com/Mic92/mina-sidekiq"
@@ -14,6 +16,13 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.post_install_message = <<-MESSAGE
+Starting with 0.2.0, you have to add:
+
+    require 'mina_sidekiq/tasks'
+
+in your deploy.rb to load the library
+MESSAGE
 
   s.add_runtime_dependency "mina"
 end

data/test_env/config/deploy.rb

@@ -0,0 +1,46 @@
+require 'mina'
+require 'mina/git'
+require 'mina_sidekiq/tasks'
+require 'mina/git'
+require 'mina/bundler'
+require 'mina/rvm'
+require 'fileutils'
+
+FileUtils.mkdir_p "#{Dir.pwd}/deploy"
+
+set :ssh_options, '-o StrictHostKeyChecking=no'
+
+set :domain, 'localhost'
+set :deploy_to, "#{Dir.pwd}/deploy"
+set :repository, 'https://github.com/Mic92/mina-sidekiq-test-rails.git'
+set :keep_releases, 2
+set :sidekiq_processes, 2
+
+set :shared_paths, ['log']
+
+task :environment do
+  invoke :'rvm:use[ruby-2.0.0]'
+end
+
+task :setup => :environment do
+  queue! %[mkdir -p "#{deploy_to}/shared/pids/"]
+  queue! %[mkdir -p "#{deploy_to}/shared/log/"]
+end
+
+task :deploy => :environment do
+  deploy do
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    invoke :'bundle:install'
+
+    to :launch do
+      invoke :'sidekiq:start'
+      queue! %[sleep 3; kill -0 `cat #{sidekiq_pid}`]
+
+      invoke :'sidekiq:quiet'
+
+      invoke :'sidekiq:stop'
+      queue! %[(kill -0 `cat #{sidekiq_pid}`) 2> /dev/null && exit 1 || exit 0]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mina-sidekiq
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Joerg Thalheim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
+date: 2013-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina
@@ -32,18 +32,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- Changelog.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
-- VERSION
-- lib/mina-sidekiq.rb
-- lib/mina-sidekiq/sidekiq.rb
+- Rakefile
+- lib/mina_sidekiq.rb
+- lib/mina_sidekiq/tasks.rb
+- lib/mina_sidekiq/version.rb
 - mina-sidekiq.gemspec
+- test_env/config/deploy.rb
 homepage: http://github.com/Mic92/mina-sidekiq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  Starting with 0.2.0, you have to add:
+
+      require 'mina_sidekiq/tasks'
+
+  in your deploy.rb to load the library
 rdoc_options: []
 require_paths:
 - lib
@@ -59,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Tasks to deploy Sidekiq with mina.

data/VERSION

@@ -1 +0,0 @@
-0.1.1

data/lib/mina-sidekiq/sidekiq.rb

@@ -1,88 +0,0 @@
-# # Modules: Sidekiq
-# Adds settings and tasks for managing Sidekiq workers.
-#
-# ## Usage example
-#     require 'mina-sidekiq/sidekiq'
-#     ...
-#
-#     task :deploy => :enviroment do
-#       deploy do
-#         invoke :'sidekiq:quiet'
-#         invoke :'git:clone'
-#         ...
-#
-#         to :launch do
-#           ...
-#           invoke :'sidekiq:restart'
-#         end
-#       end
-#     end
-
-require 'mina/bundler'
-require 'mina/rails'
-
-# ## Settings
-# Any and all of these settings can be overriden in your `deploy.rb`.
-
-# ### sidekiq
-# Sets the path to sidekiq.
-set_default :sidekiq, lambda { "#{bundle_bin} exec sidekiq" }
-
-# ### sidekiqctl
-# Sets the path to sidekiqctl.
-set_default :sidekiqctl, lambda { "#{bundle_prefix} sidekiqctl" }
-
-# ### sidekiq_timeout
-# Sets a upper limit of time a worker is allowed to finish, before it is killed.
-set_default :sidekiq_timeout, 10
-
-# ### sidekiq_config
-# Sets the path to the configuration file of sidekiq
-set_default :sidekiq_config, "./config/sidekiq.yml"
-
-# ### sidekiq_log
-# Sets the path to the log file of sidekiq
-#
-# To disable logging set it to "/dev/null"
-set_default :sidekiq_log, "./log/sidekiq.log"
-
-# ### sidekiq_pid
-# Sets the path to the pid file of a sidekiq worker
-set_default :sidekiq_pid, lambda { "#{deploy_to}/#{shared_path}/pids/sidekiq.pid" }
-
-# ## Control Tasks
-namespace :sidekiq do
-  # ### sidekiq:quiet
-  desc "Quiet sidekiq (stop accepting new work)"
-  task :quiet do
-    queue %{ if [ -f #{sidekiq_pid} ]; then
-      echo "-----> Quiet sidekiq (stop accepting new work)"
-      #{echo_cmd %{(cd #{deploy_to}/#{current_path} && #{sidekiqctl} quiet #{sidekiq_pid})} }
-      fi }
-  end
-
-  # ### sidekiq:stop
-  desc "Stop sidekiq"
-  task :stop do
-    queue %[ if [ -f #{sidekiq_pid} ]; then
-      echo "-----> Stop sidekiq"
-      #{echo_cmd %[(cd #{deploy_to}/#{current_path} && #{sidekiqctl} stop #{sidekiq_pid} #{sidekiq_timeout})]}
-      fi ]
-  end
-
-  # ### sidekiq:start
-  desc "Start sidekiq"
-  task :start do
-    queue %{
-      echo "-----> Start sidekiq"
-      #{echo_cmd %[(cd #{deploy_to}/#{current_path}; nohup #{sidekiq} -e #{rails_env} -C #{sidekiq_config} -P #{sidekiq_pid} >> #{sidekiq_log} 2>&1 </dev/null &) ] }
-      }
-  end
-
-  # ### sidekiq:restart
-  desc "Restart sidekiq"
-  task :restart do
-    invoke :'sidekiq:stop'
-    invoke :'sidekiq:start'
-  end
-end

data/lib/mina-sidekiq.rb

@@ -1,3 +0,0 @@
-module MinaSidekiq
-  require "mina-sidekiq/sidekiq"
-end