ztk 1.0.9 → 1.0.10

data/.travis.yml

@@ -3,13 +3,14 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 
 before_install:
-  - sudo apt-get -qq update
+  - sudo apt-get -qq --force-yes update
 
 bundler_args: --binstubs
 
-script: "rake spec"
+script: "rake test"
 
 notifications:
   irc: "irc.freenode.net#jovelabs"

data/README.md

@@ -1,6 +1,6 @@
 [![Build Status](https://secure.travis-ci.org/zpatten/ztk.png)](http://travis-ci.org/zpatten/ztk)
-[![Dependency Status](https://gemnasium.com/zpatten/ztk.png)](https://gemnasium.com/zpatten/ztk)
 [![Code Climate](https://codeclimate.com/github/zpatten/ztk.png)](https://codeclimate.com/github/zpatten/ztk)
+[![Dependency Status](https://gemnasium.com/zpatten/ztk.png)](https://gemnasium.com/zpatten/ztk)
 
 # ZTK
 

data/lib/ztk.rb

@@ -43,6 +43,7 @@ module ZTK
   autoload :Config, "ztk/config"
   autoload :Logger, "ztk/logger"
   autoload :Parallel, "ztk/parallel"
+  autoload :PTY, "ztk/pty"
   autoload :Report, "ztk/report"
   autoload :RescueRetry, "ztk/rescue_retry"
   autoload :Spinner, "ztk/spinner"

data/lib/ztk/command.rb

@@ -61,7 +61,7 @@ module ZTK
     # @example Execute a command:
     #
     #   cmd = ZTK::Command.new
-    #   puts cmd.exec("hostname -f").inspect
+    #   puts cmd.exec("hostname").inspect
     #
     def exec(command, options={})
       options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(config.send(:table)).merge(options))

data/lib/ztk/pty.rb

@@ -0,0 +1,61 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Zachary Patten
+#     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 'pty'
+
+module ZTK
+
+  # ZTK::PTY Error Class
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class PTYError < Error; end
+
+  # Ruby PTY Class Wrapper
+  # @author Zachary Patten <zachary@jovelabs.net>
+  class PTY
+
+    class << self
+
+      # Wraps the Ruby PTY class, providing better functionality.
+      #
+      # @param [Array] args An argument splat to be passed to PTY::spawn
+      #
+      # @return [Object] Returns the $? object.
+      def spawn(*args, &block)
+
+        if block_given?
+          ::PTY.spawn(*args) do |reader, writer, pid|
+            begin
+              yield(reader, writer, pid)
+            rescue Errno::EIO
+            ensure
+              ::Process.wait(pid)
+            end
+          end
+        else
+          reader, writer, pid = ::PTY.spawn(*args)
+        end
+
+        [reader, writer, pid]
+      end
+
+    end
+
+  end
+
+end

data/lib/ztk/ssh.rb

@@ -205,7 +205,7 @@ module ZTK
     #     config.user = ENV["USER"]
     #     config.host_name = "127.0.0.1"
     #   end
-    #   puts ssh.exec("hostname -f").inspect
+    #   puts ssh.exec("hostname").inspect
     def exec(command, options={})
       options = OpenStruct.new({ :exit_code => 0, :silence => false }.merge(config.send(:table)).merge(options))
 

data/lib/ztk/version.rb

@@ -21,6 +21,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "1.0.9"
+  VERSION = "1.0.10"
 
 end

data/spec/spec_helper.rb

@@ -31,6 +31,7 @@ end if ENV["COVERAGE"]
 ENV['LOG_LEVEL'] = "DEBUG"
 
 WAIT_SMALL = 3
+READ_PARTIAL_CHUNK = 2048
 
 RSpec.configure do |config|
 

data/spec/ztk/command_spec.rb

@@ -36,12 +36,12 @@ describe ZTK::Command do
 
     describe "execute" do
 
-      it "should be able to execute the command \"hostname -f\"" do
+      it "should be able to execute the command \"hostname\"" do
         subject.config do |config|
           config.ui = $ui
         end
-        hostname = %x(hostname -f).chomp
-        status = subject.exec("hostname -f")
+        hostname = %x(hostname).chomp
+        status = subject.exec("hostname")
         status.exit_code.should == 0
         $ui.stdout.rewind
         $ui.stdout.read.chomp.should == hostname
@@ -52,8 +52,8 @@ describe ZTK::Command do
           config.ui = $ui
           config.timeout = WAIT_SMALL
         end
-        hostname = %x(hostname -f).chomp
-        lambda { subject.exec("hostname -f ; sleep 10") }.should raise_error ZTK::CommandError
+        hostname = %x(hostname).chomp
+        lambda { subject.exec("hostname ; sleep 10") }.should raise_error ZTK::CommandError
       end
 
       it "should throw an exception if the exit status is not as expected" do
@@ -107,7 +107,7 @@ describe ZTK::Command do
           end
           data = "Hello World @ #{Time.now.utc}"
 
-          subject.exec(%Q{echo "#{data}" -f >&1})
+          subject.exec(%Q{echo "#{data}" >&1})
 
           $ui.stdout.rewind
           $ui.stdout.read.match(data).should_not be nil
@@ -129,7 +129,7 @@ describe ZTK::Command do
           end
           data = "Hello World @ #{Time.now.utc}"
 
-          subject.exec(%Q{echo "#{data}" -f >&2})
+          subject.exec(%Q{echo "#{data}" >&2})
 
           $ui.stdout.rewind
           $ui.stdout.read.match(data).should be nil

data/spec/ztk/pty_spec.rb

@@ -0,0 +1,100 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.net>
+#   Copyright: Copyright (c) Zachary Patten
+#     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::PTY do
+
+  subject { ZTK::PTY }
+
+  describe "class" do
+
+    it "should be ZTK::PTY" do
+      subject.should be ZTK::PTY
+    end
+
+  end
+
+  describe "behaviour" do
+
+    it "should spawn a command with a block" do
+      lambda do
+        subject.spawn("hostname") do |r, w, p|
+        end
+      end.should_not raise_error
+    end
+
+    it "should spawn a command without a block" do
+      lambda do
+        r, w, p = subject.spawn("hostname")
+      end.should_not raise_error
+    end
+
+    describe "spawn" do
+
+      it "should be able to spawn the command \"hostname\"" do
+        data = %x(hostname).chomp
+
+        reader, writer, pid = subject.spawn("hostname")
+        output = reader.readpartial(READ_PARTIAL_CHUNK).chomp
+
+        output.should == data
+      end
+
+      it "should return the output of spawned commands" do
+        data = "Hello World @ #{Time.now.utc}"
+
+        reader, writer, pid = subject.spawn(%(echo "#{data}"))
+        output = reader.readpartial(READ_PARTIAL_CHUNK).chomp
+
+        output.should == data
+      end
+
+      describe "stdout" do
+
+        it "should capture stdout and send it to the reader" do
+          data = "Hello World @ #{Time.now.utc}"
+
+          reader, writer, pid = subject.spawn(%(echo "#{data}" >&1))
+          output = reader.readpartial(READ_PARTIAL_CHUNK).chomp
+
+          output.should == data
+        end
+
+      end
+
+      describe "stderr" do
+
+        it "should capture stderr and send it to the reader" do
+          data = "Hello World @ #{Time.now.utc}"
+
+          reader, writer, pid = subject.spawn(%(echo "#{data}" >&2))
+          output = reader.readpartial(READ_PARTIAL_CHUNK).chomp
+
+          output.should == data
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/ztk/ssh_spec.rb

@@ -45,9 +45,9 @@ describe ZTK::SSH do
           config.host_name = "127.0.0.1"
         end
 
-        data = %x(hostname -f).chomp
+        data = %x(hostname).chomp
 
-        status = subject.exec("hostname -f")
+        status = subject.exec("hostname")
         status.exit_code.should == 0
         $ui.stdout.rewind
         $ui.stdout.read.chomp.should == data
@@ -61,8 +61,8 @@ describe ZTK::SSH do
           config.host_name = "127.0.0.1"
           config.timeout = WAIT_SMALL
         end
-        hostname = %x(hostname -f).chomp
-        lambda { subject.exec("hostname -f ; sleep 10") }.should raise_error ZTK::SSHError
+        hostname = %x(hostname).chomp
+        lambda { subject.exec("hostname ; sleep 10") }.should raise_error ZTK::SSHError
       end
 
       it "should throw an exception if the exit status is not as expected" do
@@ -293,9 +293,9 @@ describe ZTK::SSH do
           config.proxy_host_name = "127.0.0.1"
         end
 
-        data = %x( hostname -f ).chomp
+        data = %x( hostname ).chomp
 
-        status = subject.exec("hostname -f")
+        status = subject.exec("hostname")
         status.exit_code.should == 0
         $ui.stdout.rewind
         $ui.stdout.read.chomp.should == data
@@ -311,8 +311,8 @@ describe ZTK::SSH do
           config.proxy_host_name = "127.0.0.1"
           config.timeout = WAIT_SMALL
         end
-        hostname = %x(hostname -f).chomp
-        lambda { subject.exec("hostname -f ; sleep 10") }.should raise_error ZTK::SSHError
+        hostname = %x(hostname).chomp
+        lambda { subject.exec("hostname ; sleep 10") }.should raise_error ZTK::SSHError
       end
 
       it "should throw an exception if the exit status is not as expected" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -209,6 +209,7 @@ files:
 - lib/ztk/dsl/core/relations/has_many.rb
 - lib/ztk/logger.rb
 - lib/ztk/parallel.rb
+- lib/ztk/pty.rb
 - lib/ztk/report.rb
 - lib/ztk/rescue_retry.rb
 - lib/ztk/spinner.rb
@@ -228,6 +229,7 @@ files:
 - spec/ztk/dsl_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
+- spec/ztk/pty_spec.rb
 - spec/ztk/rescue_retry_spec.rb
 - spec/ztk/spinner_spec.rb
 - spec/ztk/ssh_spec.rb
@@ -250,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -955411107059050686
+      hash: 4473587828937144611
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -259,10 +261,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -955411107059050686
+      hash: 4473587828937144611
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Contains various classes and utilities I find I regularly need.
@@ -278,6 +280,7 @@ test_files:
 - spec/ztk/dsl_spec.rb
 - spec/ztk/logger_spec.rb
 - spec/ztk/parallel_spec.rb
+- spec/ztk/pty_spec.rb
 - spec/ztk/rescue_retry_spec.rb
 - spec/ztk/spinner_spec.rb
 - spec/ztk/ssh_spec.rb