ztk 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5601e9072a8dc2eacd437f77c0ebbedcb408e42
-  data.tar.gz: 005d552f42c484ca4cbe260b91bd7b5d7d71323f
+  metadata.gz: bdc8f617cd4946e08ae511019c8c824602e10690
+  data.tar.gz: d59c97edbd63a148a7453aa5ccfc5ade274928b0
 SHA512:
-  metadata.gz: f8fc899e8ad6a804e1d2cd145e3c19e14b7a3cbda0317b70fcf7d43e398461229f54b13aa455e7b78ddbfb8dafa2b3b3104f278dc1d40bf773a6b1c47380a0b8
-  data.tar.gz: 5a9472f0d227c6e30d1f3c5e1687184c65df3709a3e63867cb88a68be348eb9f6325b21d456ee5cdc38b43dac4a9732d26d8fd221d2beb15c6c0da8dfe882223
+  metadata.gz: d2ba6a6764ad01b16e5e7dfd33e704f34b7c33c666299745622035c8eeefc0fc0c71d9bacb18f4587e24de74c5688a6a6a20d8b3fe4dc5e966a54dc8d4be3292
+  data.tar.gz: 6f715ee4bb05e8cc3430756556834f6057d0cd9e4d7525a054836c2240d0b2f3f8c355dbb9b6fd41df81d61b3b7ed9515eca9708237ed49017dd0de782327a1c

data/Gemfile

@@ -1,13 +1,3 @@
 source 'https://rubygems.org'
 
-gem "json" if (RUBY_VERSION == "1.8.7")
-
-if (RUBY_VERSION < "1.9.3")
-  gem "activesupport", "< 4.0.0"
-end
-
-if (RUBY_VERSION < "1.9.2")
-  gem "mime-types", "< 2.0"
-end
-
 gemspec

data/README.md

@@ -6,7 +6,7 @@
 
 # ZTK
 
-Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby, especially devops tooling.  These classes provide functionality I often find myself needing from project to project.  Instead of reinventing the wheel each time, I've started building a collection of reusable classes.  Easy-bake DSLs, parallel processing, complex logging, templating and many other useful design patterns, for example are all contained in simple, reusable classes with a common interface and configuration style.
+Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby.  These classes provide functionality I often find myself needing from project to project.  Instead of reinventing the wheel each time, I've started building a collection of reusable classes.  Easy-bake DSLs, parallel processing, complex logging, templating and many other useful design patterns, for example are all contained in simple, reusable classes with a common interface and configuration style.
 
 - **ZTK::ANSI**
 

data/lib/ztk/version.rb

@@ -1,6 +1,6 @@
 module ZTK
 
   # ZTK Version String
-  VERSION = "3.0.3"
+  VERSION = "3.0.4"
 
 end

data/spec/support/before_install.sh

@@ -17,8 +17,7 @@
 #   limitations under the License.
 #
 ################################################################################
-#!/bin/bash
-set -x
+#!/bin/bash -eux
 
 sudo apt-get -qy update
 

data/spec/ztk/ansi_spec.rb

@@ -0,0 +1,83 @@
+################################################################################
+#
+#      Author: Zachary Patten <zachary AT jovelabs DOT com>
+#   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::ANSI Module" do
+
+  subject { ZTK::ANSI }
+
+  describe "module" do
+
+    it "should be ZTK::ANSI" do
+      subject.should be ZTK::ANSI
+    end
+
+  end
+
+end
+
+describe "ZTK::ANSI Monkey-Patch String Class" do
+
+  subject {
+    class String
+      include ZTK::ANSI
+    end
+  }
+
+  describe "class" do
+
+    it "should include ZTK::ANSI" do
+      expect(subject.include?(ZTK::ANSI)).to be true
+    end
+
+  end
+
+  describe "methods" do
+
+    ZTK::ANSI::ANSI_COLORS.each do |color, code|
+
+      it "should color the string #{color}" do
+        expect(subject.new("#{color}").send(color)).to match(/#{color}/)
+        expect(subject.new("#{color}").send(color)).to match(/#{code}/)
+      end
+
+      it "should remove #{color} color from the string" do
+        expect(subject.new("#{color}").send(color).uncolor).to match(/#{color}/)
+        expect(subject.new("#{color}").send(color).uncolor).not_to match(/#{code}/)
+      end
+
+
+      it "should reset the screen and color the string #{color}" do
+        expect(subject.new("#{color}").send(color).reset).to match(/#{color}/)
+        expect(subject.new("#{color}").send(color).reset).to match(/#{code}/)
+        expect(subject.new("#{color}").send(color).reset).to start_with("\e[2J")
+      end
+
+    end
+
+    x, y = Random.rand(25), Random.rand(25)
+    it "should move the cursor to #{x},#{y}" do
+      expect(subject.new.goto(x,y)).to start_with("\e[#{x};#{y}H")
+    end
+
+  end
+
+end

data/spec/ztk/ssh_spec.rb

@@ -35,7 +35,7 @@ describe ZTK::SSH do
   describe "class" do
 
     it "should be an instance of ZTK::SSH" do
-      subject.should be_an_instance_of ZTK::SSH
+      expect(subject).to be_an_instance_of ZTK::SSH
     end
 
   end
@@ -59,6 +59,8 @@ describe ZTK::SSH do
         status.exit_code.should == 0
         @ui.stdout.rewind
         @ui.stdout.read.chomp.should == data
+
+        expect(subject.close).to be true
       end
 
       it "should timeout after the period specified" do
@@ -71,6 +73,8 @@ describe ZTK::SSH do
         end
         hostname = %x(hostname).chomp
         lambda { subject.exec("hostname ; sleep 10") }.should raise_error ZTK::SSHError
+
+        expect(subject.close).to be true
       end
 
       it "should throw an exception if the exit status is not as expected" do
@@ -81,6 +85,8 @@ describe ZTK::SSH do
           config.host_name = "127.0.0.1"
         end
         lambda { subject.exec("/bin/bash -c 'exit 64'") }.should raise_error ZTK::SSHError
+
+        expect(subject.close).to be true
       end
 
       it "should return a instance of an OpenStruct object" do
@@ -92,6 +98,8 @@ describe ZTK::SSH do
         end
         result = subject.exec(%q{echo "Hello World"})
         result.should be_an_instance_of OpenStruct
+
+        expect(subject.close).to be true
       end
 
       it "should return the exit code" do
@@ -105,6 +113,8 @@ describe ZTK::SSH do
 
         result = subject.exec(%Q{/bin/bash -c 'exit #{data}'}, :exit_code => data)
         result.exit_code.should == data
+
+        expect(subject.close).to be true
       end
 
       it "should return the output" do
@@ -118,6 +128,8 @@ describe ZTK::SSH do
 
         result = subject.exec(%Q{echo "#{data}"})
         result.output.match(data).should_not be nil
+
+        expect(subject.close).to be true
       end
 
       it "should allow us to change the expected exit code" do
@@ -129,6 +141,47 @@ describe ZTK::SSH do
         end
         data = 32
         result = subject.exec(%Q{/bin/bash -c 'exit #{data}'}, :exit_code => data)
+
+        expect(subject.close).to be true
+      end
+
+      it "should allow us to execute a bootstrap script" do
+        subject.config do |config|
+          config.ui = @ui
+
+          config.user = ENV["USER"]
+          config.host_name = "127.0.0.1"
+        end
+        data = "Hello World @ #{Time.now.utc}"
+
+        result = subject.bootstrap(<<-EOBOOTSTRAP)
+echo "#{data}" >&1
+EOBOOTSTRAP
+
+        expect(result.output).to match(/#{data}/)
+
+        expect(subject.close).to be true
+      end
+
+      it "should allow us to write a file" do
+        subject.config do |config|
+          config.ui = @ui
+
+          config.user = ENV["USER"]
+          config.host_name = "127.0.0.1"
+        end
+        data = "Hello World @ #{Time.now.utc}"
+        test_filename = File.join("", "tmp", "test_file.txt")
+
+        subject.file(:target => test_filename) do |f|
+          f.write(data)
+        end
+
+        result = subject.exec(%Q{cat #{test_filename}})
+
+        expect(result.output).to match(/#{data}/)
+
+        expect(subject.close).to be true
       end
 
       describe "stdout" do
@@ -142,16 +195,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
         it "should capture STDOUT (without PTY) and send it to the STDOUT pipe" do
@@ -165,16 +220,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
       end
@@ -190,16 +247,18 @@ describe ZTK::SSH 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_not be nil
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
         it "should capture STDERR (without PTY) and send it to the STDERR pipe" do
@@ -213,16 +272,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to be_empty
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should_not be nil
+          expect(@ui.stderr.read).to match(/#{data}/)
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
       end
@@ -259,11 +320,13 @@ describe ZTK::SSH do
           end
 
           File.exists?(remote_file).should == false
-          subject.upload(local_file, remote_file)
+          subject.upload(local_file, remote_file, :use_scp => use_scp)
           File.exists?(remote_file).should == true
 
           File.exists?(remote_file) && File.delete(remote_file)
           File.exists?(local_file) && File.delete(local_file)
+
+          expect(subject.close).to be true
         end
       end
 
@@ -278,7 +341,6 @@ describe ZTK::SSH do
 
             config.user = ENV["USER"]
             config.host_name = "127.0.0.1"
-            config.use_scp = use_scp
           end
 
           data = "Hello World @ #{Time.now.utc}"
@@ -300,11 +362,13 @@ describe ZTK::SSH do
           end
 
           File.exists?(local_file).should == false
-          subject.download(remote_file, local_file)
+          subject.download(remote_file, local_file, :use_scp => use_scp)
           File.exists?(local_file).should == true
 
           File.exists?(local_file) && File.delete(local_file)
           File.exists?(remote_file) && File.delete(remote_file)
+
+          expect(subject.close).to be true
         end
       end
 
@@ -332,6 +396,8 @@ describe ZTK::SSH do
         status.exit_code.should == 0
         @ui.stdout.rewind
         @ui.stdout.read.chomp.should == data
+
+        expect(subject.close).to be true
       end
 
       it "should timeout after the period specified" do
@@ -346,6 +412,8 @@ describe ZTK::SSH do
         end
         hostname = %x(hostname).chomp
         lambda { subject.exec("hostname ; sleep 10") }.should raise_error ZTK::SSHError
+
+        expect(subject.close).to be true
       end
 
       it "should throw an exception if the exit status is not as expected" do
@@ -358,6 +426,8 @@ describe ZTK::SSH do
           config.proxy_host_name = "127.0.0.1"
         end
         lambda { subject.exec("/bin/bash -c 'exit 64'") }.should raise_error ZTK::SSHError
+
+        expect(subject.close).to be true
       end
 
       it "should return a instance of an OpenStruct object" do
@@ -371,6 +441,8 @@ describe ZTK::SSH do
         end
         result = subject.exec(%q{echo "Hello World"})
         result.should be_an_instance_of OpenStruct
+
+        expect(subject.close).to be true
       end
 
       it "should return the exit code" do
@@ -386,6 +458,8 @@ describe ZTK::SSH do
 
         result = subject.exec(%Q{/bin/bash -c 'exit #{data}'}, :exit_code => data)
         result.exit_code.should == data
+
+        expect(subject.close).to be true
       end
 
       it "should return the output" do
@@ -401,6 +475,8 @@ describe ZTK::SSH do
 
         result = subject.exec(%Q{echo "#{data}"})
         result.output.match(data).should_not be nil
+
+        expect(subject.close).to be true
       end
 
       it "should allow us to change the expected exit code" do
@@ -414,6 +490,47 @@ describe ZTK::SSH do
         end
         data = 32
         result = subject.exec(%Q{/bin/bash -c 'exit #{data}'}, :exit_code => data)
+
+        expect(subject.close).to be true
+      end
+
+      it "should allow us to execute a bootstrap script" do
+        subject.config do |config|
+          config.ui = @ui
+
+          config.user = ENV["USER"]
+          config.host_name = "127.0.0.1"
+        end
+        data = "Hello World @ #{Time.now.utc}"
+
+        result = subject.bootstrap(<<-EOBOOTSTRAP)
+echo "#{data}" >&1
+EOBOOTSTRAP
+
+        expect(result.output).to match(/#{data}/)
+
+        expect(subject.close).to be true
+      end
+
+      it "should allow us to write a file" do
+        subject.config do |config|
+          config.ui = @ui
+
+          config.user = ENV["USER"]
+          config.host_name = "127.0.0.1"
+        end
+        data = "Hello World @ #{Time.now.utc}"
+        test_filename = File.join("", "tmp", "test_file.txt")
+
+        subject.file(:target => test_filename) do |f|
+          f.write(data)
+        end
+
+        result = subject.exec(%Q{cat #{test_filename}})
+
+        expect(result.output).to match(/#{data}/)
+
+        expect(subject.close).to be true
       end
 
       describe "stdout" do
@@ -429,16 +546,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
         it "should capture STDOUT (without PTY) and send it to the STDOUT pipe" do
@@ -454,16 +573,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
       end
@@ -481,16 +602,18 @@ describe ZTK::SSH 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_not be nil
+          expect(@ui.stdout.read).to match(/#{data}/)
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should be nil
+          expect(@ui.stderr.read).to be_empty
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
         it "should capture STDERR (without PTY) and send it to the STDERR pipe" do
@@ -506,16 +629,18 @@ describe ZTK::SSH 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
+          expect(@ui.stdout.read).to be_empty
 
           @ui.stderr.rewind
-          @ui.stderr.read.match(data).should_not be nil
+          expect(@ui.stderr.read).to match(/#{data}/)
 
           @ui.stdin.rewind
-          @ui.stdin.read.match(data).should be nil
+          expect(@ui.stdin.read).to be_empty
+
+          expect(subject.close).to be true
         end
 
       end
@@ -554,11 +679,13 @@ describe ZTK::SSH do
           end
 
           File.exists?(remote_file).should == false
-          subject.upload(local_file, remote_file)
+          subject.upload(local_file, remote_file, :use_scp => use_scp)
           File.exists?(remote_file).should == true
 
           File.exists?(remote_file) && File.delete(remote_file)
           File.exists?(local_file) && File.delete(local_file)
+
+          expect(subject.close).to be true
         end
       end
 
@@ -596,11 +723,13 @@ describe ZTK::SSH do
           end
 
           File.exists?(local_file).should == false
-          subject.download(remote_file, local_file)
+          subject.download(remote_file, local_file, :use_scp => use_scp)
           File.exists?(local_file).should == true
 
           File.exists?(local_file) && File.delete(local_file)
           File.exists?(remote_file) && File.delete(remote_file)
+
+          expect(subject.close).to be true
         end
       end
 

data/spec/ztk/tcp_socket_check_spec.rb

@@ -98,10 +98,10 @@ describe ZTK::TCPSocketCheck do
 
       describe "read check" do
 
-        it "should return false on a read check to 127.0.0.1:0" do
+        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 = 0
+            config.port = 1
             config.wait = WAIT_SMALL
           end
           subject.wait.should == false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ztk
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Zachary Patten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -346,6 +346,7 @@ files:
 - spec/support/before_install.sh
 - spec/support/test-config.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/ansi_spec.rb
 - spec/ztk/background_spec.rb
 - spec/ztk/base_spec.rb
 - spec/ztk/benchmark_spec.rb
@@ -394,6 +395,7 @@ test_files:
 - spec/support/before_install.sh
 - spec/support/test-config.rb
 - spec/support/test-template.txt.erb
+- spec/ztk/ansi_spec.rb
 - spec/ztk/background_spec.rb
 - spec/ztk/base_spec.rb
 - spec/ztk/benchmark_spec.rb