ztk 0.2.5 → 0.2.6

data/lib/ztk.rb

@@ -31,6 +31,8 @@ module ZTK
   class Error < StandardError; end
 
   autoload :Base, 'ztk/base'
+
+  autoload :Background, 'ztk/background'
   autoload :Benchmark, 'ztk/benchmark'
   autoload :Command, 'ztk/command'
   autoload :Config, 'ztk/config'

data/lib/ztk/background.rb

@@ -0,0 +1,145 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Jove Labs
+#     License: Apache License, VersIOn 2.0
+#
+#   Licensed under the Apache License, VersIOn 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissIOns and
+#   limitatIOns under the License.
+#
+################################################################################
+
+require "base64"
+
+module ZTK
+
+  # ZTK::Background Error Class
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class BackgroundError < Error; end
+
+  # Background Processing Class
+  #
+  # This class can be used to easily run a linear process in a background manner.
+  #
+  #     a_callback = Proc.new do |pid|
+  #       puts "Hello from After Callback - PID #{pid}"
+  #     end
+  #
+  #     b_callback = Proc.new do |pid|
+  #       puts "Hello from Before Callback - PID #{pid}"
+  #     end
+  #
+  #     background = ZTK::Background.new
+  #     background.config do |config|
+  #       config.before_fork = b_callback
+  #       config.after_fork = a_callback
+  #     end
+  #
+  #     background.process do
+  #       x
+  #     end
+  #
+  #     background.wait
+  #     background.result
+  #
+  # The before fork callback is called once in the parent process.
+  #
+  # The after fork callback is called twice, once in the parent process and once
+  # in the child process.
+  #
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class Background < ZTK::Base
+
+    # Result Set
+    attr_accessor :pid, :result
+
+    # @param [Hash] config Configuration options hash.
+    # @option config [Integer] :max_forks Maximum number of forks to use.
+    # @option config [Proc] :before_fork (nil) Proc to call before forking.
+    # @option config [Proc] :after_fork (nil) Proc to call after forking.
+    def initialize(configuration={})
+      super({
+      }.merge(configuration))
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
+
+      @result = nil
+      GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true
+    end
+
+    # Process in background.
+    #
+    # @yield Block should execute tasks to be performed in background.
+    # @yieldreturn [Object] Block can return any object to be marshalled back to
+    #   the parent processes result set.
+    # @return [Integer] Returns the pid of the child process forked.
+    def process(&block)
+      !block_given? and log_and_raise(BackgroundError, "You must supply a block to the process method!")
+
+      @child_reader, @parent_writer = IO.pipe
+      @parent_reader, @child_writer = IO.pipe
+
+      config.before_fork and config.before_fork.call(Process.pid)
+      @pid = Process.fork do
+        config.after_fork and config.after_fork.call(Process.pid)
+
+        @parent_writer.close
+        @parent_reader.close
+
+        STDOUT.reopen("/dev/null", "a")
+        STDERR.reopen("/dev/null", "a")
+        STDIN.reopen("/dev/null")
+
+        if !(data = block.call).nil?
+          config.logger.debug { "write(#{data.inspect})" }
+          @child_writer.write(Base64.encode64(Marshal.dump(data)))
+        end
+
+        @child_reader.close
+        @child_writer.close
+        Process.exit!(0)
+      end
+      config.after_fork and config.after_fork.call(Process.pid)
+
+      @child_reader.close
+      @child_writer.close
+
+      @pid
+    end
+
+    # Wait for the background process to finish.
+    #
+    # If a process successfully finished, it's return value from the *process*
+    # block is stored into the result set.
+    #
+    # @return [Array<pid, status, data>] An array containing the pid,
+    #   status and data returned from the process block.  If wait2() fails nil
+    #   is returned.
+    def wait
+      config.logger.debug { "wait" }
+      pid, status = (Process.wait2(@pid) rescue nil)
+      if !pid.nil? && !status.nil?
+        data = (Marshal.load(Base64.decode64(@parent_reader.read.to_s)) rescue nil)
+        config.logger.debug { "read(#{data.inspect})" }
+        !data.nil? and @result = data
+
+        @parent_reader.close
+        @parent_writer.close
+
+        return [pid, status, data]
+      end
+      nil
+    end
+
+  end
+
+end

data/lib/ztk/benchmark.rb

@@ -35,7 +35,7 @@ module ZTK
 
       def bench(options={}, &block)
         options = Base.build_config(options)
-        options.logger.debug { "options(#{options.inspect})" }
+        options.logger.debug { "options=#{options.send(:table).inspect}" }
 
         !block_given? and Base.log_and_raise(options.logger, BenchmarkError, "You must supply a block!")
 
@@ -54,7 +54,7 @@ module ZTK
         end
 
         (options.message && options.mark) and options.stdout.print("#{options.mark}\n" % benchmark)
-        options.logger.info { "#{options.message} #{options.mark}" }
+        options.logger.info { "#{options.message} #{options.mark}" % benchmark }
 
         benchmark
       end

data/lib/ztk/command.rb

@@ -44,9 +44,10 @@ module ZTK
 
     def initialize(configuration={})
       super({
-        :timeout => 600
+        :timeout => 600,
+        :ignore_exit_status => false
       }.merge(configuration))
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
     end
 
     def inspect
@@ -78,8 +79,8 @@ module ZTK
 
       options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(options))
 
-      config.logger.debug { "config(#{config.inspect})" }
-      config.logger.debug { "options(#{options.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
+      config.logger.debug { "options=#{options.send(:table).inspect}" }
       config.logger.info { "command(#{command.inspect})" }
 
       output = ""
@@ -167,7 +168,7 @@ module ZTK
 
       config.logger.debug { "exit_code(#{exit_code})" }
 
-      if (exit_code != options.exit_code)
+      if !config.ignore_exit_status && (exit_code != options.exit_code)
         log_and_raise(CommandError, "exec(#{command.inspect}, #{options.inspect}) failed! [#{exit_code}]")
       end
       OpenStruct.new(:output => output, :exit_code => exit_code)

data/lib/ztk/logger.rb

@@ -61,6 +61,10 @@ module ZTK
       add(severity, nil, nil, shift, &block)
     end
 
+    def inspect
+      "#<#{self.class} filename=#{@logdev.filename.inspect}>"
+    end
+
 
   private
 

data/lib/ztk/parallel.rb

@@ -80,7 +80,7 @@ module ZTK
       super({
         :max_forks => MAX_FORKS
       }.merge(configuration))
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
 
       (config.max_forks < 1) and log_and_raise(ParallelError, "max_forks must be equal to or greater than one!")
 

data/lib/ztk/rescue_retry.rb

@@ -34,9 +34,10 @@ module ZTK
       def try(options={}, &block)
         options = Base.build_config({
           :tries => 1,
-          :on => Exception
+          :on => Exception,
+          :delay => 1
         }.merge(options))
-        options.logger.debug { "options(#{options.inspect})" }
+        options.logger.debug { "options=#{options.send(:table).inspect}" }
 
         !block_given? and Base.log_and_raise(options.logger, RescueRetryError, "You must supply a block!")
 
@@ -45,9 +46,10 @@ module ZTK
         rescue options.on => e
           if ((options.tries -= 1) > 0)
             options.logger.warn { "Caught #{e.inspect}, we will give it #{options.tries} more tr#{options.tries > 1 ? 'ies' : 'y'}." }
+            sleep(options.delay)
             retry
           else
-            options.logger.fatal { "Caught #{e.inspect}, sorry, we have to give up now." }
+            options.logger.fatal { "Caught #{e.inspect} and we have no more tries left, sorry, we have to give up now." }
             raise e
           end
         end

data/lib/ztk/spinner.rb

@@ -40,7 +40,7 @@ module ZTK
         options = Base.build_config({
           :sleep => 0.1
         }.merge(options))
-        options.logger.debug { "options(#{options.inspect})" }
+        options.logger.debug { "options(#{options.send(:table).inspect})" }
 
         !block_given? and Base.log_and_raise(options.logger, SpinnerError, "You must supply a block!")
 

data/lib/ztk/ssh.rb

@@ -85,6 +85,36 @@ module ZTK
   # @author Zachary Patten <zachary@jovelabs.net>
   class SSH < ZTK::Base
 
+    EXIT_SIGNALS = {
+      1 => "SIGHUP",
+      2 => "SIGINT",
+      3 => "SIGQUIT",
+      4 => "SIGILL",
+      5 => "SIGTRAP",
+      6 => "SIGABRT",
+      7 => "SIGBUS",
+      8 => "SIGFPE",
+      9 => "SIGKILL",
+      10 => "SIGUSR1",
+      11 => "SIGSEGV",
+      12 => "SIGUSR2",
+      13 => "SIGPIPE",
+      14 => "SIGALRM",
+      15 => "SIGTERM",
+      # 16 unused?
+      17 => "SIGCHLD",
+      18 => "SIGCONT",
+      19 => "SIGSTOP",
+      20 => "SIGTSTP",
+      21 => "SIGTTIN",
+      22 => "SIGTTOU",
+      23 => "SIGURG",
+      24 => "SIGXCPU",
+      25 => "SIGXFSZ",
+      26 => "SIGVTALRM",
+      27 => "SIGPROF"
+    }
+
     # @param [Hash] config Configuration options hash.
     # @option config [String] :host_name Server hostname to connect to.
     # @option config [String] :user Username to use for authentication.
@@ -106,9 +136,10 @@ module ZTK
         :forward_agent => true,
         :compression => false,
         :user_known_hosts_file => '/dev/null',
-        :timeout => 60
+        :timeout => 60,
+        :ignore_exit_status => false
       }.merge(configuration))
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
     end
 
     def inspect
@@ -160,7 +191,7 @@ module ZTK
     #   end
     #   ssh.console
     def console
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
       config.logger.info { "console(#{console_command.inspect})" }
 
       Kernel.exec(console_command)
@@ -198,12 +229,12 @@ module ZTK
 
       options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(options))
 
-      config.logger.debug { "config(#{config.inspect})" }
-      config.logger.debug { "options(#{options.inspect})" }
-      config.logger.info { "exec(#{command.inspect}, #{options.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
+      config.logger.debug { "options=#{options.send(:table).inspect}" }
+      config.logger.info { "exec(#{command.inspect})" }
 
       output = ""
-      exit_code = nil
+      exit_code = -1
       exit_signal = nil
       stdout_header = false
       stderr_header = false
@@ -273,10 +304,15 @@ module ZTK
         log_and_raise(SSHError, "Session timed out after #{config.timeout} seconds!")
       end
 
-      config.logger.debug { "exit_code(#{exit_code}), exit_signal(#{exit_signal})" }
+      message = [
+        "exit_code=#{exit_code}",
+        (exit_signal.nil? ? nil : "exit_signal=#{exit_signal} (#{EXIT_SIGNALS[exit_signal]})")
+      ].compact.join(", ")
+
+      config.logger.debug { message }
 
-      if (exit_code != options.exit_code)
-        log_and_raise(SSHError, "exec(#{command.inspect}, #{options.inspect}) failed! [#{exit_code}, #{exit_signal}]")
+      if !config.ignore_exit_status && (exit_code != options.exit_code)
+        log_and_raise(SSHError, message)
       end
       OpenStruct.new(:output => output, :exit_code => exit_code, :exit_signal => exit_signal)
     end
@@ -297,7 +333,7 @@ module ZTK
     #   remote = File.expand_path(File.join("/tmp", "id_rsa.pub"))
     #   ssh.upload(local, remote)
     def upload(local, remote)
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
       config.logger.info { "upload(#{local.inspect}, #{remote.inspect})" }
 
       ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do
@@ -337,7 +373,7 @@ module ZTK
     #   remote = File.expand_path(File.join(ENV["HOME"], ".ssh", "id_rsa.pub"))
     #   ssh.download(remote, local)
     def download(remote, local)
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
       config.logger.info { "download(#{remote.inspect}, #{local.inspect})" }
 
       ZTK::RescueRetry.try(:tries => 3, :on => EOFError) do

data/lib/ztk/tcp_socket_check.rb

@@ -95,7 +95,7 @@ module ZTK
         :timeout => 5,
         :wait => 60
       }.merge(configuration))
-      config.logger.debug { "config(#{config.inspect})" }
+      config.logger.debug { "config=#{config.send(:table).inspect}" }
     end
 
     # Check to see if socket on the host and port specified is ready.  This

data/lib/ztk/version.rb

@@ -19,5 +19,5 @@
 ################################################################################
 
 module ZTK
-  VERSION = "0.2.5" unless const_defined?(:VERSION)
+  VERSION = "0.2.6" unless const_defined?(:VERSION)
 end

data/spec/ztk/background_spec.rb

@@ -0,0 +1,108 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Jove Labs
+#     License: Apache License, Version 2.0
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+################################################################################
+
+require "spec_helper"
+
+describe ZTK::Background do
+
+  subject { ZTK::Background.new }
+
+  before(:all) do
+    $stdout = File.open("/dev/null", "w")
+    $stderr = File.open("/dev/null", "w")
+    $stdin = File.open("/dev/null", "r")
+  end
+
+  describe "class" do
+
+    it "should be an instance of ZTK::Background" do
+      subject.should be_an_instance_of ZTK::Background
+    end
+
+    describe "default config" do
+
+      it "should use $stdout as the default" do
+        subject.config.stdout.should be_a_kind_of $stdout.class
+        subject.config.stdout.should == $stdout
+      end
+
+      it "should use $stderr as the default" do
+        subject.config.stderr.should be_a_kind_of $stderr.class
+        subject.config.stderr.should == $stderr
+      end
+
+      it "should use $stdin as the default" do
+        subject.config.stdin.should be_a_kind_of $stdin.class
+        subject.config.stdin.should == $stdin
+      end
+
+      it "should use $logger as the default" do
+        subject.config.logger.should be_a_kind_of ZTK::Logger
+        subject.config.logger.should == $logger
+      end
+
+    end
+
+  end
+
+  describe "behaviour" do
+
+    it "should throw an exception if the process method is called without a block" do
+      lambda{ subject.process }.should raise_error ZTK::BackgroundError, "You must supply a block to the process method!"
+    end
+
+    describe "process" do
+
+      it "should spawn a process to handle the task" do
+        subject.process do
+          Process.pid
+        end
+        subject.wait
+
+        subject.result.should be_kind_of Integer
+        subject.result.should > 0
+        subject.result.should_not == Process.pid
+      end
+
+    end
+
+    describe "result" do
+
+      it "should marshal objects" do
+        class BackgroundMarshalTest
+          def hello_world
+            "Hello World"
+          end
+        end
+
+        subject.process do
+          BackgroundMarshalTest.new
+        end
+        subject.wait
+
+        subject.result.should be_kind_of BackgroundMarshalTest
+        subject.result.hello_world.should == "Hello World"
+      end
+
+    end
+
+  end
+
+end

data/spec/ztk/parallel_spec.rb

@@ -74,8 +74,9 @@ describe ZTK::Parallel do
           Process.pid
         end
       end
+
       subject.waitall
-      puts subject.results.inspect
+
       subject.results.all?{ |r| r.should be_kind_of Integer }
       subject.results.all?{ |r| r.should > 0 }
       subject.results.uniq.count.should == 3
@@ -88,10 +89,11 @@ describe ZTK::Parallel do
           Process.pid
         end
       end
+
       3.times do
         subject.wait
       end
-      puts subject.results.inspect
+
       subject.results.all?{ |r| r.should be_kind_of Integer }
       subject.results.all?{ |r| r.should > 0 }
       subject.results.uniq.count.should == 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -173,6 +173,7 @@ files:
 - Rakefile
 - bin/ztk
 - lib/ztk.rb
+- lib/ztk/background.rb
 - lib/ztk/base.rb
 - lib/ztk/benchmark.rb
 - lib/ztk/command.rb
@@ -188,6 +189,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/test-config.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/background_spec.rb
 - spec/ztk/base_spec.rb
 - spec/ztk/benchmark_spec.rb
 - spec/ztk/command_spec.rb
@@ -214,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 394683779756367584
+      hash: -2261439734103096284
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -223,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 394683779756367584
+      hash: -2261439734103096284
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -234,6 +236,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/test-config.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/background_spec.rb
 - spec/ztk/base_spec.rb
 - spec/ztk/benchmark_spec.rb
 - spec/ztk/command_spec.rb