dolphin 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96307e5f4700eaa30d22be8103a85ddcf32c8132
-  data.tar.gz: fc210b44ca75f5683e537f271063a15a373bca0a
+  metadata.gz: 64b7b1836dabf66d97b69fe469e1f8f4033f79e1
+  data.tar.gz: 83df23c962252ad8e9410219d8a8a69fb0be9229
 SHA512:
-  metadata.gz: 546c32db70818adbf42cc99a2959d6613a5bfd354ce052040e12e8818a1a885fd521bdff61491718aa8752184c4d03a2cd5bdf41012369e01cb5f21d5e7ad8c5
-  data.tar.gz: 7ae901e6f2bda4e7c9e546c7902fbd3aabdcdce0efaba45f60e2b7d67e862a873f631e5df601b57c60991c6cff4dd418f31e29a6cc97a79eca247287cc83a7e3
+  metadata.gz: 1cbff0b4fe5d73c500a6b99b7ef944083407fef7c4670c3d9adc9b24b369aa6a7087223d313a941ebc56fce142071bf5a6c0bebecbed1e2310480b0e8ce255c5
+  data.tar.gz: 7fb173b1c59804e27891accfba0a29e25f4485afaad496b669abaf7080ac54f50d3215013651bd1e97be282623ceb33730e9499c38e3b83d3f28406d30aed0fb

data/lib/dolphin.rb

@@ -1,143 +1,9 @@
-require "thor"
-require 'net/ssh'
-require 'parallel'
-
 require_relative "dolphin/version"
+require_relative "dolphin/base"
+require_relative "dolphin/lock"
+require_relative "dolphin/deploy"
 
 module Dolphin
-  # core functions
-  class Base < Thor
-    include Thor::Actions
-
-  # =============================================================================
-  # class options
-  # =============================================================================
-
-    class_option :env, :aliases => '-e', :type => :string, :default => 'alpha'
-
-    def initialize(args=[], options={}, config={})
-      super(args, options, config)
-      # set up environment
-      env
-    end
-
-  # =============================================================================
-  # private functions
-  # =============================================================================
-
-    private
-
-    # deployment environment
-    def env
-      # placeholder, to be implemented in each project
-
-    end
-
-    def parse_commands(menu)
-      # Helper method to parse a list of text menu of possible commands,
-      # which may contain empty lines or commented out with #
-      # commands can be separated into groups
-
-      commands = []
-      menu.each do |group|
-        buffer = []
-        group.split(/\r?\n/).each do |line|
-          line = line.strip
-          unless line.empty? or line.start_with?('#') # empty or commented out
-            buffer << line
-          end
-        end
-        commands.push(*buffer)
-      end
-      commands
-    end
-
-    def ssh_connection(server)
-      @sessions[server] ||= begin
-        ssh = Net::SSH.start(server, @user, )
-        at_exit { ssh.close }
-        ssh
-      end
-    end
-
-    def execute(menu)
-      # execute commands defined in menu
-      commands = parse_commands(menu)
-      puts "#{'*'*10}Executing commands#{'*'*10}\n"
-      commands.each do |command|
-        puts "#{command}\n"
-      end
-      puts "#{'='*60}\n"
-
-      # use Parallel to execute commands on multiple servers in parallel
-      tracks = @servers.size
-      # 3 threads maximum
-      tracks = 3 if tracks > 3
-      # record output to display at the end
-      output = {}
-
-      Parallel.map(@servers, in_threads: tracks) do |server|
-        session = ssh_connection(server)
-        output[server] = [] # output from this server
-
-        channel = session.open_channel do |chan|
-          chan.send_channel_request "shell" do |ch, success|
-          # chan.request_pty do |ch, success|
-            raise "could not start user shell" unless success
-
-            # normal output
-            ch.on_data do |c, data|
-              msg = "[output]: #{data}"
-              puts "#{server} => #{msg}"
-              output[server] << msg
-            end
-
-            # error message
-            ch.on_extended_data do |c, type, data|
-              msg = "[error]: #{data}"
-              puts "#{server} => #{msg}"
-              output[server] << msg
-            end
-
-            # exit code
-            ch.on_request "exit-status" do |c, data|
-              msg = "[exit]: #{data.read_long}\n"
-              puts "#{server} => #{msg}"
-              output[server] << msg
-            end
-
-            # has to explicitly call shell startup script
-            ch.send_data "source ~/.bash_profile\n"
-
-            # pick up ruby
-            ch.send_data "chruby #{@ruby_version}\n"
-
-            # Output each command as if they were entered on the command line
-            commands.each do |command|
-              ch.send_data "#{command}\n"
-            end
-
-            # Remember to exit or we'll hang!
-            ch.send_data "exit\n"
-
-          end
-        end
-
-        # Wait for everything to complete
-        channel.wait
-      end
-
-      # puts output
-      puts "\n#{'*'*10}Results Review#{'*'*10}\n"
-      output.each do |server, data|
-        puts "\n#{'='*60}\n"
-        puts "Executing on [#{server}] =>\n"
-        data.each {|line| puts line}
-      end
-      puts "\n\n"
-    end
-
-  end
 
   # =============================================================================
   # Setup
@@ -345,49 +211,6 @@ module Dolphin
 
   end
 
-  # =============================================================================
-  # Deploy
-  # =============================================================================
-  class Deploy < Base
-    desc "bundle", "sudo bundle install"
-    def bundle
-      menu = [
-        "
-          cd #{@deploy_dir}
-          sudo bundle install --quiet
-        ",
-      ]
-
-      execute menu
-    end
-
-    desc "go", "normal deploy procedure"
-    def go
-      # update code
-      invoke "dolphin:git:update"
-
-      # no need to invoke since it is within the same class
-      bundle
-
-      # restart app server
-      invoke "dolphin:puma:restart"
-    end
-
-    desc "try", "normal deploy procedure"
-    def try
-      menu = [
-        "
-          cd #{@deploy_dir}
-          pwd
-          bundle check
-        ",
-      ]
-
-      execute menu
-    end
-
-  end
-
   # =============================================================================
   # Git
   # =============================================================================
@@ -463,6 +286,7 @@ module Dolphin
     register(Puma, 'puma', 'puma', 'Puma related commands')
     register(Nginx, 'nginx', 'nginx', 'Nginx related commands')
     register(Git, 'git', 'git', 'Git related commands')
+    register(Lock, 'lock', 'lock', 'Lock resource to avoid simultaneous deployments')
   end
 
 end

data/lib/dolphin/base.rb

@@ -0,0 +1,167 @@
+require "thor"
+require 'net/ssh'
+require 'parallel'
+
+# core functions
+class Dolphin::Base < Thor
+  include Thor::Actions
+
+# =============================================================================
+# class options
+# =============================================================================
+
+  class_option :env, :aliases => '-e', :type => :string, :default => 'alpha'
+
+  def initialize(args=[], options={}, config={})
+    super(args, options, config)
+    # set up environment
+    env
+  end
+
+# =============================================================================
+# private functions
+# =============================================================================
+
+  private
+
+  # deployment environment
+  def env
+    # placeholder, to be implemented in each project
+
+  end
+
+  def parse_commands(menu)
+    # Helper method to parse a list of text menu of possible commands,
+    # which may contain empty lines or commented out with #
+    # commands can be separated into groups
+
+    commands = []
+    menu.each do |group|
+      buffer = []
+      group.split(/\r?\n/).each do |line|
+        line = line.strip
+        unless line.empty? or line.start_with?('#') # empty or commented out
+          buffer << line
+        end
+      end
+      commands.push(*buffer)
+    end
+    commands
+  end
+
+  def ssh_connection(server)
+    @sessions[server] ||= begin
+      ssh = Net::SSH.start(server, @user, )
+      at_exit { ssh.close }
+      ssh
+    end
+  end
+
+  def capture(command, server)
+    # capture output from one target server
+    output = ''
+    session = ssh_connection(server)
+
+    channel = session.open_channel do |chan|
+      chan.exec(command) do |ch, success|
+
+        ch.on_data do |c, data|
+          output << data
+        end
+
+        ch.on_extended_data do |c, type, data|
+          output << data
+        end
+
+      end
+    end
+
+    channel.wait
+    output
+  end
+
+  def execute(menu, target_server=nil)
+    # execute commands defined in menu, when :target_server is passed in, only execute on this server
+    commands = parse_commands(menu)
+    puts "#{'*'*10}Executing commands#{'*'*10}\n"
+    commands.each do |command|
+      puts "#{command}\n"
+    end
+    puts "#{'='*60}\n"
+
+    if target_server # solo
+      tracks = 1
+      target = [target_server]
+    else
+      # use Parallel to execute commands on multiple servers in parallel
+      tracks = @servers.size
+      # 3 threads maximum
+      tracks = 3 if tracks > 3
+      target = @servers
+    end
+
+    # record output to display at the end
+    output = {}
+
+    Parallel.map(target, in_threads: tracks) do |server|
+      session = ssh_connection(server)
+      output[server] = [] # output from this server
+
+      channel = session.open_channel do |chan|
+        chan.send_channel_request "shell" do |ch, success|
+        # chan.request_pty do |ch, success|
+          raise "could not start user shell" unless success
+
+          # normal output
+          ch.on_data do |c, data|
+            msg = "[output]: #{data}"
+            puts "#{server} => #{msg}"
+            output[server] << msg
+          end
+
+          # error message
+          ch.on_extended_data do |c, type, data|
+            msg = "[error]: #{data}"
+            puts "#{server} => #{msg}"
+            output[server] << msg
+          end
+
+          # exit code
+          ch.on_request "exit-status" do |c, data|
+            msg = "[exit]: #{data.read_long}\n"
+            puts "#{server} => #{msg}"
+            output[server] << msg
+          end
+
+          # has to explicitly call shell startup script
+          ch.send_data "source ~/.bash_profile\n"
+
+          # pick up ruby
+          ch.send_data "chruby #{@ruby_version}\n"
+
+          # Output each command as if they were entered on the command line
+          commands.each do |command|
+            ch.send_data "#{command}\n"
+          end
+
+          # Remember to exit or we'll hang!
+          ch.send_data "exit\n"
+
+        end
+      end
+
+      # Wait for everything to complete
+      channel.wait
+    end
+
+    # puts output
+    puts "\n#{'*'*10}Results Review#{'*'*10}\n"
+    output.each do |server, data|
+      puts "\n#{'='*60}\n"
+      puts "Executing on [#{server}] =>\n"
+      data.each {|line| puts line}
+    end
+    puts "\n\n"
+  end
+
+end

data/lib/dolphin/deploy.rb

@@ -0,0 +1,49 @@
+# Deploy tasks
+class Dolphin::Deploy < Dolphin::Base
+
+  desc "bundle", "sudo bundle install"
+  def bundle
+    menu = [
+      "
+        cd #{@deploy_dir}
+        sudo bundle install --quiet
+      ",
+    ]
+
+    execute menu
+  end
+
+  desc "go", "normal deploy procedure"
+  def go
+    # check lock
+    invoke "dolphin:lock:check"
+    # put lock
+    invoke "dolphin:lock:create"
+
+    # update code
+    invoke "dolphin:git:update"
+
+    # no need to invoke since it is within the same class
+    bundle
+
+    # restart app server
+    invoke "dolphin:puma:restart"
+
+    # remove lock
+    invoke "dolphin:lock:release"
+  end
+
+  desc "try", "normal deploy procedure"
+  def try
+    menu = [
+      "
+        cd #{@deploy_dir}
+        pwd
+        bundle check
+      ",
+    ]
+
+    execute menu
+  end
+
+end

data/lib/dolphin/lock.rb

@@ -0,0 +1,29 @@
+# Use lock to avoid simultaneous deployments
+class Dolphin::Lock < Dolphin::Base
+
+  desc "check", "Check lock"
+  def check
+    command = "if [ -e #{@lock_file} ]; then cat #{@lock_file}; fi"
+    output = capture(command, @lead_server)
+    if output.empty?
+      puts "OK to proceed"
+    else
+      puts "[output]: #{output}"
+      abort "\e[0;31m A deployment is already in progress\n Please wait for its completion\nOr in case of stale lock, remove #{@lock_file} to unlock \e[0m\n"
+    end
+  end
+
+  desc "create", "Create lock"
+  def create
+    lock_message = "Deploy started at #{@deploy_date} in progress\n"
+    command = "echo '#{lock_message}' > #{@lock_file}"
+    puts capture(command, @lead_server)
+  end
+
+  desc "release", "Release lock"
+  def release
+    command = "rm -f #{@lock_file}"
+    puts capture(command, @lead_server)
+  end
+
+end

data/lib/dolphin/version.rb

@@ -1,3 +1,3 @@
 module Dolphin
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dolphin
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - |
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -95,6 +95,9 @@ files:
 - Rakefile
 - dolphin.gemspec
 - lib/dolphin.rb
+- lib/dolphin/base.rb
+- lib/dolphin/deploy.rb
+- lib/dolphin/lock.rb
 - lib/dolphin/version.rb
 homepage: ''
 licenses: