mina-sidekiq-upstart 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3142e282119266a06790d3aee4b7b98a39b4f5c1f61d90b1a69516a4864066df
+  data.tar.gz: e15ca89d1aac02ebd648a0a2f2b346c3e6d2aa4d6ff263adf1203531aa0037fa
+SHA512:
+  metadata.gz: 77d26f5cc4302f04d452d212c8c1076340e65b6e2375ad109cddfa7cab7d7b47eccbd5e9be2a9e9d8b03ccce9532ab7d687c6560ff9a2b269d9cd9ffc885b707
+  data.tar.gz: d66c69e93770be26534e074015be13d14d7a47adfdc0c10a6b5c4eae74d7da40f4242270b655a580ee29d0c258556c31efd35572fae54d55fb54625cdeea65ed

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+test_env/deploy/
+.idea

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+services: redis
+env: FORCE_ADD_SSH_KEY=1

data/Changelog.md

@@ -0,0 +1,19 @@
+Changelog
+=========
+
+0.3.1 2015-01-18
+----------------
+
+* fix starting in background
+
+0.2.0 2013-08-18
+----------------
+
+Breaking Changes:
+
+* to load the tasks requiring 'mina_sidekiq_upstart/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

@@ -0,0 +1,3 @@
+source "http://www.rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    mina-sidekiq-upstart (0.3.1)
+      mina
+
+GEM
+  remote: http://www.rubygems.org/
+  specs:
+    mina (0.3.1)
+      open4 (~> 1.3.4)
+      rake
+    open4 (1.3.4)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mina-sidekiq-upstart!

data/LICENSE

@@ -0,0 +1,23 @@
+LICENSE
+
+The MIT License
+
+Copyright (c) 2012 Nadarei, Inc.
+
+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,82 @@
+mina-sidekiq-upstart
+============
+
+[![Build Status](https://travis-ci.org/Mic92/mina-sidekiq-upstart.png?branch=master)](https://travis-ci.org/Mic92/mina-sidekiq-upstart)
+
+mina-sidekiq-upstart is a gem that adds tasks to aid in the deployment of [Sidekiq] (http://mperham.github.com/sidekiq/)
+using [Mina] (http://nadarei.co/mina).
+
+# Getting Start
+
+## Installation
+
+    gem install mina-sidekiq-upstart
+
+## Example
+
+## Usage example
+
+    require 'mina_sidekiq_upstart/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 do
+      deploy do
+        # stop accepting new workers
+        invoke :'sidekiq:quiet'
+        invoke :'git:clone'
+        invoke :'deploy:link_shared_paths'
+        ...
+
+        to :launch do
+          ...
+          invoke :'sidekiq:restart'
+        end
+      end
+    end
+
+## Available Tasks
+
+* sidekiq:stop
+* sidekiq:start
+* sidekiq:restart
+* sidekiq:quiet
+
+## Available Options
+
+| Option              | Description                                                                    |
+| ------------------- | ------------------------------------------------------------------------------ |
+| *sidekiq*           | Sets the path to sidekiq.                                                      |
+| *sidekiqctl*        | Sets the path to sidekiqctl.                                                   |
+| *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.                                 |
+
+## Testing
+
+The test requires a local running ssh server with the ssh keys of the current
+user added to its `~/.ssh/authorized_keys`. In OS X, this is "Remote Login"
+under the Sharing pref pane.
+
+To run the full blown test suite use:
+
+    bundle exec rake test
+
+For faster release cycle use
+
+    cd test_env
+    bundle exec mina deploy --verbose
+
+## Copyright
+
+Copyright (c) 2013 Jörg Thalheim http://higgsboson.tk/joerg
+
+See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/mina_sidekiq_upstart/tasks.rb

@@ -0,0 +1,125 @@
+# # Modules: Sidekiq
+# Adds settings and tasks for managing Sidekiq workers.
+#
+# ## Usage example
+#     require 'mina_sidekiq_upstart/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, lambda { "#{deploy_to}/#{current_path}/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 => :environment do
+    queue %[echo "-----> Quiet sidekiq (stop accepting new work)"]
+    for_each_process do |pid_file, idx|
+      queue %{
+        if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
+          cd "#{deploy_to}/#{current_path}"
+          #{echo_cmd %{#{sidekiqctl} quiet #{pid_file}} }
+        else
+          echo 'Skip quiet command (no pid file found)'
+        fi
+      }
+    end
+  end
+
+  # ### sidekiq:stop
+  desc "Stop sidekiq"
+  task :stop => :environment do
+    queue %[echo "-----> Stop sidekiq"]
+    for_each_process do |pid_file, idx|
+      queue %[
+        if [ -f #{pid_file} ] && kill -0 `cat #{pid_file}`> /dev/null 2>&1; then
+          cd "#{deploy_to}/#{current_path}"
+          #{echo_cmd %[#{sidekiqctl} stop #{pid_file} #{sidekiq_timeout}]}
+        else
+          echo 'Skip stopping sidekiq (no pid file found)'
+        fi
+      ]
+    end
+  end
+
+  # ### sidekiq:start
+  desc "Start sidekiq"
+  task :start => :environment do
+    queue %[echo "-----> Start sidekiq"]
+    for_each_process do |pid_file, idx|
+      #queue %{
+      #  cd "#{deploy_to}/#{current_path}"
+      #  #{echo_cmd %[#{sidekiq} -d -e #{rails_env} -C #{sidekiq_config} -i #{idx} -P #{pid_file} -L #{sidekiq_log}] }
+      #}
+      queue %[sudo start sidekiq app=#{deploy_to}/#{current_path} index=0 ]
+    end
+  end
+
+  # ### sidekiq:restart
+  desc "Restart sidekiq"
+  task :restart do
+    invoke :'sidekiq:stop'
+    invoke :'sidekiq:start'
+  end
+end

data/lib/mina_sidekiq_upstart/version.rb

@@ -0,0 +1,5 @@
+module MinaSidekiqUpstart
+  def self.version
+    "0.0.1"
+  end
+end

data/lib/mina_sidekiq_upstart.rb

@@ -0,0 +1,4 @@
+require 'mina_sidekiq_upstart/version'
+
+module MinaSidekiqUpstart
+end

data/mina-sidekiq-upstart.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require "./lib/mina_sidekiq_upstart/version.rb"
+
+Gem::Specification.new do |s|
+  s.name = "mina-sidekiq-upstart"
+  s.version = MinaSidekiqUpstart.version
+  s.authors = ["Максим Столбухин"]
+  s.email = ["maxstbn@gmail.com"]
+  s.homepage = "https://github.com/vened/mina-sidekiq-upstart"
+  s.summary = "Tasks to deploy Sidekiq with mina."
+  s.description = "Adds tasks to aid in the deployment of Sidekiq"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  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_upstart/tasks"
+
+in your deploy.rb to load the library
+MESSAGE
+
+  s.add_runtime_dependency "mina"
+end

data/test/deploy_test.rb

@@ -0,0 +1,61 @@
+require "test_helper"
+
+describe "mina_sidekiq_upstart" do
+  before do
+    @old_cwd = Dir.pwd
+    @env_root = TEST_ROOT.join("..", "test_env")
+    Dir.chdir(@env_root)
+    FileUtils.rm_rf("deploy")
+  end
+  after { Dir.chdir(@old_cwd) }
+
+  def mina(task)
+    cmd = "bundle exec mina --verbose #{task}"
+    puts "$ #{cmd}"
+    system cmd
+  end
+
+  def check_process(pid)
+    begin
+      Process.kill(0, pid)
+      return true
+    rescue Errno::EPERM => e
+      puts "No permission to query #{pid}!"
+      raise e
+    rescue Errno::ESRCH
+      puts "#{pid} is NOT running."
+      return false
+    rescue
+      puts "Unable to determine status for #{pid} : #{$!}"
+    end
+  end
+
+  describe "setup" do
+    before { mina "setup" }
+    it "should deploy" do
+      begin
+        # fresh deploy
+        mina "deploy"
+        # second deploy
+        mina "deploy"
+      rescue Exception => e
+        log = "./deploy/shared/sidekiq.log"
+        if File.exists?(log)
+          puts "cat #{log}"
+          puts File.open(log).read
+        end
+        raise e
+      end
+    end
+    it "should start/stop sidekiq" do
+      sidekiq_pid_path = @env_root.join("deploy", "shared", "pids", "sidekiq.pid")
+      # fresh deploy
+      mina "sidekiq:start"
+      pid = File.read(sidekiq_pid_path)
+      check_process(pid).must_equal true
+      # second deploy
+      mina "sidekiq:stop"
+      check_process(pid).must_equal true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+require "minitest/spec"
+require "minitest/autorun"
+require 'pathname'
+
+TEST_ROOT = Pathname.new(File.dirname(__FILE__))
+
+module MiniTestWithHooks
+  class Unit < MiniTest::Unit
+    def before_suites; end
+    def after_suites; end
+
+    def _run_suites(suites, type)
+      begin
+        before_suites
+        super(suites, type)
+      ensure
+        after_suites
+      end
+    end
+
+    def _run_suite(suite, type)
+      begin
+        suite.before_suite
+        super(suite, type)
+      ensure
+        suite.after_suite
+      end
+    end
+  end
+end
+
+module MiniTestWithTransactions
+  class Unit < MiniTestWithHooks::Unit
+    def before_suites
+      super
+      if ENV["FORCE_ADD_SSH_KEY"]
+        force_add_ssh_key
+      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
+  end
+end

data/test_env/config/deploy.rb

@@ -0,0 +1,47 @@
+require 'mina'
+require 'mina/git'
+require 'mina_sidekiq_upstart/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-upstart-test-rails.git'
+set :keep_releases, 2
+set :sidekiq_processes, 2
+
+set :shared_paths, ['log']
+
+task :environment do
+  invoke :'rvm:use[ruby-2.1.2]'
+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

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: mina-sidekiq-upstart
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Максим Столбухин
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds tasks to aid in the deployment of Sidekiq
+email:
+- maxstbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mina_sidekiq_upstart.rb
+- lib/mina_sidekiq_upstart/tasks.rb
+- lib/mina_sidekiq_upstart/version.rb
+- mina-sidekiq-upstart.gemspec
+- test/deploy_test.rb
+- test/test_helper.rb
+- test_env/config/deploy.rb
+homepage: https://github.com/vened/mina-sidekiq-upstart
+licenses:
+- MIT
+metadata: {}
+post_install_message: |
+  Starting with 0.2.0, you have to add:
+
+      require "mina_sidekiq_upstart/tasks"
+
+  in your deploy.rb to load the library
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Tasks to deploy Sidekiq with mina.
+test_files:
+- test/deploy_test.rb
+- test/test_helper.rb