joekhoobyar-capistrano-extensions 0.0.3 → 0.0.5

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 3
+:patch: 5
 :major: 0
 :minor: 0

data/lib/capistrano_extensions/files.rb

@@ -1,38 +1,40 @@
-require File.join(File.dirname(__FILE__), %w(files local.rb))
-require File.join(File.dirname(__FILE__), %w(files remote.rb))
+module CapistranoExtensions
+  module Files
 
-module CapistranoExtensions::Files
+    COMMANDS = [ %w(mkdir mkdir_p rmdir cp cp_r rm rm_r rm_rf
+                    chmod chmod_R chown chown_R touch),
+                %w(ln ln_s ln_sf mv install) ]
 
-  COMMANDS = [ %w(mkdir mkdir_p rmdir cp cp_r rm rm_r rm_rf
-                  chmod chmod_R chown chown_R touch),
-              %w(ln ln_s ln_sf mv install) ]
+    FILE_TESTS = [
+      %w(blockdev? -b),
+      %w(chardev? -c),
+      %w(directory? -d),
+      %w(exists? -e),
+      %w(file? -f),
+      %w(grpowned? -G),
+      %w(owned? -O),
+      %w(pipe? -p),
+      %w(readable? -r),
+      %w(setgid? -g),
+      %w(setuid? -u),
+      %w(size? -s),
+      %w(socket? -S),
+      %w(sticky? -k),
+      %w(symlink? -h),
+      %w(writable? -w),
+      %w(executable? -x)
+    ]
 
-  FILE_TESTS = [
-    %w(blockdev? -b),
-    %w(chardev? -c),
-    %w(directory? -d),
-    %w(exists? -e),
-    %w(file? -f),
-    %w(grpowned? -G),
-    %w(owned? -O),
-    %w(pipe? -p),
-    %w(readable? -r),
-    %w(setgid? -g),
-    %w(setuid? -u),
-    %w(size? -s),
-    %w(socket? -S),
-    %w(sticky? -k),
-    %w(symlink? -h),
-    %w(writable? -w),
-    %w(executable? -x)
-  ]
+    require File.join(File.dirname(__FILE__), %w(files local.rb))
+    require File.join(File.dirname(__FILE__), %w(files remote.rb))
 
-  class_eval(Local.public_instance_methods(false).map do |m|
-    "def #{m}(*f) send(_via.to_s + '_files').#{m}(*f) end"
-  end.join("\n"))
+    class_eval(Local.public_instance_methods(false).map do |m|
+      "def #{m}(*args, &block)\n  send(_via.to_s + '_files').#{m}(*args, &block)\nend"
+    end.join("\n"), __FILE__, __LINE__)
 
-  def _via
-    @config.fetch(:files_via, :remote).to_sym != :local ? :remote : :local
+    def _via
+      @config.fetch(:files_via, :remote).to_sym != :local ? :remote : :local
+    end
   end
 end
 

data/lib/capistrano_extensions/files/local.rb

@@ -6,11 +6,11 @@ module CapistranoExtensions
 
       include FileUtils::Verbose
 
-      public *COMMANDS
+      public *COMMANDS.flatten
       public :pwd
 
       FILE_TESTS.each do |m,t|
-        class_eval <<-EODEF
+        class_eval <<-EODEF, __FILE__, __LINE__
           def #{m}(a, options={})
             logger.trace "test #{t} \#{a.gsub ' ', '\\ '}" if logger 
             File.#{m} a

data/lib/capistrano_extensions/files/remote.rb

@@ -9,11 +9,11 @@ module CapistranoExtensions
                   %w(ln ln_s ln_sf mv install) ]
 
       COMMANDS.each_with_index do |l,n|
-        l.each do |k|
-          k, f = k.split('_')
+        l.each do |m|
+          k, f = m.split('_')
           f = ' -' + f if f
-          class_eval <<-EODEF
-            def #{k}(a, options={})
+          class_eval <<-EODEF, __FILE__, __LINE__
+            def #{m}(*args)
               options = args.pop if Hash === args.last
               _r '#{k}#{f}', args#{', ' + (n+1).to_s if n > 0}
             end
@@ -23,7 +23,7 @@ module CapistranoExtensions
 
       def tail_f(file, n=10)
         cmd = "tail -n #{n} -f #{_q file}"
-        _via == :system ? system(cmd) : stream(cmd, :via => _via)
+        _via == :system ? local_run(cmd) : stream(cmd, :via => _via)
       rescue Interrupt
         logger.trace "interrupted (Ctrl-C)" if logger
       end
@@ -62,7 +62,7 @@ module CapistranoExtensions
       def _t(cmd, args=nil, min=nil)
         cmd = _a cmd, args, min
         if _via == :system then
-          system(cmd)
+          local_run(cmd)
         else
           capture("#{cmd}; echo $?", :via => _via).strip == '0'
         end
@@ -71,10 +71,9 @@ module CapistranoExtensions
       def _r(cmd, args=nil, min=nil)
         cmd = _a cmd, args, min
         if _via != :system then
-          invoke_command(cmd, :via => _via)
+          invoke_command cmd, :via => _via
         else
-          $stdout.puts cmd
-          system cmd
+          local_run cmd
         end          
       end
 

data/lib/capistrano_extensions/invocation.rb

@@ -1,5 +1,13 @@
-module CapistranoExtension
+module CapistranoExtensions
+
   module Invocation
+    def local_run(*args, &block)
+      args.pop if Hash===args.last
+      args = args.first
+      logger.debug "executing locally: #{args}"
+      system args
+    end
+    
     def sudo_as(*args, &block)
       options = Hash===args.last ? args.pop.dup :  {}
       options[:as] = fetch(:runner, nil)
@@ -17,10 +25,9 @@ module CapistranoExtension
       options[:shell] = false
       cmd = args[0].gsub(/[$\\`"]/) { |m| "\\#{m}" }
       args[0] = "echo \"#{cmd}\" | #{sudo} su - #{fetch(:runner, nil)}"
-      #args[0] = "echo \"#{.gsub('"', '\\"')}\" | #{sudo} su - #{fetch(:runner, nil)}"
       run *args.push(options), &block
     end
   end
+
   Capistrano::Configuration.send :include, Invocation
 end
-

data/lib/capistrano_extensions/service.rb

@@ -1,109 +1,21 @@
 module CapistranoExtensions
-  module Service
-
-    LSB_DEFAULT_ACTIONS = %w(status start stop restart)
-
-    CRM_DEFAULT_ACTIONS = [	[ :status, '-W' ],
-                            [ :summary, "-x | awk '/^raw xml:/ { exit }; { print }'" ],
-                            [ :start, "--meta -d 'target_role'" ],
-                            [ :stop, "--meta -p 'target_role' -v 'stopped'" ] ]
 
-    CRM_OCF_DEFAULT_ACTIONS = [ [ :validate, '-c -C' ],
-                                [ :monitor, '-c -m' ] ]
+  module Service
 
     SVC_ACTION_CAPTIONS = Hash.new do |h,k|
       h[k] = "#{k.to_s.capitalize} Service"
-    end
-    SVC_ACTION_CAPTIONS.update :status => 'Check Status', :check => 'Check Config', :summary => 'Status Summary'
+    end.update :status => 'Check Status', 
+                :check => 'Check Config', 
+                :summary => 'Status Summary'
 
-    def crm(id,*args)
-      svc_desc = next_description(:reset)
-      svc_cmd = "/usr/sbin/crm_resource -r #{id.to_s.split(':').last}"
-      svc_actions = CRM_DEFAULT_ACTIONS
-
-      if Hash === args.last
-        options = args.pop
-        svc_desc = id.to_s.capitalize unless svc_desc or options.delete(:hide)
-        svc_actions += args.shift if Array === args.first
-      else
-        options = {}
-      end
-
-      namespace id do
-        desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
-        task :default, options do
-            sudo "#{svc_cmd} -W"
-        end
-
-        svc_actions.each do |svc_action,svc_args|
-          svc_action = svc_action.intern unless Symbol===svc_action
-          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
-          task svc_action, options do
-            sudo "#{svc_cmd} #{svc_args}"
-          end
-        end
-
-        instance_eval { yield } if block_given?
-      end
+    %w(lsb crm windows command).each do |k|
+      require File.join(File.dirname(__FILE__), 'service', k+'.rb')
     end
 
-    def crm_ocf(id,*args)
-      svc_desc = next_description(:reset)
-      svc_cmd = "ocf_resource -g #{id.to_s.split(':').last}"
-      svc_actions = CRM_OCF_DEFAULT_ACTIONS
-
-      if Hash === args.last
-        options = args.pop
-        svc_desc = id.to_s.capitalize unless svc_desc or options.delete(:hide)
-        svc_actions += args.shift if Array === args.first
-      else
-        options = {}
-      end
+    include LSB, CRM, Windows, Command
 
-      namespace id do
-        svc_actions.each do |svc_action,svc_args|
-          svc_action = svc_action.intern unless Symbol===svc_action
-          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
-          task svc_action, options do
-            sudo "#{svc_cmd} #{svc_args}"
-          end
-        end
-
-        instance_eval { yield } if block_given?
-      end
-    end
-
-    def lsb(id,*args)
-      svc_desc = next_description(:reset)
-      svc_cmd = "/etc/init.d/#{id.to_s.split(':').last}"
-      svc_actions = LSB_DEFAULT_ACTIONS 
-
-      if Hash === args.last
-        options = args.pop
-        svc_desc = id.to_s.capitalize unless svc_desc or options.delete(:hide)
-        svc_actions += args.shift if Array === args.first
-      else
-        options = {}
-      end
-
-      namespace id do
-        desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
-        task :default, options do
-            sudo "#{svc_cmd} status"
-        end
-
-        svc_actions.each do |svc_action|
-          svc_action = svc_action.intern
-          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
-          task svc_action, options do
-            sudo "#{svc_cmd} #{svc_action}"
-          end
-        end
-
-        instance_eval { yield } if block_given?
-      end
-    end
   end
+
 end
 
 Capistrano.plugin :service, CapistranoExtensions::Service

data/lib/capistrano_extensions/service/command.rb

@@ -0,0 +1,44 @@
+module CapistranoExtensions
+  module Service
+    module Command
+
+      # Check for the existance of a generic Windows NT service.
+      def command?(start, stop)
+        files.executable? start and files.executable? stop
+      end
+
+      # Defines a recipe to control a generic Windows NT service.
+      #
+      def command(id,start,stop,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        extras = args.pop if Array === args.last
+        via = options.delete(:via)
+
+        namespace id do
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:start]}" if svc_desc
+          task :start, options do
+            send(via || fetch(:run_method, :local_run), start)
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:stop]}" if svc_desc
+          task :stop, options do
+            send(via || fetch(:run_method, :local_run), stop)
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:restart]}" if svc_desc
+          task :restart, options do
+            stop
+            start
+          end
+        
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capistrano_extensions/service/crm.rb

@@ -0,0 +1,84 @@
+module CapistranoExtensions
+  module Service
+    module CRM
+
+      DEFAULT_ACTIONS = [	[ :status, '-W' ],
+                          [ :summary, "-x | awk '/^raw xml:/ { exit }; { print }'" ],
+                          [ :start, "--meta -d 'target_role'" ],
+                          [ :stop, "--meta -p 'target_role' -v 'stopped'" ] ]
+
+      OCF_DEFAULT_ACTIONS = [ [ :validate, '-c -C' ],
+                              [ :monitor, '-c -m' ] ]
+
+      # Defines a recipe to control a cluster-managed service, using heartbeat or pacemaker.
+      #
+      def crm(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "/usr/sbin/crm_resource -r #{id.to_s.split(':').last}"
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+          task :default, options do
+              sudo "#{svc_cmd} -W"
+          end
+
+          svc_actions.each do |svc_action,svc_args|
+            svc_action = svc_action.intern unless Symbol===svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              sudo "#{svc_cmd} #{svc_args}"
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+
+      # Defines a recipe providing additional controls for a cluster-managed service, 
+      # using the ocf_resource tool which interoperates with heartbeat or pacemaker.
+      #
+      # For more information about ocf_resource and other add-ons for heartbeat/pacemaker,
+      # see http://github.com/joekhoobyar/ha-tools
+      #
+      def crm_ocf(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "ocf_resource -g #{id.to_s.split(':').last}"
+
+          svc_actions.each do |svc_action,svc_args|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              sudo "#{svc_cmd} #{svc_args}"
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capistrano_extensions/service/lsb.rb

@@ -0,0 +1,47 @@
+module CapistranoExtensions
+  module Service
+    module LSB
+
+      DEFAULT_ACTIONS = %w(status start stop restart)
+
+      # Check for the existance of a generic Windows NT service.
+      def lsb?(id)
+        files.exists? "/etc/init.d/#{id.to_s.split(':').last}"
+      end
+
+      # Defines a recipe to control a generic LSB service.
+      #
+      def lsb(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+          svc_cmd = "/etc/init.d/#{id.to_s.split(':').last}"
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+          task :default, options do
+              sudo "#{svc_cmd} status"
+          end
+
+          svc_actions.each do |svc_action|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              sudo "#{svc_cmd} #{svc_action}"
+            end
+          end
+
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/capistrano_extensions/service/windows.rb

@@ -0,0 +1,64 @@
+module CapistranoExtensions
+  module Service
+    module Windows
+
+      DEFAULT_ACTIONS = [:start, :stop]
+
+      STATUS_REGEX = /STATE +: +([0-9])+ +([^ ]+)/
+
+      # Check for the existance of a generic Windows NT service.
+      def windows?(id)
+        `sc query "#{id}"` !~ / FAILED /
+      end
+
+      # Defines a recipe to control a generic Windows NT service.
+      #
+      def windows(id,*args)
+        options = Hash===args.last ? args.pop : {}
+
+        svc_name = id.to_s
+        svc_desc = next_description(:reset) || (svc_name.capitalize unless options.delete(:hide))
+        svc_actions = DEFAULT_ACTIONS 
+        svc_actions += args.pop if Array === args.last
+
+        namespace id do
+          case args.first
+          when String; id = args.shift.intern
+          when Symbol; id = args.shift
+          end
+
+          [:default, :status].each do |k|
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:status]}" if svc_desc
+            task k, options do
+              output = `sc query "#{id}"`
+              if output =~ STATUS_REGEX
+                logger.trace "Service status: #{svc_name}: #{$2} (#{$1})" if logger
+              else
+                logger.error output if logger
+                abort "Failed to get service status for #{svc_name}"
+              end
+            end
+          end
+
+          DEFAULT_ACTIONS.each do |svc_action|
+            svc_action = svc_action.intern if String === svc_action
+            desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[svc_action]}" if svc_desc
+            task svc_action, options do
+              system "net #{svc_action} \"#{id}\""
+            end
+          end
+
+          desc "#{svc_desc}: #{SVC_ACTION_CAPTIONS[:restart]}" if svc_desc
+          task :restart, options do
+            `sc query "#{id}"` =~ STATUS_REGEX
+            $1 == '4' or stop
+            start
+          end
+        
+          instance_eval { yield } if block_given?
+        end
+      end
+    end
+  end
+end
+

data/lib/capistrano_extensions/sys.rb

@@ -0,0 +1,11 @@
+module CapistranoExtensions
+  module LocalSys
+
+    def windows?
+      @windows ||= !! (RUBY_PLATFORM =~ /cygwin|mingw|win32|mswin|windows/)
+    end
+
+  end
+
+  Capistrano.plugin :local_sys, LocalSys
+end

data/lib/jk_capistrano_extensions.rb

@@ -3,6 +3,7 @@ unless Capistrano::Configuration.respond_to?(:instance)
 end
 require 'capistrano'
 
-require "#{File.dirname(__FILE__)}/capistrano_extensions/invocation.rb"
-require "#{File.dirname(__FILE__)}/capistrano_extensions/files.rb"
-require "#{File.dirname(__FILE__)}/capistrano_extensions/service.rb"
+require File.join(File.dirname(__FILE__), %w(capistrano_extensions sys))
+require File.join(File.dirname(__FILE__), %w(capistrano_extensions invocation))
+require File.join(File.dirname(__FILE__), %w(capistrano_extensions files))
+require File.join(File.dirname(__FILE__), %w(capistrano_extensions service))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: joekhoobyar-capistrano-extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors: 
 - Joe Khoobyar
@@ -38,6 +38,11 @@ files:
 - lib/capistrano_extensions/files/remote.rb
 - lib/capistrano_extensions/invocation.rb
 - lib/capistrano_extensions/service.rb
+- lib/capistrano_extensions/service/command.rb
+- lib/capistrano_extensions/service/crm.rb
+- lib/capistrano_extensions/service/lsb.rb
+- lib/capistrano_extensions/service/windows.rb
+- lib/capistrano_extensions/sys.rb
 - lib/jk_capistrano_extensions.rb
 - README
 has_rdoc: true