luban 0.7.15 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e1f167e693836da903a95a79e5ccf3d4019c40
-  data.tar.gz: cdd786aa212e17818ae3107ebc9382697a343972
+  metadata.gz: b76fee1999addcf718abd92f2c2f49ad36e0bc01
+  data.tar.gz: 21654c1dac641251e5dfcf7dbd643dd4b474f683
 SHA512:
-  metadata.gz: 23d244aff4a62075d23589325b9510e776f76bc38c1d1e26f99b2a98825a4a67bd0719513ec35d1926a8b4de8fd6c94781efa57f19ea140dec6cbade52d20be8
-  data.tar.gz: 205dd39de95af822c32fa50b635a95d360a5d16e3f0d077b487cdd095349af6b8f5e67b0e52767dca37e5ba469392383d3cce876e442d01255f78735d972d9c9
+  metadata.gz: c7bc4215dd7b267c2910448510f93990b2d01f3d07466e06bbd07ab1fd6c5856ea15be2443ac4033c311b1f791c8e6c7284dcfd340ab877add02cb2e8dd9b429
+  data.tar.gz: ae7e62c0cafce61eca81d3b041014c65e18550cdaca7f0800a52d0c3568c8fde901579f52895adffae1b3e696e085447ff4e5827517d7130f29d6d0194a6dd80

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Change log
 
+## Version 0.8.0 (Sept 19, 2016)
+
+# New features:
+  * Supported cronjob deployment
+
+Minor enhancements:
+  * Refactored Service::Worker#compose_command to be more flexible
+  * Enhanced util method #upload_by_template to handle header and footer template rendering
+  * Added convenient method #bundle_command to compose command running within the bundler context
+  * Refactored the way of composing shell commands including cronjob commands
+  * Minor code cleanup
+
 ## Version 0.7.15 (Sept 07, 2016)
 
 Minor enhancements:
   * During app packaging, extracted vendor/gems from the source code if any along with Gemfile/Gemfile.lock
+    * As a result, bump up gem dependency on luban-cli to version 0.4.5 or above
 
 ## Version 0.7.14 (Sept 06, 2016)
 

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

@@ -7,6 +7,7 @@ module Luban
       include Luban::Deployment::Command::Tasks::Install
       include Luban::Deployment::Command::Tasks::Deploy
       include Luban::Deployment::Command::Tasks::Control
+      include Luban::Deployment::Command::Tasks::Crontab
 
       attr_reader :packages
       attr_reader :services
@@ -54,7 +55,7 @@ module Luban
       def has_services?; !services.empty?; end
 
       def installable?;  has_packages?; end
-      def deployable?;   has_source?  or has_profile? end
+      def deployable?;   has_source? or has_profile? end
       def controllable?; has_source? or has_services?; end
 
       def use_package?(package_name, package_version, servers: [])
@@ -191,7 +192,9 @@ module Luban
         show_app_environment
         deploy_release(args: args, opts: opts) if has_source?
         deploy_profile(args: args, opts: opts) if has_profile?
+        deploy_cronjobs(args: args, opts: opts)
       end
+      dispatch_task :deploy_cronjobs, to: :crontab, as: :deploy_cronjobs
 
       Luban::Deployment::Command::Tasks::Control::Actions.each do |action|
         define_method(action) do |args:, opts:|
@@ -233,6 +236,16 @@ module Luban
         end
       end
 
+      Luban::Deployment::Command::Tasks::Crontab::Actions.each do |action|
+        define_method(action) do |args:, opts:|
+          show_app_environment
+          opts = opts.merge(version: current_app) if current_app
+          send("#{action}!", args: args, opts: opts)
+        end
+        dispatch_task "#{action}!", to: :crontab, as: action
+        protected "#{action}!" 
+      end
+
       protected
 
       def set_parameters
@@ -285,6 +298,7 @@ module Luban
       def setup_tasks
         setup_init_profiles
         super
+        setup_crontab_tasks
       end
 
       def setup_init_profiles
@@ -374,4 +388,4 @@ module Luban
       end
     end
   end
-end
+end

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

@@ -0,0 +1,147 @@
+module Luban
+  module Deployment
+    class Application
+      class Crontab < Worker
+        def cronjobs; backend.host.cronjobs; end
+        def has_cronjobs?; !cronjobs.empty?; end
+
+        def crontab_file_path
+          @crontab_file_path ||= shared_path.join(crontab_file_name)
+        end
+
+        def tmp_crontab_file_path
+          @tmp_crontab_file_path ||= shared_path.join(".tmp.#{crontab_file_name}")
+        end
+
+        def crontab_file_name
+          @crontab_file_name ||= "crontab"
+        end
+
+        def crontab_template_file
+          @crontab_template_file ||= find_template_file("crontab.erb")
+        end
+
+        def crontab_header_template_file
+          @crontab_header_template_file ||= find_template_file("crontab_header.erb")
+        end
+
+        def crontab_footer_template_file
+          @crontab_footer_template_file ||= find_template_file("crontab_footer.erb")
+        end
+
+        def crontab_open
+          @crontab_open ||= "# CRONTAB BEGIN : #{env_name}"
+        end
+
+        def crontab_close
+          @crontab_close ||= "# CRONTAB END : #{env_name}"
+        end
+
+        def updated?
+          extract_crontab == capture(:cat, crontab_file_path, "2>/dev/null")
+        end
+
+        def deploy_cronjobs
+          if deploy_cronjobs!
+            update_result "Successfully published #{crontab_file_name}."
+          else
+            update_result "Skipped! ALREADY published #{crontab_file_name}.", status: :skipped
+          end
+        end
+
+        def update_cronjobs
+          unless file?(crontab_file_path)
+            update_result "FAILED to update crontab: missing #{crontab_file_path}.", status: :failed, level: :error
+            return
+          end
+          if updated?
+            update_result "Skipped! ALREADY updated crontab.", status: :skipped
+            return
+          end
+
+          update_cronjobs!
+          if updated?
+            update_result "Successfully updated crontab."
+          else
+            update_result "FAILED to update crontab.", status: :failed, level: :error
+          end
+        end
+
+        def list_cronjobs
+          crontab = extract_crontab(task.opts.all)
+          if crontab.empty?
+            update_result "No crontab for #{user}."
+          else
+            update_result crontab
+          end
+        end
+
+        def shell_setup
+          @shell_setup ||= task.opts.release.nil? ? ["source #{envrc_file}"] : super
+        end
+
+        def shell_delimiter; @shell_delimiter ||= '&&'; end
+
+        protected
+
+        def deploy_cronjobs!
+          rm(crontab_file_path) if force?
+          upload_by_template(file_to_upload: crontab_file_path,
+                             template_file:  crontab_template_file,
+                             header_file: crontab_header_template_file,
+                             footer_file: crontab_footer_template_file,
+                             auto_revision: true)
+        end
+
+        def crontab_entry(command:, schedule:, output: "", type: :shell, disabled: false)
+          if output.is_a?(String) and !output.empty?
+            output = log_path.join("cron.#{output}")
+          end
+          command_composer = "#{type}_command"
+          unless respond_to?(command_composer)
+            abort "Aborted! Unknown cronjob type: #{type.inspect}"
+          end
+          command = send(command_composer, command, output: output)
+          entry = "#{schedule} #{command}"
+          disabled ? "# DISABLED - #{entry}" : entry
+        end
+
+        def update_cronjobs!
+          crontab = capture(:crontab, "-l")
+          new_crontab = capture(:cat, crontab_file_path, "2>/dev/null")
+          old = false
+          crontab = crontab.split("\n").inject([]) do |lines, line|
+            if old || line == crontab_open
+              lines << new_crontab unless (old = line != crontab_close)
+            else
+              lines << line
+            end
+            lines
+          end
+          if crontab.empty?
+            test(:crontab, crontab_file_path, "2>&1")
+          else
+            upload!(StringIO.new(crontab.join("\n")), tmp_crontab_file_path)
+            test(:crontab, tmp_crontab_file_path, "2>&1")
+          end
+        ensure
+          rm(tmp_crontab_file_path)
+        end
+
+        def extract_crontab(all = false)
+          crontab = capture(:crontab, "-l")
+          return crontab if all
+
+          old = false
+          crontab.split("\n").inject([]) do |lines, line|
+            if old || line == crontab_open
+              lines << line
+              old = line != crontab_close
+            end
+            lines
+          end.join("\n")
+        end
+      end
+    end
+  end
+end

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

@@ -11,8 +11,8 @@ module Luban
 
         def has_gemfile?; file?(gemfile); end
 
-        def shell_setup_commands
-          @shell_setup_commands ||= super << "cd #{release_path}"
+        def shell_setup
+          @shell_setup ||= super << "cd #{release_path}"
         end
 
         %i(name full_name version major_version patch_level).each do |method|
@@ -38,6 +38,10 @@ module Luban
         def bundle_executable
           @bundle_executable ||= ruby_bin_path.join('bundle')
         end
+
+        def bundle_command(cmd, **opts)
+          shell_command("#{bundle_executable} exec #{cmd}", **opts)
+        end
       end
     end
   end

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

@@ -6,4 +6,5 @@ require_relative 'application/repository'
 require_relative 'application/publisher'
 require_relative 'application/configurator'
 require_relative 'application/controller'
+require_relative 'application/crontab'
 

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

@@ -141,6 +141,55 @@ module Luban
             end
           end
         end
+
+        module Crontab
+          Actions = %i(update_cronjobs list_cronjobs)
+          Actions.each do |action|
+            define_method(action) do |args:, opts:|
+              raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
+            end
+          end
+
+          def cronjobs; @cronjobs ||= []; end
+
+          def has_cronjobs?; !cronjobs.empty?; end
+
+          def cronjob(roles: nil, hosts: nil, **job)
+            validate_cronjob(job)
+            roles = Array(roles)
+            hosts = Array(hosts)
+            servers = select_servers(roles, hosts)
+            servers.each { |s| server(s, cronjob: job) }
+            cronjobs << job
+          end
+
+          protected
+
+          def validate_cronjob(job)
+            if job[:command].nil?
+              abort "Aborted! Cron job command is MISSING."
+            end
+            if job[:schedule].nil?
+              abort "Aborted! Cron job schedule is MISSING for command: #{job[:command]}"
+            end
+            if cronjobs.any? { |j| j[:command] == job[:command] }
+              abort "Aborted! Duplicate command is FOUND: #{job[:command]}"
+            end
+          end
+
+          def setup_crontab_tasks
+            task :cronjobs_update do
+              desc 'Update cron jobs'
+              action! :update_cronjobs
+            end
+
+            task :cronjobs_list do
+              desc 'List cron jobs'
+              switch :all, "List all cron jobs"
+              action! :list_cronjobs
+            end
+          end
+        end
       end
 
       using Luban::CLI::CoreRefinements

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

@@ -38,15 +38,15 @@ module Luban
           end
 
           def monitor_command
-            @monitor_command ||= "#{monitor_executable} monitor #{service_entry}"
+            @monitor_command ||= shell_command("#{monitor_executable} monitor #{service_entry}")
           end
 
           def unmonitor_command
-            @unmonitor_command ||= "#{monitor_executable} unmonitor #{service_entry}"
+            @unmonitor_command ||= shell_command("#{monitor_executable} unmonitor #{service_entry}")
           end
 
           def reload_monitor_command
-            @reload_monitor_command ||= "#{monitor_executable} reload"
+            @reload_monitor_command ||= shell_command("#{monitor_executable} reload")
           end
 
           def start_process
@@ -186,13 +186,8 @@ module Luban
             succeeded
           end
 
-          def start_process!
-            capture(compose_command(start_command))
-          end
-
-          def stop_process!
-            capture(compose_command(stop_command))
-          end
+          def start_process!; capture(start_command); end
+          def stop_process!; capture(stop_command); end
 
           def check_process!
             if pid_file_missing?
@@ -230,15 +225,15 @@ module Luban
           end
 
           def monitor_process!
-            test(compose_command(monitor_command))
+            test(monitor_command)
           end
 
           def unmonitor_process!
-            test(compose_command(unmonitor_command))
+            test(unmonitor_command)
           end
 
           def reload_monitor_process!
-            test(compose_command(reload_monitor_command))
+            test(reload_monitor_command)
           end
         end
         

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

@@ -3,24 +3,31 @@ module Luban
     module Service
       class Worker < Luban::Deployment::Package::Worker
         module Base
-          def shell_setup_commands
-            @shell_setup_commands ||= ["source #{envrc_file}"]
+          def shell_setup; @shell_setup ||= ["source #{envrc_file}"]; end
+          def shell_prefix; @shell_prefix ||= []; end
+          def shell_output; @shell_output ||= :stdout; end
+          def shell_delimiter; @shell_delimiter ||= ';'; end
+
+          def shell_command(cmd, setup: shell_setup, prefix: shell_prefix, 
+                                 output: shell_output, delimiter: shell_delimiter)
+            cmd = "#{prefix.join(' ')} #{cmd}" unless prefix.empty?
+            cmd = "#{cmd} #{output_redirection(output)}"
+            "#{setup.join(' ' + delimiter + ' ')} #{delimiter} #{cmd}"
+          end
+
+          def output_redirection(output)
+            case output
+            when :stdout
+              "2>&1"
+            when nil
+              ">> /dev/null 2>&1"
+            when ""
+              ""
+            else
+              ">> #{output} 2>&1"
+            end
           end
 
-          def shell_command_prefix
-            @shell_command_prefix ||= []
-          end
-
-          def shell_command_output
-            @shell_command_output ||= '2>&1'
-          end
-
-          def compose_command(cmd, delimiter: ';')
-            cmd = "#{shell_command_prefix.join(' ')} #{cmd}" unless shell_command_prefix.empty?
-            cmd = "#{cmd} #{shell_command_output}" unless shell_command_output.empty?
-            "#{shell_setup_commands.join(' ' + delimiter + ' ')} #{delimiter} #{cmd}"
-          end
-          
           %i(name full_name version major_version patch_level).each do |method|
             define_method("service_#{method}") { send("target_#{method}") }
           end

data/lib/luban/deployment/configuration/server.rb

@@ -31,7 +31,7 @@ module Luban
         end
 
         def properties
-          @properties ||= { :roles => Set.new }
+          @properties ||= { :roles => Set.new, :cronjobs => Set.new }
         end
 
         def [](key)
@@ -57,13 +57,27 @@ module Luban
         end
         alias_method :set, :[]=
 
-       def add_properties(_properties)
+        def add_properties(_properties)
           _properties.each { |k, v| self[k] = v }
         end
 
         def primary?
           self[:primary]
         end
+
+        def cronjobs
+          self[:cronjobs]
+        end
+
+        def add_cronjobs(cronjobs)
+          cronjobs.each { |cronjob| add_cronjob(cronjob) }
+        end 
+        alias_method :cronjobs=, :add_cronjobs
+
+        def add_cronjob(cronjob)
+          cronjobs.add(cronjob)
+        end
+        alias_method :cronjob=, :add_cronjob
       end
     end
   end

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

@@ -120,6 +120,7 @@ module Luban
 
         def upload_by_template(file_to_upload:, template_file:, 
                                header_file: find_template_file('header.erb'), 
+                               footer_file: nil,
                                auto_revision: false, **opts)
           content = render_template(template_file, context: binding)
 
@@ -127,13 +128,15 @@ module Luban
           if auto_revision
             require 'digest/md5'
             revision = Digest::MD5.hexdigest(content)
-            return if revision_match?(file_to_upload, revision)
+            return false if revision_match?(file_to_upload, revision)
           end
 
-          header = render_template(header_file, context: binding)
+          header = header_file.nil? ? '' : render_template(header_file, context: binding)
+          footer = footer_file.nil? ? '' : render_template(footer_file, context: binding)
 
-          upload!(StringIO.new(header + content), file_to_upload)
+          upload!(StringIO.new(header + content + footer), file_to_upload)
           yield file_to_upload if block_given?
+          true
         end
 
         def render_template(template_file, context: binding)

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

@@ -0,0 +1,6 @@
+<% unless has_cronjobs? -%>
+# !!! No cronjobs for <%= user %> !!!
+<% end -%>
+<% cronjobs.each do |cronjob| -%>
+<%= "#{crontab_entry(**cronjob)}" %>
+<% end -%>

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

@@ -0,0 +1 @@
+<%= crontab_close %>

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

@@ -0,0 +1,3 @@
+<%= crontab_open %>
+# Revision: <%= revision %>
+# Created at <%= now %>

data/lib/luban/deployment/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module Deployment
-    VERSION = "0.7.15"
+    VERSION = "0.8.0"
   end
 end

data/luban.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = ">= 2.1.0"
-  spec.add_runtime_dependency 'luban-cli'
+  spec.add_runtime_dependency 'luban-cli', ">=0.4.5"
   spec.add_runtime_dependency 'sshkit'
   
   spec.add_development_dependency "bundler", "~> 1.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban
 version: !ruby/object:Gem::Version
-  version: 0.7.15
+  version: 0.8.0
 platform: ruby
 authors:
 - Rubyist Lei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luban-cli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - lib/luban/deployment/cli/application/configurator.rb
 - lib/luban/deployment/cli/application/constructor.rb
 - lib/luban/deployment/cli/application/controller.rb
+- lib/luban/deployment/cli/application/crontab.rb
 - lib/luban/deployment/cli/application/publisher.rb
 - lib/luban/deployment/cli/application/repository.rb
 - lib/luban/deployment/cli/application/scm/git.rb
@@ -156,6 +157,9 @@ files:
 - lib/luban/deployment/templates/application/config/deploy/__stage/templates/.gitkeep
 - lib/luban/deployment/templates/application/config/templates/profile/.gitkeep
 - lib/luban/deployment/templates/application/lib/application.rb.erb
+- lib/luban/deployment/templates/crontab.erb
+- lib/luban/deployment/templates/crontab_footer.erb
+- lib/luban/deployment/templates/crontab_header.erb
 - lib/luban/deployment/templates/envrc.erb
 - lib/luban/deployment/templates/header.erb
 - lib/luban/deployment/templates/project/.gitignore