luban 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffaea169e73bcbe91d121057e872f25c28f9aa91
-  data.tar.gz: 0b0cfbe6d7b224f87f62ec78a2801f0fe970e491
+  metadata.gz: 8f634550b34b8380b8a9bb38189ab450e3c50a34
+  data.tar.gz: d507cdf9924ca36905c4e8a8585a7835071e1168
 SHA512:
-  metadata.gz: 59807ad43e6829f55c512d1d865402710de337424982863330faaa4a86acb16b36921aa3ec5fe438d55399d431988b75b33abdd461e1de85cce15be94596fcc8
-  data.tar.gz: c2085acfba4d4476242a85904f009afe9c7cbf4ca149f09260cd1972b2b9be3db5f15602ec588fa1cc6089b6ad4dd8d3f02a2e937d14504ffce9128f6d9a55d7
+  metadata.gz: 75e17a9e3a96df84cea850e4313060c5cb2a4ca09c2e4274ff75d09704b6deb55a49f6f1e8656c471e7ed51aa883d3a77b179c3a7bdb39a7d1d42b315ceb948b
+  data.tar.gz: 246833cd50c99ef0d7d0d847a2a3aa44efec01ef0832df7868ff89ce06f94a7c829fd240a4252c2c22bc458384567d4f8e4967c1366c5f66630fb3542a161b9e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change log
 
+## Version 0.4.2 (Jun 07, 2016)
+
+Minor enhancements:
+  * Enhanced process management in controller
+  * Added parameters #process_monitor to setup process monitor in Luban
+  * Added #process_monitor_via convenient method to setup process monitor in Luban
+  * Removed #monitor_process and #unmonitor_process from common control tasks
+  * Added option #configure_opts for package installation
+  * Optimized format result output message
+  * Added convenient methods #env_name and #service_name to standardize naming
+  * Minor code refactoring
+
+Bug fixes:
+  * Fixed SSHKit output format to handle :airbrussh properly
+
 ## Version 0.4.1 (May 13, 2016)
 
 Minor enhancements:

data/lib/luban/deployment/cli/application/base.rb

@@ -120,7 +120,7 @@ module Luban
 
       def set_parameters
         super
-        copy_parameters_from_parent(:stage, :project)
+        copy_parameters_from_parent(:stage, :project, :process_monitor)
         @packages = {}
         @services = {}
         @source = {}

data/lib/luban/deployment/cli/application/builder.rb

@@ -29,7 +29,7 @@ module Luban
 
         def destroy_app
           rm(etc_path.join('*', "#{stage}.#{project}.#{application}.*"))
-          rm(app_path)
+          rmdir(app_path)
           update_result "The application environment is destroyed."
         end
 
@@ -66,4 +66,4 @@ module Luban
       end
     end
   end
-end
+end

data/lib/luban/deployment/cli/application/publisher.rb

@@ -112,7 +112,7 @@ module Luban
             create_symlinks
             update_releases_log
           else
-            rm(release_path)
+            rmdir(release_path)
           end
         ensure
           rm(upload_to)
@@ -176,7 +176,7 @@ module Luban
             end
             releases_to_remove = releases - releases_to_keep
             releases_to_remove.each do |release| 
-              rm(releases_path.join(release))
+              rmdir(releases_path.join(release))
             end
             info "Removed #{releases_to_remove.count} old releases."
           else

data/lib/luban/deployment/cli/application/scm/rsync.rb

@@ -36,7 +36,7 @@ module Luban
                 assure_dirs(release_tag)
                 execute(:tar, "-C #{clone_path} -cf - . | tar -C #{release_tag} -xf -")
                 execute(:tar, "-czf", release_package_path, release_tag)
-                rm(release_tag)
+                rmdir(release_tag)
               end
             end
           end

data/lib/luban/deployment/cli/command.rb

@@ -91,8 +91,7 @@ module Luban
 
         module Control
           Actions = %i(start_process stop_process kill_process
-                       restart_process check_process
-                       monitor_process unmonitor_process)
+                       restart_process check_process)
           Actions.each do |action|
             define_method(action) do |args:, opts:|
               raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
@@ -101,6 +100,12 @@ module Luban
 
           def controllable?; true; end
 
+          def process_monitor_via(monitor, env: "uber/lubmon")
+            monitor = monitor.to_s.downcase
+            env = env.to_s.downcase
+            process_monitor name: monitor, env: env
+          end
+
           protected
 
           def setup_control_tasks
@@ -128,16 +133,6 @@ module Luban
               desc "Check process status"
               action! :check_process
             end
-
-            task :monitor do
-              desc "Turn on process monitor"
-              action! :monitor_process
-            end
-
-            task :unmonitor do
-              desc "Turn off process monitor"
-              action! :unmonitor_process
-            end
           end
         end
       end
@@ -325,7 +320,9 @@ module Luban
       def print_task_result(result)
         result.each do |entry|
           next if entry[:message].to_s.empty?
-          puts "  [#{entry[:hostname]}] #{entry[:message]}"
+          entry[:message].split("\n").each do |msg|
+            puts "  [#{entry[:hostname]}] #{msg}"
+          end
         end
       end
 
@@ -336,7 +333,7 @@ module Luban
         enable_dry_run if dry_run
 
         SSHKit.configure do |sshkit|
-          sshkit.format           = format
+          sshkit.format           = format unless format == :airbrussh
           sshkit.output_verbosity = verbosity
           sshkit.default_env      = default_env
           sshkit.backend          = sshkit_backend
@@ -368,4 +365,4 @@ module Luban
       end
     end
   end
-end
+end

data/lib/luban/deployment/cli/package/installer/core.rb

@@ -68,7 +68,9 @@ module Luban
         end
 
         def configure_build_options
-          @configure_opts = default_configure_opts | (task.opts.__remaining__ || [])
+          @configure_opts = default_configure_opts
+          @configure_opts |= task.opts.configure_opts unless task.opts.configure_opts.nil?
+          @configure_opts |= task.opts.__remaining__ unless task.opts.__remaining__.nil?
           @configure_opts.unshift(install_prefix)
         end
 

data/lib/luban/deployment/cli/package/installer/install.rb

@@ -283,8 +283,7 @@ module Luban
         end
 
         def remove_symlinks!
-          return unless symlink?(current_path)
-          execute "[ -h #{current_path} ] && rm -f #{current_path}; true"
+          symlink?(current_path) and rm(current_path)
         end
 
         def remove_binstubs!
@@ -292,7 +291,7 @@ module Luban
           find_cmd = "find #{current_bin_path}/* -type f -print && find #{current_bin_path}/* -type l -print"
           capture(find_cmd).split("\n").each do |bin|
             bin_symlink = app_bin_path.join(File.basename(bin))
-            execute "[ -h #{bin_symlink} ] && rm -f #{bin_symlink}; true"
+            symlink?(bin_symlink) and rm(bin_symlink)
           end
         end
 

data/lib/luban/deployment/cli/package/worker.rb

@@ -20,7 +20,7 @@ module Luban
           end
         end
 
-        def package_name; task.opts.name; end
+        def package_name; File.basename(task.opts.name); end
         def package_full_name; "#{package_name}-#{package_version}"; end
 
         def package_version; task.opts.version; end

data/lib/luban/deployment/cli/service/base.rb

@@ -5,18 +5,24 @@ module Luban
         include Luban::Deployment::Command::Tasks::Deploy
         include Luban::Deployment::Command::Tasks::Control
 
-        ControlActions = Luban::Deployment::Command::Tasks::Control::Actions
-        ProfileActions = %i(update_profile)
-
-        (ControlActions | ProfileActions).each do |m|
-          define_method(m) do |args:, opts:|
+        def self.service_action(name, dispatch_to: nil, locally: false, &blk)
+          define_method(name) do |args:, opts:|
             if current_version
               send("#{__method__}!", args: args, opts: opts.merge(version: current_version))
             else
               abort "Aborted! No current version of #{display_name} is specified."
             end
           end
+          unless dispatch_to.nil?
+            dispatch_task "#{name}!", to: dispatch_to, as: name, locally: locally, &blk
+            protected "#{name}!"
+          end
+        end
+
+        Luban::Deployment::Command::Tasks::Control::Actions.each do |action|
+          service_action action, dispatch_to: :controller
         end
+        service_action :update_profile, dispatch_to: :configurator, locally: true
 
         protected
 
@@ -37,12 +43,6 @@ module Luban
           super
           linked_dirs.push('log', 'pids')
         end
-
-        ControlActions.each do |task|
-          dispatch_task "#{task}!", to: :controller, as: task
-        end
-
-        dispatch_task :update_profile!, to: :configurator, as: :update_profile, locally: true
       end
     end
   end

data/lib/luban/deployment/cli/service/controller.rb

@@ -2,11 +2,32 @@ module Luban
   module Deployment
     module Service
       class Controller < Worker
-        %i(process_stopped? process_started?
-           monitor_process unmonitor_process).each do |m|
-          define_method(m) do
-            raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
-          end
+        def pid
+          capture(:cat, "#{pid_file_path} 2>/dev/null")
+        end
+
+        def process_started?
+          !!process_grep.keys.first
+        end
+
+        def process_stopped?
+          !process_started?
+        end
+
+        def pid_file_orphaned?
+          process_stopped? and pid_file_exists?
+        end
+
+        def pid_file_missing?
+          process_started? and !pid_file_exists?
+        end
+
+        def pid_file_exists?
+          file?(pid_file_path, "-s") # file is NOT zero size
+        end
+
+        def process_pattern
+          raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
         end
 
         def start_process
@@ -17,9 +38,11 @@ module Luban
 
           output = start_process!
           if check_until { process_started? }
-            update_result "Successfully started #{package_full_name}: #{output}"
+            monitor_process
+            update_result "Start #{package_full_name}: [OK] #{output}"
           else
-            update_result "Failed to start #{package_full_name}: #{output}", 
+            remove_orphaned_pid_file
+            update_result "Start #{package_full_name}: [FAILED] #{output}", 
                           status: :failed, level: :error
           end
         end
@@ -30,11 +53,13 @@ module Luban
             return
           end
 
-          output = stop_process!
+          output = stop_process! || 'OK'
           if check_until { process_stopped? }
-            update_result "Successfully stopped #{package_full_name}: #{output}"
+            unmonitor_process
+            update_result "Stop #{package_full_name}: [OK] #{output}"
           else
-            update_result "Failed to stop #{package_full_name}: #{output}",
+            remove_orphaned_pid_file
+            update_result "Stop #{package_full_name}: [FAILED] #{output}",
                           status: :failed, level: :error
           end
         end
@@ -42,8 +67,12 @@ module Luban
         def restart_process
           if process_started?
             output = stop_process!
-            unless check_until { process_stopped? }
-              update_result "Failed to stop #{package_full_name}: #{output}",
+            if check_until { process_stopped? }
+              info "Stop #{package_full_name}: [OK] #{output}"
+              unmonitor_process
+            else
+              remove_orphaned_pid_file
+              update_result "Stop #{package_full_name}: [FAILED] #{output}",
                             status: :failed, level: :error
               return
             end
@@ -51,9 +80,11 @@ module Luban
 
           output = start_process!
           if check_until { process_started? }
-            update_result "Successfully restarted #{package_full_name}: #{output}"
+            update_result "Restart #{package_full_name}: [OK] #{output}"
+            monitor_process
           else
-            update_result "Failed to restart #{package_full_name}: #{output}", 
+            remove_orphaned_pid_file
+            update_result "Restart #{package_full_name}: [FAILED] #{output}", 
                           status: :failed, level: :error
           end
         end
@@ -65,9 +96,43 @@ module Luban
         def kill_process
           output = kill_process!
           if check_until { process_stopped? }
-            update_result "Successfully kill processs (#{output})."
+            unmonitor_process
+            remove_orphaned_pid_file
+            update_result "Kill #{package_full_name}: [OK] #{output}"
           else
-            update_result "Failed to kill process: #{output}"
+            update_result "Kill #{package_full_name}: [FAILED] #{output}"
+          end
+        end
+
+        def process_monitor_defined?
+          !process_monitor[:name].nil?
+        end
+
+        def monitor_process
+          if process_monitor_defined?
+            if monitor_process!
+              info "Turned on process monitor for #{service_entry}"
+            else
+              info "Failed to turn on process monitor for #{service_entry}"
+            end
+          end
+        end
+
+        def unmonitor_process
+          if process_monitor_defined?
+            if unmonitor_process!
+              info "Turned off process monitor for #{service_entry}"
+            else
+              info "Failed to turn off process monitor for #{service_entry}"
+            end
+          end
+        end
+
+        protected
+
+        %i(start_process! stop_process!).each do |m|
+          define_method(m) do
+            raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
           end
         end
 
@@ -80,18 +145,53 @@ module Luban
           succeeded
         end
 
-        protected
+        def check_process!
+          if pid_file_missing?
+            "#{package_full_name}: started but PID file does NOT exist - #{pid_file_path}"
+          elsif process_started?
+            "#{package_full_name}: started (PID #{pid})"
+          elsif pid_file_orphaned?
+            "#{package_full_name}: stopped but PID file exists - #{pid_file_path}"
+          else
+            "#{package_full_name}: stopped"
+          end
+        end
 
-        %i(start_process! stop_process! check_process!).each do |m|
-          define_method(m) do
-            raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
+        def kill_process!(pattern = process_pattern)
+          capture(:pkill, "-9 -f \"#{pattern}\"")
+        end
+
+        def process_grep(pattern = process_pattern)
+          capture(:pgrep, "-l -f \"#{pattern}\" 2>/dev/null").split.inject({}) do |h, p|
+            pid, pname = p.split(' ', 2)
+            h[pid] = pname
+            h
           end
         end
 
-        def kill_process!
-          pid = capture(pid_file_path)
-          output = capture(:kill, "-9 #{pid}")
-          output.empty? ? pid : output
+        def remove_orphaned_pid_file
+          rm(pid_file_path) if pid_file_orphaned?
+        end
+
+        def monitor_process!
+          test(process_monitor_command)
+        end
+
+        def unmonitor_process!
+          test(process_unmonitor_command)
+        end
+
+        def process_monitor_executable
+          @process_monitor_executable ||= env_path.join("#{stage}.#{process_monitor[:env]}").
+                                                   join('bin').join(process_monitor[:name])
+        end
+
+        def process_monitor_command
+          @process_monitor_command ||= "#{process_monitor_executable} monitor #{service_entry}"
+        end
+
+        def process_unmonitor_command
+          @process_unmonitor_command ||= "#{process_monitor_executable} unmonitor #{service_entry}"
         end
       end
     end

data/lib/luban/deployment/cli/service/worker.rb

@@ -5,7 +5,11 @@ module Luban
         include Luban::Deployment::Worker::Paths::Remote::Service
 
         def service_name
-          @service_name = package_name.downcase
+          @service_name ||= package_name.downcase
+        end
+
+        def service_entry
+          @service_entry ||= "#{env_name.gsub('/', '.')}.#{service_name}"
         end
 
         def profile_path
@@ -34,4 +38,4 @@ module Luban
       end
     end
   end
-end
+end

data/lib/luban/deployment/helpers/utils.rb

@@ -14,8 +14,8 @@ module Luban
           test "[ -d #{path} ]"
         end
 
-        def file?(path)
-          test "[ -f #{path} ]"
+        def file?(path, test_op = "-f")
+          test "[ #{test_op} #{path} ]"
         end
 
         def symlink?(path)
@@ -53,9 +53,12 @@ module Luban
         end
 
         def rm(*opts, path)
+          execute(:rm, '-f', *opts, path)
+        end
+
+        def rmdir(*opts, path)
           execute(:rm, '-fr', *opts, path)
         end
-        alias_method :rmdir, :rm
 
         def chmod(*opts, path)
           execute(:chmod, '-R', *opts, path)
@@ -101,35 +104,37 @@ module Luban
           @user_home ||= capture("eval echo ~")
         end
 
-        def url_exists?(download_url)
+        def url_exists?(url)
           # Sent HEAD request to avoid downloading the file contents
-          test("curl -s -L -I -o /dev/null -f #{download_url}")
+          test("curl -s -L -I -o /dev/null -f #{url}")
 
           # Other effective ways to check url existence with curl
 
           # In case HEAD request is refused, 
           # only the first byte of the file is requested
-          # test("curl -s -L -o /dev/null -f -r 0-0 #{download_url}")
+          # test("curl -s -L -o /dev/null -f -r 0-0 #{url}")
 
           # Alternatively, http code (200) can be validated
-          # capture("curl -s -L -I -o /dev/null -w '%{http_code}' #{download_url}") == '200'
+          # capture("curl -s -L -I -o /dev/null -w '%{http_code}' #{url}") == '200'
         end
 
         def upload_by_template(file_to_upload:, template_file:, auto_revision: false, **opts)
-          template = File.read(template_file)
-
           if auto_revision
             require 'digest/md5'
-            revision = Digest::MD5.hexdigest(template)
+            revision = Digest::MD5.file(template_file).hexdigest
             return if revision_match?(file_to_upload, revision)
           end
 
-          require 'erb'
-          context = opts[:binding] || binding
-          upload!(StringIO.new(ERB.new(template, nil, '<>').result(context)), file_to_upload)
+          upload!(StringIO.new(render_template(template_file, context: binding)), file_to_upload)
           yield file_to_upload if block_given?
         end
 
+        def render_template(template_file, context: binding)
+          require 'erb'
+          template = File.read(template_file)
+          ERB.new(template, nil, '<>').result(context)
+        end
+
         def revision_match?(file_to_upload, revision)
           file?(file_to_upload) and match?("grep \"Revision: \" #{file_to_upload}; true", revision)
         end
@@ -170,6 +175,10 @@ module Luban
           @hostname ||= host.hostname
         end
 
+        def now
+          Time.now().strftime("%d/%m/%Y %H:%M:%S")
+        end
+
         def method_missing(sym, *args, &blk)
           backend.respond_to?(sym) ? backend.send(sym, *args, &blk) : super
         end

data/lib/luban/deployment/parameters.rb

@@ -64,8 +64,6 @@ module Luban
         parameter :stage
 
         parameter :process_monitor
-        parameter :process_monitor_env
-
         parameter :sshkit_backend
         parameter :authen_key_type
         parameter :default_env
@@ -79,6 +77,7 @@ module Luban
         protected
 
         def set_default_project_parameters
+          set_default :process_monitor, {}
           set_default :sshkit_backend, SSHKit::Backend::Netssh
           set_default :authen_key_type, 'rsa'
           set_default :default_env, { path: '$PATH:/usr/local/bin' }
@@ -97,7 +96,16 @@ module Luban
             Luban::Deployment::Helpers::Configuration::Finder.project(self)
         end
 
-        def validate_project_parameters; end
+        def validate_project_parameters
+          unless process_monitor.empty?
+            if process_monitor[:name].nil?
+              abort "Aborted! Please specify the process monitor."
+            end
+            if process_monitor[:env].nil?
+              abort "Aborted! Please specify the process monitor environment."
+            end
+          end
+        end
       end
 
       module Application

data/lib/luban/deployment/templates/envrc.erb

@@ -1,7 +1,7 @@
 # Luban environment activation resource file
-# Environment: <%= env_name = "#{stage}.#{project}/#{application}" %>
+# Environment: <%= env_name %>
 # Revision: <%= revision %>
-# Created at <%= Time.now().strftime("%d/%m/%Y %H:%M:%S") %>
+# Created at <%= now %>
 
 echo_line() {
   if [ "$PS1" ]; then

data/lib/luban/deployment/templates/unset_envrc.erb

@@ -1,7 +1,7 @@
 # Environment de-activation resource file
-# Environment: <%= env_name = "#{stage}.#{project}/#{application}" %>
+# Environment: <%= env_name %>
 # Revision: <%= revision %>
-# Created at <%= Time.now().strftime("%d/%m/%Y %H:%M:%S") %>
+# Created at <%= now %>
 
 echo_line() {
   if [ "$PS1" ]; then

data/lib/luban/deployment/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module Deployment
-    VERSION = "0.4.1"
+    VERSION = "0.4.2"
   end
 end

data/lib/luban/deployment/worker/base.rb

@@ -25,6 +25,10 @@ module Luban
         def osx?; os_name == 'Darwin'; end
         def linux?; os_name == 'Linux'; end
 
+        def env_name
+          @env_name ||= "#{stage}.#{project}/#{application}"
+        end
+
         def run
           update_result(__return__: @run_blk ? run_with_block : run_with_command).to_h
         end
@@ -62,7 +66,9 @@ module Luban
             r.level = level
             r.message = message unless message.nil? or !r.message.nil?
             attrs.each_pair { |k, v| r.send("#{k}=", v) }
-            send(level, message) unless message.nil? or message.empty?  
+            unless message.nil? or message.empty?
+              message.split("\n").each { |msg| send(level, msg) }
+            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Rubyist Lei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luban-cli