luban 0.9.9 → 0.9.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26d8138a13c8141621f6b7e11def00b80b262d3f
-  data.tar.gz: 7542bad5741e215596f25811d06c0a2266602e58
+  metadata.gz: 9d25dda1f3728164c6c4dbba1cbfffc26748f9ce
+  data.tar.gz: 2967b210dc597d9293418e9005f90f705fe4e380
 SHA512:
-  metadata.gz: ead7b1483ad3cb6362ba67663641ee7102a5977f904eadbe173adae357a614dea2b7905a7cb1a6198a9f381fbc6c3c992d85f5e1fdc0437b15ae9230fcb29b35
-  data.tar.gz: ecb3abebdf9e8ca78d0b44c0b8534946f2bb98eb59662e59899df5ca27f051db2e56bc32066c0d2a8043f31319d01846ba6ef9f486e7077e1ae7b89433d45c10
+  metadata.gz: 812bbd83cc2575d2908fd1241274d069ecb60386fe1f46f07084c604fc3aede2a56d517e20e6497551358cbbc0f1ce2798bd2e0a897cac92b2a744a9f2f02e48
+  data.tar.gz: 7bd9bb1d13b426ac1d997d5a2c9f1c3138a2114854ccf24539623bacfc346b988db89dd949d39a391e86b09aed604498fe7a3c32e4f71b9631a64e8910a8471e

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change log
 
+## Version 0.9.10 (Oct 24, 2016)
+
+Minor enhancements:
+  * Refactored and enhanced the design and implementation of parameters in a deployment project
+    * Supported default value for a given parameter
+      * set method for default value should be in the form of "set_default_for_parameter_name"
+      * any methods following the above convention will be called during default value setup
+    * Supported parameter validation by convention
+      * validation method name should be in the form of "validate_for_parameter_name"
+      * any methods following the above convention will be called during parameter validation
+    * Injected parameters from service package, if any, into the application
+  * Automated default source handling and thus no more manual set_default_source
+    * Two default source paths under application base path and stage config path
+
+
+Bug fixes:
+  * Ensured linked dirs to be created in package installer
+
 ## Version 0.9.9 (Oct 20, 2016)
 
 Bug fixes:

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

@@ -80,7 +80,10 @@ module Luban
                 command(name, base: Luban::Deployment::Package::Base.package_class(name))
               end
         pkg.update_package_options(version, opts.merge(packages: packages))
-        services[name] = pkg if pkg.is_a?(Luban::Deployment::Service::Base)
+        if pkg.is_a?(Luban::Deployment::Service::Base)
+          services[name] = pkg
+          add_service_parameters(pkg)
+        end
         packages[name] = pkg
       end
       alias_method :require_package, :package
@@ -110,7 +113,11 @@ module Luban
       end
 
       def default_source_path
-        @default_source_path ||= config_finder[:application].stage_config_path.join('app')
+        @default_source_path ||=
+          [config_finder[:application].stage_config_path.join('app'),
+           config_finder[:application].base_path.join('app')].find do |source_path|
+            File.directory?(source_path)
+          end
       end
 
       def default_source?
@@ -275,26 +282,19 @@ module Luban
         @profile_opts = {}
       end
 
-      def validate_parameters
-        super
-        validate_project_parameters
-        validate_application_parameters
-      end
-
       def set_default_parameters
+        set :application, self.class.name.split(':').last.snakecase
         super
-        set_default_project_parameters
-        set_default :application, self.class.name.split(':').last.snakecase
-        set_default_application_parameters
-        set_default_profile
       end
 
-      def set_default_source
-        source(default_source_path, scm: :rsync)
-        release(stage, current: true)
+      def set_default_for_source
+        unless default_source_path.nil?
+          source(default_source_path, scm: :rsync)
+          release(stage, current: true)
+        end
       end
 
-      def set_default_profile
+      def set_default_for_profile
         if config_finder[:application].has_profile?
           profile(config_finder[:application].stage_profile_path, scm: :rsync)
           profile_release(stage, current: true)
@@ -317,6 +317,12 @@ module Luban
         setup_crontab_tasks
       end
 
+      def add_service_parameters(service)
+        service.class.parameters.each_pair do |param, default|
+          singleton_class.send(:parameter, param, default: default)
+        end
+      end
+
       def setup_init_profiles
         _services = services.keys
         task :init do

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

@@ -365,13 +365,17 @@ module Luban
       end
 
       def set_default_parameters
-        set_default_general_parameters
+        find_instance_methods(/^set_default_for_/).each { |m| send(m) }
+      end
+
+      def find_instance_methods(pattern)
+        singleton_class.instance_methods.select { |m| m.to_s =~ pattern }.reverse
       end
 
       def load_configuration; end
 
       def validate_parameters
-        validate_general_parameters
+        find_instance_methods(/^validate_for_/).each { |m| send(m) }
       end
 
       def load_libraries; end

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

@@ -207,7 +207,7 @@ module Luban
         end
 
         def before_install
-          bootstrap_install unless installed?
+          bootstrap_install
           install_required_packages(:before_install)          
         end
 

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

@@ -98,18 +98,12 @@ module Luban
 
       protected
 
-      def validate_parameters
-        super
-        validate_project_parameters
-      end
-
       def set_default_parameters
-        super
-        set_default :stage, self.class.name.split('::').first.snakecase
-        set_default :project, self.class.name.split('::').last.snakecase
-        set_default_project_parameters
+        set :stage, self.class.name.split('::').first.snakecase
+        set :project, self.class.name.split('::').last.snakecase
         @passwords = {}
         @passwords_mutex = Mutex.new
+        super
       end
 
       def load_libraries

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

@@ -5,17 +5,34 @@ module Luban
         include Luban::Deployment::Command::Tasks::Control
         include Luban::Deployment::Command::Tasks::Monitor
 
-        def self.service_action(action, dispatch_to: nil, as: action, locally: false, &blk)
-          define_method(action) 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
+        class << self
+          def inherited(subclass)
+            super
+            # Ensure parameters from base class
+            # got inherited to its subclasses
+            params = instance_variable_get('@parameters')
+            subclass.instance_variable_set('@parameters', params.nil? ? {} : params.clone)
+          end
+
+          attr_reader :parameters
+
+          def parameter(param, default: nil)
+            super
+            parameters[param] = default
           end
-          unless dispatch_to.nil?
-            dispatch_task "#{action}!", to: dispatch_to, as: as, locally: locally, &blk
-            protected "#{action}!"
+
+          def service_action(action, dispatch_to: nil, as: action, locally: false, &blk)
+            define_method(action) 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 "#{action}!", to: dispatch_to, as: as, locally: locally, &blk
+              protected "#{action}!"
+            end
           end
         end
 

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

@@ -14,7 +14,7 @@ module Luban
       end
 
       def set_default(key, value)
-        set(key, value) unless @variables.has_key?(key)
+        set(key, value) if @variables[key].nil?
       end
 
       def delete(key)
@@ -37,6 +37,10 @@ module Luban
         @variables.keys
       end
 
+      def has_key?(key)
+        @variables.has_key?(key)
+      end
+
       def role(name, hosts, **properties)
         if name == :all
           raise ArgumentError, 'Reserved role name, :all, is NOT allowed to use.'

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

@@ -157,7 +157,6 @@ module Luban
           end
 
           def load_stage_configuration
-            target.load_configuration_file(stage_config_file)
             if File.directory?(stage_config_path)
               ["*.rb", "{packages}/**/*.rb"].each do |pattern|
                 Dir[stage_config_path.join(pattern)].each do |file|
@@ -165,6 +164,7 @@ module Luban
                 end
               end
             end
+            target.load_configuration_file(stage_config_file)
           end
 
           def find_template_file(file_name)

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

@@ -194,9 +194,9 @@ module Luban
           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
+        #def method_missing(sym, *args, &blk)
+        #  backend.respond_to?(sym) ? backend.send(sym, *args, &blk) : super
+        #end
       end
     end
   end

data/lib/luban/deployment/parameters.rb

@@ -2,12 +2,12 @@ module Luban
   module Deployment
     module Parameters
       module Base
-        def parameter(*params)
-          params.each do |param|
-            define_method(param) do |value = nil|
-              value.nil? ? fetch(__method__) : set(__method__, value)
-            end
+        def parameter(param, default: nil)
+          define_method(param) do |value = nil|
+            value.nil? ? fetch(__method__) : set(__method__, value)
           end
+          define_method("set_default_for_#{param}") { set_default param, default }
+          protected "set_default_for_#{param}"
         end
       end
 
@@ -20,37 +20,35 @@ module Luban
           mod.extend(Base)
         end
 
-        parameter :luban_roles
-        parameter :luban_root_path
+        parameter :luban_roles, default: %i(app)
+        parameter :luban_root_path, default: DefaultLubanRootPath
 
         parameter :stages
         parameter :applications
-        parameter :env_vars
+        parameter :env_vars, default: ->{ Hash.new }
 
         parameter :work_dir
         parameter :apps_path
         parameter :project
-        parameter :user
-        parameter :config_finder
+        parameter :user, default: ENV['USER']
+        parameter :config_finder, default: ->{ Hash.new }
 
         protected
 
-        def set_default_general_parameters
-          set_default :luban_roles, %i(app)
-          set_default :luban_root_path, DefaultLubanRootPath
-          set_default :env_vars, {}
-          set_default :user, ENV['USER']
-          set_default :config_finder, {}
-        end
-
-        def validate_general_parameters
+        def validate_for_user
           if user != ENV['USER']
             abort "Aborted! Given deployment user (#{user.inspect}) is NOT the current user #{ENV['USER'].inspect}" +
                   "Please switch to the deployment user before any deployments."
           end
+        end
+
+        def validate_for_project
           if project.nil?
             abort "Aborted! Please specify the project name: project 'project name'"
           end
+        end
+
+        def validate_for_luban_root_path
           if luban_root_path.is_a?(String)
             luban_root_path Pathname.new(luban_root_path)
           end
@@ -65,14 +63,14 @@ module Luban
 
         parameter :stage
 
-        parameter :process_monitor
-        parameter :sshkit_backend
-        parameter :authen_key_type
-        parameter :default_env
-        parameter :pty
-        parameter :connection_timeout
-        parameter :ssh_options
-        parameter :use_sudo
+        parameter :process_monitor, default: ->{ Hash.new }
+        parameter :sshkit_backend, default: SSHKit::Backend::Netssh
+        parameter :authen_key_type, default: 'rsa'
+        parameter :default_env, default: ->{ { path: '$PATH:/usr/local/bin' } }
+        parameter :pty, default: false
+        parameter :connection_timeout, default: 30 # second
+        parameter :ssh_options, default: ->{ Hash.new }
+        parameter :use_sudo, default: false # Turn off sudo by default
 
         def process_monitor_via(monitor, env: "uber/lubmon")
           monitor = monitor.to_s.downcase
@@ -84,25 +82,12 @@ 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' }
-          set_default :pty, false
-          set_default :connection_timeout, 30 # second
-          set_default :ssh_options, {}
-          set_default :use_sudo, false # Turn off sudo by default
-
-          setup_default_project_config_finder
-        end
-
-        def setup_default_project_config_finder
+        def set_default_for_project_config_finder
           config_finder[:project] ||=
             Luban::Deployment::Helpers::Configuration::Finder.project(self)
         end
 
-        def validate_project_parameters
+        def validate_for_process_monitor
           if monitor_defined?
             if process_monitor[:name].nil?
               abort "Aborted! Please specify the process monitor."
@@ -121,10 +106,10 @@ module Luban
         DefaultLogrotateInterval = 10 # mins
 
         parameter :application
-        parameter :scm_role
-        parameter :archive_role
-        parameter :logrotate_max_age
-        parameter :logrotate_interval
+        parameter :scm_role, default: :scm
+        parameter :archive_role, default: :archive
+        parameter :logrotate_max_age, default: DefaultLogrotateMaxAge
+        parameter :logrotate_interval, default: (ENV['LUBAN_LOGROTATE_INTERVAL'] || DefaultLogrotateInterval).to_i
 
         def env_name
           @env_name ||= "#{stage}.#{project}/#{application}"
@@ -144,21 +129,12 @@ module Luban
 
         protected
 
-        def set_default_application_parameters
-          set_default :scm_role, :scm
-          set_default :archive_role, :archive
-          set_default :logrotate_max_age, DefaultLogrotateMaxAge
-          set_default :logrotate_interval, 
-                      (ENV['LUBAN_LOGROTATE_INTERVAL'] || DefaultLogrotateInterval).to_i
-          setup_default_application_config_finder
-        end
-
-        def setup_default_application_config_finder
+        def set_default_for_application_config_finder
           config_finder[:application] ||= 
             Luban::Deployment::Helpers::Configuration::Finder.application(self)
         end
 
-        def validate_application_parameters
+        def validate_for_application
           if application.nil?
             abort "Aborted! Please specify the application name - application 'app name'"
           end

data/lib/luban/deployment/version.rb

@@ -1,5 +1,5 @@
 module Luban
   module Deployment
-    VERSION = "0.9.9"
+    VERSION = "0.9.10"
   end
 end

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

@@ -38,6 +38,15 @@ module Luban
           update_result(__return__: @run_blk ? run_with_block : run_with_command).to_h
         end
 
+        def method_missing(sym, *args, &blk)
+          if args.empty? and blk.nil? and config.has_key?(sym)
+            singleton_class.send(:define_method, sym) { config.fetch(__method__) }
+            send(sym)
+          else
+            super
+          end
+        end
+
         protected
 
         def create_task(task)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: luban
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors:
 - Rubyist Lei
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: luban-cli