luban 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22f7040c1da873d1aa03672d4918506c4c6eef8d
-  data.tar.gz: 6df3eeefecd1377d4e0b6db086f57859f08cc5d1
+  metadata.gz: 1869e9e885d7001c5da72cb20649de3efe0373aa
+  data.tar.gz: 4fa710ce988a9dd6abe9b7ab099504851b25f8da
 SHA512:
-  metadata.gz: 299133650c4099b5f8e61f45998d91388b87edfb168676eee5ad07eda8c5e2652c358984e464551bea814826ae01b87eca6326ccaf77ad881e29d63a428c3e05
-  data.tar.gz: 9dcb174a692218a5f921af3e58c1b017ec1362b220b9bc19bfecaa13ae6fc1ecb95b6a89d64760f1cbed84bcdcb7ddac46cf3a32ad4108a436461972354b7698
+  metadata.gz: dc8d972f086c40b6bab462d389d685263d56bc44925ca41789ab963defe7c04a6f0348beeffeceb748d5ec8b7e298e676d3a51542ef98bb50b695a08d411862d
+  data.tar.gz: a657dfb9403ffaeee93f2abe34c1dee081058d7a84053422f6ec2bf700c09b1ae54a2890ec082b305374f1562f9f489e2ecd6eae739d1b005ee5b9983b236eac

data/CHANGELOG.md

@@ -1,6 +1,33 @@
 # Change log
 
-## Version 0.5.5 (WIP)
+## Version 0.6.0 (Jul 08, 2016)
+
+New features:
+  * Added support for Cluster in Service::Controller
+  * Added control & configuration support for application if it has its own source code
+
+Minor enhancements:
+  * Ensured profile updates with the updated release info passed thru task to Configurator
+  * Refactored and standardized the following metadata for worker task:
+    * :name, :full_name, :version:, :major_version, :patch_level
+    * Created correponding instance methods with proper prefix for worker classes:
+      * Worker::Base with prefix "target_"
+      * Package::Worker with prefix "package_" 
+      * Service::Worker with prefix "service_"
+      * Application::Worker with prefix "application_"
+  * Updated binstubs after source code deployment in case any new bins are deployed
+  * Made task dispatcher method as protected
+  * Removed two unnecessary parameters: :log_format and :log_level
+  * Refactored method #default_templates_path in a DRY way
+  * Minor code cleanup
+
+Bug fixes:
+  * Returned revision as nill if any unexpected errors occur during revision fetching for Git
+  * Do not create symlinks for linked_dirs when publishing application profile
+  * Fixed duplicate result output when output format is not blakchole
+  * Made task dispatcher methods as protected
+
+## Version 0.5.5 (Jun 29, 2016)
 
 Minor enhancements:
   * Refactored app/service profile templates initialization
@@ -15,13 +42,15 @@ Minor enhancements:
 
 ## Version 0.5.1 (Jun 24, 2016)
 
-Minor enhancements:
+New features:
   * Added subcommands #init to initialize deployment application/service profiles
+
+Minor enhancements:
   * Added .gitignore file to the deployment project skeleton
 
 ## Version 0.5.0 (Jun 22, 2016)
 
-Minor enhancements:
+New features:
   * Added a series of subcommands, #init to
     * Initialize a Luban deployment project
     * Initialize a Luban deployment application

data/README.md

@@ -30,7 +30,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/luban/fork )
+1. Fork it ( https://github.com/lubanrb/luban/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

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

@@ -69,60 +69,87 @@ module Luban
         opts[:roles] << scm_role unless scm_role.nil?
         promptless_authen!(args: args, opts: opts)
       end
+      dispatch_task :public_key!, to: :authenticator, as: :public_key, locally: true
+      dispatch_task :promptless_authen!, to: :authenticator, as: :promptless_authen
 
       def setup(args:, opts:)
         show_app_environment
         promptless_authen(args: args, opts: opts)
         setup!(args: args, opts: opts)
       end
+      dispatch_task :setup!, to: :constructor, as: :setup
 
       def build(args:, opts:)
         show_app_environment
-        install_all(args: args, opts: opts)
+        install_all!(args: args, opts: opts)
         build_repositories(args: args, opts: opts)
       end
 
       def destroy(args:, opts:)
-        uninstall_all(args: args, opts: opts)
+        uninstall_all!(args: args, opts: opts)
         destroy!(args: args, opts: opts)
       end
 
+      def destroy_project(args:, opts:)
+        show_app_environment
+        destroy!(args: args, opts: opts.merge(destroy_project: true))
+      end
+      dispatch_task :destroy!, to: :constructor, as: :destroy
+
       %i(install_all uninstall_all).each do |action|
-        define_method(action) do |args:, opts:|
-          packages.each_value { |p| p.send(__method__, args: args, opts: opts) }
+        define_method("#{action}!") do |args:, opts:|
+          packages.each_value { |p| p.send(action, args: args, opts: opts) }
         end
+        protected "#{action}!"
       end
 
-      (Luban::Deployment::Command::Tasks::Install::Actions - 
-       %i(setup build destroy)).each do |action|
+      (Luban::Deployment::Command::Tasks::Install::Actions - %i(setup build destroy)).each do |action|
         define_method(action) do |args:, opts:|
           show_app_environment
-          packages.each_value { |p| p.send(__method__, args: args, opts: opts) }
+          send("#{action}!", args: args, opts: opts)
         end
-      end
 
-      alias_method :cleanup_packages, :cleanup
-      def cleanup(args:, opts:)
-        cleanup_packages(args: args, opts: opts)
-        cleanup!(args: args, opts: opts)
+        define_method("#{action}!") do |args:, opts:|
+          packages.each_value { |p| p.send(action, args: args, opts: opts) }
+        end
+        protected "#{action}!"
       end
 
-      def destroy_project(args:, opts:)
-        show_app_environment
-        destroy!(args: args, opts: opts.merge(destroy_project: true))
+      alias_method :cleanup_packages!, :cleanup!
+      def cleanup!(args:, opts:)
+        cleanup_packages!(args: args, opts: opts)
+        cleanup_application!(args: args, opts: opts)
       end
+      protected :cleanup!
+      dispatch_task :cleanup_application!, to: :constructor, as: :cleanup
 
       def deploy(args:, opts:)
         show_app_environment
+        if has_source?
+          release = deploy_release(args: args, opts: opts)
+          opts = opts.merge(release: release)
+        end
         deploy_profile(args: args, opts: opts) if has_profile?
-        deploy_release(args: args, opts: opts) if has_source?
       end
 
       Luban::Deployment::Command::Tasks::Control::Actions.each do |action|
         define_method(action) do |args:, opts:|
           show_app_environment
-          services.each_value { |s| s.send(__method__, args: args, opts: opts) }
+          send("#{action}!", args: args, opts: opts)
+        end
+
+        define_method("#{action}!") do |args:, opts:|
+          send("application_#{action}!", args: args, opts: opts) if has_source?
+          send("service_#{action}!", args: args, opts: opts)
+        end
+        protected "#{action}!"
+
+        dispatch_task "application_#{action}!", to: :controller, as: action
+
+        define_method("service_#{action}!") do |args:, opts:|
+          services.each_value { |s| s.send(action, args: args, opts: opts) }
         end
+        protected "service_#{action}!"
       end
 
       def init_profiles(args:, opts:)
@@ -136,6 +163,7 @@ module Luban
           init_profile!(args: args, opts: opts.merge(default_templates: default_templates))
         end
       end
+      dispatch_task :init_profile!, to: :configurator, as: :init_profile, locally: true
 
       def init_service_profiles(args:, opts:)
         return if opts[:app]
@@ -171,6 +199,11 @@ module Luban
         set_default_profile
       end
 
+      def set_default_application_parameters
+        super
+        linked_dirs.push('log', 'pids')
+      end
+
       def set_default_profile
         if config_finder[:application].has_profile?
           profile(config_finder[:application].stage_profile_path, scm: :rsync) 
@@ -204,7 +237,7 @@ module Luban
       end
 
       def compose_task_options(opts)
-        super.merge(name: 'app').tap do |o|
+        super.merge(name: name.to_s, packages: packages).tap do |o|
           o.merge!(version: source_version) if has_source?
         end
       end
@@ -213,14 +246,11 @@ module Luban
         puts "#{display_name} in #{parent.class.name}"
       end
 
-      %i(setup destroy cleanup).each do |task|
-        dispatch_task "#{task}!", to: :constructor, as: task
-      end
-
       def build_repositories(args:, opts:)
         build_repository!(args: args, opts: opts.merge(repository: profile)) if has_profile?
         build_repository!(args: args, opts: opts.merge(repository: source)) if has_source?
       end
+      dispatch_task :build_repository!, to: :repository, as: :build, locally: true
 
       def deploy_profile(args:, opts:)
         update_profile(args: args, opts: opts)
@@ -231,9 +261,12 @@ module Luban
         update_profile!(args: args, opts: opts)
         services.each_value { |s| s.send(:update_profile, args: args, opts: opts) }
       end
+      dispatch_task :update_profile!, to: :configurator, as: :update_profile, locally: true
 
       def deploy_release(args:, opts:)
-        deploy_release!(args: args, opts: opts.merge(repository: source))
+        deploy_release!(args: args, opts: opts.merge(repository: source)).tap do
+          binstubs!(args: args, opts: opts)
+        end
       end
 
       def deploy_release!(args:, opts:)
@@ -244,12 +277,6 @@ module Luban
         end
       end
       alias_method :deploy_profile!, :deploy_release!
-
-      dispatch_task :promptless_authen!, to: :authenticator, as: :promptless_authen
-      dispatch_task :public_key!, to: :authenticator, as: :public_key, locally: true
-      dispatch_task :init_profile!, to: :configurator, as: :init_profile, locally: true
-      dispatch_task :update_profile!, to: :configurator, as: :update_profile, locally: true
-      dispatch_task :build_repository!, to: :repository, as: :build, locally: true
       dispatch_task :package_release!, to: :repository, as: :package, locally: true
       dispatch_task :publish_release!, to: :publisher, as: :publish
     end

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

@@ -3,6 +3,13 @@ module Luban
     class Application
       class Configurator < Worker
         include Luban::Deployment::Service::Configurator::Base
+
+        def release_type; task.opts.release[:type]; end
+        def release_tag; task.opts.release[:tag]; end
+
+        def release_path
+          @release_path ||= releases_path.join(release_type, release_tag)
+        end
       end
     end
   end

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

@@ -43,11 +43,11 @@ module Luban
         end
 
         def bundle_path
-          @bundle_path ||= shared_path.join('vendor').join('bundle')
+          @bundle_path ||= shared_path.join('vendor', 'bundle')
         end
 
         def gems_cache_path
-          @gems_cache_path ||= shared_path.join('vendor').join('cache')
+          @gems_cache_path ||= shared_path.join('vendor', 'cache')
         end
 
         def bundle_without
@@ -118,7 +118,6 @@ module Luban
 
         def create_symlinks
           send("create_#{release_type}_symlinks")
-          create_shared_symlinks_for(:directory, linked_dirs)
           create_shared_symlinks_for(:directory, bundle_linked_dirs) if file?(gemfile)
         end
 
@@ -129,7 +128,7 @@ module Luban
 
         def create_app_symlinks
           create_release_symlink(app_path)
-          create_shared_symlinks_for(:directory, %w(profile))
+          create_shared_symlinks_for(:directory, linked_dirs | %w(profile))
           create_shared_symlinks_for(:file, linked_files)
         end
 

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

@@ -23,11 +23,11 @@ module Luban
         end
 
         def clone_path
-          @clone_path ||= workspace_path.join('repositories').join(type)
+          @clone_path ||= workspace_path.join('repositories', type)
         end
 
         def releases_path
-          @releases_path ||= workspace_path.join('releases').join(type)
+          @releases_path ||= workspace_path.join('releases', type)
         end
 
         def release_package_path
@@ -67,7 +67,7 @@ module Luban
         #   release: copy the contents of cloned repository onto the release path
         [:available?, :cloned?, :fetch_revision, :clone, :update, :release].each do |method|
           define_method(method) do
-            raise NotImplementedError, "\#{self.class.name}##{__method__} is an abstract method."
+            raise NotImplementedError, "#{self.class.name}##{__method__} is an abstract method."
           end
         end
 
@@ -75,12 +75,12 @@ module Luban
           assure_dirs(clone_path, releases_path)
           if cloned? and !force?
             update_revision
-            update_result "Skipped! Local #{type} repository has been built ALREADY.", status: :skipped
+            update_result "Skipped! Local #{type} repository has been built ALREADY (#{revision}).", status: :skipped
           else
             if available?
               if build!
                 update_revision
-                update_result "Successfully built local #{type} repository."
+                update_result "Successfully built local #{type} repository (#{revision})."
               else
                 update_result "FAILED to build local #{type} repository!", status: :failed, level: :error
               end
@@ -182,4 +182,4 @@ module Luban
       end
     end
   end
-end
+end

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

@@ -22,7 +22,7 @@ module Luban
             end
 
             def fetch_revision
-              within(clone_path) { capture(git_cmd, "rev-parse --short=#{rev_size} #{ref}") }
+              within(clone_path) { capture(git_cmd, "rev-parse --short=#{rev_size} #{ref} 2>/dev/null") }
               #within(clone_path) { capture(git_cmd, "rev-list --max-count=1 --abbrev-commit --abbrev=rev_size #{ref}") }
             end
 

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

@@ -5,16 +5,21 @@ module Luban
         include Luban::Deployment::Worker::Paths::Remote
         include Luban::Deployment::Service::Worker::Base
 
-        def service_name
-          @service_name ||= task.opts.name
+        %i(name full_name version major_version patch_level).each do |method|
+          define_method("application_#{method}") { send("target_#{method}") }
         end
 
-        def service_version
-          @service_version ||= task.opts.version
+        def packages; task.opts.packages; end
+
+        def package_version(package_name); packages[package_name.to_sym].current_version; end
+
+        def package_path(package_name)
+          @package_path ||= luban_install_path.join('pkg', package_name.to_s, 'versions', 
+                                                    package_version(package_name))
         end
 
-        def service_full_name
-          @service_full_name ||= "#{service_name}-#{service_version}"
+        def package_bin_path(package_name)
+          @package_bin_path ||= package_path(package_name).join('bin')
         end
       end
     end

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

@@ -177,6 +177,8 @@ module Luban
             run_task(cmd: as, args: args, opts: opts, locally: locally,
                      worker_class: self.class.worker_class(to), &blk)
           end
+
+          protected task
         end
       end
 
@@ -204,11 +206,15 @@ module Luban
           end
           mutex.synchronize { result << r }
         end
-        print_task_result result
+        print_task_result(result) if opts[:format] == :blackhole
         locally ? result.first[:__return__] : result
       end
 
-      def default_templates_path; end
+      def default_templates_path(base_path = nil)
+        return @default_templates_path if base_path.nil?
+        path = Pathname.new(base_path).dirname.join('templates')
+        @default_templates_path ||= path.exist? ? path.realpath : nil
+      end
 
       def default_templates
         default_templates_path.nil? ? [] : default_templates_path.children
@@ -316,7 +322,7 @@ module Luban
       def compose_task_options(opts); opts.clone; end
 
       def run(roles: luban_roles, hosts: nil, once: false,
-              dry_run: false, format: log_format, verbosity: log_level, **opts)
+              dry_run: false, format:, verbosity:, **opts)
         configure_backend(dry_run: dry_run, format: format, verbosity: verbosity)
         hosts = Array(hosts)
         servers = select_servers(roles, hosts)

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

@@ -49,7 +49,7 @@ module Luban
         end
 
         def install_log_path
-          @install_log_path ||= package_path.join('log').join(package_full_name)
+          @install_log_path ||= package_path.join('log', package_full_name)
         end
 
         def install_log_file_path
@@ -62,4 +62,4 @@ module Luban
       end
     end
   end
-end
+end

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

@@ -26,12 +26,9 @@ module Luban
           end
         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
-        def package_major_version; task.opts.major_version; end
-        def package_patch_level; task.opts.patch_level; end
+        %i(name full_name version major_version patch_level).each do |method|
+          define_method("package_#{method}") { send("target_#{method}") }
+        end
 
         def parent; task.opts.parent; end
         def child?; !parent.nil?; end

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

@@ -34,8 +34,7 @@ module Luban
           end
 
           def monitor_executable
-            @monitor_executable ||= env_path.join("#{stage}.#{process_monitor[:env]}").
-                                                  join('bin').join(process_monitor[:name])
+            @monitor_executable ||= env_path.join("#{stage}.#{process_monitor[:env]}", 'bin', process_monitor[:name])
           end
 
           def monitor_command
@@ -174,11 +173,11 @@ module Luban
 
           def check_process!
             if pid_file_missing?
-              "#{service_full_name}: started but PID file does NOT exist - #{pid_file_path}"
+              "#{service_full_name}: started but PID file(s) do NOT exist in #{pids_path}"
             elsif process_started?
-              "#{service_full_name}: started (PID #{pid})"
+              "#{service_full_name}: started - PID(s) #{pid})"
             elsif pid_file_orphaned?
-              "#{service_full_name}: stopped but PID file exists - #{pid_file_path}"
+              "#{service_full_name}: stopped but PID file(s) exist in #{pids_path}"
             else
               "#{service_full_name}: stopped"
             end
@@ -209,6 +208,37 @@ module Luban
           end
         end
 
+        module Cluster
+          def pid_file_pattern
+            raise NotImplementedError, "#{self.class.name}#pid_file_pattern is an abstract method."
+          end
+
+          def pid_files_path
+            pids_path.join(pid_file_pattern)
+          end
+
+          def pid_files
+            capture(:ls, "-A #{pid_files_path} 2>/dev/null").split.map do |f|
+              Pathname.new(f)
+            end
+          end
+
+          def pids
+            pid_files.collect { |pid_file| capture(:cat, "#{pid_file} 2>/dev/null") }
+          end
+
+          def pid; pids; end
+
+          def pid_file_exists?
+            # Any pid file is NOT zero size
+            pid_files.any? { |pid_file| file?(pid_file, "-s") }
+          end
+
+          def remove_orphaned_pid_file
+            rm(pid_files_path) if pid_file_orphaned?
+          end
+        end
+
         include Base
       end
     end

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

@@ -3,16 +3,8 @@ module Luban
     module Service
       class Worker < Luban::Deployment::Package::Worker
         module Base
-          def service_name
-            @service_name ||= package_name
-          end
-
-          def service_version
-            @service_version ||= package_version
-          end
-
-          def service_full_name
-            @service_full_name ||= package_full_name
+          %i(name full_name version major_version patch_level).each do |method|
+            define_method("service_#{method}") { send("target_#{method}") }
           end
 
           def service_entry
@@ -20,7 +12,7 @@ module Luban
           end
 
           def profile_path
-            @profile_path ||= shared_path.join('profile').join(service_name)
+            @profile_path ||= shared_path.join('profile', service_name)
           end
 
           def log_path

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

@@ -45,7 +45,7 @@ module Luban
 
           def skeletons_path
             @skeletons_path ||= 
-              Pathname.new(__FILE__).dirname.join('..').join('templates').realpath
+              Pathname.new(__FILE__).dirname.join('..', 'templates').realpath
           end
 
           def copy_dir(src_path, dst_path, stages: [], depth: 1)
@@ -123,12 +123,12 @@ module Luban
             @application_target_path ||= apps_path.join(application)
           end
 
-          def application_name
+          def application_class_name
             "#{project}:#{application}".camelcase
           end
 
           def create_application_skeleton
-            puts "Creating skeleton for #{stage} application #{application_name}"
+            puts "Creating skeleton for #{stage} application #{application_class_name}"
             copy_dir(application_skeleton_path, application_target_path, stages: [stage])
           end
         end

data/lib/luban/deployment/parameters.rb

@@ -67,8 +67,6 @@ module Luban
         parameter :sshkit_backend
         parameter :authen_key_type
         parameter :default_env
-        parameter :log_format
-        parameter :log_level
         parameter :pty
         parameter :connection_timeout
         parameter :ssh_options
@@ -81,8 +79,6 @@ module Luban
           set_default :sshkit_backend, SSHKit::Backend::Netssh
           set_default :authen_key_type, 'rsa'
           set_default :default_env, { path: '$PATH:/usr/local/bin' }
-          set_default :log_format, :pretty
-          set_default :log_level, :info
           set_default :pty, false
           set_default :connection_timeout, 30 # second
           set_default :ssh_options, {}

data/lib/luban/deployment/templates/application/config/deploy/__stage.rb.erb

@@ -1,4 +1,4 @@
-# Deployment configuration for <%= stage %> application <%= application_name %>
+# Deployment configuration for <%= stage %> application <%= application_class_name %>
 
 # Application servers
 role :app, `hostname -f`.chomp

data/lib/luban/deployment/templates/application/config/deploy.rb.erb

@@ -1 +1 @@
-# Deployment configuration for application <%= application_name %>
+# Deployment configuration for application <%= application_class_name %>

data/lib/luban/deployment/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module Deployment
-    VERSION = "0.5.5"
+    VERSION = "0.6.0"
   end
 end

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

@@ -29,6 +29,13 @@ module Luban
           @env_name ||= "#{stage}.#{project}/#{application}"
         end
 
+        def target_name; task.opts.name; end
+        def target_full_name; "#{target_name}-#{target_version}"; end
+
+        def target_version; task.opts.version; end
+        def target_major_version; task.opts.major_version || target_version; end
+        def target_patch_level; task.opts.patch_level || ''; end
+
         def run
           update_result(__return__: @run_blk ? run_with_block : run_with_command).to_h
         end

metadata

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