ztk 0.0.5 → 0.0.6

data/lib/ztk/tcp_socket_check.rb

@@ -30,7 +30,7 @@ module ZTK
 
 ################################################################################
 
-  class TCPSocketCheck < Base
+  class TCPSocketCheck < ZTK::Base
 
 ################################################################################
 
@@ -49,28 +49,28 @@ module ZTK
     def ready?
       if @config.host.nil?
         message = "You must supply a host!"
-        @config.logger and @config.logger.fatal { message }
+        log(:fatal) { message }
         raise TCPSocketCheckError, message
       end
 
       if @config.port.nil?
         message = "You must supply a port!"
-        @config.logger and @config.logger.fatal { message }
+        log(:fatal) { message }
         raise TCPSocketCheckError, message
       end
 
-      socket = ::TCPSocket.new(@config.host, @config.port)
+      socket = TCPSocket.new(@config.host, @config.port)
 
       if @config.data.nil?
-        @config.logger and @config.logger.debug { "read(#{@config.host}:#{@config.port})" }
-        ((::IO.select([socket], nil, nil, @config.timeout) && socket.gets) ? true : false)
+        log(:debug) { "read(#{@config.host}:#{@config.port})" }
+        ((IO.select([socket], nil, nil, @config.timeout) && socket.gets) ? true : false)
       else
-        @config.logger and @config.logger.debug { "write(#{@config.host}:#{@config.port}, '#{@config.data}')" }
-        ((::IO.select(nil, [socket], nil, @config.timeout) && socket.write(@config.data)) ? true : false)
+        log(:debug) { "write(#{@config.host}:#{@config.port}, '#{@config.data}')" }
+        ((IO.select(nil, [socket], nil, @config.timeout) && socket.write(@config.data)) ? true : false)
       end
 
     rescue Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
-      @config.logger and @config.logger.debug { "#{@config.host}:#{@config.port} - #{e.message}" }
+      log(:debug) { "#{@config.host}:#{@config.port} - #{e.message}" }
       false
     ensure
       (socket && socket.close)
@@ -79,16 +79,16 @@ module ZTK
 ################################################################################
 
     def wait
-      @config.logger and @config.logger.debug{ "waiting for socket to become available; timeout after #{@config.wait} seconds" }
+      log(:debug) { "waiting for socket to become available; timeout after #{@config.wait} seconds" }
       Timeout.timeout(@config.wait) do
         until ready?
-          @config.logger and @config.logger.debug{ "sleeping 1 second" }
+          log(:debug) { "sleeping 1 second" }
           sleep(1)
         end
       end
       true
     rescue Timeout::Error => e
-      @config.logger and @config.logger.warn{ "socket(#{@config.host}:#{@config.port}) timeout!" }
+      log(:warn) { "socket(#{@config.host}:#{@config.port}) timeout!" }
       false
     end
 

data/lib/ztk/template.rb

@@ -47,13 +47,13 @@ module ZTK
 ################################################################################
 
       def load_template(template)
-        ::IO.read(template).chomp
+        IO.read(template).chomp
       end
 
 ################################################################################
 
       def render_template(template, context={})
-        ::Erubis::Eruby.new(template).evaluate(context)
+        Erubis::Eruby.new(template).evaluate(context)
       end
 
 ################################################################################

data/lib/ztk/version.rb

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

data/spec/spec_helper.rb

@@ -22,14 +22,6 @@ require "ztk"
 
 ################################################################################
 
-$logger = ZTK::Logger.new("/dev/null")
-
-dev_null = File.open("/dev/null", "w")
-$stdout = dev_null
-$stderr = dev_null
-
-################################################################################
-
 require 'simplecov'
 SimpleCov.start do
   add_filter '/spec/'

data/spec/ztk/command_spec.rb

@@ -0,0 +1,78 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary@jovelabs.com>
+#   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::Command do
+
+  subject { ZTK::Command.new }
+
+  before(:all) do
+    $logger = ZTK::Logger.new("/dev/null")
+    $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::Command" do
+      subject.should be_an_instance_of ZTK::Command
+    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
+
+  it "should be able to execute the command \"hostname -f\"" do
+    stdout = StringIO.new
+    subject.config do |config|
+      config.stdout = stdout
+    end
+    hostname = %x( hostname -f ).chomp
+    status = subject.exec("hostname -f")
+    status.exitstatus.should == 0
+    stdout.rewind
+    stdout.read.chomp.should == hostname
+  end
+
+end

data/spec/ztk/parallel_spec.rb

@@ -24,6 +24,13 @@ describe ZTK::Parallel do
 
   subject { ZTK::Parallel.new }
 
+  before(:all) do
+    $logger = ZTK::Logger.new("/dev/null")
+    $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::Parallel" do
@@ -32,22 +39,22 @@ describe ZTK::Parallel do
 
     describe "default config" do
 
-      it "should use $stdout as the default STDOUT" 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 STDERR" do
+      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 STDIN" do
+      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 logger" do
+      it "should use $logger as the default" do
         subject.config.logger.should be_a_kind_of ZTK::Logger
         subject.config.logger.should == $logger
       end
@@ -56,18 +63,26 @@ describe ZTK::Parallel do
 
   end
 
-  it "should spawn multiple processes to handle each iteration" do
-    3.times do |x|
-      subject.process do
-        Process.pid
+  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::ParallelError, "You must supply a block to the process method!"
+    end
+
+    it "should spawn multiple processes to handle each iteration" do
+      3.times do |x|
+        subject.process 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
+      subject.results.include?(Process.pid).should be false
     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
-    subject.results.include?(Process.pid).should be false
+
   end
 
 end

data/spec/ztk/ssh_spec.rb

@@ -24,6 +24,13 @@ describe ZTK::SSH do
 
   subject { ZTK::SSH.new }
 
+  before(:all) do
+    $logger = ZTK::Logger.new("test.log")
+    $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::SSH" do
@@ -32,22 +39,22 @@ describe ZTK::SSH do
 
     describe "default config" do
 
-      it "should use $stdout as the default STDOUT" 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 STDERR" do
+      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 STDIN" do
+      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 logger" do
+      it "should use $logger as the default" do
         subject.config.logger.should be_a_kind_of ZTK::Logger
         subject.config.logger.should == $logger
       end
@@ -60,23 +67,33 @@ describe ZTK::SSH do
   if !ENV['CI'] && !ENV['TRAVIS']
 
     it "should be able to connect to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
+      stdout = StringIO.new
       subject.config do |config|
-        config.ssh.user = ENV["USER"]
-        config.ssh.host = "127.0.0.1"
+        config.stdout = stdout
+        config.user = ENV["USER"]
+        config.host_name = "127.0.0.1"
       end
       hostname = %x( hostname -f ).chomp
-      subject.exec("hostname -f").chomp.should == hostname
+      status = subject.exec("hostname -f")
+      status.exit.exitstatus.should == 0
+      stdout.rewind
+      stdout.read.chomp.should == hostname
     end
 
     it "should be able to proxy through 127.0.0.1, connecting to 127.0.0.1 as the current user and execute a command (your key must be in ssh-agent)" do
+      stdout = StringIO.new
       subject.config do |config|
-        config.ssh.user = ENV["USER"]
-        config.ssh.host = "127.0.0.1"
-        config.ssh.proxy_user = ENV["USER"]
-        config.ssh.proxy_host = "127.0.0.1"
+        config.stdout = stdout
+        config.user = ENV["USER"]
+        config.host_name = "127.0.0.1"
+        config.proxy_user = ENV["USER"]
+        config.proxy_host_name = "127.0.0.1"
       end
       hostname = %x( hostname -f ).chomp
-      subject.exec("hostname -f").chomp.should == hostname
+      status = subject.exec("hostname -f")
+      status.exit.exitstatus.should == 0
+      stdout.rewind
+      stdout.read.chomp.should == hostname
     end
 
   end

data/spec/ztk/tcp_socket_check_spec.rb

@@ -22,22 +22,55 @@ require "spec_helper"
 
 describe ZTK::TCPSocketCheck do
 
-  subject { ZTK::TCPSocketCheck }
+  subject { ZTK::TCPSocketCheck.new }
+
+  before(:all) do
+    $logger = ZTK::Logger.new("/dev/null")
+    $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 ZTK::TCPSocketCheck" do
-      subject.should be ZTK::TCPSocketCheck
+    it "should be an instance of ZTK::TCPSocketCheck" do
+      subject.should be_an_instance_of ZTK::TCPSocketCheck
+    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
 
     describe "config" do
 
       it "should throw an exception if the host is not specified" do
-        lambda{ subject.new(:port => 22).ready? }.should raise_error ZTK::TCPSocketCheckError, "You must supply a host!"
+        subject.config.port = 22
+        lambda{ subject.ready? }.should raise_error ZTK::TCPSocketCheckError, "You must supply a host!"
       end
 
       it "should throw an exception if the port is not specified" do
-        lambda{ subject.new(:host => "127.0.0.1").ready? }.should raise_error ZTK::TCPSocketCheckError, "You must supply a port!"
+        subject.config.host = "127.0.0.1"
+        lambda{ subject.ready? }.should raise_error ZTK::TCPSocketCheckError, "You must supply a port!"
       end
 
     end
@@ -51,13 +84,19 @@ describe ZTK::TCPSocketCheck do
       describe "read check" do
 
         it "should return true on a remote read check to github.com:22" do
-          tcp_check = subject.new(:host => "github.com", :port => 22)
-          tcp_check.ready?.should == true
+          subject.config do |config|
+            config.host = "github.com"
+            config.port = 22
+          end
+          subject.ready?.should == true
         end
 
         it "should return false on a remote read check to 127.0.0.1:1" do
-          tcp_check = subject.new(:host => "127.0.0.1", :port => 1, :timeout => 3)
-          tcp_check.ready?.should == false
+          subject.config do |config|
+            config.host = "127.0.0.1"
+            config.port = 1
+          end
+          subject.ready?.should == false
         end
 
       end
@@ -65,13 +104,21 @@ describe ZTK::TCPSocketCheck do
       describe "write check" do
 
         it "should return true on a remote write check to www.google.com:80" do
-          tcp_check = subject.new(:host => "www.google.com", :port => 80, :data => "GET")
-          tcp_check.ready?.should == true
+          subject.config do |config|
+            config.host = "www.google.com"
+            config.port = 80
+            config.data = "GET"
+          end
+          subject.ready?.should == true
         end
 
         it "should return false on a remote write check to 127.0.0.1:1" do
-          tcp_check = subject.new(:host => "127.0.0.1", :port => 1, :data => "GET", :timeout => 3)
-          tcp_check.ready?.should == false
+          subject.config do |config|
+            config.host = "127.0.0.1"
+            config.port = 1
+            config.data = "GET"
+          end
+          subject.ready?.should == false
         end
 
       end
@@ -82,28 +129,46 @@ describe ZTK::TCPSocketCheck do
 
       describe "read check" do
 
-        it "should timeout and should return false on a read check to 127.0.0.1:1" do
-          tcp_check = subject.new(:host => "127.0.0.1", :port => 1, :wait => 3)
-          tcp_check.wait.should == false
+        it "should return false on a read check to 127.0.0.1:1" do
+          subject.config do |config|
+            config.host = "127.0.0.1"
+            config.port = 1
+            config.wait = 5
+          end
+          subject.wait.should == false
         end
 
-        it "should not timeout and should return true on a read check to github.com:22" do
-          tcp_check = subject.new(:host => "github.com", :port => 22, :wait => 3)
-          tcp_check.wait.should == true
+        it "should return true on a read check to github.com:22" do
+          subject.config do |config|
+            config.host = "github.com"
+            config.port = 22
+            config.wait = 5
+          end
+          subject.wait.should == true
         end
 
       end
 
       describe "write check" do
 
-        it "should timeout and should return false on a write check to 127.0.0.1:1" do
-          tcp_check = subject.new(:host => "127.0.0.1", :port => 1, :data => "GET", :wait => 3)
-          tcp_check.wait.should == false
+        it "should return false on a write check to 127.0.0.1:1" do
+          subject.config do |config|
+            config.host = "127.0.0.1"
+            config.port = 1
+            config.data = "GET"
+            config.wait = 5
+          end
+          subject.wait.should == false
         end
 
-        it "should not timeout and should return true on a write check to www.google.com:80" do
-          tcp_check = subject.new(:host => "www.google.com", :port => 80, :data => "GET", :wait => 3)
-          tcp_check.wait.should == true
+        it "should return true on a write check to www.google.com:80" do
+          subject.config do |config|
+            config.host = "www.google.com"
+            config.port = 80
+            config.data = "GET"
+            config.wait = 5
+          end
+          subject.wait.should == true
         end
 
       end