trick_bag 0.62.1 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e8ed88386c75d0f6522fca732a04df5579ab5e
-  data.tar.gz: cc023bc71f5647e01088546869b755dc896b7b26
+  metadata.gz: 0768490eaa9eb879f69f015c1d8f49c0085ba0b3
+  data.tar.gz: 8cb3fb12ffb33ef3830fcd2241b42b282085f2fd
 SHA512:
-  metadata.gz: 4ea59ca32862f9b6ad6cc99f4ec1dff179b3afe15d3cd989ccb6b9c7605ac9632a3b6d78df1e406bb15359ac6614d50181d8cc8a9b08faf4b6347c904e2ea24c
-  data.tar.gz: cc121cced456988a0a5915b3a217a52e151252b06573b3a08237201766c04a1f211ab68d60b3d8f9b2b24c155f26ddf65000a7670c2f4733ebebefd89d755278
+  metadata.gz: 5f01c0def2bc580f7f638cc1c62e19a960226ed8d3b336eddf4bf2e00c7454ea182076aa0d5d9eafd1ff4abf5271e7a35b9be2c8514983e7b72c0af0cba78bac
+  data.tar.gz: abdc6c693166648ecb65b6f1245ea9e9dc3cb0c8de73f67c65ac1ad39942855627272eeae70b0de253c4a29daffe358dcf95dc723e4963bf105a9d5b633e3369

data/RELEASE_NOTES.md

@@ -1,3 +1,7 @@
+## v0.63.0
+
+* Add SshOutputReader.
+
 ## v0.62.1
 
 * Reinstated thread.kill in Timing.try_with_timeout.

data/lib/trick_bag/networking/ssh_output_reader.rb

@@ -0,0 +1,157 @@
+require 'net/ssh'
+
+# Runs an ssh command, collecting the stdout and stderr produced by it.
+# Optionally a predicate can be specified that, when called with the
+# instance of this class, returns true to close
+# the channel or false to continue.
+#
+# There are instance methods to return the most recent and all accumulated text
+# for both stdout and stderr, so the predicate can easily inspect the text.
+#
+# While the predicate will most likely be a lambda, it can be any
+# object that responds to call().
+class SshOutputReader
+
+  attr_reader :host, :command, :user, :password, :exit_predicate
+  attr_accessor :latest_stdout, :all_stdout, :latest_stderr, :all_stderr, :latest_output_type, :channel
+
+  def initialize(host, command, user = ENV['USER'], password = nil)
+    @host = host
+    @user = user
+    @password = password
+    @command = command
+    @exit_predicate = ->(instance_of_this_class) { false }
+    clear_buffers
+  end
+
+
+  def clear_buffers
+    @latest_stdout = ''
+    @all_stdout = ''
+    @latest_stderr = ''
+    @all_stderr = ''
+  end
+
+
+  # Sets a predicate that, when called with this reader instance, returns true
+  # to close the channel and return, or false to permit the
+  # channel to continue operating.
+  #
+  # Using this self value, any instance methods can be called; the most useful
+  # will probably be latest_stdout, all_stdout, latest_stderr, and all_stderr.
+  # There is also a latest_output_type that returns :stdout or :stderr to
+  # indicate which type of output just occurred.
+  #
+  # For example, to exit when the string "exit" is sent to stdout:
+  # reader.set_exit_predicate(->(reader) { /exit/ === reader.latest_stdout })
+  #
+  # Returns self to facilitate chaining, e.g.:
+  # stdout, stderr = SshOutputReader.new(...).set_exit_predicate(...).run
+  def set_exit_predicate(exit_predicate)
+    @exit_predicate = exit_predicate
+    self
+  end
+
+
+  # Runs the specified command.
+  # If an exit predicate has been specified via set_exit_predicate,
+  # then it will be called whenever anything is output to stdout or stderr,
+  # and the channel will be closed if the predicate returns true.
+  #
+  # @return self, to support chaining
+  def run
+    clear_buffers
+    Net::SSH.start(host, user, password: password) do |ssh|
+
+      # Open a new channel and configure a minimal set of callbacks, then run
+      # the event loop until the channel finishes (closes).
+      self.channel = ssh.open_channel do |ch|
+        ch.exec(command) do |ch, success|
+          raise "could not execute command" unless success
+
+          # "on_data" is called when the process writes something to stdout
+          ch.on_data do |c, data|
+            self.latest_output_type = :stdout
+            self.latest_stdout = data
+            self.all_stdout << data
+            $stdout.print data
+            ch.close if exit_predicate.(self)
+          end
+
+          # "on_extended_data" is called when the process writes something to stderr
+          ch.on_extended_data do |c, type, data|
+            self.latest_output_type = :stderr
+            self.latest_stderr = data
+            self.all_stderr << data
+            $stderr.print data
+            ch.close if exit_predicate.(self)
+          end
+
+          ch.on_close { self.channel = nil; return self }
+        end
+      end
+
+      channel.wait
+      self.channel = nil
+      self
+    end
+  end
+
+
+  # The channel will automatically be closed if the predicate returns false
+  # or if the command completes.  This method is provided for cases where
+  # the predicate wants to raise an error; close should be called before raising the error.
+  def close
+    channel.close if channel
+  end
+
+
+  def to_s
+    "host = #{host}, command = #{command}, user = #{user}" # password intentionally omitted
+  end
+end
+
+
+
+if $0 == __FILE__
+
+  Thread.abort_on_exception = true
+  # require 'pry'
+  has_a_2 = ->(reader) do
+    reader.latest_output_type == :stdout \
+    && \
+    /2/ === reader.latest_stdout
+  end
+
+  has_3_lines = ->(reader) { reader.all_stdout.split("\n").size >= 3 }
+
+  def run_reader(r)
+    puts "Starting reader: #{r}"
+    r.run
+    puts; puts "Stdout:\n" + (r.all_stdout.empty? ? '[Empty]' : r.all_stdout)
+    puts; puts "Stderr:\n" + (r.all_stderr.empty? ? '[Empty]' : r.all_stderr)
+    puts "Done\n#{'-' * 79}\n"
+  end
+
+  command = \
+'echo 1
+sleep 1
+echo error output >& 2
+echo 2
+sleep 1
+echo 3
+sleep 1
+echo 4'
+
+  # reader = SshOutputReader.new('localhost', command)
+  # reader.run
+  # puts "All reader stdout:\n" + reader.all_stdout
+
+  run_reader(SshOutputReader.new('localhost', command)\
+      .set_exit_predicate(has_a_2))
+
+  # run_reader(SshOutputReader.new('localhost', command)\
+  #     .set_exit_predicate(has_3_lines))
+
+  # run_reader(SshOutputReader.new('localhost', command))
+end

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = '0.62.1'
+  VERSION = '0.63.0'
 end

data/trick_bag.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "os", '~> 0'
   spec.add_dependency "diffy", '~> 3.0'
+  spec.add_dependency 'net-ssh'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", '~> 10.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.62.1
+  version: 0.63.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +152,7 @@ files:
 - lib/trick_bag/io/temp_files.rb
 - lib/trick_bag/io/text_mode_status_updater.rb
 - lib/trick_bag/meta/classes.rb
+- lib/trick_bag/networking/ssh_output_reader.rb
 - lib/trick_bag/numeric/bit_mapping.rb
 - lib/trick_bag/numeric/bitmap.rb
 - lib/trick_bag/numeric/kmgt_numeric_string.rb